esphome::runtime_image::PngDecoder Class Reference

Image decoder specialization for PNG images. More...

#include <png_decoder.h>

Inheritance diagram for esphome::runtime_image::PngDecoder:

Public Member Functions
	PngDecoder (RuntimeImage *image)
	Construct a new PNG Decoder object.
	~PngDecoder () override
int	prepare (size_t expected_size) override
int HOT	decode (uint8_t *buffer, size_t size) override
void	increment_pixels_decoded (uint32_t count)
uint32_t	get_pixels_decoded () const
Public Member Functions inherited from esphome::runtime_image::ImageDecoder
	ImageDecoder (RuntimeImage *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.
virtual bool	is_finished () const
	Check if the decoder has finished processing.

Protected Attributes
RAMAllocator< pngle_t >	allocator_
pngle_t *	pngle_ {nullptr}
uint32_t	pixels_decoded_ {0}
Protected Attributes inherited from esphome::runtime_image::ImageDecoder
RuntimeImage *	image_
size_t	expected_size_ = 0
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_decoder.h.

Constructor & Destructor Documentation

PngDecoder()

esphome::runtime_image::PngDecoder::PngDecoder

(

RuntimeImage *

image

)

Construct a new PNG Decoder object.

Parameters

image

The RuntimeImage to decode the stream into.

Definition at line 51 of file png_decoder.cpp.

~PngDecoder()

esphome::runtime_image::PngDecoder::~PngDecoder ( )

override

Definition at line 64 of file png_decoder.cpp.

Member Function Documentation

decode()

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

overridevirtual

Implements esphome::runtime_image::ImageDecoder.

Definition at line 83 of file png_decoder.cpp.

get_pixels_decoded()

uint32_t esphome::runtime_image::PngDecoder::get_pixels_decoded ( ) const

inline

Definition at line 29 of file png_decoder.h.

increment_pixels_decoded()

void esphome::runtime_image::PngDecoder::increment_pixels_decoded ( uint32_t count )

inline

Definition at line 28 of file png_decoder.h.

prepare()

int esphome::runtime_image::PngDecoder::prepare ( size_t expected_size )

overridevirtual

Reimplemented from esphome::runtime_image::ImageDecoder.

Definition at line 71 of file png_decoder.cpp.

Field Documentation

allocator_

RAMAllocator<pngle_t> esphome::runtime_image::PngDecoder::allocator_

protected

Definition at line 32 of file png_decoder.h.

pixels_decoded_

uint32_t esphome::runtime_image::PngDecoder::pixels_decoded_ {0}

protected

Definition at line 34 of file png_decoder.h.

pngle_

pngle_t* esphome::runtime_image::PngDecoder::pngle_ {nullptr}

protected

Definition at line 33 of file png_decoder.h.

---

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

• esphome/components/runtime_image/png_decoder.h
• esphome/components/runtime_image/png_decoder.cpp