Struct wayland_cursor::CursorTheme

pub struct CursorTheme {
    pub(crate) name: String,
    pub(crate) cursors: Vec<Cursor>,
    pub(crate) size: u32,
    pub(crate) pool: WlShmPool,
    pub(crate) pool_size: i32,
    pub(crate) file: File,
    pub(crate) backend: WeakBackend,
    pub(crate) fallback: Option<FallBack>,
}

Represents a cursor theme loaded from the system.

Fields

name: String

cursors: Vec<Cursor>

size: u32

pool: WlShmPool

pool_size: i32

file: File

backend: WeakBackend

fallback: Option<FallBack>

Implementations

impl CursorTheme

pub fn load(conn: &Connection, shm: WlShm, size: u32) -> Result<Self, InvalidId>

Load a cursor theme from system defaults.

Same as calling the following:

CursorTheme::load_or(conn, shm, "default", size)

pub fn load_or( conn: &Connection, shm: WlShm, name: &str, size: u32, ) -> Result<Self, InvalidId>

Load a cursor theme, using name as fallback.

The theme name and cursor size are read from the XCURSOR_THEME and XCURSOR_SIZE environment variables, respectively, or from the provided variables if those are invalid.

pub fn load_from_name( conn: &Connection, shm: WlShm, name: &str, size: u32, ) -> Result<Self, InvalidId>

Create a new cursor theme, ignoring the system defaults.

pub fn get_cursor(&mut self, name: &str) -> Option<&Cursor>

Retrieve a cursor from the theme.

This method returns None if this cursor is not provided either by the theme, or by one of its parents.

If a fallback is set, it will use the data returned by the fallback.

pub fn set_fallback<F>(&mut self, fallback: F)

where F: Fn(&str, u32) -> Option<Cow<'static, [u8]>> + Send + Sync + 'static,

Set a fallback to load the cursor data, in case the system theme is missing a cursor that you need.

Your fallback will be invoked with the name and size of the requested cursor and should return a byte array with the contents of an xcursor file, or None if you don’t provide a fallback for this cursor.

For example, this defines a generic fallback cursor image and uses it for all missing cursors:

use wayland_cursor::CursorTheme;
use wayland_client::{Connection, backend::InvalidId, protocol::wl_shm};
fn example(conn: &Connection, shm: wl_shm::WlShm, size: u32) -> Result<CursorTheme, InvalidId> {
  let mut theme = CursorTheme::load_or(conn, shm, "default", size)?;
  theme.set_fallback(|name, size| {
      include_bytes!("./icons/default")
  });
  Ok(theme)
}

pub(crate) fn load_cursor(&mut self, name: &str, size: u32) -> Option<Cursor>

This function loads a cursor, parses it and pushes the images onto the shm pool.

Keep in mind that if the cursor is already loaded, the function will make a duplicate.

pub(crate) fn grow(&mut self, size: i32)

Grow the wl_shm_pool this theme is stored on.

This method does nothing if the provided size is smaller or equal to the pool’s current size.

Trait Implementations

impl Debug for CursorTheme

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.