dear-imgui-rs 0.13.0

High-level Rust bindings to Dear ImGui v1.92.7 with docking, WGPU/GL backends, and extensions (ImPlot/ImPlot3D, ImNodes, ImGuizmo, file browser, reflection-based UI)
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117

//! Window scrolling
//!
//! Read and control the current window scroll offsets as well as their maxima
//! to implement custom scrolling behaviors.
//!
use crate::Ui;
use crate::sys;

fn assert_finite_f32(caller: &str, name: &str, value: f32) {
    assert!(value.is_finite(), "{caller} {name} must be finite");
}

fn assert_unit_ratio(caller: &str, name: &str, value: f32) {
    assert_finite_f32(caller, name, value);
    assert!(
        (0.0..=1.0).contains(&value),
        "{caller} {name} must be between 0.0 and 1.0"
    );
}

impl Ui {
    /// Returns the current scroll position of the window
    #[doc(alias = "GetScrollX")]
    pub fn scroll_x(&self) -> f32 {
        unsafe { sys::igGetScrollX() }
    }

    /// Returns the current vertical scroll position of the window
    #[doc(alias = "GetScrollY")]
    pub fn scroll_y(&self) -> f32 {
        unsafe { sys::igGetScrollY() }
    }

    /// Returns the maximum horizontal scroll position
    #[doc(alias = "GetScrollMaxX")]
    pub fn scroll_max_x(&self) -> f32 {
        unsafe { sys::igGetScrollMaxX() }
    }

    /// Returns the maximum vertical scroll position
    #[doc(alias = "GetScrollMaxY")]
    pub fn scroll_max_y(&self) -> f32 {
        unsafe { sys::igGetScrollMaxY() }
    }

    /// Sets the horizontal scroll position
    #[doc(alias = "SetScrollX")]
    pub fn set_scroll_x(&self, scroll_x: f32) {
        assert_finite_f32("Ui::set_scroll_x()", "scroll_x", scroll_x);
        unsafe {
            sys::igSetScrollX_Float(scroll_x);
        }
    }

    /// Sets the vertical scroll position
    #[doc(alias = "SetScrollY")]
    pub fn set_scroll_y(&self, scroll_y: f32) {
        assert_finite_f32("Ui::set_scroll_y()", "scroll_y", scroll_y);
        unsafe {
            sys::igSetScrollY_Float(scroll_y);
        }
    }

    /// Sets the horizontal scroll position to center on the given position
    ///
    /// The center_x_ratio parameter should be between 0.0 (left) and 1.0 (right)
    #[doc(alias = "SetScrollFromPosX")]
    pub fn set_scroll_from_pos_x(&self, local_x: f32, center_x_ratio: f32) {
        assert_finite_f32("Ui::set_scroll_from_pos_x()", "local_x", local_x);
        assert_unit_ratio(
            "Ui::set_scroll_from_pos_x()",
            "center_x_ratio",
            center_x_ratio,
        );
        unsafe {
            sys::igSetScrollFromPosX_Float(local_x, center_x_ratio);
        }
    }

    /// 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)
    #[doc(alias = "SetScrollFromPosY")]
    pub fn set_scroll_from_pos_y(&self, local_y: f32, center_y_ratio: f32) {
        assert_finite_f32("Ui::set_scroll_from_pos_y()", "local_y", local_y);
        assert_unit_ratio(
            "Ui::set_scroll_from_pos_y()",
            "center_y_ratio",
            center_y_ratio,
        );
        unsafe {
            sys::igSetScrollFromPosY_Float(local_y, center_y_ratio);
        }
    }

    /// Scrolls to make the current item visible
    ///
    /// This is useful when you want to ensure a specific item is visible in a scrollable region
    #[doc(alias = "SetScrollHereX")]
    pub fn set_scroll_here_x(&self, center_x_ratio: f32) {
        assert_unit_ratio("Ui::set_scroll_here_x()", "center_x_ratio", center_x_ratio);
        unsafe {
            sys::igSetScrollHereX(center_x_ratio);
        }
    }

    /// 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
    #[doc(alias = "SetScrollHereY")]
    pub fn set_scroll_here_y(&self, center_y_ratio: f32) {
        assert_unit_ratio("Ui::set_scroll_here_y()", "center_y_ratio", center_y_ratio);
        unsafe {
            sys::igSetScrollHereY(center_y_ratio);
        }
    }
}