UI group

UI::DrawList A drawing list for a layer on the UI.

UI::ListClipper Helper class to manually clip large lists of items.

UI::InputTextCallbackData Callback data for text input widgets. Do not keep handles of this around!

UI::TableColumnSortSpecs Sorting specification for a single column of a table.

UI::TableSortSpecs Sorting information for tables. Do not keep this object around! Use the Dirty property to see if the sorting changed, then set it to false when you've sorted your list.

UI::DrawList@ UI::GetBackgroundDrawList() Get background draw list. (Note: You might want to prefer using the Nvg API!)

UI::DrawList@ UI::GetForegroundDrawList() Get foreground draw list.

UI::DrawList@ UI::GetWindowDrawList() Get draw list associated to the current UI window. (Do not keep this handle around outside of windows this was called from!)

bool UI::Begin(const string&in title, int flags = UI :: WindowFlags :: NoCollapse) Begins an imgui window.

bool UI::Begin(const string&in title, bool&out open, int flags = UI :: WindowFlags :: NoCollapse) Begins an imgui window.

void UI::End() Ends an imgui window.

void UI::BeginGroup() Begins a new group.

void UI::EndGroup() Ends a group.

void UI::BeginFormattingGroup() Begins the formatting group for $-style formatting. This means that 2 consecutive widgets will share the color stack (and the default text color) of the first widget.

void UI::EndFormattingGroup() Ends the formatting group.

void UI::BeginDisabled(bool disabled = true) Begins a group of disabled widgets.

void UI::EndDisabled() Ends a group of disabled widgets.

void UI::PushStyleColor(UI::Col idx, const vec4&in col) Temporarily pushes a color change for the next widgets. You must call PopStyleColor() sometime after!

void UI::PopStyleColor(int count = 1) Pops one or more temporary color changes.

void UI::PushStyleVar(UI::StyleVar var, float value) Temporarily pushes a style change for the next widgets. You must call PopStyleVar() sometime after!

void UI::PushStyleVar(UI::StyleVar var, const vec2&in value) Temporarily pushes a style change for the next widgets. You must call PopStyleVar() sometime after!

void UI::PopStyleVar(int count = 1) Pops one or more temporary style changes.

float UI::GetScrollX() Get scrolling amount, from 0 to GetScrollMaxX().

float UI::GetScrollY() Get scrolling amount, from 0 to GetScrollMaxY().

void UI::SetScrollX(float x) Set scrolling amount, from 0 to GetScrollMaxX().

void UI::SetScrollY(float y) Set scrolling amount, from 0 to GetScrollMaxY().

float UI::GetScrollMaxX() Get maximum horizontal scrolling amount.

float UI::GetScrollMaxY() Get maximum vertical scrolling amount.

void UI::SetScrollHereX(float center_x_ratio = 0.5f) Adjust scrolling amount to make current cursor position visible. center_x_ratio=0.0: left, 0.5: center, 1.0: right. When using to make a "default / current item" visible, consider using SetItemDefaultFocus() instead.

void UI::SetScrollHereY(float center_y_ratio = 0.5f) Adjust scrolling amount to make current cursor position visible. center_y_ratio=0.0: top, 0.5: center, 1.0: bottom. When using to make a "default / current item" visible, consider using SetItemDefaultFocus() instead.

void UI::SetScrollFromPosX(float local_x, float center_x_ratio = 0.5f) Adjust scrolling amount to make given position visible. Generally GetCursorStartPos() + offset to compute a valid position.

void UI::SetScrollFromPosY(float local_y, float center_y_ratio = 0.5f) Adjust scrolling amount to make given position visible. Generally GetCursorStartPos() + offset to compute a valid position.

void UI::SetNextWindowSize(int w, int h, UI::Cond cond = UI :: Cond :: Appearing) Sets the size for the next window created with UI::Begin().

void UI::SetNextWindowPos(int x, int y, UI::Cond cond = UI :: Cond :: Appearing, float pivotx = 0.0f, float pivoty = 0.0f) Sets the position for the next window created with UI::Begin(). Pivot floats can be used to align the window on the given point.

void UI::SetNextWindowContentSize(int w, int h = 0) Sets the size for the next window contents. Set height to 0 to only set width.

void UI::SetNextItemWidth(float w) Sets the width of the next item.

void UI::PushID(const ?&in) Pushes an ID to the stack.

void UI::PushID(const string&in id) Pushes an ID to the stack.

void UI::PopID() Pops an ID from the stack.

void UI::PushFont(Resources::Font@ font) Pushes a font to the stack.

void UI::PopFont() Pops a font from the stack.

void UI::PushItemWidth(float item_width) Pushes width of items.

void UI::PopItemWidth() Pops width of items.

void UI::SameLine() Marks the next control to be drawn on the same line as the last one.

void UI::NewLine() Marks the next control to be drawn on the next line rather than the current line.

void UI::Separator() Separator line.

void UI::Dummy(const vec2&in size) Dummy space.

void UI::Dummy(const vec2&in size, float text_baseline_y) Dummy space with a custom baseline.

void UI::PushTextWrapPos(float wrap_local_pos_x = 0.0f) Push word-wrapping position for Text*() commands. Less than 0: no wrapping; 0: wrap to end of window (or column); > 0: wrap at the given position in window local space.

void UI::PopTextWrapPos() Pops word-wrapping position for Text*() commands.

int UI::CalcWordWrapPosition(float scale, const string&in text, float wrap_width, int text_offset = 0, Resources::Font@ font = null) Calculates the word wrapping position of the given string.

bool UI::Button(const string&in label, const vec2&in size = vec2 ( )) Clickable button. Returns true if it was clicked.

bool UI::InvisibleButton(const string&in id, const vec2&in size, int flags = UI :: ButtonFlags :: None) Clickable invisible button. Returns true if it was clicked.

void UI::Text(const string&in text, int length = - 1) Simple text label with an optional length.

void UI::TextWrapped(const string&in text) Simple text label with word wrapping.

void UI::TextWrappedWindow(const string&in text, float new_line_padding = 0, float extra_wrap_size = 0) Simple text label with word wrapping, but the text resets to the start of the window instead of the starting cursor position.

void UI::TextDisabled(const string&in text) Simple text label, but in its disabled color.

void UI::LabelText(const string&in label, const string&in text) Text label with a value.

void UI::PlotLines(const string&in label, const float[]&in values, int offset = 0, float height = 0.0f) Line graph.

void UI::PlotHistogram(const string&in label, const float[]&in values, int offset = 0, float height = 0.0f) Histogram graph.

bool UI::Checkbox(const string&in label, bool value) Checkbox. For value, pass the current value. The return value is the new value.

bool UI::RadioButton(const string&in label, bool active) Radio button. For active, pass whether the current value is active. Returns true if the button was pressed.

bool UI::BeginMenuBar() Begins an imgui menu bar.

void UI::EndMenuBar() Ends an imgui menu bar.

bool UI::BeginMenu(const string&in label, bool enabled = true) Begins an imgui menu.

void UI::EndMenu() Ends an imgui menu.

bool UI::MenuItem(const string&in label, const string&in shortcut = "", bool selected = false, bool enabled = true) Clickable menu item. Returns true when clicked.

bool UI::IsWindowAppearing() Returns true if the previous window is just now appearing.

bool UI::TreeNode(const string&in text) Node in a tree list. Returns true if opened.

void UI::TreePop() End of the previously tree node. Must only be called if TreeNode() returned true.

void UI::TreeAdvanceToLabelPos() Advance the cursor position to the normal label position for tree nodes.

bool UI::CollapsingHeader(const string&in label) Collapsable header. Returns true if open.

void UI::Columns(int count, const string&in id = "", bool border = true) Begins a table layout. Call this with count set to 1 to reset to normal.

void UI::NextColumn() Goes to the next column.

bool UI::IsItemHovered() Returns true if the mouse is hovering the previous control.

bool UI::IsItemActive() Returns true if the previous control is active.

bool UI::IsItemFocused() Returns true if the previous control is focused.

bool UI::IsItemClicked() Returns true if the previous control is clicked.

bool UI::IsItemDeactivated() Returns true if the previous control is deactivated.

vec4 UI::GetItemRect() Returns the rectangle of the previous control in screen space.

bool UI::IsKeyPressed(UI::Key key) Returns true if the given key was pressed.

void UI::BeginTooltip() Begins a tooltip dialog.

void UI::EndTooltip() Ends a tooltip dialog.

void UI::OpenPopup(const string&in id) Opens a popup with the given ID. Must be within the same scope of ID's.

void UI::CloseCurrentPopup() Closes the current popup.

bool UI::BeginPopup(const string&in id, int flags = UI :: WindowFlags :: None) Begins a popup.

bool UI::BeginPopupContextItem(const string&in id) Begins a popup context item.

bool UI::BeginPopupModal(const string&in id, int flags = UI :: WindowFlags :: None) Begins a modal popup.

bool UI::BeginPopupModal(const string&in id, bool&out open, int flags = UI :: WindowFlags :: None) Begins a modal popup.

void UI::EndPopup() Ends a popup.

bool UI::BeginCombo(const string&in label, const string&in current, int flags = UI :: ComboFlags :: None) Begins a combo box.

bool UI::Selectable(const string&in label, bool selected, int flags = UI :: SelectableFlags :: None) Represents a selectable item. Could be inside of a combo box.

void UI::SetItemDefaultFocus() Puts default focus on the last added item.

void UI::EndCombo() Ends a combo box.

string UI::InputText(const string&in label, string str, int flags = UI :: InputTextFlags :: None, UI::InputTextCallback@ callback = null) Input text. Returns the new value.

string UI::InputText(const string&in label, string str, bool&out changed, int flags = UI :: InputTextFlags :: None, UI::InputTextCallback@ callback = null) Input text. Returns the new value as well as the changed boolean.

string UI::InputTextMultiline(const string&in label, string str, const vec2&in size = vec2 ( 0 , 0 ), UI::InputTextFlags flags = UI :: InputTextFlags :: None, UI::InputTextCallback@ callback = null) Input text in a multiline box. Returns the new value.

string UI::InputTextMultiline(const string&in label, string str, bool&out changed, const vec2&in size = vec2 ( 0 , 0 ), UI::InputTextFlags flags = UI :: InputTextFlags :: None, UI::InputTextCallback@ callback = null) Input text in a multiline box. Returns the new value as well as the changed boolean.

void UI::SetKeyboardFocusHere(int offset = 0) Sets the keyboard focus on the next widget. Use positive offsets to access sub components of a multiple component widget. Use -1 to access previous widget.

int UI::InputInt(const string&in label, int num, int step = 1) Input integer. Returns the new value.

float UI::InputFloat(const string&in label, float num, float step = 1.0f) Input float. Returns the new value.

int UI::SliderInt(const string&in label, int num, int min, int max) Slider for integers. Returns the new value.

float UI::SliderFloat(const string&in label, float num, float min, float max) Slider for floats. Returns the new value.

int UI::VSliderInt(const string&in label, const vec2&in size, int num, int min, int max, const string&in format = "%d") Vertical slider for integers. Returns the new value.

float UI::VSliderFloat(const string&in label, const vec2&in size, float num, float min, float max, const string&in format = "%.3f") Vertical slider for floats. Returns the new value.

vec3 UI::InputColor3(const string&in label, vec3 color) Input color. Returns the new value.

void UI::Image(Resources::Texture&inout texture) An image.

void UI::Image(Resources::Texture&inout texture, const vec2&in size) An image scaled to a specific size.

bool UI::BeginChild(const string&in id, const vec2&in size = vec2 ( ), bool border = false, int flags = 0) Begins a self-contained indepedendent scrolling container.

void UI::EndChild() Ends a child container.

void UI::BeginTabBar(const string&in id, int flags = UI :: TabBarFlags :: None) Begins a multi-tab container.

bool UI::BeginTabItem(const string&in label, int flags = UI :: TabItemFlags :: None) Begins a tab item within a multi-tab container.

bool UI::BeginTabItem(const string&in label, bool&out open, int flags = UI :: TabItemFlags :: None) Begins a tab item within a multi-tab container.

void UI::EndTabItem() Ends a tab item within a multi-tab container.

void UI::EndTabBar() Ends a multi-tab container.

bool UI::BeginTable(const string&in id, int columns, int flags = UI :: TableFlags :: None, const vec2&in outer_size = vec2 ( ), float inner_width = 0.0f) Begins a table. Only call EndTable() if BeginTable() returns true.

void UI::EndTable() Ends a table.

void UI::TableNextRow(int flags = UI :: TableRowFlags :: None, float min_height = 0.0f) Append into the first cell of a new row in a table.

bool UI::TableNextColumn() Append into the next column (or first column of new row) of a table. Returns true if visible.

bool UI::TableSetColumnIndex(int index) Append into a specified column of a table. Returns true if visible.

void UI::TableSetupColumn(const string&in label, int flags = UI :: TableColumnFlags :: None, float init_width_or_weight = 0.0f, uint user_id = 0) Sets up a column within a table with a label, flags, and initial size.

void UI::TableSetupScrollFreeze(int cols, int rows) Lock columns and rows in a table so they stay visible when scrolled.

void UI::TableHeadersRow() Submit all table header cells based on data provided to TableSetupColumn.

void UI::TableHeader(const string&in label) Submit one header cell manually. (Prefer TableHeadersRow!)

UI::TableSortSpecs@ UI::TableGetSortSpecs() Get latest sort specs for the table. Returns null when not sorting.

void UI::AlignTextToFramePadding() Vertically align upcoming text baseline to frame padding so that it will align properly to regularly framed items (call if you have text on a line before a framed item).

float UI::GetTextLineHeight() Gets the line height of text. Typically the font size.

float UI::GetTextLineHeightWithSpacing() Gets the line height of text plus the distance between 2 consecutive lines of text.

float UI::GetFrameHeight() Gets the frame height.

float UI::GetFrameHeightWithSpacing() Gets the frame height plus the distance in pixels between 2 consecutive lines of framed widgets.

vec2 UI::GetCursorPos() Gets the current position of the UI cursor.

void UI::SetCursorPos(const vec2&in pos) Sets the current position of the UI cursor.

vec2 UI::GetWindowPos() Gets the current position of the UI window.

void UI::SetWindowPos(const vec2&in size, UI::Cond cond = UI :: Cond :: None) Sets the current position of the UI window.

vec2 UI::GetWindowSize() Gets the current size of the UI window.

void UI::SetWindowSize(const vec2&in size, UI::Cond cond = UI :: Cond :: None) Sets the current size of the UI window.

bool UI::IsWindowFocused(int flags = UI :: FocusedFlags :: None) Is the current window focused? Or its root/child, depending on flags.

vec2 UI::GetContentRegionAvail() Gets the currently available size in the window.

vec2 UI::GetContentRegionMax() Gets the current content boundaries.

vec2 UI::GetWindowContentRegionMin() Gets the content boundaries minimum.

vec2 UI::GetWindowContentRegionMax() Gets the content boundaries maximum.

float UI::GetWindowContentRegionWidth() Gets the content width.

void UI::NodTree(CMwNod@ nod, UI::NodTreeMemberCallback@ memberCallback = null) A tree of nods, much like Nod Explorer.

bool UI::IsOverlayShown() Returns true if the overlay is currently visible.

void UI::ShowOverlay() Shows the overlay.

void UI::HideOverlay() Hides the overlay.

void UI::ShowNotification(const string&in text, int time = 5000) Shows a notification in the overlay.

void UI::ShowNotification(const string&in header, const string&in text, int time = 5000) Shows a notification in the overlay with an additional header.

void UI::ShowNotification(const string&in header, const string&in text, const vec4&in colBackground, int time = 5000) Shows a notification in the overlay with an additional header and background color.

vec2 UI::GetMousePos() Get the current position of the mouse relative to the top-left corner of the window.

vec4 UI::HSV(float h, float s, float v) Converts HSV values into RGB values.

void UI::Markdown(const string&in str) Renders a block of text with Markdown formatting.