Struct WebEventMouse 

#[repr(C)]
pub struct WebEventMouse {
    pub x: js_number,
    pub y: js_number,
    pub button: u8,
    pub buttons: u8,
    pub mods: KeyMods,
    pub etype: WebEventKind,
    pub timestamp: JsInstant,
}

Available on crate features event and web only.

🎫 🌐 A web API Mouse Event.

---

^{📍 sys/os/browser/web}

^{📦 size_of::<WebEventMouse>() == 32 bytes / 256 bits ⚗️Option<T>}

---

Represents a JavaScript mouse event containing relevant properties.

• https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent

Compatibility

Browser Back/Forward mouse buttons are backend-dependent.

Chromium exposes them as DOM mouse events (button 3/4, buttons 8/16). Firefox currently may consume them for history navigation before the page receives mousedown/mouseup.

Fields

x: js_number

The X-coordinate of the mouse event relative to the viewport.

y: js_number

The Y-coordinate of the mouse event relative to the viewport.

button: u8

Raw DOM-compatible button value.

Uses 255 to represent DOM button = -1, meaning no button changed.

buttons: u8

Raw DOM buttons bitmask for buttons currently held down.

mods: KeyMods

A bitmask of active keyboard modifiers during the mouse event.

etype: WebEventKind

The type of mouse event (Click, MouseDown, MouseMove, etc.).

timestamp: JsInstant

The JavaScript event timestamp.

Implementations

impl WebEventMouse

pub const fn new( x: js_number, y: js_number, button: u8, buttons: u8, mods: KeyMods, etype: WebEventKind, timestamp: JsInstant, ) -> Self

Returns a new WebEventMouse.

impl WebEventMouse

pub const fn button(self) -> Option<EventButton>

Returns the normalized triggering button, or None when no button changed.

pub const fn web_button(self) -> u8

Returns the raw DOM-compatible button value.

Returns 255 for DOM button = -1, meaning no button changed.

pub const fn buttons(self) -> EventButtons

Returns the normalized held-button set.

pub const fn web_buttons(self) -> u8

Returns the raw DOM buttons bitmask.

pub const fn to_kind_timed(self) -> EventKindTimed

Converts WebEventMouse to EventKindTimed.

pub const fn from_event_mouse_timed( from: Timed<EventMouse, Option<EventTimestamp>>, ) -> WebEventMouse

Converts a timed normalized EventMouse back to WebEventMouse.

Trait Implementations

impl Clone for WebEventMouse

fn clone(&self) -> WebEventMouse

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for WebEventMouse

impl Debug for WebEventMouse

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

Formats the value using the given formatter.

impl From<Timed<EventMouse, Option<EventTimestamp>>> for WebEventMouse

fn from(from: Timed<EventMouse, Option<EventTimestamp>>) -> Self

Converts to this type from the input type.

impl From<WebEventMouse> for EventKindTimed

fn from(from: WebEventMouse) -> Self

Converts to this type from the input type.

impl PartialEq for WebEventMouse

fn eq(&self, other: &WebEventMouse) -> 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 StructuralPartialEq for WebEventMouse