bevy::pbr

Enum 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,
    },
}

Expand description

Configuration of the clustering strategy for clustered forward rendering

Variants§

§

None

Disable 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

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

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-object index limit

§

FixedZ

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.

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 clusterable object index limit

Enum ClusterConfigCopy item path

Variants§

None

Single

XYZ

Fields

FixedZ

Fields

Trait Implementations§

impl Clone for ClusterConfig

fn clone(&self) -> ClusterConfig

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

impl Component for ClusterConfigwhere ClusterConfig: Send + Sync + 'static,

const STORAGE_TYPE: StorageType = bevy_ecs::component::StorageType::Table

fn register_required_components( requiree: ComponentId, components: &mut Components, storages: &mut Storages, required_components: &mut RequiredComponents, inheritance_depth: u16, )

fn register_component_hooks(hooks: &mut ComponentHooks)

impl Debug for ClusterConfig

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

impl Default for ClusterConfig

fn default() -> ClusterConfig

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

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

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

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

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

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

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

fn field_len(&self) -> usize

fn variant_name(&self) -> &str

fn variant_index(&self) -> usize

fn variant_type(&self) -> VariantType

fn clone_dynamic(&self) -> DynamicEnum

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

fn variant_path(&self) -> String

fn get_represented_enum_info(&self) -> Option<&'static EnumInfo>

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

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

fn get_type_registration() -> TypeRegistration

fn register_type_dependencies(registry: &mut TypeRegistry)

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

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

fn try_apply( &mut self, __value_param: &(dyn PartialReflect + 'static), ) -> Result<(), ApplyError>

fn reflect_kind(&self) -> ReflectKind

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

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

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

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

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

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

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

fn as_partial_reflect(&self) -> &(dyn PartialReflect + 'static)

fn as_partial_reflect_mut(&mut self) -> &mut (dyn PartialReflect + 'static)

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

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

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

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

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

fn is_dynamic(&self) -> bool

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

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

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

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

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

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

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

impl TypePath for ClusterConfigwhere ClusterConfig: Any + Send + Sync,

fn type_path() -> &'static str

fn short_type_path() -> &'static str

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

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

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

fn type_info() -> &'static TypeInfo

impl Copy for ClusterConfig

Auto Trait Implementations§

impl Freeze for ClusterConfig

impl RefUnwindSafe for ClusterConfig

impl Send for ClusterConfig

impl Sync for ClusterConfig

impl Unpin for ClusterConfig

impl UnwindSafe for ClusterConfig

Enum ClusterConfig

impl Component for ClusterConfig
where ClusterConfig: Send + Sync + 'static,

impl TypePath for ClusterConfig
where ClusterConfig: Any + Send + Sync,

impl<T> Any for T
where T: 'static + ?Sized,

impl<T, U> AsBindGroupShaderType<U> for T
where U: ShaderType, &'a T: for<'a> Into<U>,

impl<T> Borrow<T> for T
where T: ?Sized,

impl<T> BorrowMut<T> for T
where T: ?Sized,

impl<C> Bundle for C
where C: Component,

unsafe fn from_components<T, F>(ctx: &mut T, func: &mut F) -> C
where F: for<'a> FnMut(&'a mut T) -> OwningPtr<'a>,

impl<T> CloneToUninit for T
where T: Clone,

impl<T> Downcast for T
where T: Any,

impl<T> DowncastSync for T
where T: Any + Send + Sync,

impl<C> DynamicBundle for C
where C: Component,

impl<T> DynamicTypePath for T
where T: TypePath,

impl<T> DynamicTyped for T
where T: Typed,

impl<T> FromWorld for T
where T: Default,

impl<T> GetPath for T
where T: Reflect + ?Sized,

fn path<'p, T>( &self, path: impl ReflectPath<'p>, ) -> Result<&T, ReflectPathError<'p>>
where T: Reflect,

fn path_mut<'p, T>( &mut self, path: impl ReflectPath<'p>, ) -> Result<&mut T, ReflectPathError<'p>>
where T: Reflect,

impl<T, U> Into<U> for T
where U: From<T>,

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

impl<T> ToOwned for T
where T: Clone,

impl<T, U> TryFrom<U> for T
where U: Into<T>,