Struct wayland_client::cursor::Cursor

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

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

Methods

impl<'a> Cursor<'a>

pub fn name(&self) -> String

Retrieve the name of this cursor.

pub fn image_count(&self) -> usize

Retrieve the number of images contained in this animated cursor

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

Retrieve the image number of cursor animation.

Returns the image number of the animation that should be displayed after a given amount of time since the beginning of the animation, in milliseconds.

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

Retrieve the image number and its duration.

Same as frame(), but also returns the number of milliseconds this frame should still be displayed.

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

Retrieve a CursorImageBuffer containing the given image of an animation.

It can be used to 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)>

Retrieve the metadata associated with 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>