Enum ButtonSource 

#[non_exhaustive]
pub enum ButtonSource {
    Mouse(MouseButton),
    Touch {
        finger_id: FingerId,
        force: Option<Force>,
    },
    TabletTool {
        kind: TabletToolKind,
        button: TabletToolButton,
        data: TabletToolData,
    },
    Unknown(u16),
}

Represents the pointer type of a WindowEvent::PointerButton.

Wayland/X11: Unknown device types are converted to known variants by the system.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Mouse(MouseButton)

Platform-specific

macOS

Users may expect holding CTRL while clicking MouseButton::Left to result in a “secondary” click, but the way these clicks behave natively is slightly different from how a physical secondary button press would, depending on the content under the cursor when clicked. If applications want this behavior they should implement it themselves by interpreting Left clicks as secondary when CTRL is held and their internal logic deems it appropriate for the content under the pointer. See also https://github.com/rust-windowing/winit/issues/4469.

Touch

See PointerSource::Touch for more details.

Platform-specific

macOS: Unsupported.

Fields

finger_id: FingerId

force: Option<Force>

TabletTool

Fields

kind: TabletToolKind

button: TabletToolButton

data: TabletToolData

Unknown(u16)

A pointer button of unknown source.

Codes are undefined and may not be reproducible across platforms or winit versions.

Implementations

impl ButtonSource

pub fn mouse_button(self) -> Option<MouseButton>

Try to convert a ButtonSource to an equivalent MouseButton. If a pointer type has no special handling in an application, this method can be used to handle it like any generic mouse input.

Trait Implementations

impl Clone for ButtonSource

fn clone(&self) -> ButtonSource

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ButtonSource

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 PartialEq for ButtonSource

fn eq(&self, other: &ButtonSource) -> bool

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ButtonSource