ImGui::CustomStatePluginWindowParameters Struct Reference

Structure that contains parameters for State plugin window with custom style. More...

#include <ImGuiHelpers.h>

Public Attributes
bool *	collapsed { nullptr }
float	width { 0.0f }
	window width (should be already scaled with UI::scale())
float	height { 0.0f }
	window height, usually calculated internally (if value is zero)
bool	allowScrollbar = true
	If false, will never show the scrollbar.
ImVec2 *	position { nullptr }
	start Position
ImVec2	pivot { 0.0f, 0.0f }
	the position of the starting point of the window
ImGuiWindowFlags	flags = ImGuiWindowFlags_NoResize | ImGuiWindowFlags_AlwaysAutoResize
	window flags, ImGuiWindowFlags_NoScrollbar and ImGuiWindow_NoScrollingWithMouse are forced inside BeginCustomStatePlugin function
ImVec2 *	changedSize { nullptr }
	outside owned parameter for windows with resize option
std::function< void()>	customHeaderFn = nullptr
	draw custom header items immediately after the caption
std::function< void()>	helpBtnFn = nullptr
	reaction on press "Help" button
bool	closeWithEscape { true }
	if true esc button closes the plugin

Detailed Description

Structure that contains parameters for State plugin window with custom style.

Member Data Documentation

allowScrollbar

bool ImGui::CustomStatePluginWindowParameters::allowScrollbar = true

If false, will never show the scrollbar.

changedSize

ImVec2* ImGui::CustomStatePluginWindowParameters::changedSize { nullptr }

outside owned parameter for windows with resize option

closeWithEscape

bool ImGui::CustomStatePluginWindowParameters::closeWithEscape { true }

if true esc button closes the plugin

collapsed

bool* ImGui::CustomStatePluginWindowParameters::collapsed { nullptr }

All fields those have explicit initializers, even if they have sane default constructors. This makes it so that Clangd doens't warn when they aren't initialized in partial aggregate initialization. current collapsed state of window in/out parameter, owned outside of BeginCustomStatePlugin function

customHeaderFn

std::function<void()> ImGui::CustomStatePluginWindowParameters::customHeaderFn = nullptr

draw custom header items immediately after the caption

flags

ImGuiWindowFlags ImGui::CustomStatePluginWindowParameters::flags = ImGuiWindowFlags_NoResize | ImGuiWindowFlags_AlwaysAutoResize

window flags, ImGuiWindowFlags_NoScrollbar and ImGuiWindow_NoScrollingWithMouse are forced inside BeginCustomStatePlugin function

height

float ImGui::CustomStatePluginWindowParameters::height { 0.0f }

window height, usually calculated internally (if value is zero)

helpBtnFn

std::function<void()> ImGui::CustomStatePluginWindowParameters::helpBtnFn = nullptr

reaction on press "Help" button

pivot

ImVec2 ImGui::CustomStatePluginWindowParameters::pivot { 0.0f, 0.0f }

the position of the starting point of the window

position

ImVec2* ImGui::CustomStatePluginWindowParameters::position { nullptr }

start Position

width

float ImGui::CustomStatePluginWindowParameters::width { 0.0f }

window width (should be already scaled with UI::scale())

---

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

• ImGuiHelpers.h