Struct CustomPointerIcon 

pub struct CustomPointerIcon { /* private fields */ }

An application-drawn pointer shape: a bitmap plus the hotspot, the pixel inside the image that sits exactly on the pointer’s position.

The alpha channel is not premultiplied, which is what both winit and the browser expect of cursor images.

Implementations

impl CustomPointerIcon

pub fn new( image: ImageBitmap, hotspot_x: u32, hotspot_y: u32, ) -> Result<CustomPointerIcon, PointerIconError>

Builds a custom pointer icon from image, with its hotspot at (hotspot_x, hotspot_y) pixels from the image’s top-left corner.

pub fn image(&self) -> &ImageBitmap

The icon’s bitmap, with unpremultiplied alpha in its declared pixel format.

pub fn hotspot_x(&self) -> u32

The hotspot’s x offset from the image’s left edge, in pixels.

pub fn hotspot_y(&self) -> u32

The hotspot’s y offset from the image’s top edge, in pixels.

pub fn id(&self) -> u64

A stable identity derived from the pixels and the hotspot. Platform backends key their per-window cursor caches on it so an icon that reappears across frames is uploaded to the windowing system once.

Trait Implementations

impl Clone for CustomPointerIcon

fn clone(&self) -> CustomPointerIcon

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CustomPointerIcon

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

Formats the value using the given formatter.

impl Eq for CustomPointerIcon

impl From<CustomPointerIcon> for PointerIcon

fn from(icon: CustomPointerIcon) -> PointerIcon

Converts to this type from the input type.

impl Hash for CustomPointerIcon

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

where __H: Hasher,

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 CustomPointerIcon

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for CustomPointerIcon