Struct pix_engine::core::engine::PixEngineBuilder

pub struct PixEngineBuilder { /* fields omitted */ }

Builds a PixEngine instance by providing several configration functions.

Implementations

impl PixEngineBuilder

pub fn new() -> Self

Constructs a PixEngineBuilder.

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

Set a window title.

pub fn with_font<P>(&mut self, path: P, size: u32) -> &mut Self where
    P: Into<PathBuf>, 

Set a True-Type Font for text rendering.

pub fn icon<P>(&mut self, path: P) -> &mut Self where
    P: Into<PathBuf>, 

Set a window icon.

pub fn asset_dir<P>(&mut self, path: P) -> &mut Self where
    P: Into<PathBuf>, 

Set the temporary directory for extraction of static library assets.

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

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

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

Position the window in the center of the display.

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

Set window dimensions.

pub fn scale(&mut self, x: f32, y: f32) -> &mut Self

Scales the window.

pub fn audio_sample_rate(&mut self, sample_rate: i32) -> &mut Self

Set audio sample rate.

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

Start window in fullscreen mode.

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

Enable VSync.

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

Allow window resizing.

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

Removes the window decoration.

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

Enables high-DPI on displays that support it.

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

Starts engine with window hidden.

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

Enable average frame rate (FPS) in title.

pub fn target_frame_rate(&mut self, rate: usize) -> &mut Self

Set a target frame rate to render at, controls how often on_update is called.

pub fn build(&self) -> PixEngine

Convert PixEngineBuilder to a PixEngine instance.

Trait Implementations

impl Debug for PixEngineBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for PixEngineBuilder

fn default() -> PixEngineBuilder

Returns the “default value” for a type.