Enum MouseButton 

#[repr(u8)]
pub enum MouseButton {
    Left = 0,
    Right = 1,
    Middle = 2,
    Back = 3,
    Forward = 4,
    Button6 = 5,
    Button7 = 6,
    Button8 = 7,
    Button9 = 8,
    Button10 = 9,
    Button11 = 10,
    Button12 = 11,
    Button13 = 12,
    Button14 = 13,
    Button15 = 14,
    Button16 = 15,
    Button17 = 16,
    Button18 = 17,
    Button19 = 18,
    Button20 = 19,
    Button21 = 20,
    Button22 = 21,
    Button23 = 22,
    Button24 = 23,
    Button25 = 24,
    Button26 = 25,
    Button27 = 26,
    Button28 = 27,
    Button29 = 28,
    Button30 = 29,
    Button31 = 30,
    Button32 = 31,
}

Identifies a button of a mouse controller.

Platform-specific

The first three buttons should be supported on all platforms. Self::Back and Self::Forward are supported on most platforms (when using a compatible mouse).

• Android, iOS: Currently not supported.
• Orbital: Only left/right/middle buttons are supported at this time.
• Web, Windows: Supports left/right/middle/back/forward buttons.
• Wayland: Supports buttons 0..=15.
• macOS: Supports all button variants.
• X11: Technically supports further buttons than this (0..=250), these are emitted in ButtonSource::Unknown.

Variants

Left = 0

The primary (usually left) button

Right = 1

The secondary (usually right) button

Middle = 2

The tertiary (usually middle) button

Back = 3

The first side button, frequently assigned a back function

Forward = 4

The second side button, frequently assigned a forward function

Button6 = 5

The sixth button

Button7 = 6

The seventh button

Button8 = 7

The eighth button

Button9 = 8

The ninth button

Button10 = 9

The tenth button

Button11 = 10

The eleventh button

Button12 = 11

The twelfth button

Button13 = 12

The thirteenth button

Button14 = 13

The fourteenth button

Button15 = 14

The fifteenth button

Button16 = 15

The sixteenth button

Button17 = 16

Button18 = 17

Button19 = 18

Button20 = 19

Button21 = 20

Button22 = 21

Button23 = 22

Button24 = 23

Button25 = 24

Button26 = 25

Button27 = 26

Button28 = 27

Button29 = 28

Button30 = 29

Button31 = 30

Button32 = 31

Implementations

impl MouseButton

pub fn try_from_u8(b: u8) -> Option<MouseButton>

Construct from a u8 if within the range 0..=31

Trait Implementations

impl Clone for MouseButton

fn clone(&self) -> MouseButton

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MouseButton

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

Formats the value using the given formatter.

impl From<MouseButton> for ButtonSource

fn from(mouse: MouseButton) -> Self

Converts to this type from the input type.

impl Hash for MouseButton

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 Ord for MouseButton

fn cmp(&self, other: &MouseButton) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for MouseButton

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

fn partial_cmp(&self, other: &MouseButton) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for MouseButton

impl Eq for MouseButton

impl StructuralPartialEq for MouseButton