Struct bevy::pbr::ScreenSpaceAmbientOcclusionSettings

pub struct ScreenSpaceAmbientOcclusionSettings {
    pub quality_level: ScreenSpaceAmbientOcclusionQualityLevel,
}

Component to apply screen space ambient occlusion to a 3d camera.

Screen space ambient occlusion (SSAO) approximates small-scale, local occlusion of indirect diffuse light between objects, based on what’s visible on-screen. SSAO does not apply to direct lighting, such as point or directional lights.

This darkens creases, e.g. on staircases, and gives nice contact shadows where objects meet, giving entities a more “grounded” feel.

Usage Notes

Requires that you add ScreenSpaceAmbientOcclusionPlugin to your app, and add the DepthPrepass and NormalPrepass components to your camera.

It strongly recommended that you use SSAO in conjunction with TAA (bevy_core_pipeline::experimental::taa::TemporalAntiAliasSettings). Doing so greatly reduces SSAO noise.

SSAO is not supported on WebGL2, and is not currently supported on WebGPU or DirectX12.

Fields

quality_level: ScreenSpaceAmbientOcclusionQualityLevel

Trait Implementations

impl Clone for ScreenSpaceAmbientOcclusionSettings

fn clone(&self) -> ScreenSpaceAmbientOcclusionSettings

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Component for ScreenSpaceAmbientOcclusionSettings

where ScreenSpaceAmbientOcclusionSettings: Send + Sync + 'static,

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

A constant indicating the storage type used for this component.

fn register_component_hooks(_hooks: &mut ComponentHooks)

Called when registering this component, allowing mutable access to its ComponentHooks.

impl Default for ScreenSpaceAmbientOcclusionSettings

fn default() -> ScreenSpaceAmbientOcclusionSettings

Returns the “default value” for a type.

impl ExtractComponent for ScreenSpaceAmbientOcclusionSettings

where ScreenSpaceAmbientOcclusionSettings: Clone,

type QueryData = &'static ScreenSpaceAmbientOcclusionSettings

ECS ReadOnlyQueryData to fetch the components to extract.

type QueryFilter = ()

Filters the entities with additional constraints.

type Out = ScreenSpaceAmbientOcclusionSettings

The output from extraction.

fn extract_component( item: <<ScreenSpaceAmbientOcclusionSettings as ExtractComponent>::QueryData as WorldQuery>::Item<'_> ) -> Option<<ScreenSpaceAmbientOcclusionSettings as ExtractComponent>::Out>

Defines how the component is transferred into the “render world”.

impl FromReflect for ScreenSpaceAmbientOcclusionSettings

where ScreenSpaceAmbientOcclusionSettings: Any + Send + Sync, ScreenSpaceAmbientOcclusionQualityLevel: FromReflect + TypePath + RegisterForReflection,

fn from_reflect( reflect: &(dyn Reflect + 'static) ) -> Option<ScreenSpaceAmbientOcclusionSettings>

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 ScreenSpaceAmbientOcclusionSettings

where ScreenSpaceAmbientOcclusionSettings: Any + Send + Sync, ScreenSpaceAmbientOcclusionQualityLevel: FromReflect + TypePath + RegisterForReflection,

fn get_type_registration() -> TypeRegistration

Returns the default TypeRegistration for this type.

fn register_type_dependencies(registry: &mut TypeRegistry)

Registers other types needed by this type.

impl Hash for ScreenSpaceAmbientOcclusionSettings

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for ScreenSpaceAmbientOcclusionSettings

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

where ScreenSpaceAmbientOcclusionSettings: Any + Send + Sync, ScreenSpaceAmbientOcclusionQualityLevel: FromReflect + TypePath + RegisterForReflection,

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

Returns the TypeInfo of the type represented by this value.

fn into_any(self: Box<ScreenSpaceAmbientOcclusionSettings>) -> 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<ScreenSpaceAmbientOcclusionSettings> ) -> 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: 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 + '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<ScreenSpaceAmbientOcclusionSettings>) -> ReflectOwned

Returns an owned enumeration of “kinds” of type.

fn reflect_partial_eq(&self, value: &(dyn Reflect + 'static)) -> 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 Struct for ScreenSpaceAmbientOcclusionSettings

where ScreenSpaceAmbientOcclusionSettings: Any + Send + Sync, ScreenSpaceAmbientOcclusionQualityLevel: FromReflect + TypePath + RegisterForReflection,

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

Returns a reference to the value of the field named name as a &dyn Reflect.

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

Returns a mutable reference to the value of the field named name as a &mut dyn Reflect.

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

Returns a reference to the value of the field with index index as a &dyn Reflect.

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

Returns a mutable reference to the value of the field with index index as a &mut dyn Reflect.

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

Returns the name of the field with index index.

fn field_len(&self) -> usize

Returns the number of fields in the struct.

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

Returns an iterator over the values of the reflectable fields for this struct.

fn clone_dynamic(&self) -> DynamicStruct

Clones the struct into a DynamicStruct.

impl TypePath for ScreenSpaceAmbientOcclusionSettings

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

where ScreenSpaceAmbientOcclusionSettings: Any + Send + Sync, ScreenSpaceAmbientOcclusionQualityLevel: FromReflect + TypePath + RegisterForReflection,

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.

impl Eq for ScreenSpaceAmbientOcclusionSettings

impl StructuralPartialEq for ScreenSpaceAmbientOcclusionSettings