Struct wayland_client::cursor::Cursor

pub struct Cursor<'a> { /* fields omitted */ }

A cursor from a theme. Can contain several images if animated.

Implementations

impl<'a> Cursor<'a>

pub fn name(&self) -> String

Returns the name of this cursor.

pub fn image_count(&self) -> usize

Returns the number of images contained in this animated cursor

pub fn frame(&self, duration: u32) -> usize

Returns which frame of an animated cursor should be displayed at a given time.

The time is given in milliseconds after the beginning of the animation.

pub fn frame_and_duration(&self, duration: u32) -> (usize, u32)

Returns the frame number and its remaining duration.

Same as frame(), but also returns the amount of milliseconds this frame should continue to be displayed.

pub fn frame_buffer(&self, frame: usize) -> Option<CursorImageBuffer<'_>>

Returns a CursorImageBuffer containing the given image of an animation.

It can be attached to a surface as a classic WlBuffer.

Returns None if the frame is out of bounds.

Note: destroying this buffer (using the destroy method) will corrupt your theme data, so you might not want to do it.

pub fn frame_info(&self, frame: usize) -> Option<(u32, u32, u32, u32, u32)>

Returns the metadata associated with a given frame of the animation.

The tuple contains: (width, height, hotspot_x, hotspot_y, delay)

Returns None if the frame is out of bounds.

Trait Implementations

impl<'a> Send for Cursor<'a>