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
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
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
use crate::sys;
use std::cell::UnsafeCell;
use std::ffi::{CStr, c_void};

fn assert_finite_vec2(caller: &str, name: &str, value: [f32; 2]) {
    assert!(
        value[0].is_finite() && value[1].is_finite(),
        "{caller} {name} must contain finite values"
    );
}

fn assert_non_negative_finite_vec2(caller: &str, name: &str, value: [f32; 2]) {
    assert_finite_vec2(caller, name, value);
    assert!(
        value[0] >= 0.0 && value[1] >= 0.0,
        "{caller} {name} must contain non-negative values"
    );
}

#[cfg(feature = "multi-viewport")]
fn assert_dpi_scale(caller: &str, value: f32) {
    assert!(value.is_finite(), "{caller} scale must be finite");
    assert!(
        value > 0.0 && value < 99.0,
        "{caller} scale must be greater than 0.0 and less than 99.0"
    );
}

// - Viewport management
// - Platform backend callbacks
// - Renderer backend callbacks
// - Monitor information
// - Platform-specific settings

/// Viewport structure for multi-viewport support
///
/// This is a transparent wrapper around `ImGuiViewport` that provides
/// safe access to viewport functionality.
#[repr(transparent)]
pub struct Viewport {
    raw: UnsafeCell<sys::ImGuiViewport>,
}

// Ensure the wrapper stays layout-compatible with the sys bindings.
const _: [(); std::mem::size_of::<sys::ImGuiViewport>()] = [(); std::mem::size_of::<Viewport>()];
const _: [(); std::mem::align_of::<sys::ImGuiViewport>()] = [(); std::mem::align_of::<Viewport>()];

impl Viewport {
    #[inline]
    fn inner(&self) -> &sys::ImGuiViewport {
        // Safety: `Viewport` is a view into ImGui-owned viewport state which may be mutated by
        // Dear ImGui and platform/renderer backends while Rust holds `&Viewport`.
        unsafe { &*self.raw.get() }
    }

    #[inline]
    fn inner_mut(&mut self) -> &mut sys::ImGuiViewport {
        unsafe { &mut *self.raw.get() }
    }

    /// Get a reference to the viewport from a raw pointer
    ///
    /// # Safety
    ///
    /// The caller must ensure that:
    /// - `raw` is non-null and points to a valid `ImGuiViewport`.
    /// - The viewport outlives the returned reference (e.g. it belongs to the
    ///   currently active ImGui context).
    pub(crate) unsafe fn from_raw<'a>(raw: *const sys::ImGuiViewport) -> &'a Self {
        unsafe { &*(raw as *const Self) }
    }

    /// Get a mutable reference to the viewport from a raw pointer
    ///
    /// # Safety
    ///
    /// The caller must ensure that:
    /// - `raw` is non-null and points to a valid `ImGuiViewport`.
    /// - The viewport outlives the returned reference (e.g. it belongs to the
    ///   currently active ImGui context).
    /// - No other references (shared or mutable) to the same viewport are alive.
    pub unsafe fn from_raw_mut<'a>(raw: *mut sys::ImGuiViewport) -> &'a mut Self {
        unsafe { &mut *(raw as *mut Self) }
    }

    /// Get the raw pointer to the underlying `ImGuiViewport`
    pub fn as_raw(&self) -> *const sys::ImGuiViewport {
        self.raw.get().cast_const()
    }

    /// Get the raw mutable pointer to the underlying `ImGuiViewport`
    pub fn as_raw_mut(&mut self) -> *mut sys::ImGuiViewport {
        self.raw.get()
    }

    /// Get the viewport ID
    pub fn id(&self) -> sys::ImGuiID {
        self.inner().ID
    }

    /// Set the viewport position
    pub fn set_pos(&mut self, pos: [f32; 2]) {
        assert_finite_vec2("Viewport::set_pos()", "pos", pos);
        self.inner_mut().Pos.x = pos[0];
        self.inner_mut().Pos.y = pos[1];
    }

    /// Get the viewport position
    pub fn pos(&self) -> [f32; 2] {
        [self.inner().Pos.x, self.inner().Pos.y]
    }

    /// Set the viewport size
    pub fn set_size(&mut self, size: [f32; 2]) {
        assert_non_negative_finite_vec2("Viewport::set_size()", "size", size);
        self.inner_mut().Size.x = size[0];
        self.inner_mut().Size.y = size[1];
    }

    /// Get the viewport size
    pub fn size(&self) -> [f32; 2] {
        [self.inner().Size.x, self.inner().Size.y]
    }

    /// Get the viewport work position (excluding menu bars, task bars, etc.)
    pub fn work_pos(&self) -> [f32; 2] {
        [self.inner().WorkPos.x, self.inner().WorkPos.y]
    }

    /// Get the viewport work size (excluding menu bars, task bars, etc.)
    pub fn work_size(&self) -> [f32; 2] {
        [self.inner().WorkSize.x, self.inner().WorkSize.y]
    }

    /// Get the center of the viewport rectangle.
    #[doc(alias = "GetCenter")]
    pub fn center(&self) -> [f32; 2] {
        unsafe {
            let center = sys::ImGuiViewport_GetCenter(self.as_raw().cast_mut());
            [center.x, center.y]
        }
    }

    /// Get the center of the work rectangle.
    #[doc(alias = "GetWorkCenter")]
    pub fn work_center(&self) -> [f32; 2] {
        unsafe {
            let center = sys::ImGuiViewport_GetWorkCenter(self.as_raw().cast_mut());
            [center.x, center.y]
        }
    }

    /// Get the viewport debug name used by Dear ImGui tooling.
    #[doc(alias = "GetDebugName")]
    pub fn debug_name(&self) -> &str {
        unsafe {
            let ptr = sys::ImGuiViewport_GetDebugName(self.as_raw().cast_mut());
            if ptr.is_null() {
                ""
            } else {
                CStr::from_ptr(ptr).to_str().unwrap_or("")
            }
        }
    }

    /// Check if this is the main viewport
    ///
    /// Note: Main viewport is typically identified by ID == 0 or by checking if it's not a platform window
    #[cfg(feature = "multi-viewport")]
    pub fn is_main(&self) -> bool {
        self.inner().ID == 0
            || (self.inner().Flags & (crate::ViewportFlags::IS_PLATFORM_WINDOW.bits())) == 0
    }

    #[cfg(not(feature = "multi-viewport"))]
    pub fn is_main(&self) -> bool {
        self.inner().ID == 0
    }

    /// Check if this is a platform window (not the main viewport)
    #[cfg(feature = "multi-viewport")]
    pub fn is_platform_window(&self) -> bool {
        (self.inner().Flags & (crate::ViewportFlags::IS_PLATFORM_WINDOW.bits())) != 0
    }

    #[cfg(not(feature = "multi-viewport"))]
    pub fn is_platform_window(&self) -> bool {
        false
    }

    /// Check if this is a platform monitor
    #[cfg(feature = "multi-viewport")]
    pub fn is_platform_monitor(&self) -> bool {
        (self.inner().Flags & (crate::ViewportFlags::IS_PLATFORM_MONITOR.bits())) != 0
    }

    #[cfg(not(feature = "multi-viewport"))]
    pub fn is_platform_monitor(&self) -> bool {
        false
    }

    /// Check if this viewport is owned by the application
    #[cfg(feature = "multi-viewport")]
    pub fn is_owned_by_app(&self) -> bool {
        (self.inner().Flags & (crate::ViewportFlags::OWNED_BY_APP.bits())) != 0
    }

    #[cfg(not(feature = "multi-viewport"))]
    pub fn is_owned_by_app(&self) -> bool {
        false
    }

    /// Get the platform user data
    pub fn platform_user_data(&self) -> *mut c_void {
        self.inner().PlatformUserData
    }

    /// Set the platform user data
    pub fn set_platform_user_data(&mut self, data: *mut c_void) {
        self.inner_mut().PlatformUserData = data;
    }

    /// Get the renderer user data
    pub fn renderer_user_data(&self) -> *mut c_void {
        self.inner().RendererUserData
    }

    /// Set the renderer user data
    pub fn set_renderer_user_data(&mut self, data: *mut c_void) {
        self.inner_mut().RendererUserData = data;
    }

    /// Get the platform handle
    pub fn platform_handle(&self) -> *mut c_void {
        self.inner().PlatformHandle
    }

    /// Set the platform handle
    pub fn set_platform_handle(&mut self, handle: *mut c_void) {
        self.inner_mut().PlatformHandle = handle;
    }

    /// Get the raw platform handle.
    ///
    /// This is backend/platform specific. For example, on Win32 this may be an `HWND`.
    pub fn platform_handle_raw(&self) -> *mut c_void {
        self.inner().PlatformHandleRaw
    }

    /// Set the raw platform handle.
    pub fn set_platform_handle_raw(&mut self, handle: *mut c_void) {
        self.inner_mut().PlatformHandleRaw = handle;
    }

    /// Check if the platform window was created
    pub fn platform_window_created(&self) -> bool {
        self.inner().PlatformWindowCreated
    }

    /// Set whether the platform window was created
    pub fn set_platform_window_created(&mut self, created: bool) {
        self.inner_mut().PlatformWindowCreated = created;
    }

    /// Check if the platform requested move
    pub fn platform_request_move(&self) -> bool {
        self.inner().PlatformRequestMove
    }

    /// Set whether the platform requested move
    pub fn set_platform_request_move(&mut self, request: bool) {
        self.inner_mut().PlatformRequestMove = request;
    }

    /// Check if the platform requested resize
    pub fn platform_request_resize(&self) -> bool {
        self.inner().PlatformRequestResize
    }

    /// Set whether the platform requested resize
    pub fn set_platform_request_resize(&mut self, request: bool) {
        self.inner_mut().PlatformRequestResize = request;
    }

    /// Check if the platform requested close
    pub fn platform_request_close(&self) -> bool {
        self.inner().PlatformRequestClose
    }

    /// Set whether the platform requested close
    pub fn set_platform_request_close(&mut self, request: bool) {
        self.inner_mut().PlatformRequestClose = request;
    }

    /// Get the viewport flags
    pub fn flags(&self) -> crate::ViewportFlags {
        crate::ViewportFlags::from_bits_retain(self.inner().Flags)
    }

    /// Set the viewport flags
    pub fn set_flags(&mut self, flags: crate::ViewportFlags) {
        crate::io::validate_viewport_flags("Viewport::set_flags()", flags);
        self.inner_mut().Flags = flags.bits();
    }

    /// Get the raw viewport flag bits.
    pub fn raw_flags(&self) -> sys::ImGuiViewportFlags {
        self.inner().Flags
    }

    /// Set raw viewport flag bits without validation.
    ///
    /// # Safety
    ///
    /// The caller must ensure `flags` contains only bits valid for this Dear ImGui version and
    /// preserves any viewport invariants expected by the platform and renderer backends.
    pub unsafe fn set_raw_flags_unchecked(&mut self, flags: sys::ImGuiViewportFlags) {
        self.inner_mut().Flags = flags;
    }

    /// Get the DPI scale factor
    #[cfg(feature = "multi-viewport")]
    pub fn dpi_scale(&self) -> f32 {
        self.inner().DpiScale
    }

    /// Set the DPI scale factor
    #[cfg(feature = "multi-viewport")]
    pub fn set_dpi_scale(&mut self, scale: f32) {
        assert_dpi_scale("Viewport::set_dpi_scale()", scale);
        self.inner_mut().DpiScale = scale;
    }

    /// Get the parent viewport ID
    #[cfg(feature = "multi-viewport")]
    pub fn parent_viewport_id(&self) -> sys::ImGuiID {
        self.inner().ParentViewportId
    }

    /// Set the parent viewport ID
    #[cfg(feature = "multi-viewport")]
    pub fn set_parent_viewport_id(&mut self, id: sys::ImGuiID) {
        self.inner_mut().ParentViewportId = id;
    }

    /// Get the draw data pointer
    #[cfg(feature = "multi-viewport")]
    pub fn draw_data(&self) -> *mut sys::ImDrawData {
        self.inner().DrawData
    }

    /// Get the draw data as a reference (if available)
    #[cfg(feature = "multi-viewport")]
    pub fn draw_data_ref(&self) -> Option<&sys::ImDrawData> {
        if self.inner().DrawData.is_null() {
            None
        } else {
            Some(unsafe { &*self.inner().DrawData })
        }
    }

    /// Get the framebuffer scale
    #[cfg(feature = "multi-viewport")]
    pub fn framebuffer_scale(&self) -> [f32; 2] {
        [
            self.inner().FramebufferScale.x,
            self.inner().FramebufferScale.y,
        ]
    }

    /// Set the framebuffer scale
    #[cfg(feature = "multi-viewport")]
    pub fn set_framebuffer_scale(&mut self, scale: [f32; 2]) {
        assert_non_negative_finite_vec2("Viewport::set_framebuffer_scale()", "scale", scale);
        self.inner_mut().FramebufferScale.x = scale[0];
        self.inner_mut().FramebufferScale.y = scale[1];
    }
}

#[cfg(test)]
mod tests {
    use super::Viewport;
    use crate::Context;
    use crate::sys;
    use std::ffi::c_void;

    fn new_viewport() -> *mut sys::ImGuiViewport {
        unsafe {
            let ptr = sys::ImGuiViewport_ImGuiViewport();
            assert!(
                !ptr.is_null(),
                "ImGuiViewport_ImGuiViewport() returned null"
            );
            ptr
        }
    }

    #[test]
    fn viewport_center_and_work_center_follow_imgui_helpers() {
        let raw = new_viewport();
        unsafe {
            (*raw).Pos.x = 10.0;
            (*raw).Pos.y = 20.0;
            (*raw).Size.x = 100.0;
            (*raw).Size.y = 40.0;
            (*raw).WorkPos.x = 30.0;
            (*raw).WorkPos.y = 50.0;
            (*raw).WorkSize.x = 20.0;
            (*raw).WorkSize.y = 10.0;

            let viewport = Viewport::from_raw_mut(raw);
            assert_eq!(viewport.center(), [60.0, 40.0]);
            assert_eq!(viewport.work_center(), [40.0, 55.0]);

            sys::ImGuiViewport_destroy(raw);
        }
    }

    #[test]
    fn viewport_platform_handle_raw_roundtrips() {
        let raw = new_viewport();
        unsafe {
            let viewport = Viewport::from_raw_mut(raw);
            let handle = 0x1234usize as *mut c_void;
            viewport.set_platform_handle_raw(handle);
            assert_eq!(viewport.platform_handle_raw(), handle);

            sys::ImGuiViewport_destroy(raw);
        }
    }

    #[test]
    fn viewport_flags_are_typed_and_checked_before_storage() {
        let raw = new_viewport();
        unsafe {
            let viewport = Viewport::from_raw_mut(raw);

            let flags = crate::ViewportFlags::OWNED_BY_APP | crate::ViewportFlags::NO_DECORATION;
            viewport.set_flags(flags);
            assert_eq!(viewport.flags(), flags);
            assert_eq!(viewport.raw_flags(), flags.bits());

            let unsupported = crate::ViewportFlags::from_bits_retain(1 << 14);
            assert!(
                std::panic::catch_unwind(std::panic::AssertUnwindSafe(|| {
                    viewport.set_flags(unsupported);
                }))
                .is_err()
            );
            assert_eq!(viewport.flags(), flags);

            viewport.set_raw_flags_unchecked(unsupported.bits());
            assert_eq!(viewport.raw_flags(), unsupported.bits());

            sys::ImGuiViewport_destroy(raw);
        }
    }

    #[test]
    fn viewport_geometry_and_scale_setters_validate_before_storage() {
        let raw = new_viewport();
        unsafe {
            let viewport = Viewport::from_raw_mut(raw);

            viewport.set_pos([10.0, 20.0]);
            viewport.set_size([100.0, 40.0]);
            assert_eq!(viewport.pos(), [10.0, 20.0]);
            assert_eq!(viewport.size(), [100.0, 40.0]);

            assert!(
                std::panic::catch_unwind(std::panic::AssertUnwindSafe(|| {
                    viewport.set_pos([f32::NAN, 20.0]);
                }))
                .is_err()
            );
            assert_eq!(viewport.pos(), [10.0, 20.0]);

            assert!(
                std::panic::catch_unwind(std::panic::AssertUnwindSafe(|| {
                    viewport.set_size([-1.0, 40.0]);
                }))
                .is_err()
            );
            assert_eq!(viewport.size(), [100.0, 40.0]);

            #[cfg(feature = "multi-viewport")]
            {
                viewport.set_dpi_scale(1.5);
                viewport.set_framebuffer_scale([2.0, 2.0]);
                assert_eq!(viewport.dpi_scale(), 1.5);
                assert_eq!(viewport.framebuffer_scale(), [2.0, 2.0]);

                assert!(
                    std::panic::catch_unwind(std::panic::AssertUnwindSafe(|| {
                        viewport.set_dpi_scale(99.0);
                    }))
                    .is_err()
                );
                assert_eq!(viewport.dpi_scale(), 1.5);

                assert!(
                    std::panic::catch_unwind(std::panic::AssertUnwindSafe(|| {
                        viewport.set_framebuffer_scale([1.0, f32::INFINITY]);
                    }))
                    .is_err()
                );
                assert_eq!(viewport.framebuffer_scale(), [2.0, 2.0]);
            }

            sys::ImGuiViewport_destroy(raw);
        }
    }

    #[test]
    fn main_viewport_exposes_debug_name() {
        let mut ctx = Context::create();
        let viewport = ctx.main_viewport();
        assert!(!viewport.debug_name().is_empty());
    }
}