Skip to main content

Crate dear_imgui_winit

Crate dear_imgui_winit 

Source
Expand description

Winit platform backend for Dear ImGui

This crate provides a platform backend for Dear ImGui that integrates with the winit windowing library. It handles window events, input processing, and platform-specific functionality including multi-viewport support.

§Features

  • Basic Platform Support: Window events, input handling, cursor management
  • Multi-Viewport Support: Create and manage multiple OS windows (requires multi-viewport feature)
  • DPI Awareness: Proper handling of high-DPI displays

§Example - Basic Usage

use dear_imgui_rs::Context;
use dear_imgui_winit::WinitPlatform;
use winit::event_loop::EventLoop;

let event_loop = EventLoop::new().unwrap();
let mut imgui_ctx = Context::create();
let mut platform = WinitPlatform::new(&mut imgui_ctx);

// Use in your event loop...

§Example - Multi-Viewport Support

use dear_imgui_rs::Context;
use dear_imgui_winit::{WinitPlatform, multi_viewport};
use winit::event_loop::EventLoop;

let event_loop = EventLoop::new().unwrap();
let mut imgui_ctx = Context::create();
imgui_ctx.enable_multi_viewport();

let mut platform = WinitPlatform::new(&mut imgui_ctx);

// In your event loop callback (before updating platform windows):
// let _guard = multi_viewport::set_event_loop_for_frame(event_loop);
// multi_viewport::init_multi_viewport_support(&mut imgui_ctx, &window);

Structs§

WinitPlatform
Main platform backend for Dear ImGui with winit integration

Enums§

HiDpiMode
DPI scaling mode for the platform