Struct pix_engine::engine::Builder

pub struct Builder { /* private fields */ }

Builds a PixEngine instance by providing several configration functions.

Example

fn main() -> PixResult<()> {
    let mut engine = PixEngine::builder()
        .with_title("My App")
        .position(10, 10)
        .resizable()
        .with_frame_rate()
        .icon("myapp.png")
        .build()?;
    let mut app = MyApp;
    engine.run(&mut app)
}

Implementations

impl Builder

pub fn new() -> Self

Constructs a Builder.

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

Set a window title.

pub fn with_font(&mut self, font: Font) -> &mut Self

Set font for text rendering.

pub fn with_font_size(&mut self, size: u32) -> &mut Self

Set font size for text rendering.

pub fn with_theme(&mut self, theme: Theme) -> &mut Self

Set theme for UI rendering.

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

Set a window icon.

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. This is the default.

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

Set the rendering scale of the current canvas. Drawing coordinates are scaled by x/y factors before being drawn to the canvas.

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

Set audio sample rate in Hz (samples per second). Defaults to device fallback sample rate.

pub fn audio_channels(&mut self, channels: u8) -> &mut Self

Set number of audio channels (1 for Mono, 2 for Stereo, etc). Defaults to device fallback number of channels.

pub fn audio_buffer_size(&mut self, buffer_size: u16) -> &mut Self

Set audio buffer size in samples. Defaults to device fallback sample size.

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

Start window in fullscreen mode.

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

Set the window to synchronize frame rate to the screens refresh rate (VSync).

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

Allow window resizing.

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

Removes the window decoration.

pub fn with_deadzone(&mut self, value: i32) -> &mut Self

Alter the joystick axis deadzone.

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 AppState::on_update is called.

pub fn with_texture_cache(&mut self, size: usize) -> &mut Self

Set a custom texture cache size other than the default of 20. Affects font family and image rendering caching operations.

pub fn with_text_cache(&mut self, size: usize) -> &mut Self

Set a custom text cache size other than the default of 500. Affects text rendering caching operations.

pub fn build(&self) -> PixResult<PixEngine>

Convert Builder to a PixEngine instance.

Errors

If the engine fails to create a new renderer, 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.

Trait Implementations

impl Debug for Builder

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

Formats the value using the given formatter.

impl Default for Builder

fn default() -> Self

Returns the “default value” for a type.