Struct freya_renderer::LaunchConfig

pub struct LaunchConfig<'a, T: Clone = ()> {
    pub state: Option<T>,
    pub window_config: WindowConfig,
    pub embedded_fonts: EmbeddedFonts<'a>,
    pub plugins: PluginsManager,
    pub default_fonts: Vec<String>,
}

Launch configuration.

Fields

state: Option<T>

window_config: WindowConfig

embedded_fonts: EmbeddedFonts<'a>

plugins: PluginsManager

default_fonts: Vec<String>

Implementations

impl<'a, T: Clone> LaunchConfig<'a, T>

pub fn new() -> LaunchConfig<'a, T>

impl LaunchConfig<'_, ()>

pub fn load_icon(icon: &[u8]) -> Icon

impl<'a, T: Clone> LaunchConfig<'a, T>

pub fn with_size(self, width: f64, height: f64) -> Self

Specify a Window size.

pub fn with_min_size(self, min_width: f64, min_height: f64) -> Self

Specify a minimum Window size.

pub fn with_max_size(self, max_width: f64, max_height: f64) -> Self

Specify a maximum Window size.

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

Whether the Window will have decorations or not.

pub fn with_title(self, title: &'static str) -> Self

Specify the Window title.

pub fn with_transparency(self, transparency: bool) -> Self

Make the Window transparent or not.

pub fn with_state(self, state: T) -> Self

Pass a custom value that your app will consume.

pub fn with_background(self, background: &str) -> Self

Specify the Window background color.

pub fn with_visible(self, visible: bool) -> Self

Specify the Window visibility at launch.

pub fn with_font(self, font_name: &'a str, font: &'a [u8]) -> Self

Embed a font.

pub fn without_default_fonts(self) -> Self

Clear default fonts.

pub fn with_default_font(self, font_name: &str) -> Self

Regiter a default font.

pub fn with_icon(self, icon: Icon) -> Self

Specify the Window icon.

pub fn on_setup(self, callback: fn(_: &mut Window)) -> Self

Register a callback that will be executed when the window is created.

pub fn on_exit(self, callback: fn(_: &mut Window)) -> Self

Register a callback that will be executed when the window is closed.

pub fn with_plugin(self, plugin: impl FreyaPlugin + 'static) -> Self

Add a new plugin.

pub fn with_window_attributes( self, window_attributes_hook: impl FnOnce(WindowAttributes) -> WindowAttributes + 'static, ) -> Self

Register a Window Attributes hook.

pub fn with_event_loop_builder( self, event_loop_builder_hook: impl FnOnce(&mut EventLoopBuilder<EventMessage>) + 'static, ) -> Self

Register an Event Loop Builder hook.

Trait Implementations

impl<'a, T: Clone> Default for LaunchConfig<'a, T>

fn default() -> Self

Returns the “default value” for a type.