ImGui Namespace Reference

Functions
bool	Combo (const char *label, int *currIndex, std::vector< std::string > &values)
void	ShowHelpMarker (const char *description, const float sameLineOffset=0.0f)
	Helper function that inserts a help marker that displays a tooltip. More...
void	DraggableFloat (const char *label, float &value, float min=std::numeric_limits< float >::lowest(), float max=(std::numeric_limits< float >::max)())
	Show widget to edit a float. More...
void	DraggableVec2 (const char *label, glm::vec2 &value, float min=std::numeric_limits< float >::lowest(), float max=(std::numeric_limits< float >::max)())
	Show widget to edit a vec2. More...
void	DraggableVec3 (const char *label, glm::vec3 &value, float min=std::numeric_limits< float >::lowest(), float max=(std::numeric_limits< float >::max)())
	Show widget to edit a vec3. More...
void	SetNextWindowPosCenter ()
	Set the next window to be centered. More...
void	HorizontalSplitter (const ImVec2 &position, int height, int splitterSize, int &value, bool &active, int min, int max)
	Handle a horizontal splitter. More...
void	VerticalSplitter (const ImVec2 &position, int width, int splitterSize, int &value, bool &active, int min, int max)
	Handle a vertical splitter. More...
void	SaveTheme (const char *name)
	Save current theme to a JSON file. More...
void	LoadTheme (const char *name)
	Load theme from JSON file. More...
void	LoadDefaultTheme ()
	Load the default theme. More...

Function Documentation

Combo()

bool ImGui::Combo	(	const char *	label,
		int *	currIndex,
		std::vector< std::string > &	values
	)

DraggableFloat()

void ImGui::DraggableFloat	(	const char *	label,
		float &	value,
		float	min = std::numeric_limits< float >::lowest(),
		float	max = (std::numeric_limits< float >::max)()
	)

Show widget to edit a float.

Parameters

label	Label describing the value being edited.
value	Value to edit.
min	Minimum allowed value.
max	Maximum allowed value.

DraggableVec2()

void ImGui::DraggableVec2	(	const char *	label,
		glm::vec2 &	value,
		float	min = std::numeric_limits< float >::lowest(),
		float	max = (std::numeric_limits< float >::max)()
	)

Show widget to edit a vec2.

Parameters

label	Label describing the value being edited.
value	Value to edit.
min	Minimum allowed value.
max	Maximum allowed value.

DraggableVec3()

void ImGui::DraggableVec3	(	const char *	label,
		glm::vec3 &	value,
		float	min = std::numeric_limits< float >::lowest(),
		float	max = (std::numeric_limits< float >::max)()
	)

Show widget to edit a vec3.

Parameters

label	Label describing the value being edited.
value	Value to edit.
min	Minimum allowed value.
max	Maximum allowed value.

HorizontalSplitter()

void ImGui::HorizontalSplitter	(	const ImVec2 &	position,
		int	height,
		int	splitterSize,
		int &	value,
		bool &	active,
		int	min,
		int	max
	)

Handle a horizontal splitter.

Parameters

position	Position of the splitter.
height	Height of the splitter.
splitterSize	The size of the splitter.
value	The value being manipulated.
active	Bool to hold whether the splitter is active.
min	The minimum allowed value.
max	The maximum allowed value.

LoadDefaultTheme()

void ImGui::LoadDefaultTheme

(

)

Load the default theme.

LoadTheme()

void ImGui::LoadTheme

(

const char *

name

)

Load theme from JSON file.

Parameters

name	The name of the theme.

SaveTheme()

void ImGui::SaveTheme

(

const char *

name

)

Save current theme to a JSON file.

Parameters

name	The name of the theme.

SetNextWindowPosCenter()

void ImGui::SetNextWindowPosCenter

(

)

Set the next window to be centered.

ShowHelpMarker()

void ImGui::ShowHelpMarker	(	const char *	description,
		const float	sameLineOffset = 0.0f
	)

Helper function that inserts a help marker that displays a tooltip.

Parameters

description	The content of the tooltip.
sameLineOffset	If set to higher than 0.f, the help marker will be offset on the same line.

VerticalSplitter()

void ImGui::VerticalSplitter	(	const ImVec2 &	position,
		int	width,
		int	splitterSize,
		int &	value,
		bool &	active,
		int	min,
		int	max
	)

Handle a vertical splitter.

Parameters

position	Position of the splitter.
width	Width of the splitter.
splitterSize	The size of the splitter.
value	The value being manipulated.
active	Bool to hold whether the splitter is active.
min	The minimum allowed value.
max	The maximum allowed value.