Struct piston::ButtonArgs

pub struct ButtonArgs {
    pub state: ButtonState,
    pub button: Button,
    pub scancode: Option<i32>,
}

[−] Expand description

Button arguments.

Fields

state: ButtonState

[−] Expand description

New state of the button.

button: Button

[−] Expand description

The button that changed state.

scancode: Option<i32>

[−] Expand description

An optional scancode that tells the physical layout of a keyboard key. For other devices than keyboard, this is set to None.

Scancode follows SDL (https://wiki.libsdl.org/SDL_Scancode).

This is stored here to make Button equality check work with keyboard layouts.

Some window backends might not support scancodes. To test a window backend, use https://github.com/PistonDevelopers/piston-examples/tree/master/user_input

Trait Implementations

impl Clone for ButtonArgs[+]

[+] Show hidden undocumented items

pub fn clone(&self) -> ButtonArgs[−]

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)[−]

Performs copy-assignment from source.

impl Copy for ButtonArgs

impl Debug for ButtonArgs[+]

[+] Show hidden undocumented items

pub fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>[−]

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ButtonArgs[+]

[+] Show hidden undocumented items

pub fn deserialize<__D>(
    __deserializer: __D
) -> Result<ButtonArgs, <__D as Deserializer<'de>>::Error> where
    __D: Deserializer<'de>, [−]

Deserialize this value from the given Serde deserializer.

impl Eq for ButtonArgs

impl From<ButtonArgs> for Input[+]

[+] Show hidden undocumented items

pub fn from(args: ButtonArgs) -> Input[−]

Performs the conversion.

impl Hash for ButtonArgs[+]

[+] Show hidden undocumented items

pub fn hash<__H>(&self, state: &mut __H) where
    __H: Hasher, [−]

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, [−]

Feeds a slice of this type into the given Hasher.

impl Ord for ButtonArgs[+]

[+] Show hidden undocumented items

pub fn cmp(&self, other: &ButtonArgs) -> Ordering[−]

This method returns an Ordering between self and other.

#[must_use]

pub fn max(self, other: Self) -> Self[−]

Compares and returns the maximum of two values.

#[must_use]

pub fn min(self, other: Self) -> Self[−]

Compares and returns the minimum of two values.

#[must_use]

pub fn clamp(self, min: Self, max: Self) -> Self[−]

Restrict a value to a certain interval.

impl PartialEq<ButtonArgs> for ButtonArgs[+]

[+] Show hidden undocumented items

pub fn eq(&self, other: &ButtonArgs) -> bool[−]

This method tests for self and other values to be equal, and is used by ==.

pub fn ne(&self, other: &ButtonArgs) -> bool[−]

This method tests for !=.

impl PartialOrd<ButtonArgs> for ButtonArgs[+]

[+] Show hidden undocumented items

pub fn partial_cmp(&self, other: &ButtonArgs) -> Option<Ordering>[−]

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

#[must_use]

pub fn lt(&self, other: &Rhs) -> bool[−]

This method tests less than (for self and other) and is used by the < operator.

#[must_use]

pub fn le(&self, other: &Rhs) -> bool[−]

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

#[must_use]

pub fn gt(&self, other: &Rhs) -> bool[−]

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]

pub fn ge(&self, other: &Rhs) -> bool[−]

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

impl Serialize for ButtonArgs[+]

[+] Show hidden undocumented items

pub fn serialize<__S>(
    &self,
    __serializer: __S
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error> where
    __S: Serializer, [−]

Serialize this value into the given Serde serializer.

impl StructuralEq for ButtonArgs

impl StructuralPartialEq for ButtonArgs