dear_imgui_winit/
lib.rs

1//! Winit platform backend for Dear ImGui
2//!
3//! This crate provides a platform backend for Dear ImGui that integrates with
4//! the winit windowing library. It handles window events, input processing,
5//! and platform-specific functionality including multi-viewport support.
6//!
7//! # Features
8//!
9//! - **Basic Platform Support**: Window events, input handling, cursor management
10//! - **Multi-Viewport Support**: Create and manage multiple OS windows (requires `multi-viewport` feature)
11//! - **DPI Awareness**: Proper handling of high-DPI displays
12//!
13//! # Example - Basic Usage
14//!
15//! ```rust,no_run
16//! use dear_imgui_rs::Context;
17//! use dear_imgui_winit::WinitPlatform;
18//! use winit::event_loop::EventLoop;
19//!
20//! let event_loop = EventLoop::new().unwrap();
21//! let mut imgui_ctx = Context::create();
22//! let mut platform = WinitPlatform::new(&mut imgui_ctx);
23//!
24//! // Use in your event loop...
25//! ```
26//!
27//! # Example - Multi-Viewport Support
28//!
29//! ```rust,no_run
30//! # #[cfg(feature = "multi-viewport")]
31//! # {
32//! use dear_imgui_rs::Context;
33//! use dear_imgui_winit::{WinitPlatform, multi_viewport};
34//! use winit::event_loop::EventLoop;
35//!
36//! let event_loop = EventLoop::new().unwrap();
37//! let mut imgui_ctx = Context::create();
38//! imgui_ctx.enable_multi_viewport();
39//!
40//! let mut platform = WinitPlatform::new(&mut imgui_ctx);
41//!
42//! // In your event loop callback (before updating platform windows):
43//! // let _guard = multi_viewport::set_event_loop_for_frame(event_loop);
44//! // multi_viewport::init_multi_viewport_support(&mut imgui_ctx, &window);
45//! # }
46//! ```
47
48mod cursor;
49mod events;
50mod input;
51#[cfg(feature = "multi-viewport")]
52pub mod multi_viewport;
53mod platform;
54#[cfg(test)]
55mod test_util;
56
57// Re-export main types
58pub use platform::{HiDpiMode, WinitPlatform};
dear_imgui_winit/lib.rs

dear_imgui_winit/
lib.rs
