pu::ui::Overlay Class Reference

Class that represents an overlay, which is a container that is rendered over the current Layout. More...

#include <ui_Overlay.hpp>

Inheritance diagram for pu::ui::Overlay:

Public Member Functions
	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.
virtual void	OnPreRender (render::Renderer::Ref &drawer)
	Function called before the overlay is rendered. You may use it to configure additional effects, such as alpha modulation during the Overlay rendering.
virtual void	OnPostRender (render::Renderer::Ref &drawer)
	Function called after the overlay is rendered. You may use it to configure additional effects, such as alpha modulation during the Overlay rendering.
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	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

Class that represents an overlay, which is a container that is rendered over the current Layout.

Note

The overlay consists on a base rectangle (or rounded rectangle) over which child classes can do custom rendering.

Constructor & Destructor Documentation

Overlay()

pu::ui::Overlay::Overlay ( const i32 x, const i32 y, const i32 width, const i32 height, const Color bg_clr )

inline

Creates a new Overlay with the specified position, size, and background color.

Parameters

x	X coordinate of the Overlay.
y	Y coordinate of the Overlay.
width	Width of the Overlay.
height	Height of the Overlay.
bg_clr	Background color of the Overlay.

Member Function Documentation

HasRadius()

bool pu::ui::Overlay::HasRadius ( )

inline

Checks whether the overlay has a radius for its background rectangle.

Returns

Whether the overlay has a rounded rectangle.

NotifyEnding()

void pu::ui::Overlay::NotifyEnding ( const bool ending )

inline

Notifies the overlay that it is ending (fading out).

Note

Used by Application to handle the overlay fade out effect.

Parameters

ending

Whether the overlay is ending.

OnPostRender()

virtual void pu::ui::Overlay::OnPostRender ( render::Renderer::Ref & drawer )

inlinevirtual

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 in pu::ui::extras::Toast.

OnPreRender()

virtual void pu::ui::Overlay::OnPreRender ( render::Renderer::Ref & drawer )

inlinevirtual

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 in pu::ui::extras::Toast.

Render()

bool pu::ui::Overlay::Render

(

render::Renderer::Ref &

drawer

)

Rendering callback of the overlay.

Member Data Documentation

DefaultFadeAlphaVariation

u8 pu::ui::Overlay::DefaultFadeAlphaVariation = 25

staticconstexpr

Default alpha variation (increment) for the overlay fade effect.

DefaultMaxFadeAlpha

u8 pu::ui::Overlay::DefaultMaxFadeAlpha = 200

staticconstexpr

Default maximum alpha value for the overlay fade effect.

DefaultRadius

i32 pu::ui::Overlay::DefaultRadius = 37

staticconstexpr

Default radius of the overlay rectangle.

---

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

• Plutonium/include/pu/ui/ui_Overlay.hpp