Struct SDL_MouseButtonFlags 

#[repr(transparent)]
pub struct SDL_MouseButtonFlags(pub Uint32);

A bitmask of pressed mouse buttons, as reported by SDL_GetMouseState, etc.

• Button 1: Left mouse button
• Button 2: Middle mouse button
• Button 3: Right mouse button
• Button 4: Side mouse button 1
• Button 5: Side mouse button 2

Availability

This datatype is available since SDL 3.2.0.

See also

• SDL_GetMouseState
• SDL_GetGlobalMouseState
• SDL_GetRelativeMouseState

Known values (sdl3-sys)

Associated constant	Global constant	Description
LMASK	SDL_BUTTON_LMASK
MMASK	SDL_BUTTON_MMASK
RMASK	SDL_BUTTON_RMASK
X1MASK	SDL_BUTTON_X1MASK
X2MASK	SDL_BUTTON_X2MASK

Tuple Fields

0: Uint32

Implementations

impl SDL_MouseButtonFlags

pub const LMASK: Self

pub const MMASK: Self

pub const RMASK: Self

pub const X1MASK: Self

pub const X2MASK: Self

Trait Implementations

impl BitAnd for SDL_MouseButtonFlags

type Output = SDL_MouseButtonFlags

The resulting type after applying the & operator.

fn bitand(self, rhs: Self) -> Self::Output

Performs the & operation.

impl BitAndAssign for SDL_MouseButtonFlags

fn bitand_assign(&mut self, rhs: Self)

Performs the &= operation.

impl BitOr for SDL_MouseButtonFlags

type Output = SDL_MouseButtonFlags

The resulting type after applying the | operator.

fn bitor(self, rhs: Self) -> Self::Output

Performs the | operation.

impl BitOrAssign for SDL_MouseButtonFlags

fn bitor_assign(&mut self, rhs: Self)

Performs the |= operation.

impl BitXor for SDL_MouseButtonFlags

type Output = SDL_MouseButtonFlags

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: Self) -> Self::Output

Performs the ^ operation.

impl BitXorAssign for SDL_MouseButtonFlags

fn bitxor_assign(&mut self, rhs: Self)

Performs the ^= operation.

impl Clone for SDL_MouseButtonFlags

fn clone(&self) -> SDL_MouseButtonFlags

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SDL_MouseButtonFlags

Available on crate feature debug-impls only.

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

Formats the value using the given formatter.

impl Default for SDL_MouseButtonFlags

fn default() -> SDL_MouseButtonFlags

Returns the “default value” for a type.

impl From<SDL_MouseButtonFlags> for Uint32

fn from(value: SDL_MouseButtonFlags) -> Self

Converts to this type from the input type.

impl GroupMetadata for SDL_MouseButtonFlags

Available on crate feature metadata only.

const GROUP_METADATA: &'static Group

Metadata for this group

impl Hash for SDL_MouseButtonFlags

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 Not for SDL_MouseButtonFlags

type Output = SDL_MouseButtonFlags

The resulting type after applying the ! operator.

fn not(self) -> Self::Output

Performs the unary ! operation.

impl PartialEq<SDL_MouseButtonFlags> for Uint32

fn eq(&self, other: &SDL_MouseButtonFlags) -> 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 PartialEq<u32> for SDL_MouseButtonFlags

fn eq(&self, other: &Uint32) -> 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 PartialEq for SDL_MouseButtonFlags

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

impl Eq for SDL_MouseButtonFlags

impl StructuralPartialEq for SDL_MouseButtonFlags