imgui_kit::BackgroundImageParameters Struct Reference

Background image drawn behind all windows. More...

#include <user_interface_parameters.h>

Collaboration diagram for imgui_kit::BackgroundImageParameters:

Public Member Functions
	BackgroundImageParameters (std::string path="", ImageFitType fitType=ImageFitType::KEEP_ASPECT_RATIO)
	Constructs background image parameters.

Public Attributes
std::string	path
	Path to the image file; empty means no background image.
ImageFitType	fitType
	How the image is scaled to the window.
int	width
	Native image width in pixels (set when the image is loaded).
int	height
	Native image height in pixels (set when the image is loaded).

Detailed Description

Background image drawn behind all windows.

Constructor & Destructor Documentation

BackgroundImageParameters()

imgui_kit::BackgroundImageParameters::BackgroundImageParameters	(	std::string	path = "",
		ImageFitType	fitType = ImageFitType::KEEP_ASPECT_RATIO
	)

Constructs background image parameters.

Parameters

path	Path to the image file; empty means no background image.
fitType	How the image is scaled to the window.

Member Data Documentation

fitType

ImageFitType imgui_kit::BackgroundImageParameters::fitType

How the image is scaled to the window.

height

int imgui_kit::BackgroundImageParameters::height

Native image height in pixels (set when the image is loaded).

path

std::string imgui_kit::BackgroundImageParameters::path

Path to the image file; empty means no background image.

width

int imgui_kit::BackgroundImageParameters::width

Native image width in pixels (set when the image is loaded).

---

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

• include/user_interface_parameters.h