Struct Ui

This is locked and returns [0.0, 0.0] until the mouse has moved past the given threshold. If the given threshold is invalid or negative, the global distance threshold is used (io.mouse_drag_threshold).

Source

pub fn reset_mouse_drag_delta(&self, button: MouseButton)

Resets the current delta from initial clicking position.

Source

pub fn mouse_cursor(&self) -> Option<MouseCursor>

Returns the currently desired mouse cursor type.

Returns None if no cursor should be displayed

Source

pub fn set_mouse_cursor(&self, cursor_type: Option<MouseCursor>)

Sets the desired mouse cursor type.

Passing None hides the mouse cursor.

Source

pub fn is_current_mouse_pos_valid(&self) -> bool

Source

pub fn is_mouse_pos_valid(&self, mouse_pos: impl Into<Vector2<f32>>) -> bool

Source §

impl Ui

§Cursor / Layout

Source

pub fn separator(&self)

Renders a separator (generally horizontal).

This becomes a vertical separator inside a menu bar or in horizontal layout mode.

Source

pub fn same_line(&self)

Call between widgets or groups to layout them horizontally.

X position is given in window coordinates.

This is equivalent to calling same_line_with_pos with the pos set to 0.0, which uses Style::item_spacing.

Source

pub fn same_line_with_pos(&self, pos_x: f32)

Call between widgets or groups to layout them horizontally.

X position is given in window coordinates.

This is equivalent to calling same_line_with_spacing with the spacing set to -1.0, which means no extra spacing.

Source

pub fn same_line_with_spacing(&self, pos_x: f32, spacing_w: f32)

Call between widgets or groups to layout them horizontally.

X position is given in window coordinates.

Source

pub fn new_line(&self)

Undo a same_line call or force a new line when in horizontal layout mode

Source

pub fn spacing(&self)

Adds vertical spacing

Source

pub fn dummy(&self, size: impl Into<Vector2<f32>>)

Fills a space of size in pixels with nothing on the current window.

Can be used to move the cursor on the window.

Source

pub fn indent(&self)

Moves content position to the right by Style::indent_spacing

This is equivalent to indent_by with width set to Style::ident_spacing.

Source

pub fn indent_by(&self, width: f32)

Moves content position to the right by width

Source

pub fn unindent(&self)

Moves content position to the left by Style::indent_spacing

This is equivalent to unindent_by with width set to Style::ident_spacing.

Source

pub fn unindent_by(&self, width: f32)

Moves content position to the left by width

Source

pub fn begin_group(&self) -> GroupToken<'_>

Groups items together as a single item.

May be useful to handle the same mouse event on a group of items, for example.

Returns a GroupToken that must be ended by calling .end()

Source

pub fn group<R, F: FnOnce() -> R>(&self, f: F) -> R

Creates a layout group and runs a closure to construct the contents.

May be useful to handle the same mouse event on a group of items, for example.

Source

pub fn cursor_pos(&self) -> [f32; 2]

Returns the cursor position (in window coordinates)

Source

pub fn set_cursor_pos(&self, pos: impl Into<Vector2<f32>>)

Sets the cursor position (in window coordinates).

This sets the point on which the next widget will be drawn.

Source

pub fn cursor_start_pos(&self) -> [f32; 2]

Returns the initial cursor position (in window coordinates)

Source

pub fn cursor_screen_pos(&self) -> [f32; 2]

Returns the cursor position (in absolute screen coordinates).

This is especially useful for drawing, as the drawing API uses screen coordinates.

Source

pub fn set_cursor_screen_pos(&self, pos: impl Into<Vector2<f32>>)

Sets the cursor position (in absolute screen coordinates)

Source

pub fn align_text_to_frame_padding(&self)

Vertically aligns text baseline so that it will align properly to regularly frame items.

Call this if you have text on a line before a framed item.

Source

pub fn text_line_height(&self) -> f32

Source

pub fn text_line_height_with_spacing(&self) -> f32

Source

pub fn frame_height(&self) -> f32

Source

pub fn frame_height_with_spacing(&self) -> f32

Source §

impl Ui

Source

pub fn open_popup(&self, str_id: impl AsRef<str>)

Instructs ImGui that a popup is open.

You should call this function once while calling any of the following per-frame:

The confusing aspect to popups is that ImGui holds control over the popup itself.

Source

pub fn begin_popup(&self, str_id: impl AsRef<str>) -> Option<PopupToken<'_>>

Construct a popup that can have any kind of content.

This should be called per frame, whereas open_popup should be called once to signal that this popup is active.

Construct a popup that can have any kind of content.

This should be called per frame, whereas open_popup should be called once to signal that this popup is active.

Source

pub fn modal_popup<Label, Func, R>(&self, str_id: Label, f: Func) -> Option<R>
where Label: AsRef<str>, Func: FnOnce() -> R,

Creates a PopupModal, and runs a closure on it.

To customize the behavior of this PopupModal, use modal_popup_config.

Source

pub fn begin_modal_popup<Label: AsRef<str>>( &self, str_id: Label, ) -> Option<PopupToken<'_>>

Creates a PopupModal, returning a drop token.

To customize the behavior of this PopupModal, use modal_popup_config.

Source

pub fn modal_popup_config<Label: AsRef<str>>( &self, str_id: Label, ) -> PopupModal<'_, '_, Label>

Creates a PopupModal builder.

Source

pub fn close_current_popup(&self)

Close a popup. Should be called within the closure given as argument to Ui::popup or Ui::modal_popup.

Source

pub fn begin_popup_context_item(&self) -> Option<PopupToken<'_>>

Open and begin popup when clicked with the right mouse button on last item.

This does not take a label, which means that multiple calls in a row will use the same label, which is based on the last node which had a label. Text and other non-interactive elements generally don’t have ids, so you’ll need to use begin_popup_context_with_label for them.

Source

pub fn begin_popup_context_with_label<Label: AsRef<str>>( &self, str_id: Label, ) -> Option<PopupToken<'_>>

Open and begin popup when clicked with the right mouse button on the given item with a dedicated label.

If you want to use the label of the previous popup (outside of Text and other non-interactive cases, that is the more normal case), use begin_popup_context_item.

Source

pub fn begin_popup_context_window(&self) -> Option<PopupToken<'_>>

Open and begin popup when clicked on current window.

This does not take a label, which means that multiple calls will use the same provided label. If you want an explicit label, such as having two different kinds of windows popups in your program, use begin_popup_context_window_with_label.

Source

pub fn begin_popup_context_window_with_label<Label: AsRef<str>>( &self, str_id: Label, ) -> Option<PopupToken<'_>>

Open and begin popup when clicked on current window.

This takes a label explicitly. This is useful when multiple code locations may want to manipulate/open the same popup, given an explicit id.

Source

pub fn begin_popup_context_void(&self) -> Option<PopupToken<'_>>

Open and begin popup when right clicked in void (where there are no windows).

This does not take a label, which means that multiple calls will use the same provided label. If you want an explicit label, such as having two different kinds of void popups in your program, use begin_popup_context_void_with_label.

Source

pub fn begin_popup_context_void_with_label<Label: AsRef<str>>( &self, str_id: Label, ) -> Option<PopupToken<'_>>

Open and begin popup when right clicked in void (where there are no windows).

This takes a label explicitly. This is useful when multiple code locations may want to manipulate/open the same popup, given an explicit id.

Source §

impl Ui

§Parameter stacks (shared)

Source

pub fn push_font(&self, id: FontId) -> FontStackToken<'_>

Switches to the given font by pushing it to the font stack.

Returns a FontStackToken that must be popped by calling .pop()

§Panics

Panics if the font atlas does not contain the given font

§Examples

// At initialization time
let my_custom_font = ctx.fonts().add_font(&font_data_sources);
// During UI construction
let font = ui.push_font(my_custom_font);
ui.text("I use the custom font!");
font.pop();

Source

pub fn push_style_color( &self, style_color: StyleColor, color: impl Into<Vector4<f32>>, ) -> ColorStackToken<'_>

Changes a style color by pushing a change to the color stack.

Returns a ColorStackToken that must be popped by calling .pop()

§Examples

const RED: [f32; 4] = [1.0, 0.0, 0.0, 1.0];
let color = ui.push_style_color(StyleColor::Text, RED);
ui.text("I'm red!");
color.pop();

Source

pub fn push_style_var(&self, style_var: StyleVar) -> StyleStackToken<'_>

Changes a style variable by pushing a change to the style stack.

Returns a StyleStackToken that can be popped by calling .end() or by allowing to drop.

§Examples

let style = ui.push_style_var(StyleVar::Alpha(0.2));
ui.text("I'm transparent!");
style.pop();

Source §

impl Ui

§Parameter stacks (current window)

Source

pub fn push_item_width(&self, item_width: f32) -> ItemWidthStackToken<'_>

Changes the item width by pushing a change to the item width stack.

Returns an ItemWidthStackToken. The pushed width item is popped when either ItemWidthStackToken goes out of scope, or .end() is called.

> 0.0: width is item_width pixels
= 0.0: default to ~2/3 of window width
< 0.0: item_width pixels relative to the right of window (-1.0 always aligns width to the right side)

Source

pub fn set_next_item_width(&self, item_width: f32)

Sets the width of the next item.

> 0.0: width is item_width pixels
= 0.0: default to ~2/3 of window width
< 0.0: item_width pixels relative to the right of window (-1.0 always aligns width to the right side)

Source

pub fn calc_item_width(&self) -> f32

Returns the width of the item given the pushed settings and the current cursor position.

This is NOT necessarily the width of last item.

Source

pub fn push_text_wrap_pos(&self) -> TextWrapPosStackToken<'_>

Makes the text wrap at the end of window/column (which is generally the default), by pushing a change to the text wrapping position stack.

This is the same as calling push_text_wrap_pos_with_pos with wrap_pos_x set to 0.0.

Returns a TextWrapPosStackToken. The pushed position item is popped when either TextWrapPosStackToken goes out of scope, or .end() is called.

Source

pub fn push_text_wrap_pos_with_pos( &self, wrap_pos_x: f32, ) -> TextWrapPosStackToken<'_>

Changes the text wrapping position by pushing a change to the text wrapping position stack.

Returns a TextWrapPosStackToken. The pushed position item is popped when either TextWrapPosStackToken goes out of scope, or .end() is called.

> 0.0: wrap at wrap_pos_x position in window local space
= 0.0: wrap to end of window (or column)
< 0.0: no wrapping

Source

pub fn push_allow_keyboard_focus( &self, allow: bool, ) -> PushAllowKeyboardFocusToken<'_>

Tab stop enable. Allow focusing using TAB/Shift-TAB, enabled by default but you can disable it for certain widgets

Returns a PushAllowKeyboardFocusToken that should be dropped.

Source

pub fn push_button_repeat(&self, allow: bool) -> PushButtonRepeatToken<'_>

In ‘repeat’ mode, button_x functions return repeated true in a typematic manner (using io.KeyRepeatDelay/io.KeyRepeatRate setting). Note that you can call IsItemActive() after any Button() to tell if the button is held in the current frame.

Returns a PushButtonRepeatToken that should be dropped.

Source

pub fn push_item_flag(&self, item_flag: ItemFlag) -> ItemFlagsStackToken<'_>

👎Deprecated since 0.9.0: use push_allow_keyboard_focus or push_button_repeat instead

Changes an item flag by pushing a change to the item flag stack.

Returns a ItemFlagsStackToken that may be popped by calling .pop()

§Deprecated

This was deprecated in 0.9.0 because it isn’t part of the dear imgui design, and supporting it required a manual implementation of its drop token.

Instead, just use push_allow_keyboard_focus and push_button_repeat.

Source §

impl Ui

§ID stack

Source

pub fn push_id(&self, s: impl AsRef<str>) -> IdStackToken<'_>

Pushes an identifier to the ID stack.

Returns an IdStackToken that can be popped by calling .end() or by dropping manually.

§Examples

Dear ImGui uses labels to uniquely identify widgets. For a good explaination, see this part of the Dear ImGui FAQ

In imgui-rs the same applies, we can manually specify labels with the ## syntax:


ui.button("Click##button1");
ui.button("Click##button2");

Here Click is the label used for both buttons, and everything after ## is used as the identifier.

However when you either have many items (say, created in a loop), we can use our loop number as an item in the “ID stack”:


ui.window("Example").build(|| {
    // The window adds "Example" to the token stack.
    for num in 0..10 {
        // And now we add the loop number to the stack too,
        // to make our buttons unique within this window.
        let _id = ui.push_id_usize(num);
        if ui.button("Click!") {
            println!("Button {} clicked", num);
        }
    }
});

We don’t have to use numbers - strings also work:


fn callback1(ui: &imgui::Ui) {
    if ui.button("Click") {
        println!("First button clicked")
    }
}

fn callback2(ui: &imgui::Ui) {
    if ui.button("Click") {
        println!("Second button clicked")
    }
}

ui.window("Example")
.build(||{
    {
        // Since we don't know what callback1 might do, we create
        // a unique ID stack by pushing (a hash of) "first" to the ID stack:
        let _id1 = ui.push_id("first");
        callback1(&ui);
    }
    {
        // Same for second callback. If we didn't do this, clicking the "Click" button
        // would trigger both println statements!
        let id2 = ui.push_id("second");
        callback2(&ui);
        // Here we manually end the scope. Typically letting it drop is neater
        // but sometimes it's useful to end the scope earlier
        id2.end();
        ui.text("We can do other things, outside of the id2 scope");
    }
});

Source

pub fn push_id_usize(&self, id: usize) -> IdStackToken<'_>

Pushes a usize to the ID stack.

Returns an IdStackToken that can be popped by calling .end() or by dropping manually.

See push_id for more information.

Source

pub fn push_id_int(&self, id: i32) -> IdStackToken<'_>

Pushes an i32 to the ID stack.

Returns an IdStackToken that can be popped by calling .end() or by dropping manually.

See push_id for more information.

Source

pub fn push_id_ptr<T>(&self, value: &T) -> IdStackToken<'_>

Pushes a ptr to the ID stack.

Returns an IdStackToken that can be popped by calling .end() or by dropping manually.

See push_id for more information.

Source §

impl Ui

Source

pub fn begin_table( &self, str_id: impl AsRef<str>, column_count: usize, ) -> Option<TableToken<'_>>

Begins a table with no flags and with standard sizing contraints.

This does no work on styling the headers (the top row) – see either begin_table_header or the more complex table_setup_column.

Nb: we take column as a usize, but it will be converted with as i32 to an i32. If this makes a difference to you, you are probably trying to make too many columns.

Source

pub fn begin_table_with_flags( &self, str_id: impl AsRef<str>, column_count: usize, flags: TableFlags, ) -> Option<TableToken<'_>>

Begins a table with flags and standard sizing contraints.

This does no work on styling the headers (the top row) – see either begin_table_header or the more complex table_setup_column.

Nb: we take column as a usize, but it will be converted with as i32 to an i32. If this makes a difference to you, you are probably trying to make too many columns.

Source

pub fn begin_table_with_sizing( &self, str_id: impl AsRef<str>, column: usize, flags: TableFlags, outer_size: [f32; 2], inner_width: f32, ) -> Option<TableToken<'_>>

Begins a table with all flags and sizing contraints. This is the base method, and gives users the most flexibility.

This does no work on styling the headers (the top row) – see either begin_table_header or the more complex table_setup_column.

Nb: we take column as a usize, but it will be converted with as i32 to an i32. If this makes a difference to you, you are probably trying to make too many columns.

Source

pub fn begin_table_header<Name: AsRef<str>, const N: usize>( &self, str_id: impl AsRef<str>, column_data: [TableColumnSetup<Name>; N], ) -> Option<TableToken<'_>>

Begins a table with no flags and with standard sizing contraints.

Takes an array of table header information, the length of which determines how many columns will be created.

Source

pub fn begin_table_header_with_flags<Name: AsRef<str>, const N: usize>( &self, str_id: impl AsRef<str>, column_data: [TableColumnSetup<Name>; N], flags: TableFlags, ) -> Option<TableToken<'_>>

Begins a table with flags and standard sizing contraints.

Takes an array of table header information, the length of which determines how many columns will be created.

Source

pub fn begin_table_header_with_sizing<Name: AsRef<str>, const N: usize>( &self, str_id: impl AsRef<str>, column_data: [TableColumnSetup<Name>; N], flags: TableFlags, outer_size: [f32; 2], inner_width: f32, ) -> Option<TableToken<'_>>

Begins a table with all flags and sizing contraints. This is the base method, and gives users the most flexibility. Takes an array of table header information, the length of which determines how many columns will be created.

Source

pub fn table_next_row(&self)

Moves a table to the next row (ie, down) with no flags, and with the next row having a standard computed height.

If your table was made with begin_table, this must be called before rendering any cells (along with table_next_column). If your table was made with begin_table_header, this does not need to be called, though table_next_column still should be.

Source

pub fn table_next_row_with_flags(&self, flags: TableRowFlags)

Moves a table to the next row (ie, down), with the given flags, and with the next row having a standard computed height.

Setting a flag here will make the next row a “header” now, which may require setup of column data.

See table_next_row for information on how moving rows work. To set the row with a given height, see table_next_row_with_height.

Source

pub fn table_next_row_with_height( &self, flags: TableRowFlags, min_row_height: f32, )

Moves a table to the next row (ie, down), with the given flags, and with the given minimum height.

See table_next_row for information on how moving rows work.

Source

pub fn table_next_column(&self) -> bool

Moves onto the next column. If at column_count, this will move to the next row. In this way, you can use this function as an iterator over each cell in the table.

§Example

if let Some(_t) = ui.begin_table("Basic-Table", 2) {
    // we have to call next_row because we didn't make headers..
    ui.table_next_row();

    // you always have to call this to start...
    // take advantage of this in loops!
    ui.table_next_column();
    ui.text("x: 0, y: 0");

    ui.table_next_column();
    ui.text("x: 1, y: 0");
     
    // notice that we go down a row here too.
    ui.table_next_column();
    ui.text("x: 0, y: 1");

    ui.table_next_column();
    ui.text("x: 1, y: 1");
}

This functions returns true if the given column is visible. It is not marked as must use, as you can still render commands into the not-visible column, though you can choose to not as an optimization.

Source

pub fn table_set_column_index(&self, column_index: usize) -> bool

Moves onto the given column.

§Example

if let Some(_t) = ui.begin_table("Basic-Table", 2) {
    // we have to call next_row because we didn't make headers..
    ui.table_next_row();

    for i in 0..2 {
        ui.table_set_column_index(i);
        ui.text(format!("x: {}", i));
    }
     
    // oops I just remembered, i need to add something on idx 0!
    ui.table_set_column_index(0);
    // if i uncomment this line, we'll write on top of our previous "x: 0"
    // line:
    // ui.text("hello from the future on top of the past");
    // so we do a .newline();
    ui.new_line();
    ui.text("hello from the future");

    // imgui will understand this and row spacing will be adjusted automatically.
}

This functions returns true if the given column is visible. It is not marked as must use, as you can still render commands into the not-visible column, though you can choose to not as an optimization.

§Panics

If column_index >= ui.table_columm_count, this function will panic. In debug releases, we will panic on the Rust side, for a nicer error message, though in release, we will panic in C++, which will result in an ugly stack overflow.

Source

pub fn table_setup_column(&self, str_id: impl AsRef<str>)

Specify label per column, with no flags and default sizing. You can avoid calling this method entirely by using begin_table_header.

§Example

if let Some(_t) = ui.begin_table("My Table", 2) {
    ui.table_setup_column("One");
    ui.table_setup_column("Two");
    ui.table_setup_column("Three");
    ui.table_headers_row();

    // call next_column/set_column_index and proceed like normal.
    // the above code is the equivalent of just using `begin_table_header`
    // but does allow for some columns to have headers and others to not
}

Along with table_headers_row, this method is used to create a header row and automatically submit a table header for each column. Headers are required to perform: reordering, sorting, and opening the context menu (though, the context menu can also be made available in columns body using TableFlags::CONTEXT_MENU_IN_BODY.

Source

pub fn table_setup_column_with<N: AsRef<str>>(&self, data: TableColumnSetup<N>)

Specify label per column, with data given in TableColumnSetup. You can avoid calling this method entirely by using begin_table_header.

See table_setup_column for an example of how to setup columns yourself.

Along with table_headers_row, this method is used to create a header row and automatically submit a table header for each column. Headers are required to perform: reordering, sorting, and opening the context menu (though, the context menu can also be made available in columns body using TableFlags::CONTEXT_MENU_IN_BODY.

Source

pub fn table_setup_scroll_freeze( &self, locked_columns: usize, locked_rows: usize, )

Locks columns/rows so they stay visible when scrolled. Generally, you will be calling this so that the header column is always visible (though go wild if you want). You can avoid calling this entirely by passing true to begin_table_header.

§Example

const COLUMN_COUNT: usize = 3;
if let Some(_t) = ui.begin_table("scroll-freeze-example", COLUMN_COUNT) {
    // locks the header row. Notice how we need to call it BEFORE `table_headers_row`.
    ui.table_setup_scroll_freeze(1, COLUMN_COUNT);
    ui.table_setup_column("One");
    ui.table_setup_column("Two");
    ui.table_setup_column("Three");
    ui.table_headers_row();
}

Nb: we take locked_columns and locked_rows as a usize, but it will be converted with as i32 to an i32. If this makes a difference to you, you are probably trying to make too many columns.

Source

pub fn table_headers_row(&self)

Along with table_setup_column, this method is used to create a header row and automatically submit a table header for each column.

For an example of using this method, see table_setup_column.

Headers are required to perform: reordering, sorting, and opening the context menu (though, the context menu can also be made available in columns body using TableFlags::CONTEXT_MENU_IN_BODY.

You may manually submit headers using table_next_column + table_header calls, but this is only useful in some advanced use cases (e.g. adding custom widgets in header row). See table_header for more information.

Source

pub fn table_header(&self, label: impl AsRef<str>)

Use this function to manually declare a column cell to be a header.

You generally should avoid using this outside of specific cases, such as custom widgets. Instead, use table_headers_row and table_setup_column.

Source

pub fn table_column_count(&self) -> usize

Gets the numbers of columns in the current table.

Source

pub fn table_column_index(&self) -> usize

Gets the current column index in the current table.

Source

pub fn table_row_index(&self) -> usize

Gets the current row index in the current table.

Source

pub fn table_column_name(&mut self) -> &str

Gets the name of the current column. If there is no currently bound name for this column, we will return an empty string.

Use table_column_name_with_column for arbitrary indices.

Source

pub fn table_column_name_with_column(&mut self, column: usize) -> &str

Gets the name of a given column. If there is no currently bound name for this column, we will return an empty string.

Use table_column_name for the current column.

Source

pub fn table_column_flags(&self) -> TableColumnFlags

Gets the flags on the current column in the current table.

Source

pub fn table_column_flags_with_column( &self, column_n: usize, ) -> TableColumnFlags

Gets the flags on the given column in the current table. To get the current column’s flags without having to call table_column_index, use table_column_flags.

Source

pub fn table_set_bg_color( &self, target: TableBgTarget, color: impl Into<ImColor32>, )

Sets the given background color for this column. See TableBgTarget for more information on how colors work for tables.

Use table_set_bg_color_with_column to set for arbitrary indices.

Source

pub fn table_set_bg_color_with_column( &self, target: TableBgTarget, color: impl Into<ImColor32>, column_index: usize, )

Sets the given background color for any column. See TableBgTarget for more information on how colors work for tables.

Use table_set_bg_color for the current column.

Source

pub fn table_set_enabled(&self, enabled: bool)

Change user accessible enabled/disabled state of the current column.

Set to false to hide the column. Users can use the context menu to change this themselves by right-clicking in headers, or right-clicking in columns body if TableFlags::CONTEXT_MENU_IN_BODY.

Use table_set_enabled_with_column to set for arbitrary indices.

Source

pub fn table_set_enabled_with_column(&self, enabled: bool, column_idx: usize)

Change user accessible enabled/disabled state of the current column.

Set to false to hide the column. Users can use the context menu to change this themselves by right-clicking in headers, or right-clicking in columns body if TableFlags::CONTEXT_MENU_IN_BODY.

Source

pub fn table_sort_specs_mut(&self) -> Option<TableSortSpecsMut<'_>>

Gets the sorting data for a table. This will be None when not sorting.

See the examples folder for how to use the sorting API.

Source §

impl Ui

Source

pub fn text_filter(label: String) -> TextFilter

Source

pub fn text_filter_with_filter(label: String, filter: String) -> TextFilter

Source §

impl Ui

§Item/widget utilities

Source

pub fn is_item_hovered(&self) -> bool

Returns true if the last item is hovered

Source

pub fn is_item_hovered_with_flags(&self, flags: ItemHoveredFlags) -> bool

Returns true if the last item is hovered based on the given flags

Source

pub fn is_item_active(&self) -> bool

Returns true if the last item is active

Source

pub fn is_item_focused(&self) -> bool

Returns true if the last item is focused for keyboard/gamepad navigation

Source

pub fn is_item_clicked(&self) -> bool

Returns true if the last item is being clicked by MouseButton::Left.

This is the same as is_item_clicked_with_button with button set to MouseButton::Left.

Source

pub fn is_item_clicked_with_button(&self, button: MouseButton) -> bool

Returns true if the last item is being clicked

Source

pub fn is_item_visible(&self) -> bool

Returns true if the last item is visible

Source

pub fn is_item_edited(&self) -> bool

Returns true if the last item modified its underlying value this frame or was pressed

Source

pub fn is_item_activated(&self) -> bool

Returns true if the last item was just made active

Source

pub fn is_item_deactivated(&self) -> bool

Returns true if the last item was just made inactive

Source

pub fn is_item_deactivated_after_edit(&self) -> bool

Returns true if the last item was just made inactive and made a value change when it was active

Source

pub fn is_item_toggled_open(&self) -> bool

Returns true if the last item open state was toggled

Source

pub fn is_any_item_hovered(&self) -> bool

Returns true if any item is hovered

Source

pub fn is_any_item_active(&self) -> bool

Returns true if any item is active

Source

pub fn is_any_item_focused(&self) -> bool

Returns true if any item is focused

Source

pub fn item_rect_min(&self) -> [f32; 2]

Returns the upper-left bounding rectangle of the last item (in screen coordinates)

Source

pub fn item_rect_max(&self) -> [f32; 2]

Returns the lower-right bounding rectangle of the last item (in screen coordinates)

Source

pub fn item_rect_size(&self) -> [f32; 2]

Returns the size of the last item

Source

pub fn set_item_allow_overlap(&self)

Allows the last item to be overlapped by a subsequent item.

Both may be activated during the same frame before the later one takes priority.

Source

pub fn set_item_default_focus(&self)

Makes the last item the default focused item of the window

Source §

impl Ui

§Miscellaneous utilities

Source

pub fn is_cursor_rect_visible(&self, size: impl Into<Vector2<f32>>) -> bool

Returns true if the rectangle (of given size, starting from cursor position) is visible

Source

pub fn is_rect_visible( &self, rect_min: impl Into<Vector2<f32>>, rect_max: impl Into<Vector2<f32>>, ) -> bool

Returns true if the rectangle (in screen coordinates) is visible

Source

pub fn time(&self) -> f64

Returns the global imgui-rs time.

Incremented by Io::delta_time every frame.

Source

pub fn frame_count(&self) -> i32

Returns the global imgui-rs frame count.

Incremented by 1 every frame.

Source

pub fn style_color(&self, style_color: StyleColor) -> [f32; 4]

Returns a single style color from the user interface style.

Use this function if you need to access the colors, but don’t want to clone the entire style object.

Source

pub fn style_color_name(&self, style_color: StyleColor) -> &'static str

Gets the name of some style color.

This is just a wrapper around calling name on StyleColor.

Source

pub unsafe fn style(&self) -> &Style

Returns a shared reference to the current Style.

§Safety

This function is tagged as unsafe because pushing via push_style_color or push_style_var or popping via ColorStackToken::pop or StyleStackToken::pop will modify the values in the returned shared reference. Therefore, you should not retain this reference across calls to push and pop. The clone_style version may instead be used to avoid unsafe.

Source §

impl Ui

Source

pub fn color_edit3<Label, C>(&self, label: Label, value: &mut C) -> bool
where Label: AsRef<str>, C: Copy + Into<Vector3<f32>>, Vector3<f32>: Into<C> + Into<[f32; 3]>,

Edits a color of 3 channels. Use color_edit3_config for a builder to customize this widget.

Source

pub fn color_edit3_config<'a, Label, C>( &self, label: Label, value: &'a mut C, ) -> ColorEdit3<'_, 'a, Label, C>
where Label: AsRef<str>, C: Copy + Into<Vector3<f32>>, Vector3<f32>: Into<C> + Into<[f32; 3]>,

Constructs a new color editor builder.

Source §

impl Ui

Source

pub fn color_edit4<Label, C>(&self, label: Label, value: &mut C) -> bool
where Label: AsRef<str>, C: Copy + Into<Vector4<f32>>, Vector4<f32>: Into<C> + Into<[f32; 4]>,

Edits a color of 4 channels. Use color_edit4_config for a builder to customize this widget.

Source

pub fn color_edit4_config<'a, Label, C>( &self, label: Label, value: &'a mut C, ) -> ColorEdit4<'_, 'a, Label, C>
where Label: AsRef<str>, C: Copy + Into<Vector4<f32>>, Vector4<f32>: Into<C> + Into<[f32; 4]>,

Constructs a new color editor builder.

Source §

impl Ui

Source

pub fn color_picker3<Label, C>(&self, label: Label, value: &mut C) -> bool
where Label: AsRef<str>, C: Copy + Into<Vector3<f32>>, Vector3<f32>: Into<C> + Into<[f32; 3]>,

Edits a color of 3 channels. Use color_picker3 for a builder to customize this widget.

Source

pub fn color_picker3_config<'a, Label, C>( &self, label: Label, value: &'a mut C, ) -> ColorPicker3<'_, 'a, Label, C>
where Label: AsRef<str>, C: Copy + Into<Vector3<f32>>, Vector3<f32>: Into<C> + Into<[f32; 3]>,

Constructs a new color picker editor builder.

Source §

impl Ui

Source

pub fn color_picker4<Label, C>(&self, label: Label, value: &mut C) -> bool
where Label: AsRef<str>, C: Copy + Into<Vector4<f32>>, Vector4<f32>: Into<C> + Into<[f32; 4]>,

Edits a color of 4 channels. Use color_picker4_config for a builder to customize this widget.

Source

pub fn color_picker4_config<'a, Label, C>( &self, label: Label, value: &'a mut C, ) -> ColorPicker4<'_, 'a, Label, C>
where Label: AsRef<str>, C: Copy + Into<Vector4<f32>>, Vector4<f32>: Into<C> + Into<[f32; 4]>,

Constructs a new color picker editor builder.

Source §

impl Ui

Source

pub fn color_button<Label: AsRef<str>>( &self, desc_id: Label, color: impl Into<Vector4<f32>>, ) -> bool

Builds a ColorButton.

Returns true if this color button was clicked.

Source

pub fn color_button_config<Label: AsRef<str>>( &self, desc_id: Label, color: impl Into<Vector4<f32>>, ) -> ColorButton<'_, Label>

Returns a ColorButton builder.

Source §

impl Ui

§Widgets: Color Editor/Picker

Source

pub fn set_color_edit_options(&self, flags: ColorEditFlags)

Initializes current color editor/picker options (generally on application startup) if you want to select a default format, picker type, etc. Users will be able to change many settings, unless you use .options(false) in your widget builders.

Source §

impl Ui

§Convenience functions

Source

pub fn begin_combo( &self, label: impl AsRef<str>, preview_value: impl AsRef<str>, ) -> Option<ComboBoxToken<'_>>

Begins flexibly creating a combo box.

You provide a preview string, which is displayed on the widget before it is opened. If the function returns Some(_token) you can then begin creating the widgets inside the combo popup area.

A standard looking combo is made by using selectable items, however you can create almost anything inside if desired (for example using Ui::separator and Ui::text to create sections with headings).

See the simpler Ui::combo_simple_string if you have a list of strings plus a “currently selected item index”, or Ui::combo

If you do not want to provide a preview, use begin_combo_no_preview. If you want to pass flags, use begin_combo_with_flags.

Returns None if the combo box is not open and no content should be rendered.

§Example


let items = vec!["Example 1", "Example 2"];
let mut selected = &items[0];
if let Some(cb) = ui.begin_combo("example_combo", format!("Selected item: {}", selected)) {
    for cur in &items {
        if selected == cur {
            // Auto-scroll to selected item
            ui.set_item_default_focus();
        }
        // Create a "selectable"
        let clicked = ui.selectable_config(cur)
            .selected(selected == cur)
            .build();
        // When item is clicked, store it
        if clicked {
            selected = cur;
        }
    }
}

Source

pub fn begin_combo_with_flags( &self, label: impl AsRef<str>, preview_value: impl AsRef<str>, flags: ComboBoxFlags, ) -> Option<ComboBoxToken<'_>>

Creates a combo box which can be appended to with Selectable::new.

If you do not want to provide a preview, use begin_combo_no_preview. Returns Some(ComboBoxToken) if the combo box is open. After content has been rendered, the token must be ended by calling .end().

Returns None if the combo box is not open and no content should be rendered.

Source

pub fn begin_combo_no_preview( &self, label: impl AsRef<str>, ) -> Option<ComboBoxToken<'_>>

Creates a combo box which can be appended to with Selectable::new.

If you want to provide a preview, use begin_combo. If you want to pass flags, use begin_combo_no_preview_with_flags.

Returns Some(ComboBoxToken) if the combo box is open. After content has been rendered, the token must be ended by calling .end().

Returns None if the combo box is not open and no content should be rendered.

Source

pub fn begin_combo_no_preview_with_flags( &self, label: impl AsRef<str>, flags: ComboBoxFlags, ) -> Option<ComboBoxToken<'_>>

Creates a combo box which can be appended to with Selectable::new.

If you do not want to provide a preview, use begin_combo_no_preview. Returns Some(ComboBoxToken) if the combo box is open. After content has been rendered, the token must be ended by calling .end().

Returns None if the combo box is not open and no content should be rendered.

Source

pub fn combo<V, L>( &self, label: impl AsRef<str>, current_item: &mut usize, items: &[V], label_fn: L, ) -> bool
where for<'b> L: Fn(&'b V) -> Cow<'b, str>,

Builds a simple combo box for choosing from a slice of values.

See Ui::begin_combo for a more “immediate mode” style API for creating dynamic combo boxes

Source

pub fn combo_simple_string( &self, label: impl AsRef<str>, current_item: &mut usize, items: &[impl AsRef<str>], ) -> bool

Builds a simple combo box for choosing from a slice of strings

This is useful if you already have a list of strings to choose from, along with a currently selected idnex value. In cases where you have a list of non-string objects, instead of allocating a Vec<String> to use this method try using Ui::begin_combo instead

Source §

impl Ui

Source

pub fn image_button( &self, str_id: impl AsRef<str>, texture_id: TextureId, size: impl Into<Vector2<f32>>, ) -> bool

Source

pub fn image_button_config<IdStr: AsRef<str>>( &self, str_id: IdStr, texture_id: TextureId, size: impl Into<Vector2<f32>>, ) -> ImageButton<'_, IdStr>

Source §

impl Ui

§Widgets: Menus

Source

pub fn begin_main_menu_bar(&self) -> Option<MainMenuBarToken<'_>>

Creates and starts appending to a full-screen menu bar.

Returns Some(MainMenuBarToken) if the menu bar is visible. After content has been rendered, the token must be ended by calling .end().

Returns None if the menu bar is not visible and no content should be rendered.

Source

pub fn main_menu_bar<F: FnOnce()>(&self, f: F)

Creates a full-screen main menu bar and runs a closure to construct the contents.

Note: the closure is not called if the menu bar is not visible.

Source

pub fn begin_menu_bar(&self) -> Option<MenuBarToken<'_>>

Creates and starts appending to the menu bar of the current window.

Returns Some(MenuBarToken) if the menu bar is visible. After content has been rendered, the token must be ended by calling .end().

Returns None if the menu bar is not visible and no content should be rendered.

Source

pub fn menu_bar<F: FnOnce()>(&self, f: F)

Creates a menu bar in the current window and runs a closure to construct the contents.

Note: the closure is not called if the menu bar is not visible.

Source

pub fn begin_menu(&self, label: impl AsRef<str>) -> Option<MenuToken<'_>>

Creates and starts appending to a sub-menu entry.

Returns Some(MenuToken) if the menu is visible. After content has been rendered, the token must be ended by calling .end().

Returns None if the menu is not visible and no content should be rendered.

This is the equivalent of begin_menu_with_enabled with enabled set to true.

Source

pub fn begin_menu_with_enabled( &self, label: impl AsRef<str>, enabled: bool, ) -> Option<MenuToken<'_>>

Creates and starts appending to a sub-menu entry.

Returns Some(MenuToken) if the menu is visible. After content has been rendered, the token must be ended by calling .end().

Returns None if the menu is not visible and no content should be rendered.

Creates a menu and runs a closure to construct the contents.

Note: the closure is not called if the menu is not visible.

This is the equivalent of menu_with_enabled with enabled set to true.

Source

pub fn menu_with_enabled<F: FnOnce()>( &self, label: impl AsRef<str>, enabled: bool, f: F, )

Creates a menu and runs a closure to construct the contents.

Note: the closure is not called if the menu is not visible.

Source

pub fn menu_item(&self, label: impl AsRef<str>) -> bool

Creates a menu item with the given label, returning true if it was pressed.

If you want to configure this menu_item by setting selection, or enablement, use menu_item_config.

Note: a menu_item is the actual button/selectable within a Menu.

Source

pub fn menu_item_config<L: AsRef<str>>(&self, label: L) -> MenuItem<'_, L>

Creates a menu item builder, with further methods on it as needed. Use menu_item for simple Menu Items with no features on them.

Note: a menu_item is the actual button/selectable within a Menu.

Source §

impl Ui