Struct WindowDescription

Struct Documentation

struct WindowDescription

Full description of a floating sub-window with tabbed content.

Position / size semantics

Both values are treated as first-use hints:

  • nanogui : setPosition / setFixedWidth called unconditionally (nanogui does not persist layouts between runs).

  • ImGui : ImGui::SetNextWindowPos(pos, ImGuiCond_FirstUseEver) and ImGui::SetNextWindowSize(size, ImGuiCond_FirstUseEver). This is correct for the docking branch: the dock manager can override position and size freely after the first frame, and imgui.ini persists the docked layout across sessions without any extra work.

starts_hidden

  • nanogui : setVisible(false).

  • ImGui : window is not rendered until the module sets a shared bool visible flag (stored alongside the description). Alternatively, ImGui::SetNextWindowCollapsed(true, FirstUseEver).

Public Members

std::string title
std::array<int, 2> position = {5, 700}

Initial position hint (pixels from top-left of the parent window).

std::array<int, 2> size = {340, 0}

Initial size hint. height=0 means “auto” (let the toolkit decide).

bool starts_hidden = false

If true, the window starts hidden / collapsed.

std::vector<Tab> tabs

The tabs. If only one tab is provided the backend may omit the tab bar and render the widgets directly (saves vertical space).