[][src]Trait piston_window::Window

pub trait Window {
    fn set_should_close(&mut self, value: bool);
fn should_close(&self) -> bool;
fn size(&self) -> Size;
fn swap_buffers(&mut self);
fn wait_event(&mut self) -> Input;
fn wait_event_timeout(&mut self, timeout: Duration) -> Option<Input>;
fn poll_event(&mut self) -> Option<Input>;
fn draw_size(&self) -> Size; }

Trait representing the minimum requirements for defining a window.

This trait defines all the behavior needed for making an event loop.

An example of a working event loop can be found in the Piston-Tutorials repository under getting-started, or in the event loop examples.

Required methods

fn set_should_close(&mut self, value: bool)

Tells the window to close or stay open.

fn should_close(&self) -> bool

Returns true if the window should close.

fn size(&self) -> Size

Gets the size of the window.

fn swap_buffers(&mut self)

Swaps render buffers.

When this is set to false, this method must be called manually or through the window backend. By default it is set to true, so usually it is not needed in application code.

fn wait_event(&mut self) -> Input

Wait indefinitely for an input event to be available from the window.

fn wait_event_timeout(&mut self, timeout: Duration) -> Option<Input>

Wait for an input event to be available from the window or for the specified timeout to be reached.

Returns None only if there is no input event within the timeout.

fn poll_event(&mut self) -> Option<Input>

Polls an input event from the window.

Return None if no events available.

fn draw_size(&self) -> Size

Gets the draw size of the window.

This is equal to the size of the frame buffer of the inner window, excluding the title bar and borders.

This information is given to the client code through the Render event.

Loading content...

Implementations on Foreign Types

impl Window for GlutinWindow[src]

Loading content...

Implementors

impl Window for NoWindow[src]

impl<W> Window for PistonWindow<W> where
    W: Window
[src]

Loading content...