dear-imgui-winit 0.13.0

Winit platform backend for dear-imgui-rs
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

//! Cursor management for Dear ImGui winit backend
//!
//! This module handles mouse cursor type mapping and caching to avoid
//! unnecessary system calls when changing cursor appearance.

use dear_imgui_rs::MouseCursor;
use winit::window::{CursorIcon as WinitCursor, Window};

/// Cursor settings cache to avoid unnecessary cursor changes
#[derive(Copy, Clone, Debug, PartialEq)]
pub struct CursorSettings {
    pub cursor: Option<MouseCursor>,
    pub draw_cursor: bool,
}

impl CursorSettings {
    /// Apply cursor settings to the window
    pub fn apply(&self, window: &Window) {
        match self.cursor {
            Some(mouse_cursor) if !self.draw_cursor => {
                window.set_cursor_visible(true);
                window.set_cursor(to_winit_cursor(mouse_cursor));
            }
            _ => {
                window.set_cursor_visible(!self.draw_cursor);
            }
        }
    }
}

/// Convert Dear ImGui mouse cursor to winit cursor
pub fn to_winit_cursor(cursor: MouseCursor) -> WinitCursor {
    match cursor {
        MouseCursor::None => WinitCursor::Default, // Default cursor when none specified
        MouseCursor::Arrow => WinitCursor::Default,
        MouseCursor::TextInput => WinitCursor::Text,
        MouseCursor::ResizeAll => WinitCursor::Move,
        MouseCursor::ResizeNS => WinitCursor::NsResize,
        MouseCursor::ResizeEW => WinitCursor::EwResize,
        MouseCursor::ResizeNESW => WinitCursor::NeswResize,
        MouseCursor::ResizeNWSE => WinitCursor::NwseResize,
        MouseCursor::Hand => WinitCursor::Pointer,
        MouseCursor::NotAllowed => WinitCursor::NotAllowed,
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_cursor_mapping() {
        // Test basic cursor mappings
        assert_eq!(to_winit_cursor(MouseCursor::Arrow), WinitCursor::Default);
        assert_eq!(to_winit_cursor(MouseCursor::TextInput), WinitCursor::Text);
        assert_eq!(to_winit_cursor(MouseCursor::Hand), WinitCursor::Pointer);
        assert_eq!(
            to_winit_cursor(MouseCursor::NotAllowed),
            WinitCursor::NotAllowed
        );

        // Test resize cursors
        assert_eq!(
            to_winit_cursor(MouseCursor::ResizeNS),
            WinitCursor::NsResize
        );
        assert_eq!(
            to_winit_cursor(MouseCursor::ResizeEW),
            WinitCursor::EwResize
        );
        assert_eq!(
            to_winit_cursor(MouseCursor::ResizeNESW),
            WinitCursor::NeswResize
        );
        assert_eq!(
            to_winit_cursor(MouseCursor::ResizeNWSE),
            WinitCursor::NwseResize
        );
    }

    #[test]
    fn test_cursor_settings_equality() {
        let settings1 = CursorSettings {
            cursor: Some(MouseCursor::Arrow),
            draw_cursor: false,
        };

        let settings2 = CursorSettings {
            cursor: Some(MouseCursor::Arrow),
            draw_cursor: false,
        };

        let settings3 = CursorSettings {
            cursor: Some(MouseCursor::Hand),
            draw_cursor: false,
        };

        assert_eq!(settings1, settings2);
        assert_ne!(settings1, settings3);
    }
}