Crate easy_imgui_window

Source
Expand description

This crate makes it easy to build applications with Dear ImGui as their main GUI.

§Features

  • clipboard (default): clipboard integration, via the arboard crate.
  • freetype: use libfreetype for TTF font loading. It requires a precompiled native FreeType shared library.

Re-exports§

pub use easy_imgui;
pub use easy_imgui_renderer;
pub use easy_imgui_sys;
pub use glutin;
pub use winit;

Modules§

clipboard
Easy wrapper for the clipboard functions.
conv
Helper module to convert between common types.

Structs§

AppHandler
Default implementation for winit::application::ApplicationHandler.
Args
This type is an aggregate of values retured by AppHandler.
EventFlags
These flags can be used to customize the window_event function.
EventResult
The result of processing an event in the ImGui loop.
FutureBackCaller
Helper type to get the application arguments during an idle future.
FutureHandle
A handle to a running idle future.
FutureHandleGuard
Helper newtype that cancels a future on drop.
LocalProxy
This type is a wrapper for EventLoopProxy that is not Send.
MainWindow
This type represents a winit window and an OpenGL context.
MainWindowIdler
This struct handles the main loop going to idle when there is no user input for a while.
MainWindowPieces
Helper struct to call window_event without owning the Window.
MainWindowStatus
This struct maintains basic window info to be kept across events.
MainWindowWithRenderer
This is a MainWindow plus a Renderer. It is the ultimate easy-imgui object. Instead of a literal MainWindow you can use any type that implements MainWindowRef.
NoScale
NewType to disable the HiDPI scaling.

Enums§

AppEvent
The main event type to be used with winit::EventLoop.

Traits§

Application
Trait that connects a UiBuilder with an AppHandler.
EventLoopExt
Helper trait to extend winit::EventLoopProxy with useful functions.
MainWindowRef
This traits grants access to a Window.

Functions§

about_to_wait
Corresponds to winit’s ApplicationHandler::about_to_wait.
new_events
Corresponds to winit’s ApplicationHandler::new_events.
window_event
Corresponds to winit’s ApplicationHandler::window_event.