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

The total number of layers supported.

pub fn layer(n: u8) -> RenderLayers

Create a new RenderLayers belonging to the given layer.

pub fn all() -> RenderLayers

Create a new RenderLayers that belongs to all layers.

pub 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 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 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

pub 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 RenderLayers where
    RenderLayers: 'static,
    RenderLayers: Send,
    RenderLayers: Sync, 

type Storage = TableStorage

impl Debug for RenderLayers

pub 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.

pub fn default() -> RenderLayers

Returns the “default value” for a type.

impl FromIterator<u8> for RenderLayers

pub fn from_iter<T>(i: T) -> RenderLayers where
    T: IntoIterator<Item = u8>, 

Creates a value from an iterator.

impl GetTypeRegistration for RenderLayers

pub fn get_type_registration() -> TypeRegistration

impl Ord for RenderLayers

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl PartialEq<RenderLayers> for RenderLayers

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<RenderLayers> for RenderLayers

pub 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

pub fn type_name(&self) -> &str

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

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

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

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

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

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

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

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

Returns a serializable value, if serialization is supported. Otherwise None will be returned.

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

Returns a hash of the value (which includes the type) if hashing is supported. Otherwise None will be returned.

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

Returns a “partial equal” comparison result if comparison is supported. Otherwise None will be returned.

impl TupleStruct for RenderLayers

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

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

pub fn field_len(&self) -> usize

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

pub fn clone_dynamic(&self) -> DynamicTupleStruct

impl Copy for RenderLayers

impl Eq for RenderLayers

impl StructuralEq for RenderLayers

impl StructuralPartialEq for RenderLayers