Struct leafwing_input_manager::axislike::VirtualDPad

pub struct VirtualDPad {
    pub up: InputKind,
    pub down: InputKind,
    pub left: InputKind,
    pub right: InputKind,
}

A virtual DPad that you can get an DualAxis from.

Typically, you don’t want to store a DualAxis in this type, even though it can be stored as an InputKind.

Instead, use it directly as InputKind::DualAxis!

Fields

up: InputKind

The input that represents the up direction in this virtual DPad

down: InputKind

The input that represents the down direction in this virtual DPad

left: InputKind

The input that represents the left direction in this virtual DPad

right: InputKind

The input that represents the right direction in this virtual DPad

Implementations

impl VirtualDPad

pub fn arrow_keys() -> VirtualDPad

Generates a VirtualDPad corresponding to the arrow keyboard keycodes

pub fn wasd() -> VirtualDPad

Generates a VirtualDPad corresponding to the WASD keys on the standard US QWERTY layout.

Note that on other keyboard layouts, different keys need to be pressed. The location of the keys is the same on all keyboard layouts. This ensures that the classic triangular shape is retained on all layouts, which enables comfortable movement controls.

pub fn dpad() -> VirtualDPad

Generates a VirtualDPad corresponding to the DPad on a gamepad

pub fn gamepad_face_buttons() -> VirtualDPad

Generates a VirtualDPad corresponding to the face buttons on a gamepad

North corresponds to up, west corresponds to left, east corresponds to right, south corresponds to down

pub fn mouse_wheel() -> VirtualDPad

Generates a VirtualDPad corresponding to discretized mousewheel movements

pub fn mouse_motion() -> VirtualDPad

Generates a VirtualDPad corresponding to discretized mouse motions

pub fn inverted_y(self) -> Self

Returns this VirtualDPad but with up and down swapped.

pub fn inverted_x(self) -> Self

Returns this VirtualDPad but with left and right swapped.

pub fn inverted(self) -> Self

Returns this VirtualDPad but with inverted inputs.

Trait Implementations

impl Clone for VirtualDPad

fn clone(&self) -> VirtualDPad

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for VirtualDPad

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for VirtualDPad

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<VirtualDPad> for UserInput

fn from(input: VirtualDPad) -> Self

Converts to this type from the input type.

impl Hash for VirtualDPad

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

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for VirtualDPad

impl StructuralEq for VirtualDPad

impl StructuralPartialEq for VirtualDPad