Struct BVec3

#[repr(C, align(1))]
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: Self = _

All false.

pub const TRUE: Self = _

All true.

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

Creates a new vector mask.

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

Creates a vector mask with all elements set to v.

pub const fn from_array(a: [bool; 3]) -> Self

Creates a new vector mask from a bool array.

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.

pub fn test(&self, index: usize) -> bool

Tests the value at index.

Panics if index is greater than 2.

pub fn set(&mut self, index: usize, value: bool)

Sets the element at index.

Panics if index is greater than 2.

Trait Implementations

impl BitAnd for BVec3

type Output = BVec3

The resulting type after applying the & operator.

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

Performs the & operation.

impl BitAndAssign for BVec3

fn bitand_assign(&mut self, rhs: Self)

Performs the &= operation.

impl BitOr for BVec3

type Output = BVec3

The resulting type after applying the | operator.

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

Performs the | operation.

impl BitOrAssign for BVec3

fn bitor_assign(&mut self, rhs: Self)

Performs the |= operation.

impl BitXor for BVec3

type Output = BVec3

The resulting type after applying the ^ operator.

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

Performs the ^ operation.

impl BitXorAssign for BVec3

fn bitxor_assign(&mut self, rhs: Self)

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

Formats the value using the given formatter.

impl Default for BVec3

fn default() -> Self

Returns the “default value” for a type.

impl Display for BVec3

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

Formats the value using the given formatter.

impl From<[bool; 3]> for BVec3

fn from(a: [bool; 3]) -> Self

Converts to this type from the input type.

impl From<BVec3> for [bool; 3]

fn from(mask: BVec3) -> Self

Converts to this type from the input type.

impl From<BVec3> for [u32; 3]

fn from(mask: BVec3) -> Self

Converts to this type from the input type.

impl From<BVec3> for DVec3

fn from(v: BVec3) -> Self

Converts to this type from the input type.

impl From<BVec3> for I16Vec3

fn from(v: BVec3) -> Self

Converts to this type from the input type.

impl From<BVec3> for I64Vec3

fn from(v: BVec3) -> Self

Converts to this type from the input type.

impl From<BVec3> for I8Vec3

fn from(v: BVec3) -> Self

Converts to this type from the input type.

impl From<BVec3> for IVec3

fn from(v: BVec3) -> Self

Converts to this type from the input type.

impl From<BVec3> for U16Vec3

fn from(v: BVec3) -> Self

Converts to this type from the input type.

impl From<BVec3> for U64Vec3

fn from(v: BVec3) -> Self

Converts to this type from the input type.

impl From<BVec3> for U8Vec3

fn from(v: BVec3) -> Self

Converts to this type from the input type.

impl From<BVec3> for UVec3

fn from(v: BVec3) -> Self

Converts to this type from the input type.

impl From<BVec3> for Vec3

fn from(v: BVec3) -> Self

Converts to this type from the input type.

impl From<BVec3> for Vec3A

fn from(v: BVec3) -> Self

Converts to this type from the input type.

impl Hash for BVec3

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

type Output = BVec3

The resulting type after applying the ! operator.

fn not(self) -> Self

Performs the unary ! operation.

impl PartialEq for BVec3

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

impl Eq for BVec3

impl StructuralPartialEq for BVec3