Skip to main content

LaunchConfig

Struct LaunchConfig 

Source
pub struct LaunchConfig { /* private fields */ }
Expand description

Configuration for the initial state of the application.

Use this to register windows, plugins, fonts, and other settings that should be ready before the application starts.

Implementations§

Source§

impl LaunchConfig

Source

pub fn new() -> LaunchConfig

Source

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

Load a window icon from image bytes. Pass the result to WindowConfig::with_icon.

Source§

impl LaunchConfig

Source

pub fn with_window(self, window_config: WindowConfig) -> Self

Register a window configuration. You can call this multiple times.

To create windows dynamically after the application has started, see crate::extensions::WinitPlatformExt::launch_window().

Source

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

Register a plugin. Replaces any existing plugin with the same ID.

Source

pub fn with_font( self, font_name: impl Into<Cow<'static, str>>, font: impl Into<Bytes>, ) -> Self

Embed a font.

Source

pub fn with_fallback_font( self, font_family: impl Into<Cow<'static, str>>, ) -> Self

Register a fallback font. Will be used if the default fonts are not available.

Source

pub fn with_default_font(self, font_name: impl Into<Cow<'static, str>>) -> Self

Register a default font. Will be used if found.

Source

pub fn with_exit_on_close(self, exit_on_close: bool) -> Self

Whether to exit the event loop when all windows are closed. Defaults to true. Set to false to keep the event loop alive even when no windows remain.

Source

pub fn with_future<F, Fut>(self, task: F) -> Self
where F: FnOnce(LaunchProxy) -> Fut + 'static, Fut: Future<Output = ()> + 'static,

Register a single-thread launch task. The task receives a LaunchProxy that can be used to get access to RendererContext. The provided callback should return a 'static future which will be scheduled on the renderer thread and polled until completion.

Source

pub fn with_event_loop(self, event_loop: EventLoop<NativeEvent>) -> Self

Provide a custom winit EventLoop to use instead of the default one. This allows configuring platform-specific options on the event loop builder before passing it.

Source

pub fn with_gpu_resource_cache_limit( self, gpu_resource_cache_limit: usize, ) -> Self

Set the Skia GPU resource cache limit, in bytes, applied to every window. Defaults to 1 GB.

Trait Implementations§

Source§

impl Default for LaunchConfig

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> NoneValue for T
where T: Default,

Source§

type NoneType = T

Source§

fn null_value() -> T

The none-equivalent value.
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<R, P> ReadPrimitive<R> for P
where R: Read + ReadEndian<P>, P: Default,

Source§

fn read_from_little_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_little_endian().
Source§

fn read_from_big_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_big_endian().
Source§

fn read_from_native_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_native_endian().
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more