pu::ui::extras::Toast Class Reference

Overlay implementation that represents a simple message that appears on the screen. More...

#include <extras_Toast.hpp>

Inheritance diagram for pu::ui::extras::Toast:

Public Member Functions
	Toast (elm::TextBlock::Ref &text_block, const Color bg_clr)
	Creates a new instance of a Toast.
void	SetText (const std::string &text)
	Sets the text of the Toast.
void	OnPreRender (render::Renderer::Ref &drawer) override
	Function called before the overlay is rendered. You may use it to configure additional effects, such as alpha modulation during the Overlay rendering.
void	OnPostRender (render::Renderer::Ref &drawer) override
	Function called after the overlay is rendered. You may use it to configure additional effects, such as alpha modulation during the Overlay rendering.
Public Member Functions inherited from pu::ui::Overlay
	Overlay (const i32 x, const i32 y, const i32 width, const i32 height, const Color bg_clr)
	Creates a new Overlay with the specified position, size, and background color.
bool	HasRadius ()
	Checks whether the overlay has a radius for its background rectangle.
bool	Render (render::Renderer::Ref &drawer)
	Rendering callback of the overlay.
void	NotifyEnding (const bool ending)
	Notifies the overlay that it is ending (fading out).
Public Member Functions inherited from pu::ui::Container
	Container (const i32 x, const i32 y, const i32 width, const i32 height)
	Creates a new Container with the specified position and size.
void	Add (elm::Element::Ref elem)
	Adds an Element to the Container.
std::vector< elm::Element::Ref > &	GetElements ()
	Gets the list of Elements in the Container.
bool	Has (elm::Element::Ref &elem)
	Gets whether the Container has the specified Element.
void	Clear ()
	Removes all elements from the Container.
void	PreRender ()
	Function to be invoked before rendering the Container.

Static Public Attributes
static constexpr i32	DefaultY = 550
static constexpr i32	DefaulHeightAndTextHeightFactor = 3
static constexpr i32	DefaulHorizontalMargin = 50
static constexpr u8	DefaulBaseAlpha = 200
Static Public Attributes inherited from pu::ui::Overlay
static constexpr i32	DefaultRadius = 37
	Default radius of the overlay rectangle.
static constexpr u8	DefaultMaxFadeAlpha = 200
	Default maximum alpha value for the overlay fade effect.
static constexpr u8	DefaultFadeAlphaVariation = 25
	Default alpha variation (increment) for the overlay fade effect.

Additional Inherited Members
Protected Attributes inherited from pu::ui::Container
i32	x
i32	y
i32	w
i32	h
std::vector< elm::Element::Ref >	elems

Detailed Description

Overlay implementation that represents a simple message that appears on the screen.

Constructor & Destructor Documentation

Toast()

pu::ui::extras::Toast::Toast	(	elm::TextBlock::Ref &	text_block,
		const Color	bg_clr )

Creates a new instance of a Toast.

Parameters

text_block	TextBlock to use for the Toast.
bg_clr	Background color of the Toast.

Member Function Documentation

OnPostRender()

void pu::ui::extras::Toast::OnPostRender ( render::Renderer::Ref & drawer )

overridevirtual

Function called after the overlay is rendered. You may use it to configure additional effects, such as alpha modulation during the Overlay rendering.

Parameters

drawer

Renderer used to render the overlay.

Reimplemented from pu::ui::Overlay.

OnPreRender()

void pu::ui::extras::Toast::OnPreRender ( render::Renderer::Ref & drawer )

overridevirtual

Function called before the overlay is rendered. You may use it to configure additional effects, such as alpha modulation during the Overlay rendering.

Parameters

drawer

Renderer used to render the overlay.

Reimplemented from pu::ui::Overlay.

SetText()

void pu::ui::extras::Toast::SetText

(

const std::string &

text

)

Sets the text of the Toast.

Parameters

text	New text to set.

Member Data Documentation

DefaulBaseAlpha

u8 pu::ui::extras::Toast::DefaulBaseAlpha = 200

staticconstexpr

DefaulHeightAndTextHeightFactor

i32 pu::ui::extras::Toast::DefaulHeightAndTextHeightFactor = 3

staticconstexpr

DefaulHorizontalMargin

i32 pu::ui::extras::Toast::DefaulHorizontalMargin = 50

staticconstexpr

DefaultY

i32 pu::ui::extras::Toast::DefaultY = 550

staticconstexpr

---

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

• Plutonium/include/pu/ui/extras/extras_Toast.hpp