Struct macroquad::ui::Ui

pub struct Ui {
    pub frame: u64,
    // some fields omitted
}

Fields

frame: u64

Returns the number of frames that have elapsed since the program started.

Implementations

impl Ui

pub fn button<'a, P: Into<Option<Vec2>>, S: Into<UiContent<'a>>>(
    &mut self,
    position: P,
    label: S
) -> bool

impl Ui

pub fn checkbox(&mut self, id: Id, label: &str, data: &mut bool)

impl Ui

pub fn combo_box<'a>(
    &mut self,
    id: Id,
    label: &str,
    variants: &[&str],
    data: impl Into<Option<&'a mut usize>>
) -> usize

impl Ui

pub fn drag<T: Num, T1: Into<Option<(T, T)>>>(
    &mut self,
    id: Id,
    label: &str,
    range: T1,
    data: &mut T
)

impl Ui

pub fn editbox(&mut self, id: Id, size: Vec2, text: &mut String) -> bool

impl Ui

pub fn group<F: FnOnce(&mut Ui)>(&mut self, id: Id, size: Vec2, f: F) -> Drag

impl Ui

pub fn input_field(&mut self, id: Id, label: &str, data: &mut String)

👎 Deprecated:

Use input_text instead

pub fn input_text(&mut self, id: Id, label: &str, data: &mut String)

pub fn input_password(&mut self, id: Id, label: &str, data: &mut String)

impl Ui

pub fn label<P: Into<Option<Vec2>>>(&mut self, position: P, label: &str)

pub fn calc_size(&mut self, label: &str) -> Vec2

impl Ui

pub fn popup<F: FnOnce(&mut Ui)>(&mut self, id: Id, size: Vec2, f: F)

impl Ui

pub fn separator(&mut self)

impl Ui

pub fn slider(&mut self, id: Id, label: &str, range: Range<f32>, data: &mut f32)

impl Ui

pub fn tabbar<'a>(&mut self, id: Id, size: Vec2, tabs: &'a [&'a str]) -> u32

impl Ui

pub fn texture(&mut self, texture: Texture2D, w: f32, h: f32) -> bool

impl Ui

pub fn tree_node<F: FnOnce(&mut Ui)>(
    &mut self,
    id: Id,
    label: &str,
    f: F
) -> bool

impl Ui

pub fn window<F: FnOnce(&mut Ui)>(
    &mut self,
    id: Id,
    position: Vec2,
    size: Vec2,
    f: F
) -> bool

impl Ui

pub fn new(ctx: &mut Context) -> Ui

pub fn set_default_skin(&mut self, _skin: Skin)

pub fn style_builder(&self) -> StyleBuilder

pub fn default_skin(&self) -> Skin

pub fn last_item_clicked(&mut self) -> bool

Returns true if the last widget which had .ui called on it is being clicked.

pub fn last_item_hovered(&mut self) -> bool

Returns true if the mouse is over the last widget which had .ui called on it.

pub fn scroll_here(&mut self)

Scrolls the middle of the active GUI window to its GUI cursor

Note that this does not work on the first frame of the GUI application. If you want your widget to start with its scrollbar in a particular location, consider if ui.frame == 1 { ui.scroll_here() }.

pub fn scroll_here_ratio(&mut self, ratio: f32)

Scrolls the active GUI window to its GUI cursor.

1.0 puts the bottom of the window at the GUI cursor, 0.0 puts the top of the window there.

0.5 as the ratio puts the middle of the window at the GUI cursor, and is equivalent to Ui::scroll_here.

pub fn scroll(&mut self) -> Vec2

How far the active gui window has been scrolled down on the y axis.

Note that for these purposes, a Group widget is still considered a Window because it can have its own scrollbar.

pub fn scroll_max(&mut self) -> Vec2

The farthest down a scrollbar may go given the constraints of its window.

Note that for these purposes, a Group widget is still considered a Window because it can have its own scrollbar.

pub fn is_mouse_captured(&self) -> bool

pub fn is_mouse_over(&self, mouse_position: Vec2) -> bool

pub fn active_window_focused(&self) -> bool

pub fn is_dragging(&self) -> bool

pub fn close_current_window(&mut self)

pub fn new_frame(&mut self, delta: f32)

pub fn render(&mut self, draw_list: &mut Vec<DrawList>)

pub fn focus_window(&mut self, id: Id)

pub fn set_input_focus(&mut self, id: Id)

pub fn clear_input_focus(&mut self)

pub fn move_window(&mut self, id: Id, position: Vec2)

pub fn same_line(&mut self, x: f32)

pub fn canvas(&mut self) -> DrawCanvas<'_>

pub fn get_bool(&mut self, id: Id) -> &mut bool

small hack to keep some internal state used like this:

if ui.last_item_clicked() {
    *ui.get_bool(hash!("color picker opened")) ^= true;
}
if *ui.get_bool(hash!("color picker opened"))  {
}

pub fn get_any<T: Any + Default>(&mut self, id: Id) -> &mut T

pub fn push_skin(&mut self, skin: &Skin)

pub fn pop_skin(&mut self)

Trait Implementations

impl InputHandler for Ui

fn mouse_down(&mut self, position: (f32, f32))

fn mouse_up(&mut self, _: (f32, f32))

fn mouse_wheel(&mut self, x: f32, y: f32)

fn mouse_move(&mut self, position: (f32, f32))

fn char_event(&mut self, character: char, shift: bool, ctrl: bool)

fn key_down(&mut self, key: KeyCode, shift: bool, ctrl: bool)