Trait window::Window [−] [src]

pub trait Window {
    type Event;
    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) -> Self::Event;
    fn wait_event_timeout(&mut self, timeout: Duration) -> Option<Self::Event>;
    fn poll_event(&mut self) -> Option<Self::Event>;
    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.

Associated Types

The event type the window uses for incoming input.

Usually, this will be event_loop::Input, but may vary between implementations if more or less information is available.

For example, if a backend does not support mouse input because it is designed to be sent over a network, then it might use a different event type.

Required Methods

Tells the window to close or stay open.

Returns true if the window should close.

Gets the size of the window.

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.

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

To read events in application code, look at the Events trait instead.

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

Return None only if there is no event within the timeout.

To read events in application code, look at the Events trait instead.

Polls an event from the window.

Return None if no events available.

To read events in application code, look at the Events trait instead.

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.

Implementors