Dynui Namespace Reference

Detailed Description

Imgui Profiler UI.

Copyright

(C) 2022 Individual contributors, see AUTHORS file

Classes
class	Graph
	Time Graph with predefined amount of entries. More...
class	ImguiAddon
	(C) 2012-2016 Individual contributors, see AUTHORS file More...
class	ImguiConsole
	The ImGui console uses ImGui to produce a live interactive console. More...
class	ImguiConsoleHandler
	consolehandler that prints its output to the imgui console More...
class	ImguiContext
class	ImguiDisplayEventHandler
	Handles display events such that ImGui is made aware of them. More...
class	ImguiInputHandler
	This input handler passes input events to Imgui. More...
class	ImguiProfiler
class	ImguiRTPlugin
struct	ImGuiSecondaryWindowData
struct	ImguiState
struct	ImguiTextureId
struct	ImGuiWindowHandle

Functions
	__ImplementClass (Dynui::ImguiConsole, 'IMCO', Core::RefCounted)
	__ImplementInterfaceSingleton (Dynui::ImguiConsole)
	__ImplementClass (Dynui::ImguiConsoleHandler, 'IMCH', IO::ConsoleHandler)
	__ImplementClass (Dynui::ImguiAddon, 'IMFU', Core::RefCounted)
void	ImguiDrawFunction (const CoreGraphics::CmdBufferId cmdBuf, const Math::rectangle< int > &viewport, ImDrawData *data)
	Imgui rendering function.
	__ImplementPluginContext (ImguiContext)
Ids::Id32	AllocateImguiTextureId (const ImguiTextureId &data)
	Allocate imgui texture.
void	SetImguiTextureIdData (Ids::Id32 id, const ImguiTextureId &data)
	Set imgui texture data.
void	DeallocateImguiTextureId (Ids::Id32 id)
	Deallocate imgui texture.
void	ImGuiCloseButton (bool &toggle, int id)
	Helper function to recreate the ImGUI close button used for windows and tabs.
bool	ImGuiToggleButton (const char *label, bool toggle)
	Helper function for toggle buttons.
	__ImplementClass (Dynui::ImguiDisplayEventHandler, 'IDEH', CoreGraphics::DisplayEventHandler)
	__ImplementClass (Dynui::ImguiInputHandler, 'IMIH', Input::InputHandler)
	__ImplementClass (Dynui::ImguiRTPlugin, 'IMRT', RenderModules::RTPlugin)
	__ImplementClass (Dynui::ImguiProfiler, 'IMPR', Core::RefCounted)
int	RecursiveDrawScope (const Profiling::ProfilingScope &scope, ImDrawList *drawList, const ImVec2 start, const ImVec2 fullSize, ImVec2 pos, const ImVec2 canvas, const float frameTime, const int level)
int	RecursiveDrawGpuMarker (const CoreGraphics::FrameProfilingMarker &marker, ImDrawList *drawList, const ImVec2 start, const ImVec2 fullSize, ImVec2 pos, const ImVec2 canvas, const float frameTime, const int level)

Variables
Util::Array< Util::String >	ImguiDragAndDropFiles
const char *	EditorUIPath = "user:nebula/editor/editorui.ini"
ImGuiKey	NebulaToImguiKeyCodes []
Ids::IdAllocator< ImguiTextureId >	ImguiTextureIdAllocator (0xFFF)
struct Dynui::ImguiState	state
IndexT	VertexBufferOffset = 0
IndexT	IndexBufferOffset = 0
IndexT	VertexOffset = 0
IndexT	IndexOffset = 0
IndexT	PrimitiveIndexOffset = 0
SizeT	TotalVerticesThisFrame = 0
SizeT	TotalIndicesThisFrame = 0
static Core::CVar *	ui_opacity
ImFont *	ImguiFont
ImFont *	ImguiBoldFont
ImFont *	ImguiItFont
ImFont *	ImguiIconFont

Function Documentation

__ImplementClass() [1/7]

Dynui::__ImplementClass	(	Dynui::ImguiAddon	,
		'IMFU'	,
		Core::RefCounted	)

__ImplementClass() [2/7]

Dynui::__ImplementClass	(	Dynui::ImguiConsole	,
		'IMCO'	,
		Core::RefCounted	)

__ImplementClass() [3/7]

Dynui::__ImplementClass	(	Dynui::ImguiConsoleHandler	,
		'IMCH'	,
		IO::ConsoleHandler	)

__ImplementClass() [4/7]

Dynui::__ImplementClass	(	Dynui::ImguiDisplayEventHandler	,
		'IDEH'	,
		CoreGraphics::DisplayEventHandler	)

__ImplementClass() [5/7]

Dynui::__ImplementClass	(	Dynui::ImguiInputHandler	,
		'IMIH'	,
		Input::InputHandler	)

__ImplementClass() [6/7]

Dynui::__ImplementClass	(	Dynui::ImguiProfiler	,
		'IMPR'	,
		Core::RefCounted	)

__ImplementClass() [7/7]

Dynui::__ImplementClass	(	Dynui::ImguiRTPlugin	,
		'IMRT'	,
		RenderModules::RTPlugin	)

__ImplementInterfaceSingleton()

Dynui::__ImplementInterfaceSingleton

(

Dynui::ImguiConsole

)

__ImplementPluginContext()

Dynui::__ImplementPluginContext

(

ImguiContext

)

AllocateImguiTextureId()

Ids::Id32 Dynui::AllocateImguiTextureId

(

const ImguiTextureId &

data

)

Allocate imgui texture.

DeallocateImguiTextureId()

void Dynui::DeallocateImguiTextureId

(

Ids::Id32

id

)

Deallocate imgui texture.

ImGuiCloseButton()

void Dynui::ImGuiCloseButton	(	bool &	toggle,
		int	id )

Helper function to recreate the ImGUI close button used for windows and tabs.

ImguiDrawFunction()

void Dynui::ImguiDrawFunction	(	const CoreGraphics::CmdBufferId	cmdBuf,
		const Math::rectangle< int > &	viewport,
		ImDrawData *	data )

Imgui rendering function.

ImGuiToggleButton()

bool Dynui::ImGuiToggleButton	(	const char *	label,
		bool	toggle )

Helper function for toggle buttons.

RecursiveDrawGpuMarker()

int Dynui::RecursiveDrawGpuMarker	(	const CoreGraphics::FrameProfilingMarker &	marker,
		ImDrawList *	drawList,
		const ImVec2	start,
		const ImVec2	fullSize,
		ImVec2	pos,
		const ImVec2	canvas,
		const float	frameTime,
		const int	level )

RecursiveDrawScope()

int Dynui::RecursiveDrawScope	(	const Profiling::ProfilingScope &	scope,
		ImDrawList *	drawList,
		const ImVec2	start,
		const ImVec2	fullSize,
		ImVec2	pos,
		const ImVec2	canvas,
		const float	frameTime,
		const int	level )

SetImguiTextureIdData()

void Dynui::SetImguiTextureIdData	(	Ids::Id32	id,
		const ImguiTextureId &	data )

Set imgui texture data.

Variable Documentation

EditorUIPath

const char * Dynui::EditorUIPath = "user:nebula/editor/editorui.ini"

ImguiBoldFont

ImFont * Dynui::ImguiBoldFont

ImguiDragAndDropFiles

Util::Array< Util::String > Dynui::ImguiDragAndDropFiles

ImguiFont

ImFont * Dynui::ImguiFont

ImguiIconFont

ImFont * Dynui::ImguiIconFont

ImguiItFont

ImFont * Dynui::ImguiItFont

ImguiTextureIdAllocator

Ids::IdAllocator< ImguiTextureId > Dynui::ImguiTextureIdAllocator

(

0xFFF

)

IndexBufferOffset

IndexT Dynui::IndexBufferOffset = 0

IndexOffset

IndexT Dynui::IndexOffset = 0

NebulaToImguiKeyCodes

ImGuiKey Dynui::NebulaToImguiKeyCodes

PrimitiveIndexOffset

IndexT Dynui::PrimitiveIndexOffset = 0

state

struct Dynui::ImguiState Dynui::state

TotalIndicesThisFrame

SizeT Dynui::TotalIndicesThisFrame = 0

TotalVerticesThisFrame

SizeT Dynui::TotalVerticesThisFrame = 0

ui_opacity

Core::CVar* Dynui::ui_opacity

static

VertexBufferOffset

IndexT Dynui::VertexBufferOffset = 0

VertexOffset

IndexT Dynui::VertexOffset = 0