Struct piston_window::NoWindow

pub struct NoWindow { /* fields omitted */ }

A window without user interface, often used in server event loops.

This structure holds just enough state to return values that were set. The size can be changed because the event loop does not emit Render events when the width or height is zero.

Implementations

impl NoWindow

pub fn new(settings: &WindowSettings) -> NoWindow

Creates a new NoWindow.

Trait Implementations

impl AdvancedWindow for NoWindow

pub fn get_title(&self) -> String

Gets a copy of the title of the window.

pub fn set_title(&mut self, value: String)

Sets the title of the window.

pub fn get_exit_on_esc(&self) -> bool

Gets whether to exit when pressing esc.

pub fn set_exit_on_esc(&mut self, _value: bool)

Sets whether to exit when pressing esc.

pub fn get_automatic_close(&self) -> bool

Gets whether the window will automatically close when attempting to close it.

pub fn set_automatic_close(&mut self, value: bool)

Sets whether the window will automatically close when attempting to close it. If this is disabled, attempts to close the window can be detected via an Input::Close(..) event, and Window::set_should_close() can be called to actually close the window.

pub fn set_capture_cursor(&mut self, _value: bool)

Sets whether to capture/grab the cursor.

pub fn show(&mut self)

Shows the window.

pub fn hide(&mut self)

Hides the window.

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

Gets the position of window.

pub fn set_position<P>(&mut self, val: P) where
    P: Into<Position>, 

Sets the position of window.

pub fn set_size<S>(&mut self, val: S) where
    S: Into<Size>, 

Sets the window size.

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

Sets title on window.

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

Sets whether to exit when pressing the Esc button.

pub fn automatic_close(self, value: bool) -> Self

Sets whether the window will automatically close when attempting to close it. If this is disabled, attempts to close the window can be detected via an Input::Close(..) event, and Window::set_should_close() can be called to actually close the window.

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

Sets whether to capture/grab the cursor.

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

Sets the position of window.

impl BuildFromWindowSettings for NoWindow

pub fn build_from_window_settings(
    settings: &WindowSettings
) -> Result<NoWindow, Box<dyn Error + 'static, Global>>

Errors

This function will always return without error.

impl Window for NoWindow

pub fn should_close(&self) -> bool

Returns true if the window should close.

pub fn set_should_close(&mut self, value: bool)

Tells the window to close or stay open.

pub fn size(&self) -> Size

Gets the size of the window.

pub fn swap_buffers(&mut self)

Swaps render buffers.

pub fn wait_event(&mut self) -> Event

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

pub fn wait_event_timeout(&mut self, _timeout: Duration) -> Option<Event>

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

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

Polls an input event from the window.

pub fn draw_size(&self) -> Size

Gets the draw size of the window.