Struct Ui

Source

pub struct Ui { /* private fields */ }

Expand description

Represents the Dear ImGui user interface for one frame

Implementations§

Source §

impl Ui

Docking-related functionality

Source

pub fn dockspace(&self) -> DockspaceBuilder<'_, 'static>

Configure and submit a dockspace through the canonical builder.

Source

pub fn dock_space_over_main_viewport_raw( &self, dockspace_id: Id, flags: DockNodeFlags, ) -> Id

Submit Dear ImGui’s low-level dockspace-over-viewport operation for the main viewport.

This creates Dear ImGui’s hidden main-viewport host window, applies the viewport work rectangle and platform ownership, and submits a dockspace within that host. Submit it before every window that can be hosted by this dockspace. A KEEP_ALIVE_ONLY submission may be made later because it does not create a visible host. Without an earlier submission, Dear ImGui may already undock a window when that window is begun, before this method can diagnose the ordering error.

§Parameters

dockspace_id - The ID for the dockspace (use 0 to auto-generate)
flags - Dock node flags

§Returns

The ID of the created dockspace

§Panics

Panics when docking was not enabled before the first frame, when the effective dockspace ID names a child of another dock tree, when the dockspace was already submitted without KEEP_ALIVE_ONLY during this frame, or when a hosted window was submitted before a visible dockspace submission while that window is still attached. KEEP_ALIVE_ONLY remains valid after hosted windows.

§Example

let dockspace_id = ui.dock_space_over_main_viewport_raw(
    0.into(),
    DockNodeFlags::PASSTHRU_CENTRAL_NODE
);

Source

pub fn dock_space_raw( &self, id: Id, size: [f32; 2], flags: DockNodeFlags, window_class: Option<&WindowClass>, ) -> Id

Submit Dear ImGui’s low-level dockspace operation in the current window.

Submit it before every window that can be hosted by this dockspace. A KEEP_ALIVE_ONLY submission may be made later because it does not create a visible host. Without an earlier submission, Dear ImGui may already undock a window when that window is begun, before this method can diagnose the ordering error.

§Parameters

id - The non-zero ID for the dockspace. Use Ui::get_id to create one.
size - The size of the dockspace in pixels
flags - Dock node flags
window_class - Optional window class for docking configuration

§Returns

The ID of the created dockspace

§Panics

Panics when docking was not enabled before the first frame, when id names a child of another dock tree, when id was already submitted without KEEP_ALIVE_ONLY during this frame, or when a hosted window was submitted before a visible dockspace submission while that window is still attached. KEEP_ALIVE_ONLY remains valid after hosted windows.

§Example

let dockspace_id = ui.get_id("MyDockspace");
let dockspace_id = ui.dock_space_raw(
    dockspace_id,
    [800.0, 600.0],
    DockNodeFlags::NO_DOCKING_SPLIT,
    Some(&WindowClass::new(Id::from(1u32)))
);

Source

pub fn set_next_window_dock_id_with_cond(&self, dock_id: Id, cond: Condition)

Sets the dock ID for the next window with condition

This function must be called before creating a window to dock it to a specific dock node.

§Panics

Panics when docking was not enabled before the first frame.

§Parameters

dock_id - The ID of the dock node to dock the next window to
cond - Condition for when to apply the docking

§Example

let dockspace_id = ui.dockspace().build()?;
ui.set_next_window_dock_id_with_cond(dockspace_id, Condition::FirstUseEver);
ui.window("Docked Window").build(|| {
    ui.text("This window will be docked!");
});

Source

pub fn set_next_window_dock_id(&self, dock_id: Id)

Sets the dock ID for the next window

This function must be called before creating a window to dock it to a specific dock node. Uses Condition::Always by default.

§Panics

Panics when docking was not enabled before the first frame.

§Parameters

dock_id - The ID of the dock node to dock the next window to

§Example

let dockspace_id = ui.dockspace().build()?;
ui.set_next_window_dock_id(dockspace_id);
ui.window("Docked Window").build(|| {
    ui.text("This window will be docked!");
});

Source

pub fn set_next_window_class(&self, window_class: &WindowClass)

Sets the window class for the next window

This function must be called before creating a window to apply the window class configuration.

§Parameters

window_class - The window class configuration

§Example

let window_class = WindowClass::new(Id::from(1u32)).docking_always_tab_bar(true);
ui.set_next_window_class(&window_class);
ui.window("Classed Window").build(|| {
    ui.text("This window has a custom class!");
});

Source

pub fn get_window_dock_id(&self) -> Id

Gets the dock ID of the current window

§Returns

The dock ID of the current window, or 0 if the window is not docked

§Example

ui.window("My Window").build(|| {
    let dock_id = ui.get_window_dock_id();
    if dock_id != 0.into() {
        ui.text(format!("This window is docked with ID: {}", dock_id.raw()));
    } else {
        ui.text("This window is not docked");
    }
});

Source

pub fn is_window_docked(&self) -> bool

Checks if the current window is docked

§Returns

true if the current window is docked, false otherwise

§Example

ui.window("My Window").build(|| {
    if ui.is_window_docked() {
        ui.text("This window is docked!");
    } else {
        ui.text("This window is floating");
    }
});

Source §

impl Ui

Source

pub fn custom_rect(&self, id: CustomRectId) -> Option<CustomRectSnapshot<'_>>

Query a custom rectangle for immediate use in the current frame.

Source

pub fn image_custom_rect(&self, id: CustomRectId, size: [f32; 2]) -> bool

Draw a custom rectangle using its latest texture reference and UVs.

Returns false if the rectangle has been removed.

Source §

impl Ui

Source

pub fn font_atlas_texture(&self) -> Option<FontAtlasTexture<'_>>

Lease the current Context’s font-atlas texture for immediate image submission.

Source §

impl Ui

Source

pub fn current_baked_font(&self) -> BakedFont<'_>

Return baked data for the currently bound font, size, and rasterizer density.

let baked = {
    let mut ctx = Context::create();
    let ui = ctx.frame();
    ui.current_baked_font()
};
baked.size();

Source

pub fn baked_font(&self, font: FontId, size: f32) -> Option<BakedFont<'_>>

Return baked data for a font at the requested size and its current rasterizer density.

Returns None for a legacy renderer while the atlas is locked, because creating an arbitrary baked size during that frame is unsupported by Dear ImGui.

Source

pub fn baked_font_with_density( &self, font: FontId, size: f32, density: f32, ) -> Option<BakedFont<'_>>

Return baked data for a font at an explicit size and rasterizer density.

Returns None for a legacy renderer while the atlas is locked.

Source §

impl Ui

§Fonts

Source

pub fn current_font(&self) -> FontId

Return the persistent, atlas-validated ID of the current font.

Source

pub fn current_font_size(&self) -> f32

Returns the current font size (= height in pixels) with font scale applied

Source

pub fn push_font_with_size( &self, font: Option<FontId>, size: f32, ) -> FontStackToken<'_>

Push a font with dynamic size support (v1.92+ feature).

This allows changing font size at runtime without pre-loading different sizes. Pass None to keep the current font. A size of 0.0 keeps the current size, so push_font_with_size(Some(font), 0.0) changes only the font. A non-zero size is the base size before Dear ImGui applies global and DPI font scaling; Ui::current_font_size already includes those scales.

Returns a FontStackToken that pops the font stack when dropped or when crate::FontStackToken::pop is called.

Source

pub fn with_font_and_size<F, R>( &self, font: Option<FontId>, size: f32, f: F, ) -> R
where F: FnOnce() -> R,

Execute a closure with a specific font and size (v1.92+ dynamic fonts)

Source

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

Returns the UV coordinate for a white pixel.

Useful for drawing custom shapes with the draw list API.

Source

pub fn set_window_font_scale(&self, scale: f32)

Sets the legacy per-window font scale of the current window.

Prefer Ui::push_font_with_size or style.FontScaleMain for new code.

Source §

Check if a mouse button was double-clicked

Source

pub fn is_mouse_pos_valid(&self) -> bool

Returns true if the mouse position is valid (not NaN).

impl Ui

Source

pub fn with_current_state_storage<R>( &self, f: impl for<'storage> FnOnce(StateStorage<'storage>) -> R, ) -> R

Accesses the current window’s state storage inside a non-escaping closure.

The storage view cannot outlive this call. The owning context remains current for the duration of f, including nested calls into other contexts.

Source

pub fn with_state_storage<R>( &self, storage: &mut OwnedStateStorage, f: impl for<'storage> FnOnce(StateStorage<'storage>) -> R, ) -> R

Overrides the current state storage while f runs.

The owning context remains current throughout the call. Nested overrides restore in LIFO order, and restoration also runs if f panics. The replacement storage and its scoped view cannot escape the closure.

use dear_imgui_rs::{Context, OwnedStateStorage, StateStorage};

let mut context = Context::create();
let ui = context.frame();
let mut replacement = OwnedStateStorage::new();
let escaped: StateStorage<'_> =
    ui.with_state_storage(&mut replacement, |storage| storage);

Source

pub fn set_next_item_storage_id(&self, storage_id: Id)

Set the storage ID for the next item.

Source §

impl Ui

Source

pub fn binding(&self) -> ContextBinding

Returns a persistent capability for the Context that owns this Ui.

Source

pub fn context_id(&self) -> ContextId

Returns the process-unique identity of the Context that owns this Ui.

Source

pub fn with_bound_context<R>(&self, f: impl FnOnce() -> R) -> R

Runs a closure while this Ui’s owning ImGui context is current.

The previously current context is restored before this method returns, including when the closure panics. This is primarily intended for extension crates that need to call raw Dear ImGui-adjacent FFI while still honoring the Ui that created the safe wrapper.

Source

pub fn io(&self) -> &Io

Returns an immutable reference to the inputs/outputs object

Source

pub fn get_id(&self, label: &str) -> Id

Returns an ID from a string label in the current ID scope.

Renders the exact upstream metrics/debug window, including its font-atlas tree.

§Safety

The upstream Fonts tree can mutate or destroy font-atlas data while Rust font handles and renderer state are live. The caller must uphold the native font-atlas contract.

Source

pub unsafe fn show_font_atlas_debug_panel(&self)

Renders upstream’s internal Font Atlas debug panel for this context.

This is the isolated font-specific part omitted from the safe demo, metrics, and style editor APIs.

§Safety

The panel exposes destructive atlas operations and may continue using native font pointers after a control mutates the atlas. The caller must uphold the native font-atlas contract.

Source

Renders a table that breaks text down into UTF-8 bytes and codepoints.

This is intended for diagnosing text encoding and missing-glyph issues.

§Panics

Panics if text contains an interior NUL byte, which the upstream NUL-terminated API cannot represent.

Source

pub fn debug_flash_style_color(&self, color: StyleColor)

Temporarily flashes a style color in Dear ImGui’s debug tools.

Source

pub fn debug_start_item_picker(&self)

Starts Dear ImGui’s interactive item picker debug tool.

Source

pub fn get_version(&self) -> &str

Returns the Dear ImGui version string

Source §

impl Ui

Source

pub fn get_window_draw_list(&self) -> DrawListMut<'_>

Access to the current window’s draw list

Source

pub fn get_background_draw_list(&self) -> DrawListMut<'_>

Access to the background draw list

Source

pub fn get_foreground_draw_list(&self) -> DrawListMut<'_>

Access to the foreground draw list

Shows or hides the navigation cursor (a small marker indicating nav focus).

Renders the exact upstream style editor for the given Style structure.

Returns a copy of the current style.

pub fn window_viewport(&self) -> &Viewport

Returns the viewport of the current window.

This requires a current window (i.e. must be called between Begin/End).

Source

pub fn find_viewport_by_id(&self, viewport_id: Id) -> Option<&Viewport>

Find a viewport by ID.

Source

pub fn find_viewport_by_platform_handle( &self, platform_handle: *mut c_void, ) -> Option<&Viewport>

Find a viewport by its platform handle.

The platform handle type depends on the backend (e.g. HWND on Windows).

Source §

impl Ui

Source

pub fn text<T>(&self, text: T)
where T: AsRef<str>,

Display text

Source

pub fn image_with_bg<'tex>( &self, texture: impl Into<TextureRef<'tex>>, size: [f32; 2], bg_color: [f32; 4], tint_color: [f32; 4], )

Convenience: draw an image with background and tint (ImGui 1.92+)

pub fn set_next_item_open_with_cond(&self, is_open: bool, cond: Condition)

Set next item to be open by default with condition.

Source

pub fn set_next_item_width(&self, item_width: f32)

Set next item width.

Set to 0.0 for default width, >0.0 for explicit width, <0.0 for relative width.

Source

pub fn value_bool(&self, prefix: impl AsRef<str>, v: bool)

Display a text label with a boolean value (for quick debug UIs).

Source §

impl Ui

Source

pub fn window<'ui>(&'ui self, name: impl Into<WindowLabel<'ui>>) -> Window<'ui>

Creates a window builder

Source

pub fn set_window_focus(&self, name: Option<&str>)

Focus a window by name, or clear focus from all windows.

Source

pub fn time(&self) -> f64

Get global imgui time. Incremented by io.DeltaTime every frame.

Source

pub fn frame_count(&self) -> usize

Get global imgui frame count. Incremented by 1 every frame.

Source

pub fn calc_item_width(&self) -> f32

Returns the width of an item based on the current layout state.

Source §

pub fn item_clicked_count_with_single_click_delay(&self) -> usize

Returns a delayed single-click count, or an immediate count for repeated clicks.

This uses the left mouse button and Io::mouse_single_click_delay.

Source

pub fn item_clicked_count_with_single_click_delay_for( &self, button: MouseButton, ) -> usize

Returns a delayed single-click count for button, or an immediate count for repeated clicks.

Source

pub fn item_clicked_count_with_delay( &self, button: MouseButton, delay: f32, ) -> usize

Returns a delayed single-click count using an explicit delay.

Dear ImGui clamps the delay to remain longer than the configured double-click time.

Source

pub fn is_item_toggled_open(&self) -> bool

Returns true if the last item open state was toggled

Source

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

pub fn log_buttons(&self)

Show ImGui’s logging buttons (TTY/File/Clipboard).

Source

pub fn log_finish(&self)

Finish logging (close file / copy to clipboard as needed).

Returns an ImGui-packed ABGR color (ImU32) from a style color, with alpha multiplier.

Source

pub fn get_color_u32_from_rgba(&self, rgba: [f32; 4]) -> u32

Returns an ImGui-packed ABGR color (ImU32) from an RGBA float color.

Note: Dear ImGui applies the global style alpha when converting colors for rendering.

Source

pub fn get_color_u32_from_packed(&self, abgr: u32, alpha_mul: f32) -> u32

Returns an ImGui-packed ABGR color (ImU32) from an existing packed color, with alpha multiplier.

Source

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

Returns the name of a style color.

This queries Dear ImGui’s static name table for the provided StyleColor.

Source §

impl Ui

Source

pub fn is_rect_visible(&self, size: [f32; 2]) -> bool

Test if rectangle (of given size, starting from cursor position) is visible / not clipped.

Source

pub fn is_rect_visible_ex(&self, rect_min: [f32; 2], rect_max: [f32; 2]) -> bool

Test if rectangle (in screen space) is visible / not clipped.

Source §

Returns true if the current window is collapsed.

Source §

impl Ui

Source

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

Creates a button with the given label

Source

pub fn button_with_size( &self, label: impl AsRef<str>, size: impl Into<[f32; 2]>, ) -> bool

Creates a button with the given label and size

Source

pub fn button_config<'ui>( &'ui self, label: impl Into<Cow<'ui, str>>, ) -> Button<'ui>

Creates a button builder

Source §

impl Ui

Source

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

Creates a checkbox

Source

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

Creates a radio button

Source

pub fn radio_button_int( &self, label: impl AsRef<str>, v: &mut i32, v_button: i32, ) -> bool

Creates a radio button with integer value

Source

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

Creates a radio button suitable for choosing an arbitrary value.

Returns true if this radio button was clicked.

Source

pub fn checkbox_flags<T>( &self, label: impl AsRef<str>, flags: &mut T, mask: T, ) -> bool
where T: Copy + PartialEq + BitOrAssign + BitAndAssign + BitAnd<Output = T> + Not<Output = T>,

Renders a checkbox suitable for toggling bit flags using a mask.

Returns true if this checkbox was clicked.

§Combo Box Widgets

Source

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

Creates a combo box and starts appending to it.

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

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

Source

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

Builds a simple combo box using an i32 index (ImGui-style).

This is useful when you want to represent "no selection" with -1, matching Dear ImGui’s Combo() API.

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

Source

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

Builds a simple combo box for choosing from a slice of strings using an i32 index.

Source

pub fn set_item_default_focus(&self)

Makes the last submitted item the default focus of a newly appearing window.

Source §

Creates a drag int4 slider (4 ints)

Source §

impl Ui

§Image Widgets

Examples

Using a plain texture id:

let tex_id = texture::TextureId::new(0xDEAD_BEEF);
ui.image(tex_id, [128.0, 128.0]);

Using an ImGui-managed texture:

let tex = texture::OwnedTextureData::from_pixels(
    texture::TextureFormat::RGBA32,
    64,
    64,
    &vec![255; 64 * 64 * 4],
)?;
let tex = context.register_texture(tex);
let ui = context.frame();
ui.image(tex, [64.0, 64.0]);

Source

pub fn image<'tex>(&self, texture: impl Into<TextureRef<'tex>>, size: [f32; 2])

Creates an image widget

Source

pub fn image_button<'tex>( &self, str_id: impl AsRef<str>, texture: impl Into<TextureRef<'tex>>, size: [f32; 2], ) -> bool

Creates an image button widget

Source

pub fn image_config<'ui, 'tex>( &'ui self, texture: impl Into<TextureRef<'tex>>, size: [f32; 2], ) -> Image<'ui, 'tex>

Creates an image builder

Source

pub fn image_button_config<'ui, 'tex>( &'ui self, str_id: impl Into<Cow<'ui, str>>, texture: impl Into<TextureRef<'tex>>, size: [f32; 2], ) -> ImageButton<'ui, 'tex>

Creates an image button builder

let mut text = String::new();
if ui.input_text_multiline("Label", &mut text, [200.0, 100.0]).build() {
    println!("Text changed: {}", text);
}

Source

Source

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

Creates and starts appending to a menu bar for a 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<R>(&self, f: impl FnOnce() -> R) -> Option<R>

Creates the current window’s menu bar and runs a closure to construct its contents.

Returns None without calling f when the menu bar is not visible. The menu bar is ended before a successful closure result is returned and during unwinding if f panics.

Source

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

Creates a menu and starts appending to it.

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

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

Source

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

Creates a menu with enabled state and starts appending to it.

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

Returns None if the menu is not open 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>(&self, label: impl AsRef<str>, enabled: bool, f: F)
where F: FnOnce(),

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

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

Creates a menu item with explicit enabled/selected state. Returns true if the menu item is activated.

Source

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

Creates a menu item with explicit enabled/selected state (no shortcut).

Returns true if the menu item is activated.

Source

pub fn menu_item_enabled_selected_with_shortcut( &self, label: impl AsRef<str>, shortcut: impl AsRef<str>, selected: bool, enabled: bool, ) -> bool

Creates a menu item with explicit enabled/selected state and a shortcut.

Returns true if the menu item is activated.

Source

pub fn menu_item_toggle( &self, label: impl AsRef<str>, shortcut: Option<impl AsRef<str>>, selected: &mut bool, enabled: bool, ) -> bool

Creates a toggleable menu item bound to selected (updated in place). Returns true if the menu item is activated.

Source

pub fn menu_item_toggle_no_shortcut( &self, label: impl AsRef<str>, selected: &mut bool, enabled: bool, ) -> bool

Creates a toggleable menu item bound to selected (no shortcut).

Returns true if the menu item is activated.

Source

pub fn menu_item_toggle_with_shortcut( &self, label: impl AsRef<str>, shortcut: impl AsRef<str>, selected: &mut bool, enabled: bool, ) -> bool

Creates a toggleable menu item bound to selected with a shortcut.

Returns true if the menu item is activated.

Source §

impl Ui

Source

pub fn bullet(&self)

Creates a bullet point

pub fn with_button_repeat<R>(&self, repeat: bool, f: impl FnOnce() -> R) -> R

Push a button repeat item flag, run f, then pop the flag.

The flag is popped during unwinding if f panics.

Source §

impl Ui

Source

pub fn begin_disabled(&self) -> DisabledToken<'_>

Begin a disabled scope for subsequent items.

All following widgets will be disabled (grayed out and non-interactive) until the returned token is dropped.

Source

pub fn begin_disabled_with_cond(&self, disabled: bool) -> DisabledToken<'_>

Begin a conditionally disabled scope for subsequent items.

If disabled is false, this still needs to be paired with the returned token being dropped to correctly balance the internal stack.

Source

pub fn with_disabled<R>(&self, f: impl FnOnce() -> R) -> R

Runs f while subsequent items are disabled.

The disabled scope is ended before a successful closure result is returned and during unwinding if f panics.

Source

pub fn with_disabled_if<R>(&self, disabled: bool, f: impl FnOnce() -> R) -> R

Runs f inside a conditionally disabled scope.

Dear ImGui requires a balanced BeginDisabled/EndDisabled pair even when disabled is false. This helper preserves that balance before returning or during unwinding.

Source §

impl Ui

Source

pub fn invisible_button( &self, str_id: impl AsRef<str>, size: impl Into<[f32; 2]>, ) -> bool

Creates an invisible button

Source

pub fn invisible_button_flags( &self, str_id: impl AsRef<str>, size: impl Into<[f32; 2]>, flags: ButtonFlags, ) -> bool

Creates an invisible button with independent flags.

Use Self::invisible_button_options to choose a mouse button other than the default left button.

Source

pub fn invisible_button_options( &self, str_id: impl AsRef<str>, size: impl Into<[f32; 2]>, options: impl Into<InvisibleButtonOptions>, ) -> bool

Creates an invisible button with complete options.

Source

pub fn arrow_button(&self, str_id: impl AsRef<str>, dir: Direction) -> bool

Creates an arrow button

Source §

impl Ui

Source

pub fn set_item_key_owner(&self, key: Key) -> bool

Set the key owner for the last item, without flags.

Returns true when ownership was requested for the item.

Source

pub fn set_item_key_owner_with_flags( &self, key: Key, flags: ItemKeyOwnerFlags, ) -> bool

Set the key owner for the last item with input flags.

Returns true when ownership was requested for the item.

Source §

impl Ui

Source

pub fn with_multi_select( &self, flags: impl Into<MultiSelectOptions>, selection_size: Option<i32>, items_count: usize, render: impl FnOnce(&mut MultiSelectScope<'_>), ) -> MultiSelectResult

Run an advanced multi-select block and return an owned copy of its final requests.

The scope exposes only operations that are valid between BeginMultiSelect() and EndMultiSelect(). EndMultiSelect() runs exactly once even if render panics, and the returned MultiSelectResult contains no native pointers.

Source

pub fn multi_select_indexed<S, F>( &self, storage: &mut S, flags: impl Into<MultiSelectOptions>, render_item: F, )
where S: MultiSelectIndexStorage, F: FnMut(&Ui, usize, bool),

Multi-select helper for index-based storage.

This wraps BeginMultiSelect() / EndMultiSelect() and applies selection requests to an index-addressable selection container.

Typical usage:

let mut selected = vec![false; 128];

ui.multi_select_indexed(&mut selected, MultiSelectOptions::new(), |ui, idx, is_selected| {
    ui.text(format!(
        "{} {}",
        if is_selected { "[x]" } else { "[ ]" },
        idx
    ));
});

Notes:

storage.len() defines items_count.
This helper uses the “external storage” pattern where selection is stored entirely on the application side.
Per-item selection toggles can be queried via Ui::is_item_toggled_selection.

Source

pub fn table_multi_select_indexed<S, F>( &self, storage: &mut S, flags: impl Into<MultiSelectOptions>, build_row: F, )
where S: MultiSelectIndexStorage, F: FnMut(&Ui, usize, bool),

Multi-select helper for index-based storage inside an active table.

This is a convenience wrapper over Ui::multi_select_indexed that automatically advances table rows and starts each row at column 0.

It expects to be called between BeginTable/EndTable.

Source

pub fn multi_select_basic<G, F>( &self, selection: &mut BasicSelection, flags: impl Into<MultiSelectOptions>, items_count: usize, id_at_index: G, render_item: F, )
where G: FnMut(usize) -> Id, F: FnMut(&Ui, usize, Id, bool),

Multi-select helper using BasicSelection as underlying storage.

This variant is suitable when items are naturally identified by ImGuiID (e.g. stable ids for rows or tree nodes).

items_count: number of items in the scope.
id_at_index: maps [0, items_count) to the corresponding item id.
render_item: called once per index to emit widgets for that item.

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

Instructs ImGui that a popup is open.

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

pub fn begin_modal_popup( &self, name: impl AsRef<str>, ) -> Option<ModalPopupToken<'_>>

Creates a modal popup.

Modal popups block interaction with the rest of the application until closed.

Source

pub fn begin_modal_popup_with_opened( &self, name: impl AsRef<str>, opened: &mut bool, ) -> Option<ModalPopupToken<'_>>

Creates a modal popup with an opened-state tracking variable.

Passing opened enables the title-bar close button (X). When clicked, ImGui will set *opened = false and close the popup.

Notes:

You still need to call open_popup once to open the modal.
To pass window flags, use begin_modal_popup_config.

Source

§Progress Bar Widgets

Source

pub fn progress_bar(&self, fraction: f32) -> ProgressBar<'_>

Creates a progress bar widget.

The fraction should be between 0.0 (0%) and 1.0 (100%).

Source

pub fn progress_bar_with_overlay<'ui>( &'ui self, fraction: f32, overlay: impl Into<Cow<'ui, str>>, ) -> ProgressBar<'ui>

Creates a progress bar with overlay text.

Source §

impl Ui

Source

pub fn selectable<T>(&self, label: T) -> bool
where T: AsRef<str>,

Constructs a new simple selectable.

Use selectable_config for a builder with additional options.

Source

pub fn selectable_config<T>(&self, label: T) -> Selectable<'_, T>
where T: AsRef<str>,

Constructs a new selectable builder.

Source §

Creates a new tab item and returns a token if its contents are visible.

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 constraints.

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

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

§Panics

Panics if the array is empty, reaches Dear ImGui’s column limit, or contains invalid column setup data.

Source

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

Begins a table with flags and with standard sizing constraints.

Append into the next column, or the first column of the next row when currently in the last column.

Returns false when no table is current.

§Panics

Panics while a table draw-channel scope is active.

Source

pub fn table_set_column_index( &self, column: impl Into<TableColumnIndex>, ) -> bool

Append into the specified column.

Panics when a table is current and the requested/current column is invalid.

Source

pub fn table_set_column_enabled( &self, column: impl Into<TableColumnRef>, enabled: bool, )

Enable or disable a column by index.

§Panics

Panics outside a table, when the table lacks TableFlags::HIDEABLE, or when the requested/current column is invalid.

Source

pub fn table_get_hovered_column(&self) -> TableHoveredColumn

Return the hovered column, unused table space, or TableHoveredColumn::None when no table column is hovered.

Source

pub fn table_set_column_width( &self, column: impl Into<TableColumnIndex>, width: f32, )

Set column width for a fixed-width column.

§Panics

Panics outside a table, after table layout is locked, before layout metrics are available, for an invalid column, or when width is negative or non-finite.

Source

pub fn table_set_cell_bg_color_u32( &self, color: u32, column: impl Into<TableColumnRef>, )

Set a table background color target.

§Panics

Panics outside a table, after the first row has started, while a table draw-channel scope is active, for a non-finite/out-of-range angle, for a negative/non-finite maximum width, for an invalid column, or when headers are not ordered left-to-right without duplicates.

Source

pub fn with_table_background_channel<R>(&self, f: impl FnOnce() -> R) -> R

Run a closure while drawing into the current table’s background channel.

The channel cannot escape this closure. Row, column, nested-channel, and table-end transitions are rejected before FFI while it is active.

§Panics

Panics if there is no current table cell or another table channel is active.

Source

pub fn with_table_column_channel<R>( &self, column: impl Into<TableColumnIndex>, f: impl FnOnce() -> R, ) -> R

Run a closure while drawing into a selected table column channel.

pub fn text_wrapped(&self, text: impl AsRef<str>)

Display text wrapped to fit the current item width

This uses PushTextWrapPos + TextUnformatted + PopTextWrapPos to avoid calling C variadic APIs and to keep the input string unformatted.

Source

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

Display a label and text on the same line

Source

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

Render a hyperlink-style text button. Returns true when clicked.

Source

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

Render a hyperlink-style text button, and open the given URL when clicked. Returns true when clicked.

Source §

impl Ui

Source

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

Construct a tooltip window that can have any kind of content.

Typically used with Ui::is_item_hovered() or some other conditional check.

§Examples

ui.text("Hover over me");
if ui.is_item_hovered() {
    ui.tooltip(|| {
        ui.text_colored([1.0, 0.0, 0.0, 1.0], "I'm red!");
    });
}

Construct a tooltip window that can have any kind of content.

Returns a TooltipToken that must be ended by calling .end() or by dropping.

Source

pub fn tooltip_text(&self, text: impl AsRef<str>)

Shortcut to call Self::tooltip with simple text content.

§Examples

ui.text("Hover over me");
if ui.is_item_hovered() {
    ui.tooltip_text("I'm a tooltip!");
}

Sets a tooltip with simple text content.

This renders unformatted text (no %-style formatting) and avoids calling C variadic APIs.

Sets a tooltip with formatted text content.

Sets a tooltip for the last item with simple text content.

Returns true if the last item was edited.

Source

pub fn collapsing_header_with_visible( &self, label: impl AsRef<str>, visible: &mut bool, flags: TreeNodeFlags, ) -> bool

Creates a collapsing header widget with a visibility tracking variable.

Passing visible enables a close button on the header. When clicked, ImGui will set *visible = false. As with other immediate-mode widgets, you should stop submitting the header when *visible == false.

Source

pub fn tree_node_to_label_spacing(&self) -> f32

Returns the distance from the start of a tree node to the label text.

Source

pub fn tree_node_get_open(&self, storage_id: Id) -> bool

Returns whether the tree node identified by storage_id is open in storage.

Source §

impl Ui

Source

pub fn child_window<'ui>( &'ui self, name: impl Into<Cow<'ui, str>>, ) -> ChildWindow<'ui>

Creates a child window builder

Source

pub fn set_scroll_from_pos_y(&self, local_y: f32, center_y_ratio: f32)

Sets the vertical scroll position to center on the given position

The center_y_ratio parameter should be between 0.0 (top) and 1.0 (bottom)

Source

pub fn set_scroll_here_x(&self, center_x_ratio: f32)

Scrolls to make the current item visible

This is useful when you want to ensure a specific item is visible in a scrollable region

Source

pub fn set_scroll_here_y(&self, center_y_ratio: f32)

Scrolls to make the current item visible vertically

This is useful when you want to ensure a specific item is visible in a scrollable region

Source §

impl Ui

§Parameter stacks (shared)

Source

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

Switches to the given font at its configured reference size.

Dear ImGui 1.92 can rasterize a font at multiple sizes. This convenience method preserves the pre-1.92 behavior by using the reference size supplied when the font was added. Use Ui::push_font_with_size to preserve the current size or select another runtime size explicitly. A font without a reference size also preserves the current size.

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

§Panics

Panics before calling Dear ImGui if the FontId came from a different atlas, was invalidated by font atlas mutation, or is no longer present in the current context’s atlas.

§Examples

// At initialization time
let my_custom_font = ctx.font_atlas().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 §

impl Ui

§ID stack

Source

pub fn push_id<'a, T>(&self, id: T) -> IdStackToken<'_>
where T: Into<Id<'a>>,

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 explanation, see this part of the Dear ImGui FAQ

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


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

But sometimes we want to create widgets in a loop, or we want to avoid having to manually give each widget a unique label. In these cases, we can push an ID to the ID stack:


for i in 0..10 {
    let _id = ui.push_id(i);
    ui.button("Click");
}

Source §

impl Ui

Source

pub fn push_focus_scope(&self, id: Id) -> FocusScopeToken<'_>

Push a focus scope (affects e.g. navigation focus allocation).

Returns a FocusScopeToken which will pop the focus scope when dropped.

Source §

impl Ui

Source

pub fn item_flags(&self) -> ItemStateFlags

Returns the flags recorded for the last submitted item.

Unknown bits introduced by newer Dear ImGui versions are retained.

Source

pub fn push_item_flag( &self, flags: ItemFlags, enabled: bool, ) -> ItemFlagStackToken<'_>

Enables or disables flags for subsequently submitted items.

The returned token restores the previous item flags when dropped.

Source

pub fn with_item_flag<R>( &self, flags: ItemFlags, enabled: bool, f: impl FnOnce() -> R, ) -> R

Runs f with the requested item flags enabled or disabled.

The previous flags are restored even if f panics.

Source §

impl Ui

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

Source §

impl Ui

Source

pub fn push_style_color( &self, style_color: StyleColor, color: impl Into<[f32; 4]>, ) -> 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.

StyleVar::Alpha participates in the same restoration order as an effective disabled scope. Keep those two scopes lexically nested, or use a closure helper, so the saved alpha value is restored by the operation that owns it.

§Examples

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

Source

pub fn push_style_var_x( &self, style_var: StyleVarVec2, value: f32, ) -> StyleStackToken<'_>

Overrides the X component of a two-component style variable.

Source

pub fn push_style_var_y( &self, style_var: StyleVarVec2, value: f32, ) -> StyleStackToken<'_>

Overrides the Y component of a two-component style variable.

Source §

impl Ui

Source

pub fn push_clip_rect( &self, min: impl Into<[f32; 2]>, max: impl Into<[f32; 2]>, intersect_with_current: bool, ) -> ClipRectToken<'_>

Push a clipping rectangle in screen space.

Source

pub fn with_clip_rect<R>( &self, min: impl Into<[f32; 2]>, max: impl Into<[f32; 2]>, intersect_with_current: bool, f: impl FnOnce() -> R, ) -> R

Run a closure with a clip rect pushed and automatically popped.

Source

pub fn is_rect_visible_min_max( &self, rect_min: impl Into<[f32; 2]>, rect_max: impl Into<[f32; 2]>, ) -> bool

Returns true if the specified rectangle (min,max) is visible (not clipped).

Source

pub fn is_rect_visible_with_size(&self, size: impl Into<[f32; 2]>) -> bool

Returns true if a rectangle of given size at the current cursor pos is visible.

Source §

pub fn new_line(&self)

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

Source

Source §

impl Ui

Source

pub fn align_text_to_frame_padding(&self)

Vertically align upcoming text baseline to FramePadding.y (align text to framed items).

Source §

impl Ui

Source

pub fn drag_drop_source_config<T>(&self, name: T) -> DragDropSource<'_, T>
where T: AsRef<str>,

Creates a new drag drop source configuration

§Arguments

name - Identifier for this drag source (must match target name)

§Example

ui.button("Drag me!");
if let Some(source) = ui.drag_drop_source_config("MY_DATA")
    .flags(DragDropSourceFlags::NO_PREVIEW_TOOLTIP)
    .begin() {
    ui.text("Custom drag tooltip");
    source.end();
}

Source

pub fn drag_drop_target(&self) -> Option<DragDropTarget<'_>>

Creates a drag drop target for the last item

Returns Some(DragDropTarget) if the last item can accept drops, None otherwise.

§Example

ui.button("Drop target");
if let Some(target) = ui.drag_drop_target() {
    if target.accept_payload_empty("MY_DATA", DragDropTargetFlags::NONE).is_some() {
        println!("Received drop!");
    }
    target.pop();
}

Source

pub fn drag_drop_payload(&self) -> Option<DragDropPayload>

Returns the current drag and drop payload, if any.

This is a convenience wrapper over ImGui::GetDragDropPayload.

The returned payload is owned and managed by Dear ImGui and may become invalid after the drag operation completes. Do not cache it beyond the current frame.

Source §

impl Ui

Source

pub fn text_filter(&self, label: impl Into<String>) -> TextFilter

Creates a new TextFilter with an empty pattern.

This is a convenience method equivalent to TextFilter::new.

§Arguments

label - The label to display for the filter input

§Examples

let filter = ui.text_filter("Search");

Source

pub fn text_filter_with_filter( &self, label: impl Into<String>, filter: impl AsRef<str>, ) -> TextFilter

Creates a new TextFilter with a custom filter pattern.

This is a convenience method equivalent to TextFilter::new_with_filter.

§Arguments

label - The label to display for the filter input
filter - The initial filter pattern

§Examples

let filter = ui.text_filter_with_filter(
    "Search",
    "include,-exclude"
);

Trait Implementations§

Source §

impl Debug for Ui

Source §

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter. Read more

Source §

impl ImPlotExt for Ui

Source §

fn implot<'ui>(&'ui self, ctx: &'ui PlotContext) -> PlotUi<'ui>

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

Source §

impl<T, U> TryInto for T
where U: TryFrom<T>,

Source §

type Error = >::Error

The type returned in the event of a conversion error.

Source §

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Ui

Struct Ui Copy item path

Implementations§

impl Ui

pub fn dockspace(&self) -> DockspaceBuilder<'_, 'static>

pub fn dock_space_over_main_viewport_raw( &self, dockspace_id: Id, flags: DockNodeFlags, ) -> Id

§Parameters

§Returns

§Panics

§Example

pub fn dock_space_raw( &self, id: Id, size: [f32; 2], flags: DockNodeFlags, window_class: Option<&WindowClass>, ) -> Id

§Parameters

§Returns

§Panics

§Example

pub fn set_next_window_dock_id_with_cond(&self, dock_id: Id, cond: Condition)

§Panics

§Parameters

§Example

pub fn set_next_window_dock_id(&self, dock_id: Id)

§Panics

§Parameters

§Example

pub fn set_next_window_class(&self, window_class: &WindowClass)

§Parameters

§Example

pub fn get_window_dock_id(&self) -> Id

§Returns

§Example

pub fn is_window_docked(&self) -> bool

§Returns

§Example

impl Ui

pub fn custom_rect(&self, id: CustomRectId) -> Option<CustomRectSnapshot<'_>>

pub fn image_custom_rect(&self, id: CustomRectId, size: [f32; 2]) -> bool

impl Ui

pub fn font_atlas_texture(&self) -> Option<FontAtlasTexture<'_>>

impl Ui

pub fn current_baked_font(&self) -> BakedFont<'_>

pub fn baked_font(&self, font: FontId, size: f32) -> Option<BakedFont<'_>>

pub fn baked_font_with_density( &self, font: FontId, size: f32, density: f32, ) -> Option<BakedFont<'_>>

impl Ui

§Fonts

pub fn current_font(&self) -> FontId

pub fn current_font_size(&self) -> f32

pub fn push_font_with_size( &self, font: Option<FontId>, size: f32, ) -> FontStackToken<'_>

pub fn with_font_and_size<F, R>( &self, font: Option<FontId>, size: f32, f: F, ) -> Rwhere F: FnOnce() -> R,

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

pub fn set_window_font_scale(&self, scale: f32)

impl Ui

pub fn is_key_down(&self, key: Key) -> bool

pub fn is_key_pressed(&self, key: Key) -> bool

pub fn is_key_pressed_with_repeat(&self, key: Key, repeat: bool) -> bool

pub fn is_key_released(&self, key: Key) -> bool

pub fn is_key_chord_pressed(&self, key_chord: KeyChord) -> bool

pub fn shortcut(&self, key_chord: KeyChord) -> bool

pub fn shortcut_with_flags( &self, key_chord: KeyChord, flags: impl Into<ShortcutOptions>, ) -> bool

pub fn set_next_item_shortcut(&self, key_chord: KeyChord)

pub fn set_next_item_shortcut_with_flags( &self, key_chord: KeyChord, flags: impl Into<NextItemShortcutOptions>, )

pub fn set_next_frame_want_capture_keyboard(&self, want_capture_keyboard: bool)

pub fn set_next_frame_want_capture_mouse(&self, want_capture_mouse: bool)

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

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

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

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

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

pub fn is_mouse_pos_valid(&self) -> bool

pub fn is_mouse_pos_valid_at(&self, pos: [f32; 2]) -> bool

pub fn is_mouse_released_with_delay( &self, button: MouseButton, delay: f32, ) -> bool

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

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

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

pub fn is_mouse_hovering_rect(&self, r_min: [f32; 2], r_max: [f32; 2]) -> bool

pub fn is_mouse_hovering_rect_with_clip( &self, r_min: [f32; 2], r_max: [f32; 2], clip: bool, ) -> bool

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

pub fn is_mouse_dragging_with_threshold( &self, button: MouseButton, lock_threshold: f32, ) -> bool

pub fn mouse_drag_delta(&self, button: MouseButton) -> [f32; 2]

pub fn mouse_drag_delta_with_threshold( &self, button: MouseButton, lock_threshold: f32, ) -> [f32; 2]

pub fn reset_mouse_drag_delta(&self, button: MouseButton)

pub fn is_item_toggled_selection(&self) -> bool

Struct Ui

pub fn with_font_and_size<F, R>( &self, font: Option<FontId>, size: f32, f: F, ) -> R
where F: FnOnce() -> R,