Struct BackendSelector

pub struct BackendSelector { /* private fields */ }

Use the BackendSelector to configure one of Slint’s built-in backends with a renderer to accomodate 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

impl BackendSelector

pub fn new() -> BackendSelector

Creates a new BackendSelector.

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.

pub fn require_opengl_es(self) -> BackendSelector

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

pub fn require_opengl(self) -> BackendSelector

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

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.

pub fn require_metal(self) -> BackendSelector

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

pub fn require_vulkan(self) -> BackendSelector

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

pub fn require_d3d(self) -> BackendSelector

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

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.

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.

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

impl Drop for BackendSelector

fn drop(&mut self)

Executes the destructor for this type.