Struct wlroots::cursor::xcursor::Image

pub struct Image<'cursor> {
    pub width: u32,
    pub height: u32,
    pub hotspot_x: u32,
    pub hotspot_y: u32,
    pub delay: u32,
    pub buffer: &'cursor [u8],
    // some fields omitted
}

Contains the information necessary to render the cursor.

The hotspot of the image shows where the cursor will interact with the environment. i.e. it refers to the location of the cursor "point". Note that the coordinates could be inside the image.

Fields

width: u32

The width of the image in pixels.

height: u32

The height of the image in pixels.

hotspot_x: u32

The x coordinate of the hotspot, which must be inside the image.

hotspot_y: u32

The y coordinate of the hotspot, which must be inside the image.

delay: u32

Animation delay to the next frame in milliseconds.

buffer: &'cursor [u8]

The bytes in ARGB format.

Trait Implementations

impl<'buffer> From<Image<'buffer>> for Image<'buffer>

fn from(image: Image<'buffer>) -> Self

Performs the conversion.

impl<'cursor> Eq for Image<'cursor>

impl<'cursor> PartialOrd<Image<'cursor>> for Image<'cursor>

fn partial_cmp(&self, other: &Image<'cursor>) -> Option<Ordering>

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

fn lt(&self, other: &Image<'cursor>) -> bool

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

fn le(&self, other: &Image<'cursor>) -> bool

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

fn gt(&self, other: &Image<'cursor>) -> bool

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

fn ge(&self, other: &Image<'cursor>) -> bool

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

impl<'cursor> PartialEq<Image<'cursor>> for Image<'cursor>

fn eq(&self, other: &Image<'cursor>) -> bool

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

fn ne(&self, other: &Image<'cursor>) -> bool

This method tests for !=.

impl<'cursor> Ord for Image<'cursor>

fn cmp(&self, other: &Image<'cursor>) -> 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<'cursor> Hash for Image<'cursor>

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<'cursor> Debug for Image<'cursor>

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

Formats the value using the given formatter.