Public Member Functions
void	display_update (auto &ctx)
	Display and update the overlay.

void	clear ()
	Clear all UI elements.

uint8_t	get_element_count (const ElementType type) const
	Return the count of elements of a target type.

bool	add_ui_element (const auto &ctx, const ElementType type, const colors::PaletteTy &palette, const uint16_t coordinateX=0, const uint16_t coordinateY=0, const uint8_t progress=0, const uint32_t activityDelay_ms=50)
	Add a new UI element to the overlay.

template<bool shouldUpdateTimeout = true>
bool	update_type_progress (const auto &ctx, const ElementType type, uint16_t desiredIndex, const uint8_t progress)
	Update the target UI element progress.

template<bool shouldUpdateTimeout = true>
bool	update_type_color (const auto &ctx, const ElementType type, uint16_t desiredIndex, const colors::PaletteTy &palette)
	Update the target UI element color palette.

bool	update_type_timeout (const auto &ctx, const ElementType type, uint16_t desiredIndex, const uint32_t timeout_ms)

template<bool shouldUpdateTimeout = true>
bool	update_type (const auto &ctx, const ElementType type, uint16_t desiredIndex, const uint8_t progress, const colors::PaletteTy &palette)
	Update the target UI element.

Protected Member Functions
bool	get_N_of_type (const ElementType type, uint16_t desiredIndex, size_t &elementId) const
	Find and return the Nth element of a given type.

void	drawElement (const __private::UIElement &e, auto &ctx) const

void	display_ramp (auto &ctx, const uint8_t progress, const colors::PaletteTy &palette, const uint16_t startCoordinateY) const
	Display a colored ramp.

void	display_dot (auto &ctx, const uint8_t progress, const colors::PaletteTy &palette, const uint16_t coordinateX, const uint16_t coordinateY) const
	Display a single colored pixel.

Member Function Documentation

◆ add_ui_element()

template<int UIElementSize = 16, uint8_t freezeSize = 5, uint8_t nbBlackLines = 2>

bool lampda::modes::draw::overlay::Manager< UIElementSize, freezeSize, nbBlackLines >::add_ui_element	(	const auto &	ctx,
		const ElementType	type,
		const colors::PaletteTy &	palette,
		const uint16_t	coordinateX = `0`,
		const uint16_t	coordinateY = `0`,
		const uint8_t	progress = `0`,
		const uint32_t	activityDelay_ms = `50`
	)

inline

Add a new UI element to the overlay.

Parameters

[in]	type	Type of the element. Depending on the type, some parameters may be ignored
[in]	palette	Color palette to apply, controled by the progress parameter
[in]	coordinateX	Start x coordinate
[in]	coordinateY	Start y coordinate
[in]	progress	Progress of the element, controls the color and other aspects
[in]	activityDelay_ms	Longevity delay affected to this element, after which it destroys itselfs

template<int UIElementSize = 16, uint8_t freezeSize = 5, uint8_t nbBlackLines = 2>

template<bool shouldUpdateTimeout = true>

bool lampda::modes::draw::overlay::Manager< UIElementSize, freezeSize, nbBlackLines >::update_type	(	const auto &	ctx,
		const ElementType	type,
		uint16_t	desiredIndex,
		const uint8_t	progress,
		const colors::PaletteTy &	palette
	)

inline

Update the target UI element.

Parameters

[in]	type	Type of the element to update
[in]	desiredIndex	Nth element of the target type to select
[in]	progress	Progress value to update
[in]	palette	Colors to update

template<int UIElementSize = 16, uint8_t freezeSize = 5, uint8_t nbBlackLines = 2>

template<bool shouldUpdateTimeout = true>

bool lampda::modes::draw::overlay::Manager< UIElementSize, freezeSize, nbBlackLines >::update_type_color	(	const auto &	ctx,
		const ElementType	type,
		uint16_t	desiredIndex,
		const colors::PaletteTy &	palette
	)

inline

Update the target UI element color palette.

Parameters

[in]	type	Type of the element to update
[in]	desiredIndex	Nth element of the target type to select
[in]	palette	Color value to update

template<int UIElementSize = 16, uint8_t freezeSize = 5, uint8_t nbBlackLines = 2>

template<bool shouldUpdateTimeout = true>

bool lampda::modes::draw::overlay::Manager< UIElementSize, freezeSize, nbBlackLines >::update_type_progress	(	const auto &	ctx,
		const ElementType	type,
		uint16_t	desiredIndex,
		const uint8_t	progress
	)

inline

Update the target UI element progress.

Parameters

[in]	type	Type of the element to update
[in]	desiredIndex	Nth element of the target type to select
[in]	progress	Progress value to update

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