Struct LayerMask

pub struct LayerMask(pub u32);

A bitmask for layers.

A LayerMask can be constructed from bits directly, or from types implementing PhysicsLayer. The first bit 0b0001 is reserved for the default layer, which all entities belong to by default.

#[derive(PhysicsLayer, Clone, Copy, Debug, Default)]
enum GameLayer {
    #[default]
    Default, // Layer 0 - the default layer that objects are assigned to
    Player,  // Layer 1
    Enemy,   // Layer 2
    Ground,  // Layer 3
}

// The first bit is reserved for the default layer.
assert_eq!(GameLayer::default().to_bits(), 1 << 0);

// The `GameLayer::Ground` layer is the fourth layer, so its bit value is `1 << 3`.
assert_eq!(GameLayer::Ground.to_bits(), 1 << 3);

// Here, `GameLayer::Enemy` is automatically converted to a `LayerMask` for the comparison.
assert_eq!(LayerMask(0b00100), GameLayer::Enemy);

Bitwise operations can be used to modify and combine masks:

let mask1 = LayerMask(0b0001);
let mask2 = LayerMask(0b0010);
assert_eq!(mask1 | mask2, LayerMask(0b0011));

// You can also add layers from `u32` bitmasks and compare against them directly.
assert_eq!(mask1 | 0b0010, 0b0011);

Another way to use LayerMask is to define layers as constants:

// `1 << n` is bitshifting: the first layer shifted by `n` layers.
pub const FIRST_LAYER: LayerMask = LayerMask(1 << 0);
pub const LAST_LAYER: LayerMask = LayerMask(1 << 31);

// Bitwise operations for `LayerMask` unfortunately can't be const, so we need to access the `u32` values.
pub const COMBINED: LayerMask = LayerMask(FIRST_LAYER.0 | LAST_LAYER.0);

Tuple Fields

0: u32

Implementations

impl LayerMask

pub const ALL: Self

Contains all layers.

pub const NONE: Self

Contains no layers.

pub const DEFAULT: Self

Contains the default layer.

pub fn add(&mut self, layers: impl Into<Self>)

Adds the given layers to self.

Example

let mut layers = LayerMask(0b1010);

// These are equivalent
layers.add(0b0001);
layers |= 0b0001;

assert_eq!(layers, 0b1011);

pub fn remove(&mut self, layers: impl Into<Self>)

Removes the given layers from self.

Example

let mut layers = LayerMask(0b1010);

// These are equivalent
layers.remove(0b0010);
layers &= !0b0010;

assert_eq!(layers, 0b1000);

pub fn has_all(self, layers: impl Into<Self>) -> bool

Returns true if self contains all of the given layers.

Example

let mut layers = LayerMask(0b1010);

// These are equivalent
assert!(layers.has_all(0b1010));
assert!((layers & 0b1010) != 0);

assert!(!layers.has_all(0b0100));
assert!((layers & 0b0100) == 0);

Methods from Deref<Target = u32>

pub const MIN: u32 = 0u32

pub const MAX: u32 = 4_294_967_295u32

pub const BITS: u32 = 32u32

Trait Implementations

impl<L: Into<LayerMask>> BitAnd<L> for LayerMask

type Output = LayerMask

The resulting type after applying the & operator.

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

Performs the & operation.

impl<L: Into<LayerMask>> BitAndAssign<L> for LayerMask

fn bitand_assign(&mut self, rhs: L)

Performs the &= operation.

impl<L: Into<LayerMask>> BitOr<L> for LayerMask

type Output = LayerMask

The resulting type after applying the | operator.

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

Performs the | operation.

impl<L: Into<LayerMask>> BitOrAssign<L> for LayerMask

fn bitor_assign(&mut self, rhs: L)

Performs the |= operation.

impl<L: Into<LayerMask>> BitXor<L> for LayerMask

type Output = LayerMask

The resulting type after applying the ^ operator.

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

Performs the ^ operation.

impl<L: Into<LayerMask>> BitXorAssign<L> for LayerMask

fn bitxor_assign(&mut self, rhs: L)

Performs the ^= operation.

impl Clone for LayerMask

fn clone(&self) -> LayerMask

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LayerMask

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

Formats the value using the given formatter.

impl Deref for LayerMask

type Target = u32

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for LayerMask

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<L: Into<LayerMask>, const N: usize> From<[L; N]> for LayerMask

fn from(value: [L; N]) -> Self

Converts to this type from the input type.

impl<L: PhysicsLayer> From<L> for LayerMask

fn from(layer: L) -> Self

Converts to this type from the input type.

impl From<u32> for LayerMask

fn from(layer: u32) -> Self

Converts to this type from the input type.

impl FromReflect for LayerMask

fn from_reflect(reflect: &dyn PartialReflect) -> Option<Self>

Constructs a concrete instance of Self from a reflected value.

fn take_from_reflect( reflect: Box<dyn PartialReflect>, ) -> Result<Self, Box<dyn PartialReflect>>

Attempts to downcast the given value to Self using, constructing the value using from_reflect if that fails.

impl GetTypeRegistration for LayerMask

fn get_type_registration() -> TypeRegistration

Returns the default TypeRegistration for this type.

fn register_type_dependencies(registry: &mut TypeRegistry)

Registers other types needed by this type.

impl Not for LayerMask

type Output = LayerMask

The resulting type after applying the ! operator.

fn not(self) -> Self::Output

Performs the unary ! operation.

impl Ord for LayerMask

fn cmp(&self, other: &LayerMask) -> Ordering

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<L: Into<LayerMask> + Copy> PartialEq<L> for LayerMask

fn eq(&self, other: &L) -> 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 LayerMask

fn partial_cmp(&self, other: &LayerMask) -> 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 PartialReflect for LayerMask

fn get_represented_type_info(&self) -> Option<&'static TypeInfo>

Returns the TypeInfo of the type represented by this value.

fn try_apply(&mut self, value: &dyn PartialReflect) -> Result<(), ApplyError>

Tries to apply a reflected value to this value.

fn reflect_kind(&self) -> ReflectKind

Returns a zero-sized enumeration of “kinds” of type.

fn reflect_ref(&self) -> ReflectRef<'_>

Returns an immutable enumeration of “kinds” of type.

fn reflect_mut(&mut self) -> ReflectMut<'_>

Returns a mutable enumeration of “kinds” of type.

fn reflect_owned(self: Box<Self>) -> ReflectOwned

Returns an owned enumeration of “kinds” of type.

fn try_into_reflect( self: Box<Self>, ) -> Result<Box<dyn Reflect>, Box<dyn PartialReflect>>

Attempts to cast this type to a boxed, fully-reflected value.

fn try_as_reflect(&self) -> Option<&dyn Reflect>

Attempts to cast this type to a fully-reflected value.

fn try_as_reflect_mut(&mut self) -> Option<&mut dyn Reflect>

Attempts to cast this type to a mutable, fully-reflected value.

fn into_partial_reflect(self: Box<Self>) -> Box<dyn PartialReflect>

Casts this type to a boxed, reflected value.

fn as_partial_reflect(&self) -> &dyn PartialReflect

Casts this type to a reflected value.

fn as_partial_reflect_mut(&mut self) -> &mut dyn PartialReflect

Casts this type to a mutable, reflected value.

fn reflect_partial_eq(&self, value: &dyn PartialReflect) -> Option<bool>

Returns a “partial equality” comparison result.

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

Debug formatter for the value.

fn reflect_clone(&self) -> Result<Box<dyn Reflect>, ReflectCloneError>

Attempts to clone Self using reflection.

fn apply(&mut self, value: &(dyn PartialReflect + 'static))

Applies a reflected value to this value.

fn to_dynamic(&self) -> Box<dyn PartialReflect>

Converts this reflected value into its dynamic representation based on its kind.

fn reflect_clone_and_take<T>(&self) -> Result<T, ReflectCloneError>

where T: 'static, Self: Sized + TypePath,

For a type implementing PartialReflect, combines reflect_clone and take in a useful fashion, automatically constructing an appropriate ReflectCloneError if the downcast fails.

fn reflect_hash(&self) -> Option<u64>

Returns a hash of the value (which includes the type).

fn is_dynamic(&self) -> bool

Indicates whether or not this type is a dynamic type.

impl Reflect for LayerMask

fn into_any(self: Box<Self>) -> Box<dyn Any>

Returns the value as a Box<dyn Any>.

fn as_any(&self) -> &dyn Any

Returns the value as a &dyn Any.

fn as_any_mut(&mut self) -> &mut dyn Any

Returns the value as a &mut dyn Any.

fn into_reflect(self: Box<Self>) -> Box<dyn Reflect>

Casts this type to a boxed, fully-reflected value.

fn as_reflect(&self) -> &dyn Reflect

Casts this type to a fully-reflected value.

fn as_reflect_mut(&mut self) -> &mut dyn Reflect

Casts this type to a mutable, fully-reflected value.

fn set(&mut self, value: Box<dyn Reflect>) -> Result<(), Box<dyn Reflect>>

Performs a type-checked assignment of a reflected value to this value.

impl TupleStruct for LayerMask

fn field(&self, index: usize) -> Option<&dyn PartialReflect>

Returns a reference to the value of the field with index index as a &dyn Reflect.

fn field_mut(&mut self, index: usize) -> Option<&mut dyn PartialReflect>

Returns a mutable reference to the value of the field with index index as a &mut dyn Reflect.

fn field_len(&self) -> usize

Returns the number of fields in the tuple struct.

fn iter_fields(&self) -> TupleStructFieldIter<'_>

Returns an iterator over the values of the tuple struct’s fields.

fn to_dynamic_tuple_struct(&self) -> DynamicTupleStruct

Creates a new DynamicTupleStruct from this tuple struct.

fn get_represented_tuple_struct_info(&self) -> Option<&'static TupleStructInfo>

Will return None if TypeInfo is not available.

impl TypePath for LayerMask

fn type_path() -> &'static str

Returns the fully qualified path of the underlying type.

fn short_type_path() -> &'static str

Returns a short, pretty-print enabled path to the type.

fn type_ident() -> Option<&'static str>

Returns the name of the type, or None if it is anonymous.

fn crate_name() -> Option<&'static str>

Returns the name of the crate the type is in, or None if it is anonymous.

fn module_path() -> Option<&'static str>

Returns the path to the module the type is in, or None if it is anonymous.

impl Typed for LayerMask

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.

impl Copy for LayerMask

impl Eq for LayerMask