Struct wlroots::cursor::xcursor::XCursor

pub struct XCursor<'theme> { /* fields omitted */ }

Wrapper for an xcursor from the X11 xcursor library.

The cursor must live as long as the Theme that it comes from.

Methods

impl<'theme> XCursor<'theme>

pub fn images<'cursor>(&'cursor self) -> Vec<Image<'cursor>>

Get all the image frames associated with an xcursor.

pub fn image<'cursor>(&'cursor self, index: usize) -> Option<Image<'cursor>>

Get a specific frame of the image from the animation. Returns None if the index is out of bounds.

We suggest paring this with XCursor::frame to avoid going out of bounds.

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

Returns the current frame number for an animated cursor give a monotonic time reference in milliseconds.

e.g. if it's been animating for 500 milliseconds duration should be constructed from Duration::from_millis(500).

pub fn image_len(&self) -> usize

Get the number of animation frames for the cursor.

pub fn total_delay(&self) -> u32

Length of the animation in milliseconds.

pub unsafe fn from_ptr<'unbound>(xcursor: *mut wlr_xcursor) -> XCursor<'unbound>

Constructs an XCursor from a raw pointer

Unsafety

This lifetime is unbounded, but it must not outlive the xcursor manager that the pointer came from.

Trait Implementations

impl<'theme> Eq for XCursor<'theme>

impl<'theme> PartialOrd<XCursor<'theme>> for XCursor<'theme>

fn partial_cmp(&self, other: &XCursor<'theme>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &XCursor<'theme>) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &XCursor<'theme>) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &XCursor<'theme>) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &XCursor<'theme>) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<'theme> PartialEq<XCursor<'theme>> for XCursor<'theme>

fn eq(&self, other: &XCursor<'theme>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &XCursor<'theme>) -> bool

This method tests for !=.

impl<'theme> Ord for XCursor<'theme>

fn cmp(&self, other: &XCursor<'theme>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

impl<'theme> Hash for XCursor<'theme>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where     H: Hasher,

Feeds a slice of this type into the given [Hasher].

impl<'theme> Debug for XCursor<'theme>

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

Formats the value using the given formatter.