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: 'static,
    ClusterConfig: Send,
    ClusterConfig: Sync, 

type Storage = TableStorage

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