Struct smithay_client_toolkit::seat::pointer::ThemedPointer

pub struct ThemedPointer<U = PointerData, S = SurfaceData> {
    pub(super) themes: Arc<Mutex<Themes>>,
    pub(super) pointer: WlPointer,
    pub(super) shm: WlShm,
    pub(super) surface: WlSurface,
    pub(super) shape_device: Option<WpCursorShapeDeviceV1>,
    pub(super) _marker: PhantomData<U>,
    pub(super) _surface_data: PhantomData<S>,
}

Pointer themeing

Fields

themes: Arc<Mutex<Themes>>

pointer: WlPointer

The underlying wl_pointer.

shm: WlShm

surface: WlSurface

The surface owned by the cursor to present the icon.

shape_device: Option<WpCursorShapeDeviceV1>

_marker: PhantomData<U>

_surface_data: PhantomData<S>

Implementations

impl<U: PointerDataExt + 'static, S: SurfaceDataExt + 'static> ThemedPointer<U, S>

pub fn set_cursor( &self, conn: &Connection, icon: CursorIcon, ) -> Result<(), PointerThemeError>

Set the cursor to the given CursorIcon.

The cursor icon should be reloaded on every PointerEventKind::Enter event.

fn set_cursor_legacy( &self, conn: &Connection, serial: u32, icon: CursorIcon, ) -> Result<(), PointerThemeError>

The legacy method of loading the cursor from the system cursor theme instead of relying on compositor to set the cursor.

pub fn hide_cursor(&self) -> Result<(), PointerThemeError>

Hide the cursor by providing empty surface for it.

The cursor should be hidden on every PointerEventKind::Enter event.

pub fn pointer(&self) -> &WlPointer

The WlPointer associated with this ThemedPointer.

pub fn surface(&self) -> &WlSurface

The associated WlSurface with this ThemedPointer.

Trait Implementations

impl<U: Debug, S: Debug> Debug for ThemedPointer<U, S>

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

Formats the value using the given formatter.

impl<U, S> Drop for ThemedPointer<U, S>

fn drop(&mut self)

Executes the destructor for this type.