Struct kludgine::app::Window

pub struct Window<'window, WindowEvent = ()>
where
    WindowEvent: Send + 'static,
{ /* private fields */ }

An open window.

Implementations

impl<'window, WindowEvent> Window<'window, WindowEvent>

where WindowEvent: Send + 'static,

pub fn handle(&self) -> WindowHandle<WindowEvent>

Returns a handle to this window, which can be used to send WindowEvents to it.

pub fn app(&self) -> App<WindowEvent>

Returns a handle to the application.

This is useful for opening additional windows in a multi-window application.

pub fn close(&mut self)

Closes this window as soon as control returns to Kludgine.

pub fn position(&self) -> Point<Px>

Returns the current position of the window.

pub fn set_position(&self, position: Point<Px>)

Sets the current position of the window.

pub fn inner_size(&self) -> Size<UPx>

Returns the inner size of the window.

pub fn winit(&self) -> &Window

Returns a reference to the underlying winit window.

pub fn set_inner_size(&self, inner_size: Size<UPx>)

Sets the inner size of the window.

pub const fn focused(&self) -> bool

Returns true if the window is currently focused for keyboard input.

pub const fn theme(&self) -> Theme

Returns the current user interface theme for the window.

pub const fn ocluded(&self) -> bool

Returns true if the window is currenly not visible because it is completely hidden behind other windows, offcreen, or minimized.

pub fn title(&self) -> String

Returns the current title of the window.

pub fn set_title(&mut self, new_title: &str)

Sets the title of the window.

pub fn set_ime_allowed(&self, allowed: bool)

Sets whether IME input is allowed on the window.

pub fn set_ime_purpose(&self, purpose: ImePurpose)

Sets the IME purpose.

pub fn set_ime_cursor_area(&self, area: Rect<UPx>)

Sets the cursor area for IME input suggestions.

pub fn redraw_in(&mut self, duration: Duration)

Sets the window to redraw after a duration.

If the window is already set to redraw sooner, this function does nothing.

pub fn redraw_at(&mut self, time: Instant)

Sets the window to redraw at the provided time.

If the window is already set to redraw sooner, this function does nothing.

pub fn set_needs_redraw(&mut self)

Sets the window to redraw as soon as it can.

pub const fn elapsed(&self) -> Duration

Returns the duration that has elapsed since the last frame start and the current frame start.

This value is calculated once per frame and will not update between calls within the same event.

pub const fn last_frame_rendered_in(&self) -> Duration

Returns the duration taken between when the last frame’s redraw started and when the surface’s frame was presented.

pub fn cursor_position(&self) -> Option<Point<Px>>

Returns the position of the mouse cursor within this window, if the cursor is currently above the window.

pub fn mouse_button_pressed(&self, button: MouseButton) -> bool

Returns true if the given button is currently pressed.

pub fn key_pressed(&self, key: impl Into<PhysicalKey>) -> bool

Returns true if the given virtual key code is currently pressed.

pub fn modifiers(&self) -> Modifiers

Returns currently active modifiers.

pub fn set_min_inner_size(&self, min_size: Option<Size<UPx>>)

Sets the window’s minimum inner size.

pub fn set_max_inner_size(&self, max_size: Option<Size<UPx>>)

Sets the window’s maximum inner size.