esphome::animation::Animation Class Reference

#include <animation.h>

Inheritance diagram for esphome::animation::Animation:

Public Member Functions
	Animation (const uint8_t *data_start, int width, int height, uint32_t animation_frame_count, image::ImageType type, image::Transparency transparent, bool big_endian=false)
uint32_t	get_animation_frame_count () const
int	get_current_frame () const
void	next_frame ()
void	prev_frame ()
void	set_frame (int frame)
	Selects a specific frame within the animation.
void	set_loop (uint32_t start_frame, uint32_t end_frame, int count)
Public Member Functions inherited from esphome::image::Image
	Image (const uint8_t *data_start, int width, int height, ImageType type, Transparency transparency, bool big_endian=false)
	big_endian is the RGB565 byte order; codegen writes little endian unless configured otherwise.
Color	get_pixel (int x, int y, Color color_on=display::COLOR_ON, Color color_off=display::COLOR_OFF) const
int	get_width () const override
int	get_height () const override
const uint8_t *	get_data_start () const
ImageType	get_type () const
int	get_bpp () const
size_t	get_width_stride () const
	Return the stride of the image in bytes, that is, the distance in bytes between two consecutive rows of pixels.
void	draw (int x, int y, display::Display *display, Color color_on, Color color_off) override
bool	has_transparency () const
lv_image_dsc_t *	get_lv_image_dsc ()
Public Member Functions inherited from esphome::display::BaseImage

Protected Member Functions
void	update_data_start_ ()
Protected Member Functions inherited from esphome::image::Image
template<bool ROWS_OUTER>
void	draw_ (int x, int y, display::Display *display, Color color_on, Color color_off, int x_start, int x_end, int y_start, int y_end)
	Per-pixel draw of the clipped range, rows (true) or columns (false) outer.
bool	get_binary_pixel_ (int x, int y) const
Color	get_rgb111_pixel_ (int x, int y) const
Color	get_rgb_pixel_ (int x, int y) const
Color	get_rgb565_pixel_ (int x, int y) const
Color	get_grayscale_pixel_ (int x, int y) const

Protected Attributes
const uint8_t *	animation_data_start_
int	current_frame_
uint32_t	animation_frame_count_
uint32_t	loop_start_frame_
uint32_t	loop_end_frame_
int	loop_count_
int	loop_current_iteration_
Protected Attributes inherited from esphome::image::Image
int	width_
int	height_
ImageType	type_
const uint8_t *	data_start_
Transparency	transparency_
bool	big_endian_
uint8_t	bpp_ {}
lv_img_dsc_t	dsc_ {}

Detailed Description

Definition at line 6 of file animation.h.

Constructor & Destructor Documentation

Animation()

esphome::animation::Animation::Animation	(	const uint8_t *	data_start,
		int	width,
		int	height,
		uint32_t	animation_frame_count,
		image::ImageType	type,
		image::Transparency	transparent,
		bool	big_endian = false )

Definition at line 7 of file animation.cpp.

Member Function Documentation

get_animation_frame_count()

uint32_t esphome::animation::Animation::get_animation_frame_count

(

)

const

Definition at line 24 of file animation.cpp.

get_current_frame()

int esphome::animation::Animation::get_current_frame

(

)

const

Definition at line 25 of file animation.cpp.

next_frame()

void esphome::animation::Animation::next_frame

(

)

Definition at line 26 of file animation.cpp.

prev_frame()

void esphome::animation::Animation::prev_frame

(

)

Definition at line 40 of file animation.cpp.

set_frame()

void esphome::animation::Animation::set_frame

(

int

frame

)

Selects a specific frame within the animation.

Parameters

frame

If possitive, advance to the frame. If negative, recede to that frame from the end frame.

Definition at line 49 of file animation.cpp.

set_loop()

void esphome::animation::Animation::set_loop	(	uint32_t	start_frame,
		uint32_t	end_frame,
		int	count )

Definition at line 17 of file animation.cpp.

update_data_start_()

void esphome::animation::Animation::update_data_start_ ( )

protected

Definition at line 63 of file animation.cpp.

Field Documentation

animation_data_start_

const uint8_t* esphome::animation::Animation::animation_data_start_

protected

Definition at line 27 of file animation.h.

animation_frame_count_

uint32_t esphome::animation::Animation::animation_frame_count_

protected

Definition at line 29 of file animation.h.

current_frame_

int esphome::animation::Animation::current_frame_

protected

Definition at line 28 of file animation.h.

loop_count_

int esphome::animation::Animation::loop_count_

protected

Definition at line 32 of file animation.h.

loop_current_iteration_

int esphome::animation::Animation::loop_current_iteration_

protected

Definition at line 33 of file animation.h.

loop_end_frame_

uint32_t esphome::animation::Animation::loop_end_frame_

protected

Definition at line 31 of file animation.h.

loop_start_frame_

uint32_t esphome::animation::Animation::loop_start_frame_

protected

Definition at line 30 of file animation.h.

---

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

• esphome/components/animation/animation.h
• esphome/components/animation/animation.cpp