Struct wayland_cursor::CursorTheme

pub struct CursorTheme { /* fields omitted */ }

Represents a cursor theme loaded from the system.

Implementations

impl CursorTheme

pub fn load(size: u32, shm: &Attached<WlShm>) -> Self

Load a cursor theme from system defaults.

Same as calling load_or("default", size, shm)

pub fn load_or(name: &str, size: u32, shm: &Attached<WlShm>) -> Self

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(name: &str, size: u32, shm: &Attached<WlShm>) -> Self

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.