ESPHome 2026.9.0-dev
Loading...
Searching...
No Matches
Public Member Functions | Protected Attributes
esphome::runtime_image::BmpDecoder Class Reference

Image decoder specialization for BMP images. More...

#include <bmp_decoder.h>

Inheritance diagram for esphome::runtime_image::BmpDecoder:
esphome::runtime_image::ImageDecoder

Public Member Functions

 BmpDecoder (RuntimeImage *image)
 Construct a new BMP Decoder object.
 
void reset () override
 
int HOT decode (uint8_t *buffer, size_t size) override
 
bool is_finished () const override
 
- Public Member Functions inherited from esphome::runtime_image::ImageDecoder
 ImageDecoder (RuntimeImage *image, ImageFormat format)
 Construct a new Image Decoder object.
 
virtual ~ImageDecoder ()=default
 
ImageFormat get_format () const
 Get the image format handled by this decoder.
 
bool is_active () const
 Check if a decoding session is in progress (prepare() called, reset() not yet).
 
virtual int prepare (size_t expected_size)
 Initialize the decoder, starting a new decoding session.
 
bool set_size (int width, int height)
 Request the image to be resized once the actual dimensions are known.
 
void draw (int x, int y, int w, int h, const Color &color)
 Fill a rectangle on the display_buffer using the defined color.
 

Protected Attributes

std::unique_ptr< uint32_t[]> color_table_
 
size_t current_index_ {0}
 
size_t paint_index_ {0}
 
ssize_t width_ {0}
 
ssize_t height_ {0}
 
size_t width_bytes_ {0}
 
size_t data_offset_ {0}
 
uint32_t compression_method_ {0}
 
uint32_t image_data_size_ {0}
 
uint32_t color_table_entries_ {0}
 
uint32_t color_table_capacity_ {0}
 
uint16_t bits_per_pixel_ {0}
 
uint8_t padding_bytes_ {0}
 
- Protected Attributes inherited from esphome::runtime_image::ImageDecoder
double x_scale_ = 1.0
 
double y_scale_ = 1.0
 
RuntimeImage * image_
 
size_t expected_size_ = 0
 
size_t decoded_bytes_ = 0
 
const ImageFormat format_
 
bool active_ = false
 
bool size_valid_ = true
 

Detailed Description

Image decoder specialization for BMP images.

Definition at line 17 of file bmp_decoder.h.

Constructor & Destructor Documentation

◆ BmpDecoder()

esphome::runtime_image::BmpDecoder::BmpDecoder ( RuntimeImage * image)
inline

Construct a new BMP Decoder object.

Parameters
imageThe RuntimeImage to decode the stream into.

Definition at line 24 of file bmp_decoder.h.

Member Function Documentation

◆ decode()

int HOT esphome::runtime_image::BmpDecoder::decode ( uint8_t * buffer,
size_t size )
overridevirtual

BMP file format: 0-1: Signature (BM) 2-5: File size 6-9: Reserved 10-13: Pixel data offset

Integer values are stored in little-endian format.

BMP DIB header: 14-17: DIB header size 18-21: Image width 22-25: Image height 26-27: Number of color planes 28-29: Bits per pixel 30-33: Compression method 34-37: Image data size 38-41: Horizontal resolution 42-45: Vertical resolution 46-49: Number of colors in the color table

Implements esphome::runtime_image::ImageDecoder.

Definition at line 31 of file bmp_decoder.cpp.

◆ is_finished()

bool esphome::runtime_image::BmpDecoder::is_finished ( ) const
inlineoverridevirtual

Reimplemented from esphome::runtime_image::ImageDecoder.

Definition at line 29 of file bmp_decoder.h.

◆ reset()

void esphome::runtime_image::BmpDecoder::reset ( )
overridevirtual

Reimplemented from esphome::runtime_image::ImageDecoder.

Definition at line 15 of file bmp_decoder.cpp.

Field Documentation

◆ bits_per_pixel_

uint16_t esphome::runtime_image::BmpDecoder::bits_per_pixel_ {0}
protected

Definition at line 50 of file bmp_decoder.h.

◆ color_table_

std::unique_ptr<uint32_t[]> esphome::runtime_image::BmpDecoder::color_table_
protected

Definition at line 39 of file bmp_decoder.h.

◆ color_table_capacity_

uint32_t esphome::runtime_image::BmpDecoder::color_table_capacity_ {0}
protected

Definition at line 49 of file bmp_decoder.h.

◆ color_table_entries_

uint32_t esphome::runtime_image::BmpDecoder::color_table_entries_ {0}
protected

Definition at line 48 of file bmp_decoder.h.

◆ compression_method_

uint32_t esphome::runtime_image::BmpDecoder::compression_method_ {0}
protected

Definition at line 46 of file bmp_decoder.h.

◆ current_index_

size_t esphome::runtime_image::BmpDecoder::current_index_ {0}
protected

Definition at line 40 of file bmp_decoder.h.

◆ data_offset_

size_t esphome::runtime_image::BmpDecoder::data_offset_ {0}
protected

Definition at line 45 of file bmp_decoder.h.

◆ height_

ssize_t esphome::runtime_image::BmpDecoder::height_ {0}
protected

Definition at line 43 of file bmp_decoder.h.

◆ image_data_size_

uint32_t esphome::runtime_image::BmpDecoder::image_data_size_ {0}
protected

Definition at line 47 of file bmp_decoder.h.

◆ padding_bytes_

uint8_t esphome::runtime_image::BmpDecoder::padding_bytes_ {0}
protected

Definition at line 51 of file bmp_decoder.h.

◆ paint_index_

size_t esphome::runtime_image::BmpDecoder::paint_index_ {0}
protected

Definition at line 41 of file bmp_decoder.h.

◆ width_

ssize_t esphome::runtime_image::BmpDecoder::width_ {0}
protected

Definition at line 42 of file bmp_decoder.h.

◆ width_bytes_

size_t esphome::runtime_image::BmpDecoder::width_bytes_ {0}
protected

Definition at line 44 of file bmp_decoder.h.

The documentation for this class was generated from the following files:
Generated by doxygen 1.12.0