Struct riddle_platform_winit::WindowBuilder

pub struct WindowBuilder { /* fields omitted */ }

Builder for Window instances.

Default values:

• Width: 800
• Height: 600
• Title: Riddle Window
• Resizeable: true
• Cursor Visible: true

Example

use riddle::{*, platform::*};

fn main() -> Result<(), RiddleError> {
    let rdl =  RiddleLib::new()?;

    let window: WindowHandle = WindowBuilder::new()
        .title("A Sample Title")
        .dimensions(320, 240)
        .build(rdl.context())?;

    // The window has been created, and is visible now.
    // [.. the rest of the application ..]
}

Implementations

impl WindowBuilder

pub fn new() -> Self

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

Set the dimensions of the window, in logical units.

The pixel dimensions of the window may be different if the display's scale factor does not equal 1.

pub fn resizeable(&mut self, resizeable: bool) -> &mut Self

Set whether the window is resizeable.

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

Set the window's title.

pub fn cursor_visible(&mut self, cursor_visible: bool) -> &mut Self

Set whether the system cursor will be displayed for the created window.

pub fn build<'a, C>(&self, ctx: C) -> Result<WindowHandle, PlatformError> where
    C: Borrow<PlatformContext<'a>>, 

Build the new window, returning a handle to the new window.

The window will be visible as long as the handle, or a clone of it, is alive.

Trait Implementations

impl Default for WindowBuilder

fn default() -> Self

Returns the "default value" for a type.