Struct pix_engine::window::WindowBuilder

source · [−]

pub struct WindowBuilder<'a> { /* private fields */ }

Expand description

Opens a new window by providing several window configuration functions.

In addition to the primary window created for you when calling PixEngine::run, you can open additional windows with various configurations and render to them using the PixState::with_window method.

Example

fn on_key_pressed(&mut self, s: &mut PixState, event: KeyEvent) -> PixResult<bool> {
    if let Key::O = event.key {
        let window_id = s.window()
            .with_title("New Window")
            .with_dimensions(800, 600)
            .position(10, 10)
            .resizable()
            .borderless()
            .build()?;
        self.windows.push(window_id);
        return Ok(true);
    }
    Ok(false)
}

Implementations

source

impl<'a> WindowBuilder<'a>

source

pub fn with_dimensions(&mut self, width: u32, height: u32) -> &mut Self

Set window dimensions.

source

pub fn with_title<S: Into<String>>(&mut self, title: S) -> &mut Self

Set a window title.

source

pub fn position(&mut self, x: i32, y: i32) -> &mut Self

Position the window at the given (x, y) coordinates of the display.

source

pub fn position_centered(&mut self) -> &mut Self

Position the window in the center of the display.

source

pub fn fullscreen(&mut self) -> &mut Self

Start window in fullscreen mode.

source

pub fn resizable(&mut self) -> &mut Self

Allow window resizing.

source

pub fn borderless(&mut self) -> &mut Self

Removes the window decoration.

source

pub fn icon(&mut self, icon: I) -> &mut Self where
I: Into<Icon>,

Set a window icon.

source

pub fn build(&mut self) -> PixResult<WindowId>

Create a new window from the WindowBuilder and return its id.

Errors

If the renderer fails to create a new window, then an error is returned.

Possible errors include the title containing a nul character, the position or dimensions being invalid values or overlowing and an internal renderer error such as running out of memory or a software driver issue.