C/C++ SDK / C++ layer · Registration options / kroys::PanelOptions

kroys::PanelOptions

Options of Host::AddPanel (KroysPanelDesc).

Kindstruct

Headerkroys/plugin.hpp

Members6

DECLARATION

Declaration

Declared in kroys/plugin.hpp.

plugin.hpp

struct PanelOptions

REFERENCE

Members

Fields

#std::string id;

local id; panel id "<plugin id>.<id>"

fieldwraps KroysPanelDesc::id

#std::string title;

Window title; null: id.

fieldwraps KroysPanelDesc::title

#std::string icon;

Lucide icon name; null: the plug icon.

fieldwraps KroysPanelDesc::icon

#uint32_t category = KROYS_PANEL_CATEGORY_AUTHORING;

KROYS_PANEL_CATEGORY_*

fieldwraps KroysPanelDesc::category

#uint32_t slot = KROYS_PANEL_SLOT_FLOATING;

KROYS_PANEL_SLOT_*

fieldwraps KroysPanelDesc::slot

#bool openByDefault = false;

Nonzero: the panel opens when it is registered.

fieldwraps KroysPanelDesc::openByDefault

Signatures

std::string id;
std::string title;
std::string icon;
uint32_t category = KROYS_PANEL_CATEGORY_AUTHORING;
uint32_t slot = KROYS_PANEL_SLOT_FLOATING;
bool openByDefault = false;

KroysEngine 0.1.0 documentation, built from the engine repository by Tools/BuildDocsSite.py.