Data Structures
class	BaseFont

class	BaseImage

class	ColorUtil

class	Display

class	DisplayBuffer

class	DisplayPage

class	DisplayPageShowAction

class	DisplayWriter
	Optimized display writer that uses function pointers for stateless lambdas. More...

class	Rect

class	Rgb565ToMono
	color_to_mono() of an RGB565 value as ColorUtil::to_color() reads it, from table lookups instead of a division per channel. More...

Typedefs
using	display_writer_t = DisplayWriter<Display>

Enumerations
enum class	TextAlign { TOP = 0x00 , CENTER_VERTICAL = 0x01 , BASELINE = 0x02 , BOTTOM = 0x04 , LEFT = 0x00 , CENTER_HORIZONTAL = 0x08 , RIGHT = 0x10 , TOP_LEFT = TOP \| LEFT , TOP_CENTER = TOP \| CENTER_HORIZONTAL , TOP_RIGHT = TOP \| RIGHT , CENTER_LEFT = CENTER_VERTICAL \| LEFT , CENTER = CENTER_VERTICAL \| CENTER_HORIZONTAL , CENTER_RIGHT = CENTER_VERTICAL \| RIGHT , BASELINE_LEFT = BASELINE \| LEFT , BASELINE_CENTER = BASELINE \| CENTER_HORIZONTAL , BASELINE_RIGHT = BASELINE \| RIGHT , BOTTOM_LEFT = BOTTOM \| LEFT , BOTTOM_CENTER = BOTTOM \| CENTER_HORIZONTAL , BOTTOM_RIGHT = BOTTOM \| RIGHT }
	TextAlign is used to tell the display class how to position a piece of text. More...

enum class	ImageAlign { TOP = 0x00 , CENTER_VERTICAL = 0x01 , BOTTOM = 0x02 , LEFT = 0x00 , CENTER_HORIZONTAL = 0x04 , RIGHT = 0x08 , TOP_LEFT = TOP \| LEFT , TOP_CENTER = TOP \| CENTER_HORIZONTAL , TOP_RIGHT = TOP \| RIGHT , CENTER_LEFT = CENTER_VERTICAL \| LEFT , CENTER = CENTER_VERTICAL \| CENTER_HORIZONTAL , CENTER_RIGHT = CENTER_VERTICAL \| RIGHT , BOTTOM_LEFT = BOTTOM \| LEFT , BOTTOM_CENTER = BOTTOM \| CENTER_HORIZONTAL , BOTTOM_RIGHT = BOTTOM \| RIGHT , HORIZONTAL_ALIGNMENT = LEFT \| CENTER_HORIZONTAL \| RIGHT , VERTICAL_ALIGNMENT = TOP \| CENTER_VERTICAL \| BOTTOM }
	ImageAlign is used to tell the display class how to position a image. More...

enum	DisplayType { DISPLAY_TYPE_BINARY = 1 , DISPLAY_TYPE_GRAYSCALE = 2 , DISPLAY_TYPE_COLOR = 3 }

enum	DisplayRotation { DISPLAY_ROTATION_0_DEGREES = 0 , DISPLAY_ROTATION_90_DEGREES = 90 , DISPLAY_ROTATION_180_DEGREES = 180 , DISPLAY_ROTATION_270_DEGREES = 270 }

enum	RegularPolygonVariation { VARIATION_POINTY_TOP = 0 , VARIATION_FLAT_TOP = 1 }

enum	RegularPolygonDrawing { DRAWING_OUTLINE = 0 , DRAWING_FILLED = 1 }

enum	ColorOrder : uint8_t { COLOR_ORDER_RGB = 0 , COLOR_ORDER_BGR = 1 , COLOR_ORDER_GRB = 2 }

enum	ColorBitness : uint8_t { COLOR_BITNESS_888 = 0 , COLOR_BITNESS_565 = 1 , COLOR_BITNESS_332 = 2 }

Functions
	ESPHOME_LOG_TAG (TAG, "display")

	if (display->pixel_axes_swapped())

	for (int y=0;y !=h;y++)

const LogString *	text_align_to_string (TextAlign textalign)

constexpr bool	rotation_swaps_axes (DisplayRotation rotation)
	Whether a rotation swaps the x and y axes.

constexpr Color	COLOR_OFF (0, 0, 0, 0)
	Turn the pixel OFF.

constexpr Color	COLOR_ON (255, 255, 255, 255)
	Turn the pixel ON.

constexpr uint8_t	expand_field (uint8_t value, uint8_t bits)
	esp_scale(value, (1 << bits) - 1) for a field of 2, 3, 5, 6 or 8 bits, as a multiply and shift that gives the same result for every field value.

Color	apply_color_order (Color color, ColorOrder order)

constexpr uint8_t	rec601_luma (Color color)
	Rec.601 luma of an RGB color, for optimum perceptual brightness.

constexpr uint8_t	color_to_mono (Color color)
	Map an RGB color to a single monochrome bit: 1 = white, 0 = black.

Variables
static void int	x_start

static void int int	y_start

static void int int int	w

static void int int int int	h

static void int int int int const uint8_t *	ptr

static void int int int int const uint8_t int	x_offset

static void int int int int const uint8_t int int	y_offset

static void int int int int const uint8_t int int int	x_pad

const auto	draw_source_pixel

static void int int int int const uint8_t ColorOrder	order

static void int int int int const uint8_t ColorOrder ColorBitness	bitness

static void int int int int const uint8_t ColorOrder ColorBitness bool	big_endian

constexpr uint8_t TESTCARD_FONT[3][8]	PROGMEM

const int	EDGES_TRIGON = 3

const int	EDGES_TRIANGLE = 3

const int	EDGES_TETRAGON = 4

const int	EDGES_QUADRILATERAL = 4

const int	EDGES_PENTAGON = 5

const int	EDGES_HEXAGON = 6

const int	EDGES_HEPTAGON = 7

const int	EDGES_OCTAGON = 8

const int	EDGES_NONAGON = 9

const int	EDGES_ENNEAGON = 9

const int	EDGES_DECAGON = 10

const int	EDGES_HENDECAGON = 11

const int	EDGES_DODECAGON = 12

const int	EDGES_TRIDECAGON = 13

const int	EDGES_TETRADECAGON = 14

const int	EDGES_PENTADECAGON = 15

const int	EDGES_HEXADECAGON = 16

const float	ROTATION_0_DEGREES = 0.0

const float	ROTATION_45_DEGREES = 45.0

const float	ROTATION_90_DEGREES = 90.0

const float	ROTATION_180_DEGREES = 180.0

const float	ROTATION_270_DEGREES = 270.0

Typedef Documentation

◆ display_writer_t

using esphome::display::display_writer_t = DisplayWriter<Display>

Definition at line 297 of file display.h.

Enumeration Type Documentation

◆ ColorBitness

enum esphome::display::ColorBitness : uint8_t

Enumerator
COLOR_BITNESS_888
COLOR_BITNESS_565
COLOR_BITNESS_332

Definition at line 9 of file display_color_utils.h.

◆ ColorOrder

enum esphome::display::ColorOrder : uint8_t

Enumerator
COLOR_ORDER_RGB
COLOR_ORDER_BGR
COLOR_ORDER_GRB

Definition at line 8 of file display_color_utils.h.

◆ DisplayRotation

enum esphome::display::DisplayRotation

Enumerator
DISPLAY_ROTATION_0_DEGREES
DISPLAY_ROTATION_90_DEGREES
DISPLAY_ROTATION_180_DEGREES
DISPLAY_ROTATION_270_DEGREES

Definition at line 135 of file display.h.

◆ DisplayType

enum esphome::display::DisplayType

Enumerator
DISPLAY_TYPE_BINARY
DISPLAY_TYPE_GRAYSCALE
DISPLAY_TYPE_COLOR

Definition at line 129 of file display.h.

◆ ImageAlign

enum class esphome::display::ImageAlign

strong

ImageAlign is used to tell the display class how to position a image.

By default the coordinates you enter for the image() functions take the upper left corner of the image as the "anchor" point. You can customize this behavior to, for example, make the coordinates refer to the center of the image.

All image alignments consist of an X and Y-coordinate alignment. For the alignment along the X-axis these options are allowed:

LEFT (x-coordinate of anchor point is on left)
CENTER_HORIZONTAL (x-coordinate of anchor point is in the horizontal center of the image)
RIGHT (x-coordinate of anchor point is on right)

For the Y-Axis alignment these options are allowed:

TOP (y-coordinate of anchor is on the top of the image)
CENTER_VERTICAL (y-coordinate of anchor is in the vertical center of the image)
BOTTOM (y-coordinate of anchor is on the bottom of the image)

These options are then combined to create combined TextAlignment options like:

TOP_LEFT (default)
CENTER (anchor point is in the middle of the image bounds)
...

Enumerator
TOP
CENTER_VERTICAL
BOTTOM
LEFT
CENTER_HORIZONTAL
RIGHT
TOP_LEFT
TOP_CENTER
TOP_RIGHT
CENTER_LEFT
CENTER
CENTER_RIGHT
BOTTOM_LEFT
BOTTOM_CENTER
BOTTOM_RIGHT
HORIZONTAL_ALIGNMENT
VERTICAL_ALIGNMENT

Definition at line 104 of file display.h.

◆ RegularPolygonDrawing

enum esphome::display::RegularPolygonDrawing

Enumerator
DRAWING_OUTLINE
DRAWING_FILLED

Definition at line 176 of file display.h.

◆ RegularPolygonVariation

enum esphome::display::RegularPolygonVariation

Enumerator
VARIATION_POINTY_TOP
VARIATION_FLAT_TOP

Definition at line 171 of file display.h.

◆ TextAlign

enum class esphome::display::TextAlign

strong

TextAlign is used to tell the display class how to position a piece of text.

By default the coordinates you enter for the print*() functions take the upper left corner of the text as the "anchor" point. You can customize this behavior to, for example, make the coordinates refer to the center of the text.

All text alignments consist of an X and Y-coordinate alignment. For the alignment along the X-axis these options are allowed:

LEFT (x-coordinate of anchor point is on left)
CENTER_HORIZONTAL (x-coordinate of anchor point is in the horizontal center of the text)
RIGHT (x-coordinate of anchor point is on right)

For the Y-Axis alignment these options are allowed:

TOP (y-coordinate of anchor is on the top of the text)
CENTER_VERTICAL (y-coordinate of anchor is in the vertical center of the text)
BASELINE (y-coordinate of anchor is on the baseline of the text)
BOTTOM (y-coordinate of anchor is on the bottom of the text)

These options are then combined to create combined TextAlignment options like:

TOP_LEFT (default)
CENTER (anchor point is in the middle of the text bounds)
...

Enumerator
TOP
CENTER_VERTICAL
BASELINE
BOTTOM
LEFT
CENTER_HORIZONTAL
RIGHT
TOP_LEFT
TOP_CENTER
TOP_RIGHT
CENTER_LEFT
CENTER
CENTER_RIGHT
BASELINE_LEFT
BASELINE_CENTER
BASELINE_RIGHT
BOTTOM_LEFT
BOTTOM_CENTER
BOTTOM_RIGHT

Definition at line 54 of file display.h.

Function Documentation

◆ apply_color_order()

Color esphome::display::apply_color_order	(	Color	color,
		ColorOrder	order )

inline

Definition at line 33 of file display_color_utils.h.

◆ COLOR_OFF()

Color esphome::display::COLOR_OFF	(	,
		,
		,
		)

inlineconstexpr

Turn the pixel OFF.

◆ COLOR_ON()

Color esphome::display::COLOR_ON	(	255	,
		255	,
		255	,
		255	)

inlineconstexpr

Turn the pixel ON.

◆ color_to_mono()

uint8_t esphome::display::color_to_mono ( Color color )

constexpr

Map an RGB color to a single monochrome bit: 1 = white, 0 = black.

Definition at line 216 of file display_color_utils.h.

◆ ESPHOME_LOG_TAG()

esphome::display::ESPHOME_LOG_TAG	(	TAG	,
		"display"	)

◆ expand_field()

uint8_t esphome::display::expand_field	(	uint8_t	value,
		uint8_t	bits )

constexpr

esp_scale(value, (1 << bits) - 1) for a field of 2, 3, 5, 6 or 8 bits, as a multiply and shift that gives the same result for every field value.

With bits a constant this avoids a division.

Definition at line 14 of file display_color_utils.h.

◆ for()

esphome::display::for ( int y = 0; y != h; y++ )

Definition at line 89 of file display.cpp.

◆ if()

esphome::display::if ( display-> pixel_axes_swapped() )

Definition at line 77 of file display.cpp.

◆ rec601_luma()

uint8_t esphome::display::rec601_luma ( Color color )

constexpr

Rec.601 luma of an RGB color, for optimum perceptual brightness.

Definition at line 211 of file display_color_utils.h.

◆ rotation_swaps_axes()

bool esphome::display::rotation_swaps_axes ( DisplayRotation rotation )

constexpr

Whether a rotation swaps the x and y axes.

Definition at line 143 of file display.h.

◆ text_align_to_string()

const LogString * esphome::display::text_align_to_string ( TextAlign textalign )

Definition at line 958 of file display.cpp.

Variable Documentation

◆ big_endian

void int int int int const uint8_t ColorOrder ColorBitness bool esphome::display::big_endian

Definition at line 101 of file display.cpp.

◆ bitness

void int int int int const uint8_t ColorOrder ColorBitness esphome::display::bitness

Definition at line 100 of file display.cpp.

◆ draw_source_pixel

const auto esphome::display::draw_source_pixel

Initial value:

= [&](int x, int y, size_t source_idx) ESPHOME_ALWAYS_INLINE {
    display->draw_pixel_at(
        x + x_start, y + y_start,
        ColorUtil::to_color(ColorUtil::read_packed<BITNESS>(ptr, source_idx, HIGH_BYTE_FIRST), BITNESS));
  }

Definition at line 67 of file display.cpp.

◆ EDGES_DECAGON

const int esphome::display::EDGES_DECAGON = 10

Definition at line 157 of file display.h.

◆ EDGES_DODECAGON

const int esphome::display::EDGES_DODECAGON = 12

Definition at line 159 of file display.h.

◆ EDGES_ENNEAGON

const int esphome::display::EDGES_ENNEAGON = 9

Definition at line 156 of file display.h.

◆ EDGES_HENDECAGON

const int esphome::display::EDGES_HENDECAGON = 11

Definition at line 158 of file display.h.

◆ EDGES_HEPTAGON

const int esphome::display::EDGES_HEPTAGON = 7

Definition at line 153 of file display.h.

◆ EDGES_HEXADECAGON

const int esphome::display::EDGES_HEXADECAGON = 16

Definition at line 163 of file display.h.

◆ EDGES_HEXAGON

const int esphome::display::EDGES_HEXAGON = 6

Definition at line 152 of file display.h.

◆ EDGES_NONAGON

const int esphome::display::EDGES_NONAGON = 9

Definition at line 155 of file display.h.

◆ EDGES_OCTAGON

const int esphome::display::EDGES_OCTAGON = 8

Definition at line 154 of file display.h.

◆ EDGES_PENTADECAGON

const int esphome::display::EDGES_PENTADECAGON = 15

Definition at line 162 of file display.h.

◆ EDGES_PENTAGON

const int esphome::display::EDGES_PENTAGON = 5

Definition at line 151 of file display.h.

◆ EDGES_QUADRILATERAL

const int esphome::display::EDGES_QUADRILATERAL = 4

Definition at line 150 of file display.h.

◆ EDGES_TETRADECAGON

const int esphome::display::EDGES_TETRADECAGON = 14

Definition at line 161 of file display.h.

◆ EDGES_TETRAGON

const int esphome::display::EDGES_TETRAGON = 4

Definition at line 149 of file display.h.

◆ EDGES_TRIANGLE

const int esphome::display::EDGES_TRIANGLE = 3

Definition at line 148 of file display.h.

◆ EDGES_TRIDECAGON

const int esphome::display::EDGES_TRIDECAGON = 13

Definition at line 160 of file display.h.

◆ EDGES_TRIGON

const int esphome::display::EDGES_TRIGON = 3

Definition at line 147 of file display.h.

◆ h

static void int int int int esphome::display::h

Definition at line 62 of file display.cpp.

◆ order

void int int int int const uint8_t ColorOrder esphome::display::order

Definition at line 100 of file display.cpp.

◆ PROGMEM

uint8_t TESTCARD_FONT [3][8] esphome::display::PROGMEM

constexpr

Initial value:

= {{0x41, 0x7F, 0x7F, 0x09, 0x19, 0x7F, 0x66, 0x00},   
                                                 {0x1C, 0x3E, 0x63, 0x41, 0x51, 0x73, 0x72, 0x00},   
                                                 {0x41, 0x7F, 0x7F, 0x49, 0x49, 0x7F, 0x36, 0x00}}

Definition at line 878 of file display.cpp.

◆ ptr

static void int int int int const uint8_t * esphome::display::ptr

Definition at line 63 of file display.cpp.

◆ ROTATION_0_DEGREES

const float esphome::display::ROTATION_0_DEGREES = 0.0

Definition at line 165 of file display.h.

◆ ROTATION_180_DEGREES

const float esphome::display::ROTATION_180_DEGREES = 180.0

Definition at line 168 of file display.h.

◆ ROTATION_270_DEGREES

const float esphome::display::ROTATION_270_DEGREES = 270.0

Definition at line 169 of file display.h.

◆ ROTATION_45_DEGREES

const float esphome::display::ROTATION_45_DEGREES = 45.0

Definition at line 166 of file display.h.

◆ ROTATION_90_DEGREES

const float esphome::display::ROTATION_90_DEGREES = 90.0

Definition at line 167 of file display.h.

◆ w

static void int int int esphome::display::w

Definition at line 62 of file display.cpp.

◆ x_offset

static void int int int int const uint8_t ColorOrder ColorBitness bool int esphome::display::x_offset

Definition at line 63 of file display.cpp.

◆ x_pad

static void int int int int const uint8_t ColorOrder ColorBitness bool int int int esphome::display::x_pad

Initial value:

{

const size_t line_stride = x_offset + w + x_pad

esphome::display::x_offset

static void int int int int const uint8_t int x_offset

Definition display.cpp:63

esphome::display::w

static void int int int w

Definition display.cpp:62

esphome::display::x_pad

static void int int int int const uint8_t int int int x_pad

Definition display.cpp:63

Definition at line 63 of file display.cpp.

◆ x_start

static void int esphome::display::x_start

Definition at line 62 of file display.cpp.

◆ y_offset

static void int int int int const uint8_t ColorOrder ColorBitness bool int int esphome::display::y_offset

Definition at line 63 of file display.cpp.

◆ y_start

static void int int esphome::display::y_start

Definition at line 62 of file display.cpp.

Data Structures

Typedefs

Enumerations

Functions

Variables

Typedef Documentation

◆ display_writer_t

Enumeration Type Documentation

◆ ColorBitness

◆ ColorOrder

◆ DisplayRotation

◆ DisplayType

◆ ImageAlign

◆ RegularPolygonDrawing

◆ RegularPolygonVariation

◆ TextAlign

Function Documentation

◆ apply_color_order()

◆ COLOR_OFF()

◆ COLOR_ON()

◆ color_to_mono()

◆ ESPHOME_LOG_TAG()

◆ expand_field()

◆ for()

◆ if()

◆ rec601_luma()

◆ rotation_swaps_axes()

◆ text_align_to_string()

Variable Documentation

◆ big_endian

◆ bitness

◆ draw_source_pixel

◆ EDGES_DECAGON

◆ EDGES_DODECAGON

◆ EDGES_ENNEAGON

◆ EDGES_HENDECAGON

◆ EDGES_HEPTAGON

◆ EDGES_HEXADECAGON

◆ EDGES_HEXAGON

◆ EDGES_NONAGON

◆ EDGES_OCTAGON

◆ EDGES_PENTADECAGON

◆ EDGES_PENTAGON

◆ EDGES_QUADRILATERAL

◆ EDGES_TETRADECAGON

◆ EDGES_TETRAGON

◆ EDGES_TRIANGLE

◆ EDGES_TRIDECAGON

◆ EDGES_TRIGON

◆ h

◆ order

◆ PROGMEM

◆ ptr

◆ ROTATION_0_DEGREES

◆ ROTATION_180_DEGREES

◆ ROTATION_270_DEGREES

◆ ROTATION_45_DEGREES

◆ ROTATION_90_DEGREES

◆ w

◆ x_offset

◆ x_pad

◆ x_start

◆ y_offset

◆ y_start