Struct CustomCursor

pub struct CustomCursor { /* private fields */ }

Use a custom image as a cursor (mouse pointer).

Is guaranteed to be cheap to clone.

Platform-specific

Web: Some browsers have limits on cursor sizes usually at 128x128.

Example

use winit::window::CustomCursor;

let w = 10;
let h = 10;
let rgba = vec![255; (w * h * 4) as usize];

#[cfg(not(target_family = "wasm"))]
let source = CustomCursor::from_rgba(rgba, w, h, w / 2, h / 2).unwrap();

#[cfg(target_family = "wasm")]
let source = {
    use winit::platform::web::CustomCursorExtWeb;
    CustomCursor::from_url(String::from("http://localhost:3000/cursor.png"), 0, 0)
};

if let Ok(custom_cursor) = event_loop.create_custom_cursor(source) {
    window.set_cursor(custom_cursor.clone().into());
}

Implementations

impl CustomCursor

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

Creates a new cursor from an rgba buffer.

The alpha channel is assumed to be not premultiplied.

Trait Implementations

impl Clone for CustomCursor

fn clone(&self) -> CustomCursor

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CustomCursor

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

Formats the value using the given formatter.

impl From<CustomCursor> for Cursor

fn from(custom: CustomCursor) -> Self

Converts to this type from the input type.

impl Hash for CustomCursor

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 CustomCursor

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for CustomCursor

impl StructuralPartialEq for CustomCursor