Struct bevy_math::BVec3

pub struct BVec3 {
    pub x: bool,
    pub y: bool,
    pub z: bool,
}

A 3-dimensional bool vector mask.

Fields

x: bool

y: bool

z: bool

Implementations

impl BVec3

pub const FALSE: BVec3 = Self::splat(false)

All false.

pub const TRUE: BVec3 = Self::splat(true)

All true.

pub const fn new(x: bool, y: bool, z: bool) -> BVec3

Creates a new vector mask.

pub const fn splat(v: bool) -> BVec3

Creates a vector with all elements set to v.

pub fn bitmask(self) -> u32

Returns a bitmask with the lowest 3 bits set from the elements of self.

A true element results in a 1 bit and a false element in a 0 bit. Element x goes into the first lowest bit, element y into the second, etc.

pub fn any(self) -> bool

Returns true if any of the elements are true, false otherwise.

pub fn all(self) -> bool

Returns true if all the elements are true, false otherwise.

Trait Implementations

impl BitAnd<BVec3> for BVec3

type Output = BVec3

The resulting type after applying the & operator.

fn bitand(self, rhs: BVec3) -> BVec3

Performs the & operation.

impl BitAndAssign<BVec3> for BVec3

fn bitand_assign(&mut self, rhs: BVec3)

Performs the &= operation.

impl BitOr<BVec3> for BVec3

type Output = BVec3

The resulting type after applying the | operator.

fn bitor(self, rhs: BVec3) -> BVec3

Performs the | operation.

impl BitOrAssign<BVec3> for BVec3

fn bitor_assign(&mut self, rhs: BVec3)

Performs the |= operation.

impl BitXor<BVec3> for BVec3

type Output = BVec3

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: BVec3) -> BVec3

Performs the ^ operation.

impl BitXorAssign<BVec3> for BVec3

fn bitxor_assign(&mut self, rhs: BVec3)

Performs the ^= operation.

impl Clone for BVec3

fn clone(&self) -> BVec3

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BVec3

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

Formats the value using the given formatter.

impl Default for BVec3

fn default() -> BVec3

Returns the “default value” for a type.

impl Display for BVec3

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

Formats the value using the given formatter.

impl Hash for BVec3

fn hash<__H>(&self, state: &mut __H)where
    __H: Hasher,

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 Not for BVec3

type Output = BVec3

The resulting type after applying the ! operator.

fn not(self) -> BVec3

Performs the unary ! operation.

impl PartialEq<BVec3> for BVec3

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

impl Eq for BVec3

impl StructuralEq for BVec3

impl StructuralPartialEq for BVec3