Struct CursorImage 

pub struct CursorImage { /* private fields */ }

Represents a generic cursor image.

Implementations

impl CursorImage

pub fn new( width: u32, height: u32, hotspot_x: u32, hotspot_y: u32, rgba: Vec<u8>, delay: u32, ) -> Result<Self>

Contructor for a CursorImage.

Errors

• If TryInto conversions fail.
• If hotspot_x > width and ditto for y.
• If width * height * 4 != rgba.len().

pub fn from_entry(entry: &IconDirEntry, delay: u32) -> Result<Self>

Helper function for constructing from an entry.

Entries don’t store delay unlike Xcursor, so it’s a separate parameter.

Errors

If the entry isn’t a cursor (no hotspot), or RGBA fails to decode.

pub fn scaled_to(&self, scale_factor: f64, algorithm: ResizeAlg) -> Result<Self>

Returns a new CursorImage scaled to scale_factor.

Errors

If resizing or Image/ImageRef constructors fail.

pub fn scale_point(point: (u32, u32), scale_factor: f64) -> (u32, u32)

Helper function for Self::scaled_to.

pub const fn dimensions(&self) -> (u32, u32)

Returns image dimensions as (width, height).

pub const fn hotspot(&self) -> (u32, u32)

Returns hotspot coordinates as (x, y).

pub const fn delay(&self) -> u32

Returns the delay in milliseconds.

pub fn rgba(&self) -> &[u8]

Returns a reference to the stored RGBA.

pub fn nominal_size(&self) -> u32

Returns the max of width and height.

Trait Implementations

impl Clone for CursorImage

fn clone(&self) -> CursorImage

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CursorImage

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

Formats the value using the given formatter.