Enum bevy::pbr::ClusterConfig

pub enum ClusterConfig {
    None,
    Single,
    XYZ {
        dimensions: UVec3,
        z_config: ClusterZConfig,
        dynamic_resizing: bool,
    },
    FixedZ {
        total: u32,
        z_slices: u32,
        z_config: ClusterZConfig,
        dynamic_resizing: bool,
    },
}

Configuration of the clustering strategy for clustered forward rendering

Variants

None

Disable light cluster calculations for this view

Single

One single cluster. Optimal for low-light complexity scenes or scenes where most lights affect the entire scene.

XYZ

Fields

dimensions: UVec3

z_config: ClusterZConfig

dynamic_resizing: bool

Specify if clusters should automatically resize in X/Y if there is a risk of exceeding the available cluster-light index limit

Explicit X, Y and Z counts (may yield non-square X/Y clusters depending on the aspect ratio)

FixedZ

Fields

total: u32

z_slices: u32

z_config: ClusterZConfig

dynamic_resizing: bool

Specify if clusters should automatically resize in X/Y if there is a risk of exceeding the available cluster-light index limit

Fixed number of Z slices, X and Y calculated to give square clusters with at most total clusters. For top-down games where lights will generally always be within a short depth range, it may be useful to use this configuration with 1 or few Z slices. This would reduce the number of lights per cluster by distributing more clusters in screen space X/Y which matches how lights are distributed in the scene.

Trait Implementations

impl Clone for ClusterConfig

fn clone(&self) -> ClusterConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Component for ClusterConfig

where ClusterConfig: 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 ClusterConfig

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

Formats the value using the given formatter.

impl Default for ClusterConfig

fn default() -> ClusterConfig

Returns the “default value” for a type.

impl Enum for ClusterConfig

where ClusterConfig: Any + Send + Sync, UVec3: FromReflect + TypePath, ClusterZConfig: FromReflect + TypePath, bool: FromReflect + TypePath, u32: FromReflect + TypePath,

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

Returns a reference to the value of the field (in the current variant) with the given name.

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

Returns a reference to the value of the field (in the current variant) at the given index.

fn field_mut( &mut self, __name_param: &str ) -> Option<&mut (dyn Reflect + 'static)>

Returns a mutable reference to the value of the field (in the current variant) with the given name.

fn field_at_mut( &mut self, __index_param: usize ) -> Option<&mut (dyn Reflect + 'static)>

Returns a mutable reference to the value of the field (in the current variant) at the given index.

fn index_of(&self, __name_param: &str) -> Option<usize>

Returns the index of the field (in the current variant) with the given name.

fn name_at(&self, __index_param: usize) -> Option<&str>

Returns the name of the field (in the current variant) with the given index.

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

Returns an iterator over the values of the current variant’s fields.

fn field_len(&self) -> usize

Returns the number of fields in the current variant.

fn variant_name(&self) -> &str

The name of the current variant.

fn variant_index(&self) -> usize

The index of the current variant.

fn variant_type(&self) -> VariantType

The type of the current variant.

fn clone_dynamic(&self) -> DynamicEnum

fn is_variant(&self, variant_type: VariantType) -> bool

Returns true if the current variant’s type matches the given one.

fn variant_path(&self) -> String

Returns the full path to the current variant.

impl FromReflect for ClusterConfig

where ClusterConfig: Any + Send + Sync, UVec3: FromReflect + TypePath, ClusterZConfig: FromReflect + TypePath, bool: FromReflect + TypePath, u32: FromReflect + TypePath,

fn from_reflect(__param0: &(dyn Reflect + 'static)) -> Option<ClusterConfig>

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 ClusterConfig

where ClusterConfig: Any + Send + Sync, UVec3: FromReflect + TypePath, ClusterZConfig: FromReflect + TypePath, bool: FromReflect + TypePath, u32: FromReflect + TypePath,

fn get_type_registration() -> TypeRegistration

impl Reflect for ClusterConfig

where ClusterConfig: Any + Send + Sync, UVec3: FromReflect + TypePath, ClusterZConfig: FromReflect + TypePath, bool: FromReflect + TypePath, u32: 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<ClusterConfig>) -> Box<dyn Any>

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<ClusterConfig>) -> Box<dyn Reflect>

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>

Clones the value as a Reflect trait object.

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

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

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

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<ClusterConfig>) -> ReflectOwned

Returns an owned enumeration of “kinds” of type.

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

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

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

Returns a “partial equality” comparison result.

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

where ClusterConfig: 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 ClusterConfig

where ClusterConfig: Any + Send + Sync, UVec3: FromReflect + TypePath, ClusterZConfig: FromReflect + TypePath, bool: FromReflect + TypePath, u32: FromReflect + TypePath,

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.

impl Copy for ClusterConfig