Blam::DebugUI Namespace Reference

Namespace containing things relating to ImGUI, and the ImGUI draw list. More...

Namespaces
	Widgets
	Namespace containing general-purpose widgets used in multiple ImGUI drawing groups/windows.
	Windows
	Legacy namespace to contain data for the legacy ImGUI console.

Classes
class	ImGUIDrawingGroup
	Class representing an ImGUI drawing group/draw list item. More...

Enumerations
enum	DrawListItem {   devtools_bar, menubar, dx11_window, engine_info,   config_editor, config_editor_new, ip_test, chat_window,   license_startup_prompt, stats, update_popup, logger,   crash_test_ui, d2d_test, discord_rpc_ui, font_editor,   network_stats, render_stack_editor, tag_editor, engine_info_new,   imgui_info, debug_menu, error_dialog, exit_via_menu,   imgui_user_guide, theme_selector, theme_editor }
	Enumerator containing an entry for each draw list item. More...

Functions
BLAM bool *	GetVisibility (DrawListItem key)
	Retrieves the visibility of the specified draw list item. More...
BLAM void	AddToDrawList (DrawListItem key, ImGUIDrawingGroup *group)
	Adds a new item to the ImGUI draw list. More...
BLAM ImGUIDrawingGroup *	GetDrawListItem (DrawListItem key)
	Retrieves a drawing group with the specified ID. More...
BLAM void	ShowErrorDialog (const char *title, const char *message)
	Shows a simple error dialog created using ImGUI. More...
BLAM std::map< Blam::DebugUI::DrawListItem, Blam::DebugUI::ImGUIDrawingGroup * > *	GetDrawList ()
	Retrieves the current ImGUI drawing list. More...

Detailed Description

Namespace containing things relating to ImGUI, and the ImGUI draw list.

Enumeration Type Documentation

DrawListItem

enum Blam::DebugUI::DrawListItem

Enumerator containing an entry for each draw list item.

Todo:

Find a way to do this that doesn't require an ugly enum

Enumerator
devtools_bar
menubar
dx11_window
engine_info
config_editor
config_editor_new
ip_test
chat_window
license_startup_prompt
stats
update_popup
logger
crash_test_ui
d2d_test
discord_rpc_ui
font_editor
network_stats
render_stack_editor
tag_editor
engine_info_new
imgui_info
debug_menu
error_dialog
exit_via_menu
imgui_user_guide
theme_selector
theme_editor

Function Documentation

AddToDrawList()

void Blam::DebugUI::AddToDrawList	(	DrawListItem	key,
		ImGUIDrawingGroup *	group
	)

Adds a new item to the ImGUI draw list.

Parameters

key	- The ID of the draw list item.
group	- Pointer to the drawing group to add.

GetDrawList()

std::map< Blam::DebugUI::DrawListItem, Blam::DebugUI::ImGUIDrawingGroup * > * Blam::DebugUI::GetDrawList

(

)

Retrieves the current ImGUI drawing list.

The key is the ID of the drawing group. The value is a pointer to the drawing group.

GetDrawListItem()

Blam::DebugUI::ImGUIDrawingGroup * Blam::DebugUI::GetDrawListItem

(

DrawListItem

key

)

Retrieves a drawing group with the specified ID.

Parameters

key	- The ID of the draw list item to retrieve.

Returns

A pointer to the specified drawing group.

GetVisibility()

bool * Blam::DebugUI::GetVisibility

(

DrawListItem

key

)

Retrieves the visibility of the specified draw list item.

See Blam::DebugUI::ImGUIDrawingGroup::Show for details.

Parameters

key	- The ID of the group to retrieve visibility of.

Returns

Pointer to the value indicating whether or not this group should be drawn onscreen.

ShowErrorDialog()

void Blam::DebugUI::ShowErrorDialog	(	const char *	title,
		const char *	message
	)

Shows a simple error dialog created using ImGUI.

Parameters

title	- The title of the dialog box.
message	- The message to show within the dialog box.