Struct bevy::render::view::visibility::RenderLayers

pub struct RenderLayers(_);

Describes which rendering layers an entity belongs to.

Cameras with this component will only render entities with intersecting layers.

There are 32 layers numbered 0 - TOTAL_LAYERS. Entities may belong to one or more layers, or no layer at all.

The Default instance of RenderLayers contains layer 0, the first layer.

An entity with this component without any layers is invisible.

Entities without this component belong to layer 0.

Implementations

impl RenderLayers

pub const TOTAL_LAYERS: usize = 32usize

The total number of layers supported.

pub const fn layer(n: u8) -> RenderLayers

Create a new RenderLayers belonging to the given layer.

pub const fn all() -> RenderLayers

Create a new RenderLayers that belongs to all layers.

pub const fn none() -> RenderLayers

Create a new RenderLayers that belongs to no layers.

pub fn from_layers(layers: &[u8]) -> RenderLayers

Create a RenderLayers from a list of layers.

pub const fn with(self, layer: u8) -> RenderLayers

Add the given layer.

This may be called multiple times to allow an entity to belong to multiple rendering layers. The maximum layer is TOTAL_LAYERS - 1.

Panics

Panics when called with a layer greater than TOTAL_LAYERS - 1.

pub const fn without(self, layer: u8) -> RenderLayers

Removes the given rendering layer.

Panics

Panics when called with a layer greater than TOTAL_LAYERS - 1.

pub fn iter(&self) -> impl Iterator<Item = u8>

Get an iterator of the layers.

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

Determine if a RenderLayers intersects another.

RenderLayerss intersect if they share any common layers.

A RenderLayers with no layers will not match any other RenderLayers, even another with no layers.

Trait Implementations

impl Clone for RenderLayers

fn clone(&self) -> RenderLayers

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Component for RenderLayerswhere
    RenderLayers: 'static + Send + Sync,

type Storage = TableStorage

impl Debug for RenderLayers

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

Formats the value using the given formatter.

impl Default for RenderLayers

Defaults to containing to layer 0, the first layer.

fn default() -> RenderLayers

Returns the “default value” for a type.

impl FromIterator<u8> for RenderLayers

fn from_iter<T>(i: T) -> RenderLayerswhere
    T: IntoIterator<Item = u8>,

Creates a value from an iterator.

impl GetTypeRegistration for RenderLayers

fn get_type_registration() -> TypeRegistration

impl Ord for RenderLayers

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<RenderLayers> for RenderLayers

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

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl Reflect for RenderLayers

fn type_name(&self) -> &str

Returns the type name of the underlying type.

fn get_type_info(&self) -> &'static TypeInfo

Returns the TypeInfo of the underlying type.

fn into_any(self: Box<RenderLayers, Global>) -> Box<dyn Any + 'static, Global>

Returns the value as a Box<dyn Any>.

fn as_any(&self) -> &(dyn Any + 'static)

Returns the value as a &dyn Any.

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Returns the value as a &mut dyn Any.

fn into_reflect(
    self: Box<RenderLayers, Global>
) -> Box<dyn Reflect + 'static, Global>

Casts this type to a boxed reflected value.

fn as_reflect(&self) -> &(dyn Reflect + 'static)

Casts this type to a reflected value.

fn as_reflect_mut(&mut self) -> &mut (dyn Reflect + 'static)

Casts this type to a mutable reflected value.

fn clone_value(&self) -> Box<dyn Reflect + 'static, Global>

Clones the value as a Reflect trait object.

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

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

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

Applies a reflected value to this value.

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

Returns an enumeration of “kinds” of type.

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

Returns a mutable enumeration of “kinds” of type.

fn reflect_owned(self: Box<RenderLayers, Global>) -> ReflectOwned

Returns an owned enumeration of “kinds” of type.

fn reflect_partial_eq(&self, value: &(dyn Reflect + 'static)) -> Option<bool>

Returns a “partial equality” comparison result.

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

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

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

Debug formatter for the value.

fn serializable(&self) -> Option<Serializable<'_>>

Returns a serializable version of the value.

impl TupleStruct for RenderLayers

fn field(&self, index: usize) -> Option<&(dyn Reflect + 'static)>

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 Reflect + 'static)>

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 clone_dynamic(&self) -> DynamicTupleStruct

Clones the struct into a DynamicTupleStruct.

impl Typed for RenderLayers

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.

impl Copy for RenderLayers

impl Eq for RenderLayers

impl StructuralEq for RenderLayers

impl StructuralPartialEq for RenderLayers