Struct winit::window::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::CustomCursorExtWebSys;
    CustomCursor::from_url(String::from("http://localhost:3000/cursor.png"), 0, 0)
};

let custom_cursor = event_loop.create_custom_cursor(source);

window.set_cursor(custom_cursor.clone());

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.

Examples found in repository

examples/window.rs (line 936)

fn decode_cursor(bytes: &[u8]) -> CustomCursorSource {
    let img = image::load_from_memory(bytes).unwrap().to_rgba8();
    let samples = img.into_flat_samples();
    let (_, w, h) = samples.extents();
    let (w, h) = (w as u16, h as u16);
    CustomCursor::from_rgba(samples.samples, w, h, w / 2, h / 2).unwrap()
}

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 CustomCursorExtWebSys for CustomCursor

Available on web_platform only.

fn is_animation(&self) -> bool

Returns if this cursor is an animation.

fn from_url(url: String, hotspot_x: u16, hotspot_y: u16) -> CustomCursorSource

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.

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

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

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

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

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

This method 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