BackendSelector

Struct BackendSelector 

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

Use the BackendSelector to configure one of Slint’s built-in backends with a renderer to accommodate specific needs of your application. This is a programmatic substitute for the SLINT_BACKEND environment variable.

For example, to configure Slint to use a renderer that supports OpenGL ES 3.0, configure the BackendSelector as follows:

let selector = BackendSelector::new().require_opengl_es_with_version(3, 0);
if let Err(err) = selector.select() {
    eprintln!("Error selecting backend with OpenGL ES support: {err}");
}

Implementations§

Source§

impl BackendSelector

Source

pub fn new() -> BackendSelector

Creates a new BackendSelector.

Source

pub fn require_opengl_es_with_version( self, major: u8, minor: u8, ) -> BackendSelector

Adds the requirement to the selector that the backend must render with OpenGL ES and the specified major and minor version.

Source

pub fn require_opengl_es(self) -> BackendSelector

Adds the requirement to the selector that the backend must render with OpenGL ES.

Source

pub fn require_opengl(self) -> BackendSelector

Adds the requirement to the selector that the backend must render with OpenGL.

Source

pub fn require_opengl_with_version( self, major: u8, minor: u8, ) -> BackendSelector

Adds the requirement to the selector that the backend must render with OpenGL and the specified major and minor version.

Source

pub fn require_metal(self) -> BackendSelector

Adds the requirement to the selector that the backend must render with Apple’s Metal framework.

Source

pub fn require_vulkan(self) -> BackendSelector

Adds the requirement to the selector that the backend must render with Vulkan.

Source

pub fn require_d3d(self) -> BackendSelector

Adds the requirement to the selector that the backend must render with Direct 3D.

Source

pub fn renderer_name(self, name: String) -> BackendSelector

Adds the requirement that the selected renderer must match the given name. This is equivalent to setting the SLINT_BACKEND=name environment variable and requires that the corresponding renderer feature is enabled. For example, to select the Skia renderer, enable the renderer-skia feature and call this function with skia as argument.

Source

pub fn backend_name(self, name: String) -> BackendSelector

Adds the requirement that the selected backend must match the given name. This is equivalent to setting the SLINT_BACKEND=name environment variable and requires that the corresponding backend feature is enabled. For example, to select the winit backend, enable the backend-winit feature and call this function with winit as argument.

Source

pub fn select(self) -> Result<(), PlatformError>

Completes the backend selection process and tries to combine with specified requirements with the different backends and renderers enabled at compile time. On success, the selected backend is automatically set to be active. Returns an error if the requirements could not be met.

Trait Implementations§

Source§

impl Default for BackendSelector

Source§

fn default() -> BackendSelector

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

impl Drop for BackendSelector

Source§

fn drop(&mut self)

Executes the destructor for this 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> DowncastSync for T
where T: Any + Send + Sync,

Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
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, 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
Source§

impl<T> ErasedDestructor for T
where T: 'static,