Struct rich_sdl2_rust::event::mouse::MouseWheelEvent

pub struct MouseWheelEvent {
    pub timestamp: u32,
    pub window_id: u32,
    pub mouse_id: u32,
    pub scroll_amount: Point,
    pub scroll_amount_precise: (f32, f32),
    pub is_flipped: bool,
}

An event that the mouse wheel was scrolled.

Fields

timestamp: u32

When this event occurred.

window_id: u32

The id of the window focused.

mouse_id: u32

The id of the moved.

scroll_amount: Point

How much the wheel scrolled. X is the amount scrolled horizontally, positive to the right and negative to the left. Y is the amount scrolled vertically, positive away from the user and negative towards to the user.

scroll_amount_precise: (f32, f32)

How much the wheel scrolled with float precision. The first element is the amount scrolled horizontally, positive to the right and negative to the left. The second element is the amount scrolled vertically, positive away from the user and negative towards to the user.

The value returned from the API does not contain NaN or infinity number. You should not edit the value because that MouseWheelEvent implements Eq.

is_flipped: bool

Whether the scroll direction is inverted.

Trait Implementations

impl Clone for MouseWheelEvent

fn clone(&self) -> MouseWheelEvent

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MouseWheelEvent

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

Formats the value using the given formatter.

impl From<SDL_MouseWheelEvent> for MouseWheelEvent

fn from(raw: SDL_MouseWheelEvent) -> Self

Converts to this type from the input type.

impl PartialEq for MouseWheelEvent

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

impl StructuralPartialEq for MouseWheelEvent