Struct BtnState

#[repr(C)]
pub struct BtnState(/* private fields */);

A bit-flag for the current state of a button input. https://stereokit.net/Pages/StereoKit/BtnState.html

see also Input [Ui]

Examples

use stereokit_rust::system::BtnState;

let state = BtnState::Active | BtnState::JustActive;
assert!(state.contains(BtnState::Active));
assert!(state.contains(BtnState::JustActive));
assert!(!state.contains(BtnState::JustInactive));
assert!(!state.contains(BtnState::Changed));

Implementations

impl BtnState

pub const Inactive: Self

Is the button currently up, unpressed?

pub const Active: Self

Is the button currently down, pressed?

pub const JustInactive: Self

Has the button just been released? Only true for a single frame.

pub const JustActive: Self

Has the button just been pressed? Only true for a single frame.

pub const Changed: Self

Has the button just changed state this frame?

pub const Any: Self

Matches with all states!

impl BtnState

pub const fn empty() -> Self

Get a flags value with all bits unset.

pub const fn all() -> Self

Get a flags value with all known bits set.

pub const fn bits(&self) -> u32

Get the underlying bits value.

The returned value is exactly the bits set in this flags value.

pub const fn from_bits(bits: u32) -> Option<Self>

Convert from a bits value.

This method will return None if any unknown bits are set.

pub const fn from_bits_truncate(bits: u32) -> Self

Convert from a bits value, unsetting any unknown bits.

pub const fn from_bits_retain(bits: u32) -> Self

Convert from a bits value exactly.

pub fn from_name(name: &str) -> Option<Self>

Get a flags value with the bits of a flag with the given name set.

This method will return None if name is empty or doesn’t correspond to any named flag.

pub const fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

pub const fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

pub const fn intersects(&self, other: Self) -> bool

Whether any set bits in a source flags value are also set in a target flags value.

pub const fn contains(&self, other: Self) -> bool

Whether all set bits in a source flags value are also set in a target flags value.

pub fn insert(&mut self, other: Self)

The bitwise or (|) of the bits in two flags values.

pub fn remove(&mut self, other: Self)

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. remove won’t truncate other, but the ! operator will.

pub fn toggle(&mut self, other: Self)

The bitwise exclusive-or (^) of the bits in two flags values.

pub fn set(&mut self, other: Self, value: bool)

Call insert when value is true or remove when value is false.

pub const fn intersection(self, other: Self) -> Self

The bitwise and (&) of the bits in two flags values.

pub const fn union(self, other: Self) -> Self

The bitwise or (|) of the bits in two flags values.

pub const fn difference(self, other: Self) -> Self

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

pub const fn symmetric_difference(self, other: Self) -> Self

The bitwise exclusive-or (^) of the bits in two flags values.

pub const fn complement(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

impl BtnState

pub const fn iter(&self) -> Iter<BtnState>

Yield a set of contained flags values.

Each yielded flags value will correspond to a defined named flag. Any unknown bits will be yielded together as a final flags value.

pub const fn iter_names(&self) -> IterNames<BtnState>

Yield a set of contained named flags values.

This method is like iter, except only yields bits in contained named flags. Any unknown bits, or bits not corresponding to a contained flag will not be yielded.

impl BtnState

A collection of extension methods for the BtnState enum that makes bit-field checks a little easier. https://stereokit.net/Pages/StereoKit/BtnStateExtensions.html

pub fn make(was_active: bool, is_active: bool) -> BtnState

Creates a Button State using the current and previous frame’s state! These two states allow us to add the “JustActive” and “JustInactive” bitflags when changes happen. https://stereokit.net/Pages/StereoKit/BtnState/Make.html

• was_active - Was it active previously?
• is_active - And is it active currently?

Returns a bitflag with “Just” events added in!

Examples

use stereokit_rust::system::BtnState;

// Button was not pressed, now it is pressed
let state = BtnState::make(false, true);
assert!(state.contains(BtnState::Active));
assert!(state.contains(BtnState::JustActive));
assert!(!state.contains(BtnState::JustInactive));

// Button was pressed, now it is not pressed
let state = BtnState::make(true, false);
assert!(!state.contains(BtnState::Active));
assert!(state.contains(BtnState::JustInactive));
assert!(!state.contains(BtnState::JustActive));

// Button was pressed, still pressed
let state = BtnState::make(true, true);
assert!(state.contains(BtnState::Active));
assert!(!state.contains(BtnState::JustActive));
assert!(!state.contains(BtnState::JustInactive));

pub fn is_active(&self) -> bool

Is the button pressed? https://stereokit.net/Pages/StereoKit/BtnStateExtensions/IsActive.html

pub fn is_just_active(&self) -> bool

Has the button just been pressed this frame? https://stereokit.net/Pages/StereoKit/BtnStateExtensions/IsJustActive.html

pub fn is_just_inactive(&self) -> bool

Has the button just been released this frame? https://stereokit.net/Pages/StereoKit/BtnStateExtensions/IsJustInactive.html

pub fn is_changed(&self) -> bool

Was the button either presses or released this frame? https://stereokit.net/Pages/StereoKit/BtnStateExtensions/IsChanged.html

Trait Implementations

impl Binary for BtnState

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

Formats the value using the given formatter.

impl BitAnd for BtnState

fn bitand(self, other: Self) -> Self

The bitwise and (&) of the bits in two flags values.

type Output = BtnState

The resulting type after applying the & operator.

impl BitAndAssign for BtnState

fn bitand_assign(&mut self, other: Self)

The bitwise and (&) of the bits in two flags values.

impl BitOr for BtnState

fn bitor(self, other: BtnState) -> Self

The bitwise or (|) of the bits in two flags values.

type Output = BtnState

The resulting type after applying the | operator.

impl BitOrAssign for BtnState

fn bitor_assign(&mut self, other: Self)

The bitwise or (|) of the bits in two flags values.

impl BitXor for BtnState

fn bitxor(self, other: Self) -> Self

The bitwise exclusive-or (^) of the bits in two flags values.

type Output = BtnState

The resulting type after applying the ^ operator.

impl BitXorAssign for BtnState

fn bitxor_assign(&mut self, other: Self)

The bitwise exclusive-or (^) of the bits in two flags values.

impl Clone for BtnState

fn clone(&self) -> BtnState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BtnState

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

Formats the value using the given formatter.

impl Default for BtnState

fn default() -> BtnState

Returns the “default value” for a type.

impl Extend<BtnState> for BtnState

fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)

The bitwise or (|) of the bits in each flags value.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl Flags for BtnState

const FLAGS: &'static [Flag<BtnState>]

The set of defined flags.

type Bits = u32

The underlying bits type.

fn bits(&self) -> u32

Get the underlying bits value.

fn from_bits_retain(bits: u32) -> BtnState

Convert from a bits value exactly.

fn empty() -> Self

Get a flags value with all bits unset.

fn all() -> Self

Get a flags value with all known bits set.

fn contains_unknown_bits(&self) -> bool

This method will return true if any unknown bits are set.

fn from_bits(bits: Self::Bits) -> Option<Self>

Convert from a bits value.

fn from_bits_truncate(bits: Self::Bits) -> Self

Convert from a bits value, unsetting any unknown bits.

fn from_name(name: &str) -> Option<Self>

Get a flags value with the bits of a flag with the given name set.

fn iter(&self) -> Iter<Self>

Yield a set of contained flags values.

fn iter_names(&self) -> IterNames<Self>

Yield a set of contained named flags values.

fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

fn intersects(&self, other: Self) -> bool

where Self: Sized,

Whether any set bits in a source flags value are also set in a target flags value.

fn contains(&self, other: Self) -> bool

where Self: Sized,

Whether all set bits in a source flags value are also set in a target flags value.

fn truncate(&mut self)

where Self: Sized,

Remove any unknown bits from the flags.

fn insert(&mut self, other: Self)

where Self: Sized,

The bitwise or (|) of the bits in two flags values.

fn remove(&mut self, other: Self)

where Self: Sized,

The intersection of a source flags value with the complement of a target flags value (&!).

fn toggle(&mut self, other: Self)

where Self: Sized,

The bitwise exclusive-or (^) of the bits in two flags values.

fn set(&mut self, other: Self, value: bool)

where Self: Sized,

Call Flags::insert when value is true or Flags::remove when value is false.

fn clear(&mut self)

where Self: Sized,

Unsets all bits in the flags.

fn intersection(self, other: Self) -> Self

The bitwise and (&) of the bits in two flags values.

fn union(self, other: Self) -> Self

The bitwise or (|) of the bits in two flags values.

fn difference(self, other: Self) -> Self

The intersection of a source flags value with the complement of a target flags value (&!).

fn symmetric_difference(self, other: Self) -> Self

The bitwise exclusive-or (^) of the bits in two flags values.

fn complement(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

impl FromIterator<BtnState> for BtnState

fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self

The bitwise or (|) of the bits in each flags value.

impl IntoIterator for BtnState

type Item = BtnState

The type of the elements being iterated over.

type IntoIter = Iter<BtnState>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl LowerHex for BtnState

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

Formats the value using the given formatter.

impl Not for BtnState

fn not(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

type Output = BtnState

The resulting type after applying the ! operator.

impl Octal for BtnState

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

Formats the value using the given formatter.

impl PartialEq for BtnState

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

fn partial_cmp(&self, other: &BtnState) -> Option<Ordering>

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl PublicFlags for BtnState

type Primitive = u32

The type of the underlying storage.

type Internal = InternalBitFlags

The type of the internal field on the generated flags type.

impl Sub for BtnState

fn sub(self, other: Self) -> Self

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

type Output = BtnState

The resulting type after applying the - operator.

impl SubAssign for BtnState

fn sub_assign(&mut self, other: Self)

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

impl UpperHex for BtnState

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

Formats the value using the given formatter.

impl Copy for BtnState

impl Eq for BtnState

impl StructuralPartialEq for BtnState