#include <sdl_esphome.h>

Inheritance diagram for esphome::sdl::Sdl:

Public Member Functions
display::DisplayType	get_display_type () override

void	update () override

void	loop () override

void	setup () override

void	draw_pixels_at (int x_start, int y_start, int w, int h, const uint8_t *ptr, display::ColorOrder order, display::ColorBitness bitness, bool big_endian, int x_offset, int y_offset, int x_pad) override

void	draw_pixel_at (int x, int y, Color color) override

void	set_dimensions (uint16_t width, uint16_t height)

int	get_width () override

int	get_height () override

float	get_setup_priority () const override

void	dump_config () override

Public Member Functions inherited from esphome::display::Display
virtual void	fill (Color color)
	Fill the entire screen with the given color. More...

void	clear ()
	Clear the entire screen by filling it with OFF pixels. More...

int	get_native_width ()
	Get the native (original) width of the display in pixels. More...

int	get_native_height ()
	Get the native (original) height of the display in pixels. More...

void	draw_pixel_at (int x, int y)
	Set a single pixel at the specified coordinates to default color. More...

void	draw_pixels_at (int x_start, int y_start, int w, int h, const uint8_t *ptr, ColorOrder order, ColorBitness bitness, bool big_endian)
	Convenience overload for base case where the pixels are packed into the buffer with no gaps (e.g. suits LVGL.) More...

void	line (int x1, int y1, int x2, int y2, Color color=COLOR_ON)
	Draw a straight line from the point [x1,y1] to [x2,y2] with the given color. More...

void	line_at_angle (int x, int y, int angle, int length, Color color=COLOR_ON)
	Draw a straight line at the given angle based on the origin [x, y] for a specified length with the given color. More...

void	line_at_angle (int x, int y, int angle, int start_radius, int stop_radius, Color color=COLOR_ON)
	Draw a straight line at the given angle based on the origin [x, y] from a specified start and stop radius with the given color. More...

void	horizontal_line (int x, int y, int width, Color color=COLOR_ON)
	Draw a horizontal line from the point [x,y] to [x+width,y] with the given color. More...

void	vertical_line (int x, int y, int height, Color color=COLOR_ON)
	Draw a vertical line from the point [x,y] to [x,y+width] with the given color. More...

void	rectangle (int x1, int y1, int width, int height, Color color=COLOR_ON)
	Draw the outline of a rectangle with the top left point at [x1,y1] and the bottom right point at [x1+width,y1+height]. More...

void	filled_rectangle (int x1, int y1, int width, int height, Color color=COLOR_ON)
	Fill a rectangle with the top left point at [x1,y1] and the bottom right point at [x1+width,y1+height]. More...

void	circle (int center_x, int center_xy, int radius, Color color=COLOR_ON)
	Draw the outline of a circle centered around [center_x,center_y] with the radius radius with the given color. More...

void	filled_circle (int center_x, int center_y, int radius, Color color=COLOR_ON)
	Fill a circle centered around [center_x,center_y] with the radius radius with the given color. More...

void	filled_ring (int center_x, int center_y, int radius1, int radius2, Color color=COLOR_ON)
	Fill a ring centered around [center_x,center_y] between two circles with the radius1 and radius2 with the given color. More...

void	filled_gauge (int center_x, int center_y, int radius1, int radius2, int progress, Color color=COLOR_ON)
	Fill a half-ring "gauge" centered around [center_x,center_y] between two circles with the radius1 and radius2 with he given color and filled up to 'progress' percent. More...

void	triangle (int x1, int y1, int x2, int y2, int x3, int y3, Color color=COLOR_ON)
	Draw the outline of a triangle contained between the points [x1,y1], [x2,y2] and [x3,y3] with the given color. More...

void	filled_triangle (int x1, int y1, int x2, int y2, int x3, int y3, Color color=COLOR_ON)
	Fill a triangle contained between the points [x1,y1], [x2,y2] and [x3,y3] with the given color. More...

void	get_regular_polygon_vertex (int vertex_id, int vertex_x, int vertex_y, int center_x, int center_y, int radius, int edges, RegularPolygonVariation variation=VARIATION_POINTY_TOP, float rotation_degrees=ROTATION_0_DEGREES)
	Get the specified vertex (x,y) coordinates for the regular polygon inscribed in the circle centered on [center_x,center_y] with the given radius. More...

void	regular_polygon (int x, int y, int radius, int edges, RegularPolygonVariation variation=VARIATION_POINTY_TOP, float rotation_degrees=ROTATION_0_DEGREES, Color color=COLOR_ON, RegularPolygonDrawing drawing=DRAWING_OUTLINE)
	Draw the outline of a regular polygon inscribed in the circle centered on [x,y] with the given radius and color. More...

void	regular_polygon (int x, int y, int radius, int edges, RegularPolygonVariation variation, Color color, RegularPolygonDrawing drawing=DRAWING_OUTLINE)

void	regular_polygon (int x, int y, int radius, int edges, Color color, RegularPolygonDrawing drawing=DRAWING_OUTLINE)

void	filled_regular_polygon (int x, int y, int radius, int edges, RegularPolygonVariation variation=VARIATION_POINTY_TOP, float rotation_degrees=ROTATION_0_DEGREES, Color color=COLOR_ON)
	Fill a regular polygon inscribed in the circle centered on [x,y] with the given radius and color. More...

void	filled_regular_polygon (int x, int y, int radius, int edges, RegularPolygonVariation variation, Color color)

void	filled_regular_polygon (int x, int y, int radius, int edges, Color color)

void	print (int x, int y, BaseFont font, Color color, TextAlign align, const char text, Color background=COLOR_OFF)
	Print `text` with the anchor point at [x,y] with `font`. More...

void	print (int x, int y, BaseFont font, Color color, const char text, Color background=COLOR_OFF)
	Print `text` with the top left at [x,y] with `font`. More...

void	print (int x, int y, BaseFont font, TextAlign align, const char text)
	Print `text` with the anchor point at [x,y] with `font`. More...

void	print (int x, int y, BaseFont font, const char text)
	Print `text` with the top left at [x,y] with `font`. More...

void	printf (int x, int y, BaseFont font, Color color, Color background, TextAlign align, const char format,...) __attribute__((format(printf
	Evaluate the printf-format `format` and print the result with the anchor point at [x,y] with `font`. More...

void void	printf (int x, int y, BaseFont font, Color color, TextAlign align, const char format,...) __attribute__((format(printf
	Evaluate the printf-format `format` and print the result with the anchor point at [x,y] with `font`. More...

void void void	printf (int x, int y, BaseFont font, Color color, const char format,...) __attribute__((format(printf
	Evaluate the printf-format `format` and print the result with the top left at [x,y] with `font`. More...

void void void void	printf (int x, int y, BaseFont font, TextAlign align, const char format,...) __attribute__((format(printf
	Evaluate the printf-format `format` and print the result with the anchor point at [x,y] with `font`. More...

void void void void void	printf (int x, int y, BaseFont font, const char format,...) __attribute__((format(printf
	Evaluate the printf-format `format` and print the result with the top left at [x,y] with `font`. More...

void void void void void void	strftime (int x, int y, BaseFont font, Color color, Color background, TextAlign align, const char format, ESPTime time) __attribute__((format(strftime
	Evaluate the strftime-format `format` and print the result with the anchor point at [x,y] with `font`. More...

void void void void void void void	strftime (int x, int y, BaseFont font, Color color, TextAlign align, const char format, ESPTime time) __attribute__((format(strftime
	Evaluate the strftime-format `format` and print the result with the anchor point at [x,y] with `font`. More...

void void void void void void void void	strftime (int x, int y, BaseFont font, Color color, const char format, ESPTime time) __attribute__((format(strftime
	Evaluate the strftime-format `format` and print the result with the top left at [x,y] with `font`. More...

void void void void void void void void void	strftime (int x, int y, BaseFont font, TextAlign align, const char format, ESPTime time) __attribute__((format(strftime
	Evaluate the strftime-format `format` and print the result with the anchor point at [x,y] with `font`. More...

void void void void void void void void void void	strftime (int x, int y, BaseFont font, const char format, ESPTime time) __attribute__((format(strftime
	Evaluate the strftime-format `format` and print the result with the top left at [x,y] with `font`. More...

void void void void void void void void void void void	image (int x, int y, BaseImage *image, Color color_on=COLOR_ON, Color color_off=COLOR_OFF)
	Draw the `image` with the top-left corner at [x,y] to the screen. More...

void	image (int x, int y, BaseImage *image, ImageAlign align, Color color_on=COLOR_ON, Color color_off=COLOR_OFF)
	Draw the `image` at [x,y] to the screen. More...

void	graph (int x, int y, graph::Graph *graph, Color color_on=COLOR_ON)
	Draw the `graph` with the top-left corner at [x,y] to the screen. More...

void	legend (int x, int y, graph::Graph *graph, Color color_on=COLOR_ON)
	Draw the `legend` for graph with the top-left corner at [x,y] to the screen. More...

void	qr_code (int x, int y, qr_code::QrCode *qr_code, Color color_on=COLOR_ON, int scale=1)
	Draw the `qr_code` with the top-left corner at [x,y] to the screen. More...

void	menu (int x, int y, graphical_display_menu::GraphicalDisplayMenu *menu, int width, int height)

void	get_text_bounds (int x, int y, const char text, BaseFont font, TextAlign align, int x1, int y1, int width, int height)
	Get the text bounds of the given string. More...

void	set_writer (display_writer_t &&writer)
	Internal method to set the display writer lambda. More...

void	show_page (DisplayPage *page)

void	show_next_page ()

void	show_prev_page ()

void	set_pages (std::vector< DisplayPage *> pages)

const DisplayPage *	get_active_page () const

void	add_on_page_change_trigger (DisplayOnPageChangeTrigger *t)

void	set_rotation (DisplayRotation rotation)
	Internal method to set the display rotation with. More...

void	set_auto_clear (bool auto_clear_enabled)

DisplayRotation	get_rotation () const

void	start_clipping (Rect rect)
	Set the clipping rectangle for further drawing. More...

void	start_clipping (int16_t left, int16_t top, int16_t right, int16_t bottom)

void	extend_clipping (Rect rect)
	Add a rectangular region to the invalidation region. More...

void	extend_clipping (int16_t left, int16_t top, int16_t right, int16_t bottom)

void	shrink_clipping (Rect rect)
	substract a rectangular region to the invalidation region More...

void	shrink_clipping (uint16_t left, uint16_t top, uint16_t right, uint16_t bottom)

void	end_clipping ()
	Reset the invalidation region. More...

Rect	get_clipping () const
	Get the current the clipping rectangle. More...

bool	is_clipping () const

bool	clip (int x, int y)
	Check if pixel is within region of display. More...

void	test_card ()

void	show_test_card ()

Public Member Functions inherited from esphome::PollingComponent
	PollingComponent ()

	PollingComponent (uint32_t update_interval)
	Initialize this polling component with the given update interval in ms. More...

virtual void	set_update_interval (uint32_t update_interval)
	Manually set the update interval in ms for this polling object. More...

void	call_setup () override

virtual uint32_t	get_update_interval () const
	Get the update interval in ms of this sensor. More...

void	start_poller ()

void	stop_poller ()

Public Member Functions inherited from esphome::Component
float	get_actual_setup_priority () const

void	set_setup_priority (float priority)

virtual float	get_loop_priority () const
	priority of loop(). More...

void	call ()

virtual void	on_shutdown ()

virtual void	on_safe_shutdown ()

uint32_t	get_component_state () const

virtual void	mark_failed ()
	Mark this component as failed. More...

bool	is_failed () const

bool	is_ready () const

virtual bool	can_proceed ()

bool	status_has_warning () const

bool	status_has_error () const

void	status_set_warning (const char *message="unspecified")

void	status_set_error (const char *message="unspecified")

void	status_clear_warning ()

void	status_clear_error ()

void	status_momentary_warning (const std::string &name, uint32_t length=5000)

void	status_momentary_error (const std::string &name, uint32_t length=5000)

bool	has_overridden_loop () const

void	set_component_source (const char *source)
	Set where this component was loaded from for some debug messages. More...

const char *	get_component_source () const
	Get the integration where this component was declared as a string. More...

Data Fields
int	mouse_x {}

int	mouse_y {}

bool	mouse_down {}

Protected Member Functions
int	get_width_internal () override

int	get_height_internal () override

void	redraw_ (SDL_Rect &rect)

Protected Member Functions inherited from esphome::display::Display
bool	clamp_x_ (int x, int w, int &min_x, int &max_x)

bool	clamp_y_ (int y, int h, int &min_y, int &max_y)

void	vprintf_ (int x, int y, BaseFont font, Color color, Color background, TextAlign align, const char format, va_list arg)

void	do_update_ ()

void	clear_clipping_ ()

void	filled_flat_side_triangle_ (int x1, int y1, int x2, int y2, int x3, int y3, Color color)
	This method fills a triangle using only integer variables by using a modified bresenham algorithm. More...

void	sort_triangle_points_by_y_ (int x1, int y1, int x2, int y2, int x3, int y3)

Protected Member Functions inherited from esphome::Component
virtual void	call_loop ()

virtual void	call_dump_config ()

void	set_interval (const std::string &name, uint32_t interval, std::function< void()> &&f)
	Set an interval function with a unique name. More...

void	set_interval (uint32_t interval, std::function< void()> &&f)

bool	cancel_interval (const std::string &name)
	Cancel an interval function. More...

void	set_retry (const std::string &name, uint32_t initial_wait_time, uint8_t max_attempts, std::function< RetryResult(uint8_t)> &&f, float backoff_increase_factor=1.0f)
	Set an retry function with a unique name. More...

void	set_retry (uint32_t initial_wait_time, uint8_t max_attempts, std::function< RetryResult(uint8_t)> &&f, float backoff_increase_factor=1.0f)

bool	cancel_retry (const std::string &name)
	Cancel a retry function. More...

void	set_timeout (const std::string &name, uint32_t timeout, std::function< void()> &&f)
	Set a timeout function with a unique name. More...

void	set_timeout (uint32_t timeout, std::function< void()> &&f)

bool	cancel_timeout (const std::string &name)
	Cancel a timeout function. More...

void	defer (const std::string &name, std::function< void()> &&f)
	Defer a callback to the next loop() call. More...

void	defer (std::function< void()> &&f)
	Defer a callback to the next loop() call. More...

bool	cancel_defer (const std::string &name)
	Cancel a defer callback using the specified name, name must not be empty. More...

Protected Attributes
int	width_ {}

int	height_ {}

SDL_Renderer *	renderer_ {}

SDL_Window *	window_ {}

SDL_Texture *	texture_ {}

uint16_t	x_low_ {0}

uint16_t	y_low_ {0}

uint16_t	x_high_ {0}

uint16_t	y_high_ {0}

Protected Attributes inherited from esphome::display::Display
DisplayRotation	rotation_ {DISPLAY_ROTATION_0_DEGREES}

optional< display_writer_t >	writer_ {}

DisplayPage *	page_ {nullptr}

DisplayPage *	previous_page_ {nullptr}

std::vector< DisplayOnPageChangeTrigger * >	on_page_change_triggers_

bool	auto_clear_enabled_ {true}

std::vector< Rect >	clipping_rectangle_

bool	show_test_card_ {false}

Protected Attributes inherited from esphome::PollingComponent
uint32_t	update_interval_

Protected Attributes inherited from esphome::Component
uint32_t	component_state_ {0x0000}
	State of this component. More...

float	setup_priority_override_ {NAN}

const char *	component_source_ {nullptr}

Detailed Description

Definition at line 16 of file sdl_esphome.h.

Member Function Documentation

◆ draw_pixel_at()

void esphome::sdl::Sdl::draw_pixel_at	(	int	x,
		int	y,
		Color	color
	)

overridevirtual

Implements esphome::display::Display.

Definition at line 50 of file sdl_esphome.cpp.

◆ draw_pixels_at()

void esphome::sdl::Sdl::draw_pixels_at	(	int	x_start,
		int	y_start,
		int	w,
		int	h,
		const uint8_t *	ptr,
		display::ColorOrder	order,
		display::ColorBitness	bitness,
		bool	big_endian,
		int	x_offset,
		int	y_offset,
		int	x_pad
	)

overridevirtual

Reimplemented from esphome::display::Display.

Definition at line 37 of file sdl_esphome.cpp.

◆ dump_config()

void esphome::sdl::Sdl::dump_config ( )

inlineoverridevirtual

Reimplemented from esphome::Component.

Definition at line 32 of file sdl_esphome.h.

◆ get_display_type()

display::DisplayType esphome::sdl::Sdl::get_display_type ( )

inlineoverridevirtual

Implements esphome::display::Display.

Definition at line 18 of file sdl_esphome.h.

◆ get_height()

int esphome::sdl::Sdl::get_height ( )

inlineoverridevirtual

Reimplemented from esphome::display::Display.

Definition at line 30 of file sdl_esphome.h.

◆ get_height_internal()

int esphome::sdl::Sdl::get_height_internal ( )

inlineoverrideprotectedvirtual

Implements esphome::display::Display.

Definition at line 40 of file sdl_esphome.h.

◆ get_setup_priority()

float esphome::sdl::Sdl::get_setup_priority ( ) const

inlineoverridevirtual

Reimplemented from esphome::Component.

Definition at line 31 of file sdl_esphome.h.

◆ get_width()

int esphome::sdl::Sdl::get_width ( )

inlineoverridevirtual

Reimplemented from esphome::display::Display.

Definition at line 29 of file sdl_esphome.h.

◆ get_width_internal()

int esphome::sdl::Sdl::get_width_internal ( )

inlineoverrideprotectedvirtual

Implements esphome::display::Display.

Definition at line 39 of file sdl_esphome.h.

◆ loop()

void esphome::sdl::Sdl::loop ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 64 of file sdl_esphome.cpp.

◆ redraw_()

void esphome::sdl::Sdl::redraw_ ( SDL_Rect & rect )

protected

Definition at line 32 of file sdl_esphome.cpp.

◆ set_dimensions()

void esphome::sdl::Sdl::set_dimensions	(	uint16_t	width,
		uint16_t	height
	)

inline

Definition at line 25 of file sdl_esphome.h.

◆ setup()

void esphome::sdl::Sdl::setup ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 8 of file sdl_esphome.cpp.

◆ update()

void esphome::sdl::Sdl::update ( )

overridevirtual

Implements esphome::PollingComponent.

Definition at line 20 of file sdl_esphome.cpp.

Field Documentation

◆ height_

int esphome::sdl::Sdl::height_ {}

protected

Definition at line 43 of file sdl_esphome.h.

◆ mouse_down

bool esphome::sdl::Sdl::mouse_down {}

Definition at line 36 of file sdl_esphome.h.

◆ mouse_x

int esphome::sdl::Sdl::mouse_x {}

Definition at line 34 of file sdl_esphome.h.

◆ mouse_y

int esphome::sdl::Sdl::mouse_y {}

Definition at line 35 of file sdl_esphome.h.

◆ renderer_

SDL_Renderer* esphome::sdl::Sdl::renderer_ {}

protected

Definition at line 44 of file sdl_esphome.h.

◆ texture_

SDL_Texture* esphome::sdl::Sdl::texture_ {}

protected

Definition at line 46 of file sdl_esphome.h.

◆ width_

int esphome::sdl::Sdl::width_ {}

protected

Definition at line 42 of file sdl_esphome.h.

◆ window_

SDL_Window* esphome::sdl::Sdl::window_ {}

protected

Definition at line 45 of file sdl_esphome.h.

◆ x_high_

uint16_t esphome::sdl::Sdl::x_high_ {0}

protected

Definition at line 49 of file sdl_esphome.h.

◆ x_low_

uint16_t esphome::sdl::Sdl::x_low_ {0}

protected

Definition at line 47 of file sdl_esphome.h.

◆ y_high_

uint16_t esphome::sdl::Sdl::y_high_ {0}

protected

Definition at line 50 of file sdl_esphome.h.

◆ y_low_

uint16_t esphome::sdl::Sdl::y_low_ {0}

protected

Definition at line 48 of file sdl_esphome.h.

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

/opt/build/esphome/esphome/components/sdl/sdl_esphome.h
/opt/build/esphome/esphome/components/sdl/sdl_esphome.cpp

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ draw_pixel_at()

◆ draw_pixels_at()

◆ dump_config()

◆ get_display_type()

◆ get_height()

◆ get_height_internal()

◆ get_setup_priority()

◆ get_width()

◆ get_width_internal()

◆ loop()

◆ redraw_()

◆ set_dimensions()

◆ setup()

◆ update()

Field Documentation

◆ height_

◆ mouse_down

◆ mouse_x

◆ mouse_y

◆ renderer_

◆ texture_

◆ width_

◆ window_

◆ x_high_

◆ x_low_

◆ y_high_

◆ y_low_