Struct easy_imgui_window::MainWindowWithRenderer

pub struct MainWindowWithRenderer { /* private fields */ }

This is a MainWindow plus a Renderer. It is the ultimate easy-imgui object.

Implementations

impl MainWindowWithRenderer

pub fn new(main_window: MainWindow) -> MainWindowWithRenderer

Creates a new Renderer and attaches it to the given window.

pub fn new_with_renderer( main_window: MainWindow, renderer: Renderer ) -> MainWindowWithRenderer

Attaches the given window and renderer together.

pub fn set_idle_time(&mut self, time: Duration)

Sets the time after which the UI will stop rendering, if there is no user input.

pub fn set_idle_frame_count(&mut self, frame_count: u32)

Sets the frame count after which the UI will stop rendering, if there is no user input.

Note that by default V-Sync is enabled, and that will affect the frame rate.

pub fn renderer(&mut self) -> &mut Renderer

Gets a reference to the inner renderer.

pub fn main_window(&mut self) -> &mut MainWindow

Gets a reference to the inner window.

pub fn ping_user_input(&mut self)

Forces a rebuild of the UI.

By default the window will stop rendering the UI after a while without user input. Use this function to force a redraw because of some external factor.

pub fn do_event<EventUserType>( &mut self, app: &mut impl UiBuilder, event: &Event<EventUserType>, _w: &EventLoopWindowTarget<EventUserType> ) -> ControlFlow<()>

The main event function, to be called from your event loop.

It returns std::ops::ControlFlow::Break for the event winit::event::WindowEvent::CloseRequested as a convenience. You can use it to break the main loop, or ignore it, as you see fit.