Blam::UI::Themes Namespace Reference

Namespace for anything relating to engine UI themes. More...

Functions
BLAM void	LoadBuiltInThemes ()
	Loads all hard-coded UI themes. More...
BLAM std::vector< BlamColorScheme > *	GetColorSchemeList ()
	Retrieves the list of currently loaded color schemes. More...
BLAM std::vector< BlamThemeMetrics > *	GetMetricsList ()
	Retrieves the list of currently loaded theme metrics. More...
BLAM bool	ApplyColorScheme (std::string scheme_id)
	Applies the specified color scheme. More...
BLAM bool	ApplyMetrics (std::string metrics_id)
	Applies the specified ImGui metrics. More...

Detailed Description

Namespace for anything relating to engine UI themes.

Engine UI themes can be used to alter the colors and appearance of both ImGUI as well as custom debug tools used within the engine.

Todo:

Allow for user-created themes to be used here.

Function Documentation

ApplyColorScheme()

bool Blam::UI::Themes::ApplyColorScheme

(

std::string

scheme_id

)

Applies the specified color scheme.

Parameters

scheme_id

- The ID of the color scheme to apply.

Returns

true if the color scheme was applied, or false if no matching color scheme was found.

ApplyMetrics()

bool Blam::UI::Themes::ApplyMetrics

(

std::string

metrics_id

)

Applies the specified ImGui metrics.

Parameters

metrics_id

- The ID of the metrics to apply.

Returns

true if the metrics were applied, or false if no matching metrics were found.

GetColorSchemeList()

std::vector< BlamColorScheme > * Blam::UI::Themes::GetColorSchemeList

(

)

Retrieves the list of currently loaded color schemes.

Returns

A pointer to the list of loaded color schemes.

GetMetricsList()

std::vector< BlamThemeMetrics > * Blam::UI::Themes::GetMetricsList

(

)

Retrieves the list of currently loaded theme metrics.

Returns

A pointer to the list of loaded theme metrics.

LoadBuiltInThemes()

void Blam::UI::Themes::LoadBuiltInThemes

(

)

Loads all hard-coded UI themes.