Struct conrod::backend::piston::window::Window

pub struct Window<W: BasicWindow = GlutinWindow> {
    pub window: W,
    pub context: GfxContext,
}

Contains everything required for controlling window, graphics, event loop.

Fields

window: W

The window.

context: GfxContext

Stores state associated with Gfx.

Methods

impl<W> Window<W> where
    W: BasicWindow,
    W::Event: GenericEvent, 

pub fn new(window: W, context: GfxContext) -> Self where
    W: OpenGLWindow, 

Creates a new piston window.

pub fn draw_2d<E, F, U>(&mut self, e: &E, f: F) -> Option<U> where
    W: OpenGLWindow,
    E: GenericEvent,
    F: FnOnce(Context, &mut G2d) -> U, 

Renders 2D graphics.

pub fn next_event<E>(&mut self, events: &mut E) -> Option<Event> where
    Self: EventWindow<E>, 

A wrapper around the EventWindow::next trait method. This avoids the need for users to import the EventWindow trait in most cases.

pub fn handle_event(&mut self, event: &Event<W::Event>)

Let window handle new event.

Trait Implementations

impl<W> BuildFromWindowSettings for Window<W> where
    W: BasicWindow + OpenGLWindow + BuildFromWindowSettings,
    W::Event: GenericEvent, 

fn build_from_window_settings(
    settings: &WindowSettings
) -> Result<Window<W>, String>

Builds the window from a WindowSettings object.

impl<W> BasicWindow for Window<W> where
    W: BasicWindow, 

type Event = <W as BasicWindow>::Event

The event type the window uses for incoming input.

fn should_close(&self) -> bool

Returns true if the window should close.

fn set_should_close(&mut self, value: bool)

Tells the window to close or stay open.

fn size(&self) -> Size

Gets the size of the window.

fn draw_size(&self) -> Size

Gets the draw size of the window.

fn swap_buffers(&mut self)

Swaps render buffers.

fn wait_event(&mut self) -> Self::Event

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

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

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

fn poll_event(&mut self) -> Option<Self::Event>

Polls an event from the window.

impl<W> AdvancedWindow for Window<W> where
    W: AdvancedWindow, 

fn get_title(&self) -> String

Gets a copy of the title of the window.

fn set_title(&mut self, title: String)

Sets the title of the window.

fn get_exit_on_esc(&self) -> bool

Gets whether to exit when pressing esc.

fn set_exit_on_esc(&mut self, value: bool)

Sets whether to exit when pressing esc.

fn set_capture_cursor(&mut self, value: bool)

Sets whether to capture/grab the cursor.

fn show(&mut self)

Shows the window.

fn hide(&mut self)

Hides the window.

fn get_position(&self) -> Option<Position>

Gets the position of window.

fn set_position<P: Into<Position>>(&mut self, pos: P)

Sets the position of window.

fn title(self, value: String) -> Self

Sets title on window.

fn exit_on_esc(self, value: bool) -> Self

Sets whether to exit when pressing the Esc button.

fn capture_cursor(self, value: bool) -> Self

Sets whether to capture/grab the cursor.

fn position<P>(self, val: P) -> Self where
    P: Into<Position>, 

Sets the position of window.

impl EventWindow<WindowEvents> for Window

fn next(&mut self, events: &mut WindowEvents) -> Option<Event>

receive next event from event loop and handle it