Skip to main content

InputView

Struct InputView 

Source
pub struct InputView<'a> { /* private fields */ }
Expand description

Read-only gameplay input with game-chosen action and pointer-motion masks.

Implementations§

Source§

impl<'a> InputView<'a>

Source

pub fn with_blocked_axes(self, blocked: &'a [Axis]) -> Self

Adds explicit analog masks to this gameplay view. Masked values are neutral; raw input stays readable by UI and held values resume unmasked.

Source

pub fn value(&self, axis: Axis) -> f32

Latest analog value, or zero when this axis is masked.

Source

pub fn down(&self, action: Action) -> bool

Whether an unmasked action is held.

Source

pub fn pressed(&self, action: Action) -> bool

Whether an unmasked action was pressed.

Source

pub fn released(&self, action: Action) -> bool

Whether an unmasked action was released.

Source

pub fn axis(&self, negative: Action, positive: Action) -> f32

Digital axis with masked actions contributing zero.

Source

pub fn pointer_delta(&self) -> Vec2

Relative look motion, or zero while the UI owns it.

Trait Implementations§

Source§

impl<'a> Clone for InputView<'a>

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<'a> Copy for InputView<'a>

Source§

impl<'a> Debug for InputView<'a>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'a> Freeze for InputView<'a>

§

impl<'a> RefUnwindSafe for InputView<'a>

§

impl<'a> Send for InputView<'a>

§

impl<'a> Sync for InputView<'a>

§

impl<'a> Unpin for InputView<'a>

§

impl<'a> UnsafeUnpin for InputView<'a>

§

impl<'a> UnwindSafe for InputView<'a>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> Component for T
where T: Send + Sync + 'static,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.