Struct VirtualWindow

pub struct VirtualWindow { /* private fields */ }

A virtual Cushy window.

This type allows rendering Cushy applications directly into any wgpu application.

Implementations

impl VirtualWindow

pub fn prepare(&mut self, device: &Device, queue: &Queue)

Prepares all necessary resources and operations necessary to render the next frame.

Errors

If during the preparation of rendering, the window is resized, Err(Resized) is returned and Cushy will immediately resize the graphics context and begin rendering again.

pub fn render( &mut self, pass: &RenderPassDescriptor<'_>, device: &Device, queue: &Queue, ) -> Option<SubmissionIndex>

Renders this window in a wgpu render pass created from pass.

Returns the submission index of the last command submission, if any commands were submitted.

pub fn render_with( &mut self, pass: &RenderPassDescriptor<'_>, device: &Device, queue: &Queue, additional_drawing: Option<&Drawing>, ) -> Option<SubmissionIndex>

Renders this window in a wgpu render pass created from pass.

Returns the submission index of the last command submission, if any commands were submitted.

pub fn render_into( &mut self, texture: &Texture, load_op: LoadOp<Color>, device: &Device, queue: &Queue, ) -> Option<SubmissionIndex>

Renders this window into texture after performing load_op.

pub fn graphics<'gfx>( &'gfx mut self, device: &'gfx Device, queue: &'gfx Queue, ) -> Graphics<'gfx>

Returns a new [kludgine::Graphics] context for this window.

pub fn request_close(&mut self) -> bool

Requests that the window close.

Returns true if the request should be honored.

pub fn set_focused(&mut self, focused: bool)

Sets the window’s focused status.

Being focused means that the window is expecting to be able to receive user input.

pub fn set_occluded(&mut self, occluded: bool)

Sets the window’s occlusion status.

This should only be set to true if the window is not visible at all to the end user due to being offscreen, minimized, or fully hidden behind other windows.

pub fn closed(&self) -> bool

Returns true if this window should no longer be open.

pub const fn state(&self) -> &VirtualState

Returns a reference to the window’s state.

pub const fn size(&self) -> Size<UPx>

Returns the current size of the window.

pub const fn dpi_scale(&self) -> Fraction

Returns the current DPI scale of the window.

pub fn resize( &mut self, new_size: Size<UPx>, new_scale: impl Into<Fraction>, queue: &Queue, )

Updates the dimensions and DPI scaling of the window.

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

Sets the window’s position.

pub fn keyboard_input( &mut self, device_id: DeviceId, input: KeyEvent, is_synthetic: bool, ) -> EventHandling

Provide keyboard input to this virtual window.

Returns whether the event was HANDLED or IGNORED.

pub fn mouse_wheel( &mut self, device_id: DeviceId, delta: MouseScrollDelta, phase: TouchPhase, ) -> EventHandling

Provides mouse wheel input to this window.

Returns whether the event was HANDLED or IGNORED.

pub fn ime(&mut self, ime: &Ime) -> EventHandling

Provides input manager events to this window.

Returns whether the event was HANDLED or IGNORED.

pub fn cursor_moved( &mut self, device_id: DeviceId, position: impl Into<Point<Px>>, )

Provides cursor movement events to this window.

pub fn cursor_left(&mut self)

Notifies the window that the cursor is no longer within the window.

pub fn mouse_input( &mut self, device_id: DeviceId, state: ElementState, button: MouseButton, ) -> EventHandling

Provides mouse input events to tihs window.

Returns whether the event was HANDLED or IGNORED.