Struct SDL_MouseButtonEvent 

#[repr(C)]
pub struct SDL_MouseButtonEvent {
    pub type: SDL_EventType,
    pub reserved: Uint32,
    pub timestamp: Uint64,
    pub windowID: SDL_WindowID,
    pub which: SDL_MouseID,
    pub button: Uint8,
    pub down: bool,
    pub clicks: Uint8,
    pub padding: Uint8,
    pub x: c_float,
    pub y: c_float,
}

Mouse button event structure (event.button.*)

Availability

This struct is available since SDL 3.2.0.

Notes for sdl3-sys

This struct has padding fields which shouldn’t be accessed directly; use struct update syntax with e.g. ..Default::default() for manual construction.

Fields

type: SDL_EventType

SDL_EVENT_MOUSE_BUTTON_DOWN or SDL_EVENT_MOUSE_BUTTON_UP

reserved: Uint32

timestamp: Uint64

In nanoseconds, populated using SDL_GetTicksNS()

windowID: SDL_WindowID

The window with mouse focus, if any

which: SDL_MouseID

The mouse instance id in relative mode, SDL_TOUCH_MOUSEID for touch events, or 0

button: Uint8

The mouse button index

down: bool

true if the button is pressed

clicks: Uint8

1 for single-click, 2 for double-click, etc.

padding: Uint8

👎Deprecated: padding fields are exempt from semver; init with ..Default::default()

x: c_float

X coordinate, relative to window

y: c_float

Y coordinate, relative to window

Trait Implementations

impl Clone for SDL_MouseButtonEvent

fn clone(&self) -> SDL_MouseButtonEvent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SDL_MouseButtonEvent

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

Formats the value using the given formatter.

impl Default for SDL_MouseButtonEvent

fn default() -> SDL_MouseButtonEvent

Returns the “default value” for a type.

impl PartialEq for SDL_MouseButtonEvent

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

impl StructuralPartialEq for SDL_MouseButtonEvent