ESPHome  2025.2.0
Public Member Functions | Protected Attributes
esphome::online_image::JpegDecoder Class Reference

Image decoder specialization for JPEG images. More...

#include <jpeg_image.h>

Inheritance diagram for esphome::online_image::JpegDecoder:
esphome::online_image::ImageDecoder

Public Member Functions

 JpegDecoder (OnlineImage *image)
 Construct a new JPEG Decoder object. More...
 
 ~JpegDecoder () override
 
int prepare (size_t download_size) override
 
int HOT decode (uint8_t *buffer, size_t size) override
 
- Public Member Functions inherited from esphome::online_image::ImageDecoder
 ImageDecoder (OnlineImage *image)
 Construct a new Image Decoder object. More...
 
virtual ~ImageDecoder ()=default
 
bool set_size (int width, int height)
 Request the image to be resized once the actual dimensions are known. More...
 
void draw (int x, int y, int w, int h, const Color &color)
 Fill a rectangle on the display_buffer using the defined color. More...
 
bool is_finished () const
 

Protected Attributes

JPEGDEC jpeg_ {}
 
- Protected Attributes inherited from esphome::online_image::ImageDecoder
OnlineImageimage_
 
size_t download_size_ = 1
 
size_t decoded_bytes_ = 0
 
double x_scale_ = 1.0
 
double y_scale_ = 1.0
 

Detailed Description

Image decoder specialization for JPEG images.

Definition at line 14 of file jpeg_image.h.

Constructor & Destructor Documentation

◆ JpegDecoder()

esphome::online_image::JpegDecoder::JpegDecoder ( OnlineImage image)
inline

Construct a new JPEG Decoder object.

Parameters
displayThe image to decode the stream into.

Definition at line 21 of file jpeg_image.h.

◆ ~JpegDecoder()

esphome::online_image::JpegDecoder::~JpegDecoder ( )
inlineoverride

Definition at line 22 of file jpeg_image.h.

Member Function Documentation

◆ decode()

int HOT esphome::online_image::JpegDecoder::decode ( uint8_t *  buffer,
size_t  size 
)
overridevirtual

Implements esphome::online_image::ImageDecoder.

Definition at line 54 of file jpeg_image.cpp.

◆ prepare()

int esphome::online_image::JpegDecoder::prepare ( size_t  download_size)
overridevirtual

Reimplemented from esphome::online_image::ImageDecoder.

Definition at line 44 of file jpeg_image.cpp.

Field Documentation

◆ jpeg_

JPEGDEC esphome::online_image::JpegDecoder::jpeg_ {}
protected

Definition at line 28 of file jpeg_image.h.


The documentation for this class was generated from the following files: