Struct TemporalAntiAliasing

pub struct TemporalAntiAliasing {
    pub reset: bool,
}

Component to apply temporal anti-aliasing to a 3D perspective camera.

Temporal anti-aliasing (TAA) is a form of image smoothing/filtering, like multisample anti-aliasing (MSAA), or fast approximate anti-aliasing (FXAA). TAA works by blending (averaging) each frame with the past few frames.

Tradeoffs

Pros:

• Filters more types of aliasing than MSAA, such as textures and singular bright pixels (specular aliasing)
• Cost scales with screen/view resolution, unlike MSAA which scales with number of triangles
• Greatly increases the quality of stochastic rendering techniques such as SSAO, certain shadow map sampling methods, etc

Cons:

• Chance of “ghosting” - ghostly trails left behind moving objects
• Thin geometry, lighting detail, or texture lines may flicker noisily or disappear

Because TAA blends past frames with the current frame, when the frames differ too much (such as with fast moving objects or camera cuts), ghosting artifacts may occur.

Artifacts tend to be reduced at higher framerates and rendering resolution.

Usage Notes

The TemporalAntiAliasPlugin must be added to your app. Any camera with this component must also disable Msaa by setting it to Msaa::Off.

Currently, TAA cannot be used with bevy_render::camera::OrthographicProjection.

TAA also does not work well with alpha-blended meshes, as it requires depth writing to determine motion.

It is very important that correct motion vectors are written for everything on screen. Failure to do so will lead to ghosting artifacts. For instance, if particle effects are added using a third party library, the library must either:

1. Write particle motion vectors to the motion vectors prepass texture
2. Render particles after TAA

If no MipBias component is attached to the camera, TAA will add a MipBias(-1.0) component.

Fields

reset: bool

Set to true to delete the saved temporal history (past frames).

Useful for preventing ghosting when the history is no longer representative of the current frame, such as in sudden camera cuts.

After setting this to true, it will automatically be toggled back to false at the end of the frame.

Trait Implementations

impl Clone for TemporalAntiAliasing

fn clone(&self) -> TemporalAntiAliasing

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Component for TemporalAntiAliasing

where Self: Send + Sync + 'static,

Required Components: TemporalJitter, DepthPrepass, MotionVectorPrepass.

A component’s Required Components are inserted whenever it is inserted. Note that this will also insert the required components of the required components, recursively, in depth-first order.

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

A constant indicating the storage type used for this component.

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

Registers required components.

fn register_component_hooks(hooks: &mut ComponentHooks)

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

impl Default for TemporalAntiAliasing

fn default() -> Self

Returns the “default value” for a type.

impl FromReflect for TemporalAntiAliasing

where TemporalAntiAliasing: Any + Send + Sync, bool: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

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

Constructs a concrete instance of Self from a reflected value.

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

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

impl GetTypeRegistration for TemporalAntiAliasing

where TemporalAntiAliasing: Any + Send + Sync, bool: FromReflect + TypePath + MaybeTyped + 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 PartialReflect for TemporalAntiAliasing

where TemporalAntiAliasing: Any + Send + Sync, bool: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

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

Returns the TypeInfo of the type represented by this value.

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

Clones the value as a Reflect trait object.

fn try_apply(&mut self, value: &dyn PartialReflect) -> Result<(), ApplyError>

Tries to apply 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 try_into_reflect( self: Box<Self>, ) -> Result<Box<dyn Reflect>, Box<dyn PartialReflect>>

Attempts to cast this type to a boxed, fully-reflected value.

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

Attempts to cast this type to a fully-reflected value.

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

Attempts to cast this type to a mutable, fully-reflected value.

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

Casts this type to a boxed, reflected value.

fn as_partial_reflect(&self) -> &dyn PartialReflect

Casts this type to a reflected value.

fn as_partial_reflect_mut(&mut self) -> &mut dyn PartialReflect

Casts this type to a mutable, reflected value.

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

Returns a “partial equality” comparison result.

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

Applies a reflected value to this value.

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 Reflect for TemporalAntiAliasing

where TemporalAntiAliasing: Any + Send + Sync, bool: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

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

fn as_reflect(&self) -> &dyn Reflect

Casts this type to a fully-reflected value.

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

Casts this type to a mutable, fully-reflected value.

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

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

impl Struct for TemporalAntiAliasing

where TemporalAntiAliasing: Any + Send + Sync, bool: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn field(&self, name: &str) -> Option<&dyn PartialReflect>

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

fn field_mut(&mut self, name: &str) -> Option<&mut dyn PartialReflect>

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

fn field_at(&self, index: usize) -> Option<&dyn PartialReflect>

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

fn field_at_mut(&mut self, index: usize) -> Option<&mut dyn PartialReflect>

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

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.

fn get_represented_struct_info(&self) -> Option<&'static StructInfo>

Will return None if TypeInfo is not available.

impl TypePath for TemporalAntiAliasing

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

where TemporalAntiAliasing: Any + Send + Sync, bool: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.