Struct imgui::Ui[−][src]

pub struct Ui<'ui> { /* fields omitted */ }

A temporary reference for building the user interface for one frame

Implementations

`impl<'ui> Ui<'ui>`[src]

Clipboard

`pub fn clipboard_text(&self) -> Option<ImString>`[src]

Returns the current clipboard contents as text, or None if the clipboard is empty or cannot be accessed

`pub fn set_clipboard_text(&self, text: &ImStr)`[src]

Sets the clipboard contents.

Does nothing if the clipboard cannot be accessed.

`impl<'ui> Ui<'ui>`[src]

Columns

`pub fn columns(&self, count: i32, id: &ImStr, border: bool)`[src]

`pub fn next_column(&self)`[src]

Switches to the next column.

If the current row is finished, switches to first column of the next row

`pub fn current_column_index(&self) -> i32`[src]

Returns the index of the current column

`pub fn current_column_width(&self) -> f32`[src]

Returns the width of the current column (in pixels)

`pub fn column_width(&self, column_index: i32) -> f32`[src]

Returns the width of the given column (in pixels)

`pub fn set_current_column_width(&self, width: f32)`[src]

Sets the width of the current column (in pixels)

`pub fn set_column_width(&self, column_index: i32, width: f32)`[src]

Sets the width of the given column (in pixels)

`pub fn current_column_offset(&self) -> f32`[src]

Returns the offset of the current column (in pixels from the left side of the content region)

`pub fn column_offset(&self, column_index: i32) -> f32`[src]

Returns the offset of the given column (in pixels from the left side of the content region)

`pub fn set_current_column_offset(&self, offset_x: f32)`[src]

Sets the offset of the current column (in pixels from the left side of the content region)

`pub fn set_column_offset(&self, column_index: i32, offset_x: f32)`[src]

Sets the offset of the given column (in pixels from the left side of the content region)

`pub fn column_count(&self) -> i32`[src]

Returns the current amount of columns

`impl<'ui> Ui<'ui>`[src]

Fonts

`pub fn current_font(&self) -> &Font`[src]

Returns the current font

`pub fn current_font_size(&self) -> f32`[src]

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

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

Returns the UV coordinate for a white pixel.

Useful for drawing custom shapes with the draw list API.

`pub fn set_window_font_scale(&self, scale: f32)`[src]

Sets the font scale of the current window

`impl<'ui> Ui<'ui>`[src]

Input: Keyboard

`pub fn is_key_down(&self, key: Key) -> bool`[src]

Returns true if the key is being held.

Equivalent to indexing the Io struct keys_down field: ui.io().keys_down[key_index]

`pub fn is_key_pressed(&self, key: Key) -> bool`[src]

Returns true if the key was pressed (went from !down to down).

Affected by key repeat settings (io.key_repeat_delay, io.key_repeat_rate)

`pub fn is_key_released(&self, key: Key) -> bool`[src]

Returns true if the key was released (went from down to !down)

`pub fn key_pressed_amount(&self, key: Key, repeat_delay: f32, rate: f32) -> u32`[src]

Returns a count of key presses using the given repeat rate/delay settings.

Usually returns 0 or 1, but might be >1 if rate is small enough that io.delta_time > rate.

`pub fn set_keyboard_focus_here(&self, target_widget: FocusedWidget)`[src]

Focuses keyboard on a widget relative to current position

`impl<'ui> Ui<'ui>`[src]

Input: Mouse

`pub fn is_mouse_down(&self, button: MouseButton) -> bool`[src]

Returns true if the given mouse button is held down.

Equivalent to indexing the Io struct with the button, e.g. ui.io()[button].

`pub fn is_any_mouse_down(&self) -> bool`[src]

Returns true if any mouse button is held down

`pub fn is_mouse_clicked(&self, button: MouseButton) -> bool`[src]

Returns true if the given mouse button was clicked (went from !down to down)

`pub fn is_mouse_double_clicked(&self, button: MouseButton) -> bool`[src]

Returns true if the given mouse button was double-clicked

`pub fn is_mouse_released(&self, button: MouseButton) -> bool`[src]

Returns true if the given mouse button was released (went from down to !down)

`pub fn is_mouse_dragging(&self, button: MouseButton) -> bool`[src]

Returns true if the mouse is currently dragging with the given mouse button held down

`pub fn is_mouse_dragging_with_threshold( &self, button: MouseButton, threshold: f32 ) -> bool`[src]

Returns true if the mouse is currently dragging with the given mouse button held down.

If the given threshold is invalid or negative, the global distance threshold is used (io.mouse_drag_threshold).

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

Returns true if the mouse is hovering over the given bounding rect.

Clipped by current clipping settings, but disregards other factors like focus, window ordering, modal popup blocking.

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

Returns the mouse position backed up at the time of opening a popup

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

Returns the delta from the initial clicking position.

This is locked and returns [0.0, 0.0] until the mouse has moved past the global distance threshold (io.mouse_drag_threshold).

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

Returns the delta from the initial clicking position.

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

`pub fn reset_mouse_drag_delta(&self, button: MouseButton)`[src]

Resets the current delta from initial clicking position.

`pub fn mouse_cursor(&self) -> Option<MouseCursor>`[src]

Returns the currently desired mouse cursor type.

Returns None if no cursor should be displayed

`pub fn set_mouse_cursor(&self, cursor_type: Option<MouseCursor>)`[src]

Sets the desired mouse cursor type.

Passing None hides the mouse cursor.

`pub fn is_current_mouse_pos_valid(&self) -> bool`[src]

`pub fn is_mouse_pos_valid(&self, mouse_pos: [f32; 2]) -> bool`[src]

`impl<'ui> Ui<'ui>`[src]

Cursor / Layout

`pub fn separator(&self)`[src]

Renders a separator (generally horizontal).

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

`pub fn same_line(&self, pos_x: f32)`[src]

Call between widgets or groups to layout them horizontally.

X position is given in window coordinates.

`pub fn same_line_with_spacing(&self, pos_x: f32, spacing_w: f32)`[src]

Call between widgets or groups to layout them horizontally.

X position is given in window coordinates.

`pub fn new_line(&self)`[src]

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

`pub fn spacing(&self)`[src]

Adds vertical spacing

`pub fn dummy(&self, size: [f32; 2])`[src]

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

Can be used to move the cursor on the window.

`pub fn indent(&self)`[src]

Moves content position to the right by Style::indent_spacing

`pub fn indent_by(&self, width: f32)`[src]

Moves content position to the right by width

`pub fn unindent(&self)`[src]

Moves content position to the left by Style::indent_spacing

`pub fn unindent_by(&self, width: f32)`[src]

Moves content position to the left by width

`pub fn begin_group(&self) -> GroupToken`[src]

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()

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

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.

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

Returns the cursor position (in window coordinates)

`pub fn set_cursor_pos(&self, pos: [f32; 2])`[src]

Sets the cursor position (in window coordinates).

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

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

Returns the initial cursor position (in window coordinates)

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

Returns the cursor position (in absolute screen coordinates).

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

`pub fn set_cursor_screen_pos(&self, pos: [f32; 2])`[src]

Sets the cursor position (in absolute screen coordinates)

`pub fn align_text_to_frame_padding(&self)`[src]

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.

`pub fn text_line_height(&self) -> f32`[src]

`pub fn text_line_height_with_spacing(&self) -> f32`[src]

`pub fn frame_height(&self) -> f32`[src]

`pub fn frame_height_with_spacing(&self) -> f32`[src]

`impl<'ui> Ui<'ui>`[src]

Parameter stacks (shared)

`pub fn push_font(&self, id: FontId) -> FontStackToken`[src]

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(&ui);

`pub fn push_style_color( &self, style_color: StyleColor, color: [f32; 4] ) -> ColorStackToken`[src]

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(&ui);

`pub fn push_style_colors<'a, I>(&self, style_colors: I) -> ColorStackToken where I: IntoIterator<Item = &'a (StyleColor, [f32; 4])>,` [src]

Changes style colors by pushing several changes 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];
const GREEN: [f32; 4] = [0.0, 1.0, 0.0, 1.0];
let colors = ui.push_style_colors(&[
    (StyleColor::Text, RED),
    (StyleColor::TextDisabled, GREEN),
]);
ui.text("I'm red!");
ui.text_disabled("I'm green!");
colors.pop(&ui);

`pub fn push_style_var(&self, style_var: StyleVar) -> StyleStackToken`[src]

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

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

Examples

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

`pub fn push_style_vars<'a, I>(&self, style_vars: I) -> StyleStackToken where I: IntoIterator<Item = &'a StyleVar>,` [src]

Changes style variables by pushing several changes to the style stack.

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

Examples

let styles = ui.push_style_vars(&[
    StyleVar::Alpha(0.2),
    StyleVar::ItemSpacing([50.0, 50.0])
]);
ui.text("We're transparent...");
ui.text("...with large spacing as well");
styles.pop(&ui);

`impl<'ui> Ui<'ui>`[src]

Parameter stacks (current window)

`pub fn push_item_width(&self, item_width: f32) -> ItemWidthStackToken`[src]

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

Returns an ItemWidthStackToken that may be popped by calling .pop()

> 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)

`pub fn set_next_item_width(&self, item_width: f32)`[src]

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)

`pub fn calc_item_width(&self) -> f32`[src]

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

This is NOT necessarily the width of last item.

`pub fn push_text_wrap_pos(&self, wrap_pos_x: f32) -> TextWrapPosStackToken`[src]

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

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

> 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

`pub fn push_item_flag(&self, item_flag: ItemFlag) -> ItemFlagsStackToken`[src]

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

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

`impl<'ui> Ui<'ui>`[src]

ID stack

`pub fn push_id<'a, I: Into<Id<'a>>>(&self, id: I) -> IdStackToken`[src]

Pushes an identifier to the ID stack.

Returns an IdStackToken that must be popped by calling .pop()

`impl<'ui> Ui<'ui>`[src]

Item/widget utilities

`pub fn is_item_hovered(&self) -> bool`[src]

Returns true if the last item is hovered

`pub fn is_item_hovered_with_flags(&self, flags: ItemHoveredFlags) -> bool`[src]

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

`pub fn is_item_active(&self) -> bool`[src]

Returns true if the last item is active

`pub fn is_item_focused(&self) -> bool`[src]

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

`pub fn is_item_clicked(&self, button: MouseButton) -> bool`[src]

Returns true if the last item is being clicked

`pub fn is_item_visible(&self) -> bool`[src]

Returns true if the last item is visible

`pub fn is_item_edited(&self) -> bool`[src]

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

`pub fn is_item_activated(&self) -> bool`[src]

Returns true if the last item was just made active

`pub fn is_item_deactivated(&self) -> bool`[src]

Returns true if the last item was just made inactive

`pub fn is_item_deactivated_after_edit(&self) -> bool`[src]

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

`pub fn is_item_toggled_open(&self) -> bool`[src]

Returns true if the last item open state was toggled

`pub fn is_any_item_hovered(&self) -> bool`[src]

Returns true if any item is hovered

`pub fn is_any_item_active(&self) -> bool`[src]

Returns true if any item is active

`pub fn is_any_item_focused(&self) -> bool`[src]

Returns true if any item is focused

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

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

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

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

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

Returns the size of the last item

`pub fn set_item_allow_overlap(&self)`[src]

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.

`pub fn set_item_default_focus(&self)`[src]

Makes the last item the default focused item of the window

`impl<'ui> Ui<'ui>`[src]

Miscellaneous utilities

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

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

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

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

`pub fn time(&self) -> f64`[src]

Returns the global imgui-rs time.

Incremented by Io::delta_time every frame.

`pub fn frame_count(&self) -> i32`[src]

Returns the global imgui-rs frame count.

Incremented by 1 every frame.

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

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.

`impl<'ui> Ui<'ui>`[src]

Widgets: Color Editor/Picker

`pub fn set_color_edit_options(&self, flags: ColorEditFlags)`[src]

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.

`impl<'ui> Ui<'ui>`[src]

Widgets: Menus

`#[must_use]pub fn begin_main_menu_bar(&self) -> Option<MainMenuBarToken>`[src]

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.

`pub fn main_menu_bar<F: FnOnce()>(&self, f: F)`[src]

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.

`#[must_use]pub fn begin_menu_bar(&self) -> Option<MenuBarToken>`[src]

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.

`pub fn menu_bar<F: FnOnce()>(&self, f: F)`[src]

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.

`#[must_use]pub fn begin_menu(&self, label: &ImStr, enabled: bool) -> Option<MenuToken>`[src]

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.

`pub fn menu<F: FnOnce()>(&self, label: &ImStr, enabled: bool, f: F)`[src]

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

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