pu::ui Namespace Reference

Namespaces
namespace	elm
namespace	extras
namespace	render

Classes
class	Application
	Type that represents the basic object in this library, the general context for UI and rendering. More...
struct	Color
	Type encoding a RGBA-8888 color. More...
class	Container
	Type containing a list of elements. More...
class	Dialog
	Class that represents a dialog, which is a simple way to show a message and various options to the user and get a response. More...
class	Layout
	Class that represents a layout, the core UI container in the library. More...
class	Overlay
	Class that represents an overlay, which is a container that is rendered over the current Layout. More...
class	SigmoidIncrementer
	Type used to vary a value, from an initial value to a final one, following the shape of a sigmoid function. More...
struct	TouchPoint
	Type encoding a touch point. More...

Enumerations
enum class	DefaultFontSize : u32 {   Small , Medium , MediumLarge , Large ,   Count }
	Enum containing the default font sizes used by Plutonium components. More...

Functions
std::string	MakeDefaultFontName (const u32 font_size)
	Makes a default font name with the specified font size.
constexpr u32	GetDefaultFontSize (const DefaultFontSize kind)
	Gets the default font size value for the specified DefaultFontSize.
std::string	GetDefaultFont (const DefaultFontSize kind)
	Gets the default font name for the specified DefaultFontSize.
static constexpr bool	TouchHitsRegion (const i32 touch_x, const i32 touch_y, const i32 region_x, const i32 region_y, const i32 region_w, const i32 region_h)
	Helper function to check whether a touch point hits a rectangle region.

Variables
constexpr u32	DefaultFontSizes [static_cast< u32 >(DefaultFontSize::Count)] = { 27, 30, 37, 45 }
	Array containing the default font size values used by Plutonium components, for all DefaultFontSize values.
constexpr u64	TouchPseudoKey = 1 << 29
	Input key value used internally by Plutonium to represent the presence of a touch input.

Enumeration Type Documentation

DefaultFontSize

enum class pu::ui::DefaultFontSize : u32

strong

Enum containing the default font sizes used by Plutonium components.

Enumerator
Small
Medium
MediumLarge
Large
Count

Function Documentation

GetDefaultFont()

std::string pu::ui::GetDefaultFont ( const DefaultFontSize kind )

inline

Gets the default font name for the specified DefaultFontSize.

Parameters

kind	DefaultFontSize to get the font name from.

Returns

Default font name.

GetDefaultFontSize()

u32 pu::ui::GetDefaultFontSize ( const DefaultFontSize kind )

inlineconstexpr

Gets the default font size value for the specified DefaultFontSize.

Parameters

kind	DefaultFontSize to get the value from.

Returns

Default font size value.

MakeDefaultFontName()

std::string pu::ui::MakeDefaultFontName ( const u32 font_size )

inline

Makes a default font name with the specified font size.

Parameters

font_size

Font size to use.

Returns

Default font name.

TouchHitsRegion()

static constexpr bool pu::ui::TouchHitsRegion ( const i32 touch_x, const i32 touch_y, const i32 region_x, const i32 region_y, const i32 region_w, const i32 region_h )

inlinestaticconstexpr

Helper function to check whether a touch point hits a rectangle region.

Parameters

touch_x	X coordinate of the touch point.
touch_y	Y coordinate of the touch point.
region_x	X coordinate of the region.
region_y	Y coordinate of the region.
region_w	Width of the region.
region_h	Height of the region.

Returns

Whether the touch point hits the region.

Variable Documentation

DefaultFontSizes

u32 pu::ui::DefaultFontSizes[static_cast< u32 >(DefaultFontSize::Count)] = { 27, 30, 37, 45 }

constexpr

Array containing the default font size values used by Plutonium components, for all DefaultFontSize values.

TouchPseudoKey

u64 pu::ui::TouchPseudoKey = 1 << 29

constexpr

Input key value used internally by Plutonium to represent the presence of a touch input.