Slint

https://docs.rs/slint/latest
Admin
Slint is a declarative UI framework for building user interfaces in Rust with a design markup...
Tokens:202,563
Snippets:2,796
Trust Score:9.7
Update:2 months ago
Show doc for...
Tokens:
Raw
### Install and Run with cargo-apk

Source: https://docs.rs/slint/latest/slint/android/index.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Commands to install the cargo-apk tool and deploy the application to an Android device.

```bash
cargo install cargo-apk
```

```bash
cargo apk run --target aarch64-linux-android --lib
```

--------------------------------

### Install Android Build Targets and Tools

Source: https://docs.rs/slint/latest/slint/android/index.html?search=

Commands to add the necessary Rust target and install the cargo-apk tool for deployment.

```bash
rustup target add aarch64-linux-android
```

```bash
cargo install cargo-apk
```

```bash
cargo apk run --target aarch64-linux-android --lib
```

--------------------------------

### Trim Start Matches Example

Source: https://docs.rs/slint/latest/slint/struct.SharedString.html?search=std%3A%3Avec

Demonstrates removing leading characters from a string based on a slice of characters.

```rust
let x: &[_] = &['1', '2'];
assert_eq!("12foo1bar12".trim_start_matches(x), "foo1bar12");
```

--------------------------------

### Install cargo-apk

Source: https://docs.rs/slint/latest/slint/android/index.html

Install the cargo-apk subcommand to facilitate building and deploying Android APKs.

```bash
cargo install cargo-apk
```

--------------------------------

### ReverseModel Usage Examples

Source: https://docs.rs/slint/latest/slint/struct.ReverseModel.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Examples demonstrating how to reverse a VecModel using ReverseModel, the ModelExt::reverse shortcut, and how to handle shared models.

```rust
let model = VecModel::from(vec![
    SharedString::from("Lorem"),
    SharedString::from("ipsum"),
    SharedString::from("dolor"),
]);

let reverse_model = ReverseModel::new(model);

assert_eq!(reverse_model.row_data(0).unwrap(), SharedString::from("dolor"));
assert_eq!(reverse_model.row_data(1).unwrap(), SharedString::from("ipsum"));
assert_eq!(reverse_model.row_data(2).unwrap(), SharedString::from("Lorem"));
```

```rust
let reverse_model = VecModel::from(vec![
    SharedString::from("Lorem"),
    SharedString::from("ipsum"),
    SharedString::from("dolor"),
]).reverse();
assert_eq!(reverse_model.row_data(0).unwrap(), SharedString::from("dolor"));
assert_eq!(reverse_model.row_data(1).unwrap(), SharedString::from("ipsum"));
assert_eq!(reverse_model.row_data(2).unwrap(), SharedString::from("Lorem"));
```

```rust
let model = Rc::new(VecModel::from(vec![
    SharedString::from("Lorem"),
    SharedString::from("ipsum"),
    SharedString::from("dolor"),
]));

let reverse_model = ReverseModel::new(model.clone());

assert_eq!(reverse_model.row_data(0).unwrap(), SharedString::from("dolor"));
assert_eq!(reverse_model.row_data(1).unwrap(), SharedString::from("ipsum"));
assert_eq!(reverse_model.row_data(2).unwrap(), SharedString::from("Lorem"));

model.push(SharedString::from("opsom"));

assert_eq!(reverse_model.row_data(0).unwrap(), SharedString::from("opsom"));
assert_eq!(reverse_model.row_data(1).unwrap(), SharedString::from("dolor"));
assert_eq!(reverse_model.row_data(2).unwrap(), SharedString::from("ipsum"));
assert_eq!(reverse_model.row_data(3).unwrap(), SharedString::from("Lorem"));
```

--------------------------------

### Reverse Split Examples

Source: https://docs.rs/slint/latest/slint/struct.SharedString.html?search=std%3A%3Avec

Examples of splitting strings in reverse order using various pattern types.

```rust
let v: Vec<&str> = "Mary had a little lamb".rsplit(' ').collect();
assert_eq!(v, ["lamb", "little", "a", "had", "Mary"]);

let v: Vec<&str> = "".rsplit('X').collect();
assert_eq!(v, [""]);

let v: Vec<&str> = "lionXXtigerXleopard".rsplit('X').collect();
assert_eq!(v, ["leopard", "tiger", "", "lion"]);

let v: Vec<&str> = "lion::tiger::leopard".rsplit("::").collect();
assert_eq!(v, ["leopard", "tiger", "lion"]);
```

```rust
let v: Vec<&str> = "abc1defXghi".rsplit(|c| c == '1' || c == 'X').collect();
assert_eq!(v, ["ghi", "def", "abc"]);
```

--------------------------------

### Install Android target

Source: https://docs.rs/slint/latest/slint/android/index.html

Add the required Android target toolchain using rustup.

```bash
rustup target add aarch64-linux-android
```

--------------------------------

### Initialize Translations

Source: https://docs.rs/slint/latest/slint/macro.init_translations.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Examples of initializing translations using a manifest directory or the current executable path.

```rust
fn main() {
   slint::init_translations!(concat!(env!("CARGO_MANIFEST_DIR"), "/translations/"));
   // ...
}
```

```rust
slint::init_translations!(std::env::current_exe().unwrap().parent().unwrap().join("translations"));
```

--------------------------------

### Creating Keys from Parts

Source: https://docs.rs/slint/latest/slint/struct.Keys.html

Examples of creating Keys instances from a list of string parts in Rust.

```rust
use i_slint_core::input::Keys;

let save = Keys::from_parts(["Control", "S"])?;
let undo = Keys::from_parts(["Control", "Shift?", "Z"])?;
let f5 = Keys::from_parts(["F5"])?;
let zoom_in = Keys::from_parts(["Control", "Plus"])?;
let euro = Keys::from_parts(["Control", "€"])?;
let empty = Keys::from_parts([])?;  // same as Keys::default()
```

--------------------------------

### Timer::start

Source: https://docs.rs/slint/latest/slint/struct.Timer.html

Starts the timer with a specified mode and interval. If the timer was previously started, it will be restarted.

```APIDOC
## pub fn start(&self, mode: TimerMode, interval: Duration, callback: impl FnMut() + 'static)

### Description
Starts the timer with the given mode and interval. The callback is executed when the timer fires.

### Parameters
- **mode** (TimerMode) - Required - Whether to fire repeatedly or just once.
- **interval** (Duration) - Required - The duration until the timer fires.
- **callback** (impl FnMut() + 'static) - Required - The function to execute when the timer fires.
```

--------------------------------

### Build a slint::Image from an OpenGL texture

Source: https://docs.rs/slint/latest/slint/struct.BorrowedOpenGLTextureBuilder.html

Example showing how to initialize the builder and construct an image.

```rust
let builder = unsafe { BorrowedOpenGLTextureBuilder::new_gl_2d_rgba_texture(texture_id, size) }
             .origin(BorrowedOpenGLTextureOrigin::TopLeft);

let image: slint::Image = builder.build();
```

--------------------------------

### Resizing a SharedVector

Source: https://docs.rs/slint/latest/slint/struct.SharedVector.html

Example demonstrating how to resize a SharedVector and verify the contents.

```rust
use i_slint_core::SharedVector;
let mut shared_vector = SharedVector::<u32>::from_slice(&[1, 2, 3]);
shared_vector.resize(5, 8);
assert_eq!(shared_vector.as_slice(), &[1, 2, 3, 8, 8]);
shared_vector.resize(2, 0);
assert_eq!(shared_vector.as_slice(), &[1, 2]);
```

--------------------------------

### Usage Example

Source: https://docs.rs/slint/latest/slint/android/fn.init_with_event_listener.html?search=

Demonstrates how to initialize Slint within the android_main function while providing an event listener.

```rust
#[unsafe(no_mangle)]
fn android_main(app: slint::android_activity::AndroidApp) {
    slint::android::init_with_event_listener(
       app,
       |event| { eprintln!("got event {event:?}") }
    ).unwrap();

    // ... rest of your application ...

}
```

--------------------------------

### Start a repeated timer

Source: https://docs.rs/slint/latest/slint/struct.Timer.html

Demonstrates initializing a timer to execute a callback repeatedly every 200ms.

```rust
use slint::{Timer, TimerMode};
let timer = Timer::default();
timer.start(TimerMode::Repeated, std::time::Duration::from_millis(200), move || {
   println!("This will be printed every 200ms.");
});
// ... more initialization ...
slint::run_event_loop();
```

--------------------------------

### Component mapping examples

Source: https://docs.rs/slint/latest/index.html

Illustrates how Slint components map to generated Rust structures.

```rust
export component MyComponent inherits Window { /*...*/ }
```

```rust
struct MyComponent { /*...*/ }
```

--------------------------------

### Transparentize color examples

Source: https://docs.rs/slint/latest/slint/struct.Color.html

Demonstrates how to adjust the opacity of a color using the transparentize method.

```rust
let red = Color::from_argb_f32(1.0, 1.0, 0.0, 0.0);
assert_eq!(red.transparentize(0.5), Color::from_argb_f32(0.5, 1.0, 0.0, 0.0));
```

```rust
let blue = Color::from_argb_f32(1.0, 0.0, 0.0, 1.0);
assert_eq!(blue.transparentize(0.2), Color::from_argb_f32(0.8, 0.0, 0.0, 1.0));
```

```rust
let blue = Color::from_argb_f32(0.5, 0.0, 0.0, 1.0);
assert_eq!(blue.transparentize(-0.1), Color::from_argb_f32(0.55, 0.0, 0.0, 1.0));
```

--------------------------------

### Configure OpenGL ES backend

Source: https://docs.rs/slint/latest/slint/struct.BackendSelector.html?search=

Example of configuring the backend to require OpenGL ES 3.0 support.

```rust
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}");
}
```

--------------------------------

### Export component definition

Source: https://docs.rs/slint/latest/slint/index.html?search=std%3A%3Avec

Example of a component definition in a .slint file.

```slint
export component MyComponent inherits Window { /*...*/ }
```

--------------------------------

### starts_with<P>(pat: P)

Source: https://docs.rs/slint/latest/slint/struct.SharedString.html?search=std%3A%3Avec

Checks if the string starts with the given pattern.

```APIDOC
## pub fn starts_with<P>(&self, pat: P) -> bool

### Description
Returns `true` if the given pattern matches a prefix of this string slice.
```

--------------------------------

### ComponentHandle::run

Source: https://docs.rs/slint/latest/slint/index.html

Displays the component on the screen and starts the event loop to process input events.

```APIDOC
## ComponentHandle::run()

### Description
Displays the component on the screen and spins the event loop to react to input events.

### Signature
`fn run(&self)`
```

--------------------------------

### Integrate WGPU Texture with Slint

Source: https://docs.rs/slint/latest/src/slint/lib.rs.html?search=std%3A%3Avec

Example showing how to use a rendering notifier to create a WGPU texture and display it within a Slint UI component.

```rust

use slint::wgpu_29::wgpu;
use wgpu::util::DeviceExt;

slint::slint!{
    export component HelloWorld inherits Window {
        preferred-width: 320px;
        preferred-height: 300px;
        in-out property <image> app-texture;
        VerticalLayout {
            Text {
                text: "hello world";
                color: green;
            }
            Image { source: root.app-texture; }
        }
    }
}
fn main() -> Result<(), Box<dyn std::error::Error>> {
    slint::BackendSelector::new()
        .require_wgpu_29(slint::wgpu_29::WGPUConfiguration::default())
        .select()?;
    let app = HelloWorld::new()?;

    let app_weak = app.as_weak();

    app.window().set_rendering_notifier(move |state, graphics_api| {
        let (Some(app), slint::RenderingState::RenderingSetup, slint::GraphicsAPI::WGPU29{ device, queue, ..}) = (app_weak.upgrade(), state, graphics_api) else {
            return;
        };

        let mut pixels = slint::SharedPixelBuffer::<slint::Rgba8Pixel>::new(320, 200);
        pixels.make_mut_slice().fill(slint::Rgba8Pixel {
            r: 0,
            g: 255,
            b :0,
            a: 255,
        });

        let texture = device.create_texture_with_data(queue,
            &wgpu::TextureDescriptor {
                label: None,
                size: wgpu::Extent3d { width: 320, height: 200, depth_or_array_layers: 1 },
                mip_level_count: 1,
                sample_count: 1,
                dimension: wgpu::TextureDimension::D2,
                format: wgpu::TextureFormat::Rgba8Unorm,
                usage: wgpu::TextureUsages::RENDER_ATTACHMENT | wgpu::TextureUsages::TEXTURE_BINDING,
                view_formats: &[],
            },
            wgpu::util::TextureDataOrder::default(),
            pixels.as_bytes(),
        );

        let imported_image = slint::Image::try_from(texture).unwrap();

        app.set_app_texture(imported_image);
    })?;

    app.run()?;

    Ok(())
}
```

--------------------------------

### Cargo.toml configuration for MCU

Source: https://docs.rs/slint/latest/slint/docs/mcu/index.html

Example of the required dependencies and feature flags in Cargo.toml for a bare-metal Slint project.

```toml
[package]
## ...
## Edition 2021 or later enables the feature resolver version 2.
edition = "2021"

[dependencies]
## ... your other dependencies

[dependencies.slint]
version = "1.16"
default-features = false
features = ["compat-1-2", "unsafe-single-threaded", "libm", "renderer-software"]
[build-dependencies]
slint-build = "1.16.0"
```

--------------------------------

### fn get(component: &'a Component) -> Self

Source: https://docs.rs/slint/latest/slint/trait.Global.html?search=std%3A%3Avec

Returns a reference to the global component.

```APIDOC
## fn get(component: &'a Component) -> Self

### Description
Returns a reference to the global component associated with the provided component instance.

### Parameters
- **component** (&'a Component) - Required - The component instance to retrieve the global from.
```

--------------------------------

### Accessing Winit Window Example

Source: https://docs.rs/slint/latest/slint/winit_030/trait.WinitWindowAccessor.html

Demonstrates how to use the WinitWindowAccessor trait to retrieve the winit window ID asynchronously.

```rust
// Bring winit and accessor traits into scope.
use slint::winit_030::{WinitWindowAccessor, winit};

slint::slint!{
    import { VerticalBox, Button } from "std-widgets.slint";
    export component HelloWorld inherits Window {
        callback clicked;
        VerticalBox {
            Text {
                text: "hello world";
                color: green;
            }
            Button {
                text: "Click me";
                clicked => { root.clicked(); }
            }
        }
    }
}
fn main() -> Result<(), Box<dyn std::error::Error>> {
    // Make sure the winit backed is selected:
   slint::BackendSelector::new()
       .backend_name("winit".into())
       .select()?;

    let app = HelloWorld::new()?;
    let app_weak = app.as_weak();

    slint::spawn_local(async move {
        let app = app_weak.unwrap();
        let winit_window = app.window().winit_window().await.unwrap();
        eprintln!("window id = {:#?}", winit_window.id());
    }).unwrap();
    app.run()?;
    Ok(())
}
```

--------------------------------

### SampleComponent API

Source: https://docs.rs/slint/latest/src/slint/docs.rs.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Example of the generated Rust API for a Slint component, demonstrating how to interact with properties, callbacks, and functions.

```APIDOC
## SampleComponent

### Description
Represents a generated component instance from Slint markup. Provides methods to interact with properties, callbacks, and public functions defined in the component.

### Methods
- **new() -> Result<Self, PlatformError>** - Creates a new instance of the component.
- **get_counter() -> i32** - Returns the current value of the 'counter' property.
- **set_counter(value: i32)** - Sets the value of the 'counter' property.
- **get_user_name() -> SharedString** - Returns the current value of the 'user_name' property.
- **set_user_name(value: SharedString)** - Sets the value of the 'user_name' property.
- **invoke_hello()** - Synchronously invokes the 'hello' callback.
- **on_hello(f: impl Fn() + 'static)** - Registers a handler for the 'hello' callback.
- **invoke_do_something(d: i32) -> bool** - Synchronously calls the 'do-something' public function.
```

--------------------------------

### WGPU Rendering Integration

Source: https://docs.rs/slint/latest/src/slint/lib.rs.html?search=

Example of how to configure Slint with WGPU and use a rendering notifier to update textures within a Slint UI component.

```APIDOC
## WGPU Integration Example

### Description
This example demonstrates how to initialize Slint with WGPU support and use `set_rendering_notifier` to inject custom WGPU textures into a Slint `Image` property.

### Implementation
```rust
// Configure Slint to use WGPU
slint::BackendSelector::new()
    .require_wgpu_29(slint::wgpu_29::WGPUConfiguration::default())
    .select()?;

// Set a rendering notifier to access the WGPU device and queue
app.window().set_rendering_notifier(move |state, graphics_api| {
    let (Some(app), slint::RenderingState::RenderingSetup, slint::GraphicsAPI::WGPU29{ device, queue, ..}) = (app_weak.upgrade(), state, graphics_api) else {
        return;
    };
    
    // Create a texture and convert it to a Slint Image
    let texture = device.create_texture_with_data(queue, ...);
    let imported_image = slint::Image::try_from(texture).unwrap();
    app.set_app_texture(imported_image);
})?;
```
```

--------------------------------

### Split Inclusive Example

Source: https://docs.rs/slint/latest/slint/struct.SharedString.html?search=std%3A%3Avec

Demonstrates splitting a string while keeping the delimiter as a terminator for each substring.

```rust
let v: Vec<&str> = "Mary had a little lamb\nlittle lamb\nlittle lamb."
    .split_inclusive('\n').collect();
assert_eq!(v, ["Mary had a little lamb\n", "little lamb\n", "little lamb."]);
```

```rust
let v: Vec<&str> = "Mary had a little lamb\nlittle lamb\nlittle lamb.\n"
    .split_inclusive('\n').collect();
assert_eq!(v, ["Mary had a little lamb\n", "little lamb\n", "little lamb.\n"]);
```

--------------------------------

### fn get(component: &'a Component) -> Self

Source: https://docs.rs/slint/latest/slint/trait.Global.html?search=

Returns a reference to the global singleton associated with the provided component.

```APIDOC
## fn get(component: &'a Component) -> Self

### Description
Returns a reference to the global singleton associated with the provided component. This method is used to access properties defined within an exported global block in .slint files.

### Parameters
- **component** (&'a Component) - Required - The component instance that owns the global singleton.
```

--------------------------------

### Create a new Window with a WindowAdapter

Source: https://docs.rs/slint/latest/slint/struct.Window.html

Demonstrates how to initialize a Window within a custom WindowAdapter using Rc::new_cyclic to handle ownership.

```rust
use std::rc::Rc;
use slint::platform::{WindowAdapter, Renderer};
use slint::{Window, PhysicalSize};
struct MyWindowAdapter {
    window: Window,
    //...
}
impl WindowAdapter for MyWindowAdapter {
   fn window(&self) -> &Window { &self.window }
   fn size(&self) -> PhysicalSize { unimplemented!() }
   fn renderer(&self) -> &dyn Renderer { unimplemented!() }
}

fn create_window_adapter() -> Rc<dyn WindowAdapter> {
   Rc::<MyWindowAdapter>::new_cyclic(|weak| {
       MyWindowAdapter {
          window: Window::new(weak.clone()),
          //...
       }
   })
}
```

--------------------------------

### Initialize project directory

Source: https://docs.rs/slint/latest/index.html

Shell commands to rename and enter the project directory after downloading the template.

```bash
mv slint-rust-template-main my-project
cd my-project
```

--------------------------------

### WGPUSettings

Source: https://docs.rs/slint/latest/slint/wgpu_29/struct.WGPUSettings.html?search=std%3A%3Avec

Configuration structure for WGPU renderer initialization.

```APIDOC
## Struct: WGPUSettings

### Description
Provides settings for initializing WGPU renderers. This struct is non-exhaustive and requires the `unstable-wgpu-29` crate feature.

### Fields
- **backends** (Backends) - The backends to use for the WGPU instance.
- **backend_options** (BackendOptions) - Options provided to the selected backends.
- **instance_flags** (InstanceFlags) - Flags to fine-tune WGPU instance behavior.
- **instance_memory_budget_thresholds** (MemoryBudgetThresholds) - Memory budget thresholds for backends.
- **power_preference** (PowerPreference) - Influences WGPU adapter selection.
- **device_label** (Option<Cow<'static, str>>) - Label for the device used in debugging.
- **device_required_features** (Features) - Required features for the device.
- **device_required_limits** (Limits) - Required limits for the device.
- **device_experimental_features** (ExperimentalFeatures) - Experimental features for the device.
- **device_memory_hints** (MemoryHints) - Memory hints for the device.
```

--------------------------------

### Integrate WGPU Texture into Slint

Source: https://docs.rs/slint/latest/slint/wgpu_29/index.html

Example demonstrating how to initialize the WGPU backend and import a wgpu::Texture as a slint::Image.

```rust

 use slint::wgpu_29::wgpu;
 use wgpu::util::DeviceExt;

slint::slint!{
    export component HelloWorld inherits Window {
        preferred-width: 320px;
        preferred-height: 300px;
        in-out property <image> app-texture;
        VerticalLayout {
            Text {
                text: "hello world";
                color: green;
            }
            Image { source: root.app-texture; }
        }
    }
}
fn main() -> Result<(), Box<dyn std::error::Error>> {
    slint::BackendSelector::new()
        .require_wgpu_29(slint::wgpu_29::WGPUConfiguration::default())
        .select()?;
    let app = HelloWorld::new()?;

    let app_weak = app.as_weak();

    app.window().set_rendering_notifier(move |state, graphics_api| {
        let (Some(app), slint::RenderingState::RenderingSetup, slint::GraphicsAPI::WGPU29{ device, queue, ..}) = (app_weak.upgrade(), state, graphics_api) else {
            return;
        };

        let mut pixels = slint::SharedPixelBuffer::<slint::Rgba8Pixel>::new(320, 200);
        pixels.make_mut_slice().fill(slint::Rgba8Pixel {
            r: 0,
            g: 255,
            b :0,
            a: 255,
        });

        let texture = device.create_texture_with_data(queue,
            &wgpu::TextureDescriptor {
                label: None,
                size: wgpu::Extent3d { width: 320, height: 200, depth_or_array_layers: 1 },
                mip_level_count: 1,
                sample_count: 1,
                dimension: wgpu::TextureDimension::D2,
                format: wgpu::TextureFormat::Rgba8Unorm,
                usage: wgpu::TextureUsages::RENDER_ATTACHMENT | wgpu::TextureUsages::TEXTURE_BINDING,
                view_formats: &[],
            },
            wgpu::util::TextureDataOrder::default(),
            pixels.as_bytes(),
        );

        let imported_image = slint::Image::try_from(texture).unwrap();

        app.set_app_texture(imported_image);
    })?;

    app.run()?;

    Ok(())
}
```

--------------------------------

### Configure WGPU and Integrate Textures

Source: https://docs.rs/slint/latest/src/slint/lib.rs.html?search=

Shows how to set up Slint with WGPU and use a rendering notifier to inject a custom WGPU texture into the UI.

```toml
slint = { version = "~1.17", features = ["unstable-wgpu-29"] }
```

```rust
use slint::wgpu_29::wgpu;
use wgpu::util::DeviceExt;

slint::slint!{
    export component HelloWorld inherits Window {
        preferred-width: 320px;
        preferred-height: 300px;
        in-out property <image> app-texture;
        VerticalLayout {
            Text {
                text: "hello world";
                color: green;
            }
            Image { source: root.app-texture; }
        }
    }
}
fn main() -> Result<(), Box<dyn std::error::Error>> {
    slint::BackendSelector::new()
        .require_wgpu_29(slint::wgpu_29::WGPUConfiguration::default())
        .select()?;
    let app = HelloWorld::new()?;

    let app_weak = app.as_weak();

    app.window().set_rendering_notifier(move |state, graphics_api| {
        let (Some(app), slint::RenderingState::RenderingSetup, slint::GraphicsAPI::WGPU29{ device, queue, ..}) = (app_weak.upgrade(), state, graphics_api) else {
            return;
        };

        let mut pixels = slint::SharedPixelBuffer::<slint::Rgba8Pixel>::new(320, 200);
        pixels.make_mut_slice().fill(slint::Rgba8Pixel {
            r: 0,
            g: 255,
            b :0,
            a: 255,
        });

        let texture = device.create_texture_with_data(queue,
            &wgpu::TextureDescriptor {
                label: None,
                size: wgpu::Extent3d { width: 320, height: 200, depth_or_array_layers: 1 },
                mip_level_count: 1,
                sample_count: 1,
                dimension: wgpu::TextureDimension::D2,
                format: wgpu::TextureFormat::Rgba8Unorm,
                usage: wgpu::TextureUsages::RENDER_ATTACHMENT | wgpu::TextureUsages::TEXTURE_BINDING,
                view_formats: &[],
            },
            wgpu::util::TextureDataOrder::default(),
            pixels.as_bytes(),
        );

        let imported_image = slint::Image::try_from(texture).unwrap();

        app.set_app_texture(imported_image);
    })?;

    app.run()?;

    Ok(())
}
```

--------------------------------

### Instantiate MinimalSoftwareWindow

Source: https://docs.rs/slint/latest/slint/platform/software_renderer/struct.MinimalSoftwareWindow.html

Create a new instance of the window adapter with a specified repaint buffer type.

```rust
pub fn new(repaint_buffer_type: RepaintBufferType) -> Rc<MinimalSoftwareWindow>
```

--------------------------------

### Incompatible Lifetime Error Example

Source: https://docs.rs/slint/latest/slint/trait.StrongHandle.html

An example of an error message generated when attempting to use a non-static lifetime with a Weak reference.

```rust
error: incompatible lifetime on type
  --> /path/to/file.rs:9:10
   |
 9 |     global: slint::Weak<MyGlobal<'a>>,
   |             ^^^^^^^^^^^^^^^^^^^^^^^^^
   |
note: because this has an unmet lifetime requirement
  --> slint/internal/core/api.rs:954:24
   |
954 |     pub struct Weak<T: StrongHandle> {
   |                        ^^^^^^^^^^^^ introduces a `'static` lifetime requirement
note: the lifetime `'a` as defined here...
  --> /path/to/file.rs:8:17
   |
 8 | struct MyStruct<'a> {
   |                 ^^
note: ...does not necessarily outlive the static lifetime introduced by the compatible `impl`
  --> /path/to/file.rs:246:6
   |
246 |      impl slint :: StrongHandle for r#MyGlobal < 'static > {
```

--------------------------------

### Common Lifetime Error Example

Source: https://docs.rs/slint/latest/slint/trait.StrongHandle.html

An example of an incorrect implementation that triggers a lifetime error when using Weak references with globals.

```rust
error[E0106]: missing lifetime specifier
  --> /path/to/file.rs:10:19
   |
10 |         global: Weak<MyGlobal>,
   |                      ^^^^^^^^ expected named lifetime parameter
   |
help: consider introducing a named lifetime parameter
   |
 9 ~     struct MyStruct<'a> {
10 ~         global: Weak<MyGlobal<'a>>,
```

--------------------------------

### get()

Source: https://docs.rs/slint/latest/slint/struct.SharedString.html?search=u32+-%3E+bool

Returns a subslice of the string safely.

```APIDOC
### pub fn get<I>(&self, i: I) -> Option<&<I as SliceIndex<str>>::Output>

Returns a subslice of `str`. This is the non-panicking alternative to indexing.
```

--------------------------------

### get<I>(i: I)

Source: https://docs.rs/slint/latest/slint/struct.SharedString.html?search=std%3A%3Avec

Returns a subslice of the string safely.

```APIDOC
### pub fn get<I>(&self, i: I) -> Option<&<I as SliceIndex<str>>::Output>

Returns a subslice of the string. This is the non-panicking alternative to indexing, returning None if the index is invalid.
```

--------------------------------

### Timer::restart

Source: https://docs.rs/slint/latest/slint/struct.Timer.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Restarts a previously started timer.

```APIDOC
## pub fn restart(&self)

### Description
Restarts the timer, recalculating the next invocation time relative to the current time. Does nothing if the timer was never started.
```

--------------------------------

### Timer::stop

Source: https://docs.rs/slint/latest/slint/struct.Timer.html

Stops a previously started timer.

```APIDOC
## pub fn stop(&self)

### Description
Stops the timer. If the timer was not running, this method does nothing.
```

--------------------------------

### Get slice length

Source: https://docs.rs/slint/latest/slint/struct.SharedVector.html

Returns the number of elements in the slice.

```rust
let a = [1, 2, 3];
assert_eq!(a.len(), 3);
```

--------------------------------

### WGPUSettings Struct

Source: https://docs.rs/slint/latest/slint/wgpu_29/struct.WGPUSettings.html?search=

Configuration structure for WGPU renderer initialization.

```APIDOC
## WGPUSettings

### Description
This data structure provides settings for initializing WGPU renderers. It is marked as non-exhaustive, meaning it may receive additional fields in future versions.

### Fields
- **backends** (Backends) - The backends to use for the WGPU instance.
- **backend_options** (BackendOptions) - The different options that are given to the selected backends.
- **instance_flags** (InstanceFlags) - The flags to fine-tune behavior of the WGPU instance.
- **instance_memory_budget_thresholds** (MemoryBudgetThresholds) - Memory budget thresholds used by some backends.
- **power_preference** (PowerPreference) - The power preference is used to influence the WGPU adapter selection.
- **device_label** (Option<Cow<'static, str>>) - The label for the device, used to identify the device in debugging tools.
- **device_required_features** (Features) - The required features for the device.
- **device_required_limits** (Limits) - The required limits for the device.
- **device_experimental_features** (ExperimentalFeatures) - The experimental features for the device.
- **device_memory_hints** (MemoryHints) - The memory hints for the device.
```

--------------------------------

### Trim leading whitespace

Source: https://docs.rs/slint/latest/slint/struct.SharedString.html?search=std%3A%3Avec

Removes whitespace from the start of a string slice.

```rust
let s = "\n Hello\tworld\t\n";
assert_eq!("Hello\tworld\t\n", s.trim_start());
```

```rust
let s = "  English  ";
assert!(Some('E') == s.trim_start().chars().next());
```

--------------------------------

### Enable Live Preview via Command Line

Source: https://docs.rs/slint/latest/slint/docs/cargo_features/index.html?search=

Use this command to enable live preview during development without modifying your Cargo.toml permanently.

```bash
SLINT_LIVE_PREVIEW=1 cargo build --features slint/live-preview
```

--------------------------------

### Asserting split behavior

Source: https://docs.rs/slint/latest/slint/struct.SharedString.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Example demonstrating a specific split assertion.

```rust
assert_eq!(d, &["a", "b", "c"]);
```

--------------------------------

### Strip Circumfix Examples

Source: https://docs.rs/slint/latest/slint/struct.SharedString.html?search=std%3A%3Avec

Removes both a prefix and a suffix exactly once if they do not overlap.

```rust
assert_eq!("bar:hello:foo".strip_circumfix("bar:", ":foo"), Some("hello"));
assert_eq!("bar:foo".strip_circumfix("foo", "foo"), None);
assert_eq!("foo:bar;".strip_circumfix("foo:", ';'), Some("bar"));
assert_eq!("foo:bar:baz".strip_circumfix("foo:bar:", ":bar:baz"), None);
```

--------------------------------

### Structure with @rust-attr()

Source: https://docs.rs/slint/latest/slint/docs/type_mappings/index.html

Example of applying Rust attributes to a structure in .slint.

```slint
@rust-attr(derive(serde::Serialize, serde::Deserialize))
struct MyStruct {
    foo: int,
}
```

--------------------------------

### get

Source: https://docs.rs/slint/latest/slint/struct.SharedVector.html

Returns a reference to an element or subslice depending on the type of index.

```APIDOC
## pub fn get<I>(&self, index: I) -> Option<&<I as SliceIndex<[T]>>::Output>

Returns a reference to an element or subslice depending on the type of index. If given a position, returns a reference to the element at that position or None if out of bounds. If given a range, returns the subslice corresponding to that range, or None if out of bounds.
```

--------------------------------

### user_data

Source: https://docs.rs/slint/latest/slint/struct.DataTransfer.html?search=u32+-%3E+bool

Get the application-internal data represented by this DataTransfer, if one exists.

```APIDOC
pub fn user_data(&self) -> Option<Rc<dyn Any>>
```

--------------------------------

### pub fn init(app: AndroidApp) -> Result<(), SetPlatformError>

Source: https://docs.rs/slint/latest/slint/android/fn.init.html?search=

Initializes the Android backend. This function must be called from the android_main function before any call to Slint that needs a backend. It is only available on Android with the 'backend-android-activity-05' or 'backend-android-activity-06' feature flags.

```APIDOC
## Function: slint::android::init

### Description
Initializes the Android backend for the Slint library. This must be invoked within the `android_main` function prior to any other Slint calls that require the backend.

### Signature
`pub fn init(app: AndroidApp) -> Result<(), SetPlatformError>`

### Parameters
- **app** (AndroidApp) - The Android application instance.

### Returns
- **Result<(), SetPlatformError>** - Returns `Ok(())` on success, or a `SetPlatformError` if initialization fails.

### Requirements
- **Platform**: Android
- **Features**: Requires `backend-android-activity-05` or `backend-android-activity-06`.
```

--------------------------------

### Retrieve match indices

Source: https://docs.rs/slint/latest/slint/struct.SharedString.html?search=std%3A%3Avec

Returns an iterator over disjoint matches and their starting indices.

```rust
let v: Vec<_> = "abcXXXabcYYYabc".match_indices("abc").collect();
assert_eq!(v, [(0, "abc"), (6, "abc"), (12, "abc")]);

let v: Vec<_> = "1abcabc2".match_indices("abc").collect();
assert_eq!(v, [(1, "abc"), (4, "abc")]);

let v: Vec<_> = "ababa".match_indices("aba").collect();
assert_eq!(v, [(0, "aba")]); // only the first `aba`
```

--------------------------------

### Timer::single_shot

Source: https://docs.rs/slint/latest/slint/struct.Timer.html

Starts a timer that fires exactly once after the specified duration and is then deleted.

```APIDOC
## pub fn single_shot(duration: Duration, callback: impl FnOnce() + 'static)

### Description
Starts a one-time timer. The timer is automatically deleted after the callback is executed.

### Parameters
- **duration** (Duration) - Required - The duration until the timer fires.
- **callback** (impl FnOnce() + 'static) - Required - The function to execute when the timer fires.
```

--------------------------------

### Strip Suffix Examples

Source: https://docs.rs/slint/latest/slint/struct.SharedString.html?search=std%3A%3Avec

Removes a suffix exactly once if present, returning an Option.

```rust
assert_eq!("bar:foo".strip_suffix(":foo"), Some("bar"));
assert_eq!("bar:foo".strip_suffix("bar"), None);
assert_eq!("foofoo".strip_suffix("foo"), Some("foo"));
```

--------------------------------

### Strip Prefix Examples

Source: https://docs.rs/slint/latest/slint/struct.SharedString.html?search=std%3A%3Avec

Removes a prefix exactly once if present, returning an Option.

```rust
assert_eq!("foo:bar".strip_prefix("foo:"), Some("bar"));
assert_eq!("foo:bar".strip_prefix("bar"), None);
assert_eq!("foofoo".strip_prefix("foo"), Some("foo"));
```

--------------------------------

### show()

Source: https://docs.rs/slint/latest/slint/platform/software_renderer/struct.MinimalSoftwareWindow.html

Shows the window on the screen and maintains a strong reference to the component.

```APIDOC
### pub fn show(&self) -> Result<(), PlatformError>

Shows the window on the screen. An additional strong reference on the associated component is maintained while the window is visible.
```

--------------------------------

### MapModel Usage Example

Source: https://docs.rs/slint/latest/slint/struct.MapModel.html?search=

Mapping a VecModel of custom types into a model of SharedStrings.

```rust
#[derive(Clone)]
struct Name {
    first: String,
    last: String,
}

let model = VecModel::from(vec![
    Name { first: "Hans".to_string(), last: "Emil".to_string() },
    Name { first: "Max".to_string(), last: "Mustermann".to_string() },
    Name { first: "Roman".to_string(), last: "Tisch".to_string() },
]);

let mapped_model = MapModel::new(model, |n|
    slint::format!("{}, {}", n.last, n.first)
);

assert_eq!(mapped_model.row_data(0).unwrap(), SharedString::from("Emil, Hans"));
assert_eq!(mapped_model.row_data(1).unwrap(), SharedString::from("Mustermann, Max"));
assert_eq!(mapped_model.row_data(2).unwrap(), SharedString::from("Tisch, Roman"));
```

--------------------------------

### Multiple @rust-attr() directives

Source: https://docs.rs/slint/latest/slint/docs/type_mappings/index.html

Example of using multiple @rust-attr() directives in .slint.

```slint
@rust-attr(derive(serde::Serialize, serde::Deserialize))
@rust-attr(serde(rename_all = "camelCase"))
struct MyStruct {
    foo-bar: int,
}
```

--------------------------------

### Create a new FemtoVGWGPURenderer

Source: https://docs.rs/slint/latest/slint/platform/femtovg_renderer/struct.FemtoVGWGPURenderer.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Initializes a new renderer instance using provided WGPU resources.

```rust
pub fn new( instance: Instance, device: Device, queue: Queue, ) -> Result<FemtoVGWGPURenderer, PlatformError>
```

--------------------------------

### User-defined structure in .slint

Source: https://docs.rs/slint/latest/slint/docs/type_mappings/index.html

Example of a structure definition within a .slint file.

```slint
export struct MyStruct {
    foo: int,
    bar: string,
    names: [string],
}
```

--------------------------------

### as_array

Source: https://docs.rs/slint/latest/slint/struct.SharedVector.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Gets a reference to the underlying array if the length matches the requested size.

```APIDOC
## pub fn as_array<const N: usize>(&self) -> Option<&[T; N]>

### Description
Gets a reference to the underlying array. If N is not exactly equal to the length of self, then this method returns None.
```

--------------------------------

### create_window_adapter

Source: https://docs.rs/slint/latest/slint/platform/trait.Platform.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Instantiates a window for a component.

```APIDOC
### fn create_window_adapter(&self) -> Result<Rc<dyn WindowAdapter>, PlatformError>

Instantiate a window for a component.
```

--------------------------------

### Run Slint event loop with Tokio

Source: https://docs.rs/slint/latest/src/slint/lib.rs.html

Demonstrates running a TCP server and client within the Slint event loop using async_compat.

```rust
fn main() {
    # i_slint_backend_testing::init_integration_test_with_mock_time();
    use std::io::Write;

    let listener = std::net::TcpListener::bind("127.0.0.1:0").unwrap();
    let local_addr = listener.local_addr().unwrap();
    let server = std::thread::spawn(move || {
        let mut stream = listener.incoming().next().unwrap().unwrap();
        stream.write("Hello World".as_bytes()).unwrap();
    });

    let slint_future = async move {
        use tokio::io::AsyncReadExt;
        let mut stream = tokio::net::TcpStream::connect(local_addr).await.unwrap();
        let mut data = Vec::new();
        stream.read_to_end(&mut data).await.unwrap();
        assert_eq!(data, "Hello World".as_bytes());
        slint::quit_event_loop().unwrap();
    };

    // Wrap the future that includes Tokio futures in async_compat's `Compat` to ensure
    // presence of a Tokio run-time.
    slint::spawn_local(async_compat::Compat::new(slint_future)).unwrap();

    slint::run_event_loop_until_quit().unwrap();

    server.join().unwrap();
}
```

--------------------------------

### Get last element

Source: https://docs.rs/slint/latest/slint/struct.SharedVector.html

Returns the last element of the slice, or None if it is empty.

```rust
let v = [10, 40, 30];
assert_eq!(Some(&30), v.last());

let w: &[i32] = &[];
assert_eq!(None, w.last());
```

--------------------------------

### Initialize Android Backend

Source: https://docs.rs/slint/latest/slint/android/fn.init.html?search=

Call this function from android_main before any Slint operations. Requires the backend-android-activity-06 feature.

```rust
pub fn init(app: AndroidApp) -> Result<(), SetPlatformError>
```

--------------------------------

### Get first element

Source: https://docs.rs/slint/latest/slint/struct.SharedVector.html

Returns the first element of the slice, or None if it is empty.

```rust
let v = [10, 40, 30];
assert_eq!(Some(&10), v.first());

let w: &[i32] = &[];
assert_eq!(None, w.first());
```

--------------------------------

### Window Geometry Methods

Source: https://docs.rs/slint/latest/slint/platform/software_renderer/struct.MinimalSoftwareWindow.html?search=

Methods to get and set the position and size of the window.

```APIDOC
### pub fn position(&self) -> PhysicalPosition
Returns the position of the window on the screen in physical screen coordinates.

### pub fn set_position(&self, position: impl Into<WindowPosition>)
Sets the position of the window on the screen.

### pub fn size(&self) -> PhysicalSize
Returns the size of the window on the screen in physical screen coordinates.

### pub fn set_size(&self, size: impl Into<WindowSize>)
Resizes the window to the specified size on the screen.
```

--------------------------------

### Property Accessors

Source: https://docs.rs/slint/latest/slint/docs/generated_code/struct.SampleComponent.html?search=

Methods to get and set properties defined in the .slint markup.

```APIDOC
### pub fn get_counter(&self) -> i32
Returns the value of the `counter` property.

### pub fn set_counter(&self, value: i32)
Sets the value of the `counter` property.

### pub fn get_user_name(&self) -> SharedString
Returns the value of the `user_name` property.

### pub fn set_user_name(&self, value: SharedString)
Sets the value of the `user_name` property.
```

--------------------------------

### Build and run Android application

Source: https://docs.rs/slint/latest/slint/android/index.html

Use cargo-apk to build and deploy the application to an Android device.

```bash
cargo apk run --target aarch64-linux-android --lib
```

--------------------------------

### Mix Colors in Slint

Source: https://docs.rs/slint/latest/slint/struct.Color.html

Examples demonstrating how to blend two colors using the mix method with different ratios.

```rust
let red = Color::from_rgb_f32(1.0, 0.0, 0.0);
let black = Color::from_rgb_f32(0.0, 0.0, 0.0);
assert_eq!(red.mix(&black, 0.5), Color::from_rgb_f32(0.5, 0.0, 0.0));
```

```rust
let purple = Color::from_rgb_u8(128, 0, 128);
let orange_red = Color::from_rgb_u8(255, 69, 0);
assert_eq!(purple.mix(&orange_red, 0.75), Color::from_rgb_f32(0.6264706, 0.06764706, 0.37647063));
```

--------------------------------

### Check string prefix

Source: https://docs.rs/slint/latest/slint/struct.SharedString.html?search=std%3A%3Avec

Verifies if a string starts with a specific pattern or character slice.

```rust
let bananas = "bananas";

assert!(bananas.starts_with("bana"));
assert!(!bananas.starts_with("nana"));
```

```rust
let bananas = "bananas";

// Note that both of these assert successfully.
assert!(bananas.starts_with(&['b', 'a', 'n', 'a']));
assert!(bananas.starts_with(&['a', 'b', 'c', 'd']));
```

--------------------------------

### with_winit_window

Source: https://docs.rs/slint/latest/slint/struct.Window.html

Executes a callback with the underlying winit window.

```APIDOC
## fn with_winit_window<T>(&self, callback: impl FnOnce(&Window) -> T) -> Option<T>

### Description
Invokes the specified callback with a reference to the `winit::window::Window` that exists for this Slint window and returns `Some(T)`; otherwise `None`.
```

--------------------------------

### BackendSelector Winit and Input Hooks

Source: https://docs.rs/slint/latest/slint/struct.BackendSelector.html?search=

Methods to configure window attributes, event loops, and input hooks.

```APIDOC
## Configuration Hook Methods

- **with_winit_window_attributes_hook(hook: Fn(WindowAttributes) -> WindowAttributes)**: Adjusts window settings before creation (requires unstable-winit-030).
- **with_winit_event_loop_builder(event_loop_builder: EventLoopBuilder<SlintEvent>)**: Configures the winit event loop builder (requires unstable-winit-030).
- **with_winit_custom_application_handler(handler: CustomApplicationHandler)**: Sets a custom application handler for winit events (requires unstable-winit-030).
- **with_libinput_event_hook(event_hook: Fn(&Event) -> bool)**: Sets a filter hook for libinput events on LinuxKMS (requires unstable-libinput-09).
```

--------------------------------

### Timer::restart

Source: https://docs.rs/slint/latest/slint/struct.Timer.html

Restarts a previously started timer, recalculating the next invocation time.

```APIDOC
## pub fn restart(&self)

### Description
Restarts the timer. The next invocation time is calculated relative to the current time. Does nothing if the timer was never started.
```

--------------------------------

### Run Event Loop Signature

Source: https://docs.rs/slint/latest/slint/fn.run_event_loop.html

The function signature for starting the Slint event loop.

```rust
pub fn run_event_loop() -> Result<(), PlatformError>
```
Tokens:
Raw