Struct bevy_render::view::visibility::ViewVisibility

pub struct ViewVisibility(/* private fields */);

Algorithmically-computed indication of whether an entity is visible and should be extracted for rendering.

Each frame, this will be reset to false during VisibilityPropagate systems in PostUpdate. Later in the frame, systems in CheckVisibility will mark any visible entities using ViewVisibility::set. Because of this, values of this type will be marked as changed every frame, even when they do not change.

If you wish to add custom visibility system that sets this value, make sure you add it to the CheckVisibility set.

Implementations

impl ViewVisibility

pub const HIDDEN: Self = _

An entity that cannot be seen from any views.

pub fn get(self) -> bool

Returns true if the entity is visible in any view. Otherwise, returns false.

pub fn set(&mut self)

Sets the visibility to true. This should not be considered reversible for a given frame, as this component tracks whether or not the entity visible in any view.

This will be automatically reset to false every frame in VisibilityPropagate and then set to the proper value in CheckVisibility.

You should only manually set this if you are defining a custom visibility system, in which case the system should be placed in the CheckVisibility set. For normal user-defined entity visibility, see Visibility.

Trait Implementations

impl Clone for ViewVisibility

fn clone(&self) -> ViewVisibility

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Component for ViewVisibility

where Self: Send + Sync + 'static,

type Storage = TableStorage

A marker type indicating the storage type used for this component. This must be either TableStorage or SparseStorage.

impl Debug for ViewVisibility

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

Formats the value using the given formatter.

impl Default for ViewVisibility

fn default() -> ViewVisibility

Returns the “default value” for a type.

impl Deref for ViewVisibility

type Target = bool

The resulting type after dereferencing.

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

Dereferences the value.

impl FromReflect for ViewVisibility

where Self: Any + Send + Sync, bool: FromReflect + TypePath,

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

Constructs a concrete instance of Self from a reflected value.

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

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

impl GetTypeRegistration for ViewVisibility

where Self: Any + Send + Sync, bool: FromReflect + TypePath,

fn get_type_registration() -> TypeRegistration

impl PartialEq for ViewVisibility

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

where Self: Any + Send + Sync, bool: FromReflect + TypePath,

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

Returns the TypeInfo of the type represented by this value.

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 reflected value.

fn as_reflect(&self) -> &dyn Reflect

Casts this type to a reflected value.

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

Casts this type to a mutable reflected value.

fn clone_value(&self) -> Box<dyn Reflect>

Clones the value as a Reflect trait object.

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

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

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

Applies 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 reflect_partial_eq(&self, value: &dyn Reflect) -> 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.

fn is_dynamic(&self) -> bool

Indicates whether or not this type is a dynamic type.

impl TupleStruct for ViewVisibility

where Self: Any + Send + Sync, bool: FromReflect + TypePath,

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

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>

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 TypePath for ViewVisibility

where Self: Any + Send + Sync,

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 ViewVisibility

where Self: Any + Send + Sync, bool: FromReflect + TypePath,

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.

impl Copy for ViewVisibility

impl Eq for ViewVisibility

impl StructuralEq for ViewVisibility

impl StructuralPartialEq for ViewVisibility