imgui 0.1.0

High-level Rust bindings to dear imgui
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
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160

use std::marker::PhantomData;
use std::os::raw::c_void;

use crate::render::renderer::TextureId;
use crate::sys;
use crate::Ui;

/// Represent an image about to be drawn.
/// See [`Ui::image`].
///
/// Create your image using the builder pattern then [`Image::build`] it.
#[must_use]
pub struct Image<'ui> {
    texture_id: TextureId,
    size: [f32; 2],
    uv0: [f32; 2],
    uv1: [f32; 2],
    tint_col: [f32; 4],
    border_col: [f32; 4],
    _phantom: PhantomData<&'ui Ui<'ui>>,
}

impl<'ui> Image<'ui> {
    pub fn new(_: &Ui<'ui>, texture_id: TextureId, size: [f32; 2]) -> Self {
        const DEFAULT_UV0: [f32; 2] = [0.0, 0.0];
        const DEFAULT_UV1: [f32; 2] = [1.0, 1.0];
        const DEFAULT_TINT_COL: [f32; 4] = [1.0, 1.0, 1.0, 1.0];
        const DEFAULT_BORDER_COL: [f32; 4] = [0.0, 0.0, 0.0, 0.0];
        Image {
            texture_id,
            size,
            uv0: DEFAULT_UV0,
            uv1: DEFAULT_UV1,
            tint_col: DEFAULT_TINT_COL,
            border_col: DEFAULT_BORDER_COL,
            _phantom: PhantomData,
        }
    }
    /// Set size (default based on texture)
    pub fn size(mut self, size: [f32; 2]) -> Self {
        self.size = size;
        self
    }
    /// Set uv0 (default `[0.0, 0.0]`)
    pub fn uv0(mut self, uv0: [f32; 2]) -> Self {
        self.uv0 = uv0;
        self
    }
    /// Set uv1 (default `[1.0, 1.0]`)
    pub fn uv1(mut self, uv1: [f32; 2]) -> Self {
        self.uv1 = uv1;
        self
    }
    /// Set tint color (default: no tint color)
    pub fn tint_col(mut self, tint_col: [f32; 4]) -> Self {
        self.tint_col = tint_col;
        self
    }
    /// Set border color (default: no border)
    pub fn border_col(mut self, border_col: [f32; 4]) -> Self {
        self.border_col = border_col;
        self
    }
    /// Draw image where the cursor currently is
    pub fn build(self) {
        unsafe {
            sys::igImage(
                self.texture_id.id() as *mut c_void,
                self.size.into(),
                self.uv0.into(),
                self.uv1.into(),
                self.tint_col.into(),
                self.border_col.into(),
            );
        }
    }
}

/// Represent an image button about to be drawn.
/// See [`Ui::image_button`].
///
/// Create your image button using the builder pattern then [`ImageButton::build`] it.
#[must_use]
pub struct ImageButton<'ui> {
    texture_id: TextureId,
    size: [f32; 2],
    uv0: [f32; 2],
    uv1: [f32; 2],
    frame_padding: i32,
    bg_col: [f32; 4],
    tint_col: [f32; 4],
    _phantom: PhantomData<&'ui Ui<'ui>>,
}

impl<'ui> ImageButton<'ui> {
    pub fn new(_: &Ui<'ui>, texture_id: TextureId, size: [f32; 2]) -> Self {
        const DEFAULT_UV0: [f32; 2] = [0.0, 0.0];
        const DEFAULT_UV1: [f32; 2] = [1.0, 1.0];
        const DEFAULT_FRAME_PADDING: i32 = -1;
        const DEFAULT_BG_COL: [f32; 4] = [0.0, 0.0, 0.0, 0.0];
        const DEFAULT_TINT_COL: [f32; 4] = [1.0, 1.0, 1.0, 1.0];
        ImageButton {
            texture_id,
            size: size,
            uv0: DEFAULT_UV0,
            uv1: DEFAULT_UV1,
            frame_padding: DEFAULT_FRAME_PADDING,
            bg_col: DEFAULT_BG_COL,
            tint_col: DEFAULT_TINT_COL,
            _phantom: PhantomData,
        }
    }
    /// Set size (default based on texture)
    pub fn size(mut self, size: [f32; 2]) -> Self {
        self.size = size;
        self
    }
    /// Set uv0 (default `[0.0, 0.0]`)
    pub fn uv0(mut self, uv0: [f32; 2]) -> Self {
        self.uv0 = uv0;
        self
    }
    /// Set uv1 (default `[1.0, 1.0]`)
    pub fn uv1(mut self, uv1: [f32; 2]) -> Self {
        self.uv1 = uv1;
        self
    }
    /// Set frame padding (default: uses frame padding from style).
    /// frame_padding < 0: uses frame padding from style (default)
    /// frame_padding = 0: no framing
    /// frame_padding > 0: set framing size
    pub fn frame_padding(mut self, frame_padding: i32) -> Self {
        self.frame_padding = frame_padding.into();
        self
    }
    /// Set tint color (default: no tint color)
    pub fn tint_col(mut self, tint_col: [f32; 4]) -> Self {
        self.tint_col = tint_col;
        self
    }
    /// Set background color (default: no background color)
    pub fn background_col(mut self, bg_col: [f32; 4]) -> Self {
        self.bg_col = bg_col;
        self
    }
    /// Draw image button where the cursor currently is
    pub fn build(self) -> bool {
        unsafe {
            sys::igImageButton(
                self.texture_id.id() as *mut c_void,
                self.size.into(),
                self.uv0.into(),
                self.uv1.into(),
                self.frame_padding,
                self.bg_col.into(),
                self.tint_col.into(),
            )
        }
    }
}