Struct quicksilver::prelude::Window

pub struct Window { /* fields omitted */ }

The window currently in use

Methods

impl Window

pub fn clear_temporary_states(&mut self)

Transition temporary input states (Pressed, Released) into sustained ones (Held, NotPressed)

pub fn view(&self) -> View

Get the view from the window

pub fn set_view(&mut self, view: View)

Set the view the window uses

pub fn resize_strategy(&self) -> ResizeStrategy

Get the resize strategy used by the window

pub fn set_resize_strategy(&mut self, resize: ResizeStrategy)

Switch the strategy the window uses to display content when the available area changes

pub fn screen_size(&self) -> Vector

Get the screen size

pub fn unproject(&self) -> Transform

Get the unprojection matrix according to the View

pub fn project(&self) -> Transform

Get the projection matrix according to the View

pub fn keyboard(&self) -> &Keyboard

Get a reference to the keyboard

pub fn mouse(&self) -> Mouse

Get an instance of a mouse, projected into the current View

pub fn clear(&mut self, color: Color) -> Result<()>

Clear the screen to a given color

The blend mode is also automatically reset, and any un-flushed draw calls are dropped.

pub fn clear_letterbox_color(
    &mut self,
    color: Color,
    letterbox: Color
) -> Result<()>

Clear the screen to a given color, with a given letterbox color

The blend mode is also automatically reset, and any un-flushed draw calls are dropped.

pub fn flush(&mut self) -> Result<()>

Flush the current buffered draw calls

Attributes like z-ordering will be reset: all items drawn after a flush will always draw over all items drawn before a flush.

Note that calling this can be an expensive operation

pub fn set_blend_mode(&mut self, blend: BlendMode) -> Result<()>

Set the blend mode for the window

This will flush all of the drawn items to the screen and switch to the new blend mode.

pub fn reset_blend_mode(&mut self) -> Result<()>

Reset the blend mode for the window to the default alpha blending

This will flush all of the drawn items to the screen

pub fn gamepads(&self) -> &Vec<Gamepad>

Get a reference to the connected gamepads

pub fn draw<'a>(
    &'a mut self,
    draw: &impl Drawable,
    bkg: impl Into<Background<'a>>
)

Draw a Drawable to the window, which will be finalized on the next flush

pub fn draw_ex<'a>(
    &'a mut self,
    draw: &impl Drawable,
    bkg: impl Into<Background<'a>>,
    trans: Transform,
    z: impl Scalar
)

Draw a Drawable to the window with more options provided (draw exhaustive)

pub fn mesh(&mut self) -> &mut Mesh

The mesh the window uses to draw

pub fn update_rate(&self) -> f64

The ideal delay between two calls to update in milliseconds

pub fn set_update_rate(&mut self, update_rate: f64)

Set the desired time between two calls to update in milliseconds

pub fn draw_rate(&self) -> f64

The ideal delay between two calls to draw in milliseconds

pub fn set_draw_rate(&mut self, draw_rate: f64)

Set the desired time between two calls to draw in milliseconds

pub fn current_fps(&self) -> f64

Get the delay between the last two draw frames

pub fn average_fps(&self) -> f64

Get the average framerate over the history of the app

pub fn max_updates(&self) -> u32

Get the maximum number of updates that are allowed to run in a frame

0 means no limitation

pub fn set_max_updates(&mut self, max_updates: u32)

Set the maximum number of updates that are allowed to run in a frame

0 means no limitation

pub fn set_show_cursor(&mut self, show_cursor: bool)

Deprecated since 0.3.5:

please use set_cursor instead

Set if the cursor should be visible when over the application

pub fn set_cursor(&mut self, cursor: MouseCursor)

Set current cursor

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

Set the title of the window (or tab on mobile)

pub fn get_fullscreen(&self) -> bool

Get if the application is currently fullscreen

pub fn set_fullscreen(&mut self, fullscreen: bool)

Set if the application is currently fullscreen

pub fn set_size(&mut self, size: impl Into<Vector>)

Resize the window to the given size

pub fn close(&mut self)

Close the application without triggering the onclose handler

On desktop, this closes the window, and on the web it removes the canvas from the page

pub fn screenshot(&mut self, format: PixelFormat) -> DynamicImage

Create a screenshot as an image

If a surface is active, an image of that surface is generated. If no surface is activated, an image of what has been drawn to the window is generated. Taking a screenshot in the midst of a draw call may have unexpected results.