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

void	reset () 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, 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).

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
pngle_t *	pngle_ {nullptr}

uint32_t	pixels_decoded_ {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 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 65 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 86 of file png_decoder.cpp.

◆ get_pixels_decoded()

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

inline

Definition at line 37 of file png_decoder.h.

◆ increment_pixels_decoded()

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

inline

Definition at line 36 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 73 of file png_decoder.cpp.

◆ reset()

void esphome::runtime_image::PngDecoder::reset ( )

inlineoverridevirtual

Reimplemented from esphome::runtime_image::ImageDecoder.

Definition at line 25 of file png_decoder.h.

Field Documentation

◆ pixels_decoded_

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

protected

Definition at line 41 of file png_decoder.h.

◆ pngle_

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