Core UI

Platform-agnostic widgets and helpers: GuiElement, GuiWindow, GuiButton, GuiImage, GuiText, GuiSound, GuiTrigger, the file/option browsers and the on-screen keyboard. More...

Classes
class	GuiButton
	Display, manage, and manipulate buttons in the GUI. More...
class	GuiElement
	Primary GUI class. More...
class	GuiFileBrowser
	Display a list of files. More...
class	GuiImage
	Display, manage, and manipulate images in the GUI. More...
class	GuiImageData
	Decodes compressed image data (PNG) into a platform-native texture created from it. More...
class	GuiKeyboard
	On-screen keyboard. More...
class	GuiOptionBrowser
	Display a list of menu options. More...
class	GuiSound
	Sound conversion and playback. More...
class	GuiSoundOggPlayer
	Platform-agnostic Tremor (integer OGG) decoder. More...
struct	FontOffset
	Per-pixel-size font metrics used for text-block alignment/positioning. More...
struct	GlyphData
	Cached per-glyph metrics and rasterized texture, keyed by (pixel size, char code) in GuiTextRenderer::fontData. More...
class	GuiTextRenderer
	FreeType2-based glyph shaping/caching. More...
class	GuiTextTranslator
	Hashed msgid -> UTF-8 string table loaded from a single binary .lang blob (see loadLanguage()). More...
class	GuiTrigger
	Input-condition matcher attached to a GuiElement (via setSimpleTrigger() etc.) and evaluated against an InputController - the isClicked()/ isHeld()/isReleased() methods GuiElement::update() calls each frame. More...
class	GuiWindow
	Allows GuiElements to be grouped together into a "window". More...

Enumerations
enum class	SCROLL { NONE , HORIZONTAL }
	Scrolling mode of a GuiText (none or horizontal). More...
enum class	ALIGN_V { TOP , BOTTOM , MIDDLE }
	Vertical alignment of a GuiElement relative to its parent. More...
enum class	ALIGN_H { LEFT , RIGHT , CENTRE }
	Horizontal alignment of a GuiElement relative to its parent. More...
enum class	STATE {   DEFAULT , SELECTED , CLICKED , HELD ,   DISABLED }
	Interaction state of a GuiElement (default, selected, clicked, held, disabled). More...
enum	EFFECT {   SLIDE_TOP = (1u << 0) , SLIDE_BOTTOM = (1u << 1) , SLIDE_RIGHT = (1u << 2) , SLIDE_LEFT = (1u << 3) ,   SLIDE_IN = (1u << 4) , SLIDE_OUT = (1u << 5) , FADE = (1u << 6) , SCALE = (1u << 7) ,   COLOR_TRANSITION = (1u << 8) }
	Bitmask of transition effects (slide, fade, scale, color) applied to a GuiElement. More...
enum class	IMAGE { TEXTURE , COLOR }
	Whether a GuiImage draws a texture or a flat color. More...
enum class	SOUND { NONE , PCM , OGG }
	Encoding of a GuiSound: a short PCM one-shot or a streamed OGG. More...
enum class	VOLUME_TYPE { MUSIC , SFX }
	Global volume category: music (looping stream) or sound effects. More...
enum class	TRIGGER_TYPE { SIMPLE , HELD , BUTTON_ONLY , BUTTON_ONLY_IN_FOCUS }
	How a GuiTrigger matches input: simple, held, button-only, or button-only-in-focus. More...
enum class	TRIGGER_ACTION { NONE , PRIMARY , SECONDARY }
	Whether a GuiTrigger uses an explicit button mask or a semantic primary (Accept) / secondary (Cancel) action. More...

Detailed Description

Platform-agnostic widgets and helpers: GuiElement, GuiWindow, GuiButton, GuiImage, GuiText, GuiSound, GuiTrigger, the file/option browsers and the on-screen keyboard.

Enumeration Type Documentation

ALIGN_H

enum class ALIGN_H

strong

Horizontal alignment of a GuiElement relative to its parent.

Definition at line 28 of file GuiElement.h.

ALIGN_V

enum class ALIGN_V

strong

Vertical alignment of a GuiElement relative to its parent.

Definition at line 20 of file GuiElement.h.

EFFECT

enum EFFECT

Bitmask of transition effects (slide, fade, scale, color) applied to a GuiElement.

Definition at line 46 of file GuiElement.h.

IMAGE

enum class IMAGE

strong

Whether a GuiImage draws a texture or a flat color.

Definition at line 10 of file GuiImage.h.

SCROLL

enum class SCROLL

strong

Scrolling mode of a GuiText (none or horizontal).

Definition at line 41 of file Gui.h.

SOUND

enum class SOUND

strong

Encoding of a GuiSound: a short PCM one-shot or a streamed OGG.

Definition at line 10 of file GuiSound.h.

STATE

enum class STATE

strong

Interaction state of a GuiElement (default, selected, clicked, held, disabled).

Definition at line 36 of file GuiElement.h.

TRIGGER_ACTION

enum class TRIGGER_ACTION

strong

Whether a GuiTrigger uses an explicit button mask or a semantic primary (Accept) / secondary (Cancel) action.

Definition at line 24 of file GuiTrigger.h.

TRIGGER_TYPE

enum class TRIGGER_TYPE

strong

How a GuiTrigger matches input: simple, held, button-only, or button-only-in-focus.

Definition at line 15 of file GuiTrigger.h.

VOLUME_TYPE

enum class VOLUME_TYPE

strong

Global volume category: music (looping stream) or sound effects.

Definition at line 18 of file GuiSound.h.