Struct Config

pub struct Config { /* private fields */ }

Pel configuration.

Implementations

impl Config

pub fn vsync(self, vsync: bool) -> Self

Request pel window to have vsync enabled.

By default, vsync is enabled.

pub fn srgb(self, srgb: bool) -> Self

Request pel window to have sRGB enabled.

By default, sRGB is enabled.

pub fn window_size(self, width: u32, height: u32) -> Self

Requests pel window client area to be of specific size in logical pixels.

By default, platform defaults are used.

pub fn min_window_size(self, width: u32, height: u32) -> Self

Requests minimum pel window client area to be no less than specified in logical pixels.

By default, platform defaults are used.

pub fn max_window_size(self, width: u32, height: u32) -> Self

Requests maximum pel window client area to be no more than specified in logical pixels.

By default, platform defaults are used.

pub fn resizable(self, resizable: bool) -> Self

Requests pel window to be resizable.

By default, window is resizable.

pub fn maximized(self, maximized: bool) -> Self

Requests pel window to appear maximized when created.

By default, window isn’t maximized.

pub fn decorations(self, decorations: bool) -> Self

Requests pel window to have border.

By default, window does have a border.

pub fn icon<S: Into<Surface>>(self, icon: S) -> Self

Requests pel window to use given icon.

By default, window has no icon.

pub fn title<T: Into<String>>(self, title: T) -> Self

Requests pel window to have a specific title.

By default, window title is "pel window".

pub fn fullscreen(self, fullscreen: bool) -> Self

Requests pel window to be created in fullscreen mode.

By default, window is not in fullscreen mode.

pub fn always_on_top(self, always_on_top: bool) -> Self

Requests pel window to be in always on top mode.

By default, window isn’t in always on top mode.

pub fn texture_size(self, width: usize, height: usize) -> Self

Requests window pel texture to be of specific size in logical pixels.

This is the “resolution” of your application, in which you will be working in, and it is independent of physical window size.

By default, texture size is None and it must be set manually or builder will panic.

Examples found in repository

examples/minimal.rs (line 10)

fn main() {
    pel::new()
    // it is mandatory to set desired texture size
    .texture_size(1, 1)
    // event loop requires user type that implements pel::Events
    .run(Example);
}

examples/events.rs (line 62)

fn main() {
    pel::new()
    // it is mandatory to set desired texture size
    .texture_size(1, 1)
    // event loop requires user type that implements pel::Events
    .run(EventHandler);
}

pub fn run<E>(self, event_handler: E) -> !

where E: Events + 'static,

Starts pel event loop.

Due to cross-platform limitations, this method should only be called in the main thread.

See documentation of Events for more information.

Examples found in repository

examples/minimal.rs (line 12)

fn main() {
    pel::new()
    // it is mandatory to set desired texture size
    .texture_size(1, 1)
    // event loop requires user type that implements pel::Events
    .run(Example);
}

examples/events.rs (line 64)

fn main() {
    pel::new()
    // it is mandatory to set desired texture size
    .texture_size(1, 1)
    // event loop requires user type that implements pel::Events
    .run(EventHandler);
}

Trait Implementations

impl Default for Config

fn default() -> Self

Returns the “default value” for a type.