Blam::UI Namespace Reference

Namespace containing functions relating to the Blamite UI system. More...

Namespaces
	ImGUI
	Namespace for anything related to ImGUI.
	Themes
	Namespace for anything relating to engine UI themes.
	Win32

Functions
BLAM bool	Initialize ()
	Initializes the UI system. More...
BLAM void	Render ()
	Renders all UI to the screen. More...
BLAM void	Shutdown ()
	Shuts down the UI system. More...
BLAM BlamUIWidget_Group *	GetUIRoot ()
	Retrieves the root UI group widget. More...
BLAM std::string	GetWidgetAnchorLabel (BlamWidgetAnchor anchor_position)
	Retrieves a string representation of a widget anchor position. More...
BLAM bool	LoadFromCUIScreenTag (std::string tag_path, cui_screen *cusc_tag)
	Creates a new UI widget from a cui_screen tag. More...
BLAM BlamUIWidget_CrashScreen *	GetCrashScreenWidget ()
	Retrieves the built-in crash screen widget. More...
BLAM BlamUIWidget_DebugMenu *	GetDebugMenuWidget ()
	Retrieves the built-in debug menu widget. More...
BLAM BlamUIWidget_DefaultLoadScreen *	GetLoadScreenWidget ()
	Retrieves the built-in load screen widget. More...
BLAM BlamUIWidget_InfoDisplay *	GetInfoDisplayWidget ()
	Retrieves the built-in info display widget. More...

Detailed Description

Namespace containing functions relating to the Blamite UI system.

Function Documentation

GetCrashScreenWidget()

BlamUIWidget_CrashScreen * Blam::UI::GetCrashScreenWidget

(

)

Retrieves the built-in crash screen widget.

Returns

The crash screen widget, or nullptr if the crash screen widget could not be found.

Here is the call graph for this function:

Here is the caller graph for this function:

GetDebugMenuWidget()

BlamUIWidget_DebugMenu * Blam::UI::GetDebugMenuWidget

(

)

Retrieves the built-in debug menu widget.

Returns

The debug menu widget, or nullptr if the debug menu widget could not be found.

Here is the call graph for this function:

Here is the caller graph for this function:

GetInfoDisplayWidget()

BlamUIWidget_InfoDisplay * Blam::UI::GetInfoDisplayWidget

(

)

Retrieves the built-in info display widget.

Returns

The info display widget, or nullptr if the info display widget could not be found.

Here is the call graph for this function:

Here is the caller graph for this function:

GetLoadScreenWidget()

BlamUIWidget_DefaultLoadScreen * Blam::UI::GetLoadScreenWidget

(

)

Retrieves the built-in load screen widget.

Returns

The load screen widget, or nullptr if the load screen widget could not be found.

Here is the call graph for this function:

Here is the caller graph for this function:

GetUIRoot()

BlamUIWidget_Group * Blam::UI::GetUIRoot

(

)

Retrieves the root UI group widget.

Returns

Pointer to the UI root widget, or nullptr if the UI root has not yet been initialized.

Here is the caller graph for this function:

GetWidgetAnchorLabel()

std::string Blam::UI::GetWidgetAnchorLabel

(

BlamWidgetAnchor

anchor_position

)

Retrieves a string representation of a widget anchor position.

Parameters

anchor_position

- The anchor position to get a string representation for.

Returns

A string representation of the provided anchor position.

Here is the caller graph for this function:

Initialize()

bool Blam::UI::Initialize

(

)

Initializes the UI system.

Here is the call graph for this function:

Here is the caller graph for this function:

LoadFromCUIScreenTag()

bool Blam::UI::LoadFromCUIScreenTag	(	std::string	tag_path,
		cui_screen *	cusc_tag
	)

Creates a new UI widget from a cui_screen tag.

Parameters

tag_path	- The tag path of the cui_screen tag to load.
cusc_tag	- The tag to load UI widgets from.

Returns

true if the UI was loaded successfully, otherwise returns false.

Here is the call graph for this function:

Here is the caller graph for this function:

Render()

void Blam::UI::Render

(

)

Renders all UI to the screen.

Should be called each frame.

Here is the call graph for this function:

Here is the caller graph for this function:

Shutdown()

void Blam::UI::Shutdown

(

)

Shuts down the UI system.

Here is the caller graph for this function: