Struct imgui::Ui

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

Methods

impl<'ui> Ui<'ui>

fn imgui(&self) -> &ImGui

fn want_capture_mouse(&self) -> bool

fn want_capture_keyboard(&self) -> bool

fn framerate(&self) -> f32

fn metrics_allocs(&self) -> i32

fn metrics_render_vertices(&self) -> i32

fn metrics_render_indices(&self) -> i32

fn metrics_active_windows(&self) -> i32

fn render<F, E>(self, f: F) -> Result<(), E> where
    F: FnMut(&Ui, DrawList) -> Result<(), E>, 

fn show_user_guide(&self)

fn show_default_style_editor(&self)

fn show_style_editor<'p>(&self, style: &'p mut ImGuiStyle)

fn show_test_window(&self, opened: &mut bool)

fn show_metrics_window(&self, opened: &mut bool)

impl<'a> Ui<'a>

unsafe fn current_ui() -> Option<&'a Ui<'a>>

impl<'ui> Ui<'ui>

fn window<'p>(&self, name: ImStr<'p>) -> Window<'ui, 'p>

impl<'ui> Ui<'ui>

fn push_item_width(&self, width: f32)

Pushes a value to the item width stack.

fn pop_item_width(&self)

Pops a value from the item width stack.

Aborts

The current process is aborted if the item width stack is empty.

fn with_item_width<F>(&self, width: f32, f: F) where
    F: FnOnce(), 

Runs a function after temporarily pushing a value to the item width stack.

fn separator(&self)

fn same_line(&self, pos_x: f32)

fn same_line_spacing(&self, pos_x: f32, spacing_w: f32)

fn spacing(&self)

fn columns<'p>(&self, count: i32, id: ImStr<'p>, border: bool)

fn next_column(&self)

fn get_column_index(&self) -> i32

fn get_column_offset(&self, column_index: i32) -> f32

fn set_column_offset(&self, column_index: i32, offset_x: f32)

fn get_column_width(&self, column_index: i32) -> f32

fn get_columns_count(&self) -> i32

impl<'ui> Ui<'ui>

fn push_id(&self, id: i32)

Pushes an identifier to the ID stack.

fn pop_id(&self)

Pops an identifier from the ID stack.

Aborts

The current process is aborted if the ID stack is empty.

fn with_id<F>(&self, id: i32, f: F) where
    F: FnOnce(), 

Runs a function after temporarily pushing a value to the ID stack.

impl<'ui> Ui<'ui>

fn text<'p>(&self, text: ImStr<'p>)

fn text_colored<'p, A>(&self, col: A, text: ImStr<'p>) where
    A: Into<ImVec4>, 

fn text_disabled<'p>(&self, text: ImStr<'p>)

fn text_wrapped<'p>(&self, text: ImStr<'p>)

fn label_text<'p>(&self, label: ImStr<'p>, text: ImStr<'p>)

fn bullet(&self)

fn bullet_text<'p>(&self, text: ImStr<'p>)

fn button<'p>(&self, label: ImStr<'p>, size: ImVec2) -> bool

fn small_button<'p>(&self, label: ImStr<'p>) -> bool

fn checkbox<'p>(&self, label: ImStr<'p>, value: &'p mut bool) -> bool

impl<'ui> Ui<'ui>

fn color_edit3<'p>(
    &self,
    label: ImStr<'p>,
    value: &'p mut [f32; 3]
) -> ColorEdit3<'ui, 'p>

fn color_edit4<'p>(
    &self,
    label: ImStr<'p>,
    value: &'p mut [f32; 4]
) -> ColorEdit4<'ui, 'p>

fn input_text<'p>(
    &self,
    label: ImStr<'p>,
    buf: &'p mut str
) -> InputText<'ui, 'p>

fn input_float<'p>(
    &self,
    label: ImStr<'p>,
    value: &'p mut f32
) -> InputFloat<'ui, 'p>

fn input_float2<'p>(
    &self,
    label: ImStr<'p>,
    value: &'p mut [f32; 2]
) -> InputFloat2<'ui, 'p>

fn input_float3<'p>(
    &self,
    label: ImStr<'p>,
    value: &'p mut [f32; 3]
) -> InputFloat3<'ui, 'p>

fn input_float4<'p>(
    &self,
    label: ImStr<'p>,
    value: &'p mut [f32; 4]
) -> InputFloat4<'ui, 'p>

fn input_int<'p>(
    &self,
    label: ImStr<'p>,
    value: &'p mut i32
) -> InputInt<'ui, 'p>

fn input_int2<'p>(
    &self,
    label: ImStr<'p>,
    value: &'p mut [i32; 2]
) -> InputInt2<'ui, 'p>

fn input_int3<'p>(
    &self,
    label: ImStr<'p>,
    value: &'p mut [i32; 3]
) -> InputInt3<'ui, 'p>

fn input_int4<'p>(
    &self,
    label: ImStr<'p>,
    value: &'p mut [i32; 4]
) -> InputInt4<'ui, 'p>

impl<'ui> Ui<'ui>

fn slider_float<'p>(
    &self,
    label: ImStr<'p>,
    value: &'p mut f32,
    min: f32,
    max: f32
) -> SliderFloat<'ui, 'p>

fn slider_float2<'p>(
    &self,
    label: ImStr<'p>,
    value: &'p mut [f32; 2],
    min: f32,
    max: f32
) -> SliderFloat2<'ui, 'p>

fn slider_float3<'p>(
    &self,
    label: ImStr<'p>,
    value: &'p mut [f32; 3],
    min: f32,
    max: f32
) -> SliderFloat3<'ui, 'p>

fn slider_float4<'p>(
    &self,
    label: ImStr<'p>,
    value: &'p mut [f32; 4],
    min: f32,
    max: f32
) -> SliderFloat4<'ui, 'p>

fn slider_int<'p>(
    &self,
    label: ImStr<'p>,
    value: &'p mut i32,
    min: i32,
    max: i32
) -> SliderInt<'ui, 'p>

fn slider_int2<'p>(
    &self,
    label: ImStr<'p>,
    value: &'p mut [i32; 2],
    min: i32,
    max: i32
) -> SliderInt2<'ui, 'p>

fn slider_int3<'p>(
    &self,
    label: ImStr<'p>,
    value: &'p mut [i32; 3],
    min: i32,
    max: i32
) -> SliderInt3<'ui, 'p>

fn slider_int4<'p>(
    &self,
    label: ImStr<'p>,
    value: &'p mut [i32; 4],
    min: i32,
    max: i32
) -> SliderInt4<'ui, 'p>

impl<'ui> Ui<'ui>

fn tree_node<'p>(&self, id: ImStr<'p>) -> TreeNode<'ui, 'p>

fn collapsing_header<'p>(&self, label: ImStr<'p>) -> CollapsingHeader<'ui, 'p>

impl<'ui> Ui<'ui>

fn selectable<'p>(
    &self,
    label: ImStr<'p>,
    selected: bool,
    flags: ImGuiSelectableFlags,
    size: ImVec2
) -> bool

impl<'ui> Ui<'ui>

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

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

fn menu<'p>(&self, label: ImStr<'p>) -> Menu<'ui, 'p>

fn menu_item<'p>(&self, label: ImStr<'p>) -> MenuItem<'ui, 'p>

impl<'ui> Ui<'ui>

fn open_popup<'p>(&self, str_id: ImStr<'p>)

fn popup<'p, F>(&self, str_id: ImStr<'p>, f: F) where
    F: FnOnce(), 

fn close_current_popup(&self)

impl<'ui> Ui<'ui>

fn combo<'p>(
    &self,
    label: ImStr<'p>,
    current_item: &mut i32,
    items: &'p [ImStr<'p>],
    height_in_items: i32
) -> bool

impl<'ui> Ui<'ui>

fn list_box<'p>(
    &self,
    label: ImStr<'p>,
    current_item: &mut i32,
    items: &'p [ImStr<'p>],
    height_in_items: i32
) -> bool

impl<'ui> Ui<'ui>

fn plot_lines<'p>(&self, label: ImStr<'p>, values: &'p [f32]) -> PlotLines<'p>

impl<'ui> Ui<'ui>

fn plot_histogram<'p>(
    &self,
    label: ImStr<'p>,
    values: &'p [f32]
) -> PlotHistogram<'p>

impl<'ui> Ui<'ui>

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

Creates a progress bar. Fraction is the progress level with 0.0 = 0% and 1.0 = 100%.

Example

ui.progress_bar(0.6)
    .size(imgui::ImVec2::new(100.0, 12.0))
    .overlay_text(im_str!("Progress!"))
    .build();