Struct wayland_cursor::Cursor

pub struct Cursor {
    pub(crate) name: String,
    pub(crate) images: Vec<CursorImageBuffer>,
    pub(crate) total_duration: u32,
}

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

Fields

name: String

images: Vec<CursorImageBuffer>

total_duration: u32

Implementations

impl Cursor

pub(crate) fn new( conn: &Connection, name: &str, theme: &mut CursorTheme, images: &[XCursorImage], size: u32, ) -> Self

Construct a new Cursor.

Each of the provided images will be written into theme. This will also grow theme.pool if necessary.

pub(crate) fn nearest_images( size: u32, images: &[XCursorImage], ) -> impl Iterator<Item = &XCursorImage>

pub fn frame_and_duration(&self, millis: u32) -> FrameAndDuration

Given a time, calculate which frame to show, and how much time remains until the next frame.

Time will wrap, so if for instance the cursor has an animation lasting 100ms, then calling this function with 5ms and 105ms as input gives the same output.

pub fn image_count(&self) -> usize

Total number of images forming this cursor animation

Trait Implementations

impl Clone for Cursor

fn clone(&self) -> Cursor

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Cursor

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

Formats the value using the given formatter.

impl Index<usize> for Cursor

type Output = CursorImageBuffer

The returned type after indexing.

fn index(&self, index: usize) -> &Self::Output

Performs the indexing (container[index]) operation.