Enum CustomCursorSource 

#[non_exhaustive]
pub enum CustomCursorSource {
    Image(CursorImage),
    Animation(CursorAnimation),
    Url {
        hotspot_x: u16,
        hotspot_y: u16,
        url: String,
    },
}

Source for CustomCursor.

See CustomCursor for more details.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Image(CursorImage)

Cursor that is backed by RGBA image.

See CustomCursorSource::from_rgba for more.

Platform-specific

• iOS / Android / Orbital: Unsupported

Animation(CursorAnimation)

Animated cursor.

See CustomCursorSource::from_animation for more.

Platform-specific

• iOS / Android / Wayland / Windows / X11 / macOS / Orbital: Unsupported

Url

Creates a new cursor from a URL pointing to an image. It uses the url css function, but browser support for image formats is inconsistent. Using PNG is recommended.

Platform-specific

• iOS / Android / Wayland / Windows / X11 / macOS / Orbital: Unsupported

Fields

hotspot_x: u16

hotspot_y: u16

url: String

Implementations

impl CustomCursorSource

pub fn from_rgba( rgba: Vec<u8>, width: u16, height: u16, hotspot_x: u16, hotspot_y: u16, ) -> Result<Self, BadImage>

Creates a new cursor from an rgba buffer.

The alpha channel is assumed to be not premultiplied.

pub fn from_animation( duration: Duration, cursors: Vec<CustomCursor>, ) -> Result<Self, BadAnimation>

Crates a new animated cursor from multiple CustomCursors Supplied cursors can’t be empty or other animations.

Trait Implementations

impl Clone for CustomCursorSource

fn clone(&self) -> CustomCursorSource

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CustomCursorSource

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

Formats the value using the given formatter.

impl Eq for CustomCursorSource

impl Hash for CustomCursorSource

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for CustomCursorSource

fn eq(&self, other: &CustomCursorSource) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for CustomCursorSource