imgui_kit::UserInterfaceParameters Struct Reference

Aggregates all configuration passed to imgui_kit::UserInterface. More...

#include <user_interface_parameters.h>

Collaboration diagram for imgui_kit::UserInterfaceParameters:

Public Member Functions
	UserInterfaceParameters (WindowParameters windowParameters={}, FontParameters fontParameters={}, const StyleParameters &styleParameters={}, IconParameters iconParameters={}, BackgroundImageParameters bgImgParameters={})
	Constructs the aggregated parameters.
void	save (const std::string &filename=defaultWindowParametersFilename) const
	Saves the window geometry to an INI file.

Public Attributes
WindowParameters	windowParameters
	Top-level window geometry and title.
FontParameters	fontParameters
	Fonts to load at startup.
StyleParameters	styleParameters
	Theme and window styling.
IconParameters	iconParameters
	Window icon settings.
BackgroundImageParameters	backgroundImageParameters
	Background image settings.

Detailed Description

Aggregates all configuration passed to imgui_kit::UserInterface.

Bundles window geometry, fonts, style, icon and background image settings. Every member has a sensible default, so a default-constructed instance yields a working interface.

Constructor & Destructor Documentation

UserInterfaceParameters()

imgui_kit::UserInterfaceParameters::UserInterfaceParameters	(	WindowParameters	windowParameters = {},
		FontParameters	fontParameters = {},
		const StyleParameters &	styleParameters = {},
		IconParameters	iconParameters = {},
		BackgroundImageParameters	bgImgParameters = {}
	)

Constructs the aggregated parameters.

Parameters

windowParameters	Top-level window geometry and title.
fontParameters	Fonts to load at startup.
styleParameters	Theme and window styling.
iconParameters	Window icon settings.
bgImgParameters	Background image settings.

Member Function Documentation

save()

void imgui_kit::UserInterfaceParameters::save

(

const std::string &

filename = defaultWindowParametersFilename

)

const

Saves the window geometry to an INI file.

Parameters

filename

Path of the INI file to write.

Member Data Documentation

backgroundImageParameters

BackgroundImageParameters imgui_kit::UserInterfaceParameters::backgroundImageParameters

Background image settings.

fontParameters

FontParameters imgui_kit::UserInterfaceParameters::fontParameters

Fonts to load at startup.

iconParameters

IconParameters imgui_kit::UserInterfaceParameters::iconParameters

Window icon settings.

styleParameters

StyleParameters imgui_kit::UserInterfaceParameters::styleParameters

Theme and window styling.

windowParameters

WindowParameters imgui_kit::UserInterfaceParameters::windowParameters

Top-level window geometry and title.

---

The documentation for this struct was generated from the following file:

• include/user_interface_parameters.h