candlewick::gui Namespace Reference

GUI utilities. More...

Functions
void	addDebugMesh (DebugMeshComponent &dmc, bool enable_pipeline_switch=true)
void	showCandlewickAboutWindow (bool *p_open=NULL, float wrap_width=400.f)
	Show an about window providing information about Candlewick.
void	addLightControls (DirectionalLight &light)
	Adds a set of ImGui elements to control a DirectionalLight.
void	addLightControls (std::span< DirectionalLight > lights)
	Add controls for multiple lights.
void	addLightControls (std::span< DirectionalLight > lights, Uint32 numLights, Uint32 start=0)
void	addDisableCheckbox (const char *label, entt::registry &reg, entt::entity id, bool &flag)
	Adds an ImGui::Checkbox which toggles the Disable component on the entity.
void	addFileDialog (SDL_Window *window, DialogFileType dialog_file_type, std::string &filename)
	Add a GUI button-text pair to select a file to save something to.

Detailed Description

GUI utilities.

Function Documentation

addDebugMesh()

void candlewick::gui::addDebugMesh	(	DebugMeshComponent &	dmc,
		bool	enable_pipeline_switch = true )

addDisableCheckbox()

void candlewick::gui::addDisableCheckbox	(	const char *	label,
		entt::registry &	reg,
		entt::entity	id,
		bool &	flag )

Adds an ImGui::Checkbox which toggles the Disable component on the entity.

addFileDialog()

void candlewick::gui::addFileDialog	(	SDL_Window *	window,
		DialogFileType	dialog_file_type,
		std::string &	filename )

Add a GUI button-text pair to select a file to save something to.

This function can only be called from the main thread.

addLightControls() [1/3]

void candlewick::gui::addLightControls

(

DirectionalLight &

light

)

Adds a set of ImGui elements to control a DirectionalLight.

addLightControls() [2/3]

void candlewick::gui::addLightControls

(

std::span< DirectionalLight >

lights

)

Add controls for multiple lights.

addLightControls() [3/3]

void candlewick::gui::addLightControls	(	std::span< DirectionalLight >	lights,
		Uint32	numLights,
		Uint32	start = 0 )

showCandlewickAboutWindow()

void candlewick::gui::showCandlewickAboutWindow	(	bool *	p_open = NULL,
		float	wrap_width = 400.f )

Show an about window providing information about Candlewick.