ESPHome 2025.5.2
All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Modules Pages
esphome::online_image::PngDecoder Class Reference

Image decoder specialization for PNG images. More...

#include <png_image.h>

Inheritance diagram for esphome::online_image::PngDecoder:
esphome::online_image::ImageDecoder

Public Member Functions

 PngDecoder (OnlineImage *image)
 Construct a new PNG Decoder object.
 
 ~PngDecoder () 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.
 
virtual ~ImageDecoder ()=default
 
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.
 
bool is_finished () const
 

Protected Attributes

RAMAllocator< pngle_t > allocator_
 
pngle_t * pngle_
 
- 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 PNG images.

Definition at line 15 of file png_image.h.

Constructor & Destructor Documentation

◆ PngDecoder()

esphome::online_image::PngDecoder::PngDecoder ( OnlineImage * image)

Construct a new PNG Decoder object.

Parameters
displayThe image to decode the stream into.

Definition at line 43 of file png_image.cpp.

◆ ~PngDecoder()

esphome::online_image::PngDecoder::~PngDecoder ( )
override

Definition at line 56 of file png_image.cpp.

Member Function Documentation

◆ decode()

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

Implements esphome::online_image::ImageDecoder.

Definition at line 75 of file png_image.cpp.

◆ prepare()

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

Reimplemented from esphome::online_image::ImageDecoder.

Definition at line 63 of file png_image.cpp.

Field Documentation

◆ allocator_

RAMAllocator<pngle_t> esphome::online_image::PngDecoder::allocator_
protected

Definition at line 29 of file png_image.h.

◆ pngle_

pngle_t* esphome::online_image::PngDecoder::pngle_
protected

Definition at line 30 of file png_image.h.


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