Class TemporalAntialiasing

This class holds settings for the Temporal Anti-aliasing (TAA) effect.

Inheritance

object

TemporalAntialiasing

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: UnityEngine.Rendering.PostProcessing

Assembly: Unity.Postprocessing.Runtime.dll

Syntax

[Preserve]
[Serializable]
public sealed class TemporalAntialiasing

Fields

jitterSpread

The diameter (in texels) inside which jitter samples are spread. Smaller values result in crisper but more aliased output, while larger values result in more stable but blurrier output.

Declaration

[Tooltip("The diameter (in texels) inside which jitter samples are spread. Smaller values result in crisper but more aliased output, while larger values result in more stable, but blurrier, output.")]
[Range(0.1, 1)]
public float jitterSpread

Field Value

Type	Description
float

jitteredMatrixFunc

Sets a custom function that will be called to generate the jittered projection matrice.

Declaration

public Func<Camera, Vector2, Matrix4x4> jitteredMatrixFunc

Field Value

Type	Description
Func<Camera, Vector2, Matrix4x4>

motionBlending

The blend coefficient for a fragment with significant motion. Controls the percentage of history sample blended into the final color.

Declaration

[Tooltip("The blend coefficient for a fragment with significant motion. Controls the percentage of history sample blended into the final color.")]
[Range(0, 0.99)]
public float motionBlending

Field Value

Type	Description
float

sharpness

Controls the amount of sharpening applied to the color buffer. High values may introduce dark-border artifacts.

Declaration

[Tooltip("Controls the amount of sharpening applied to the color buffer. High values may introduce dark-border artifacts.")]
[Range(0, 3)]
public float sharpness

Field Value

Type	Description
float

stationaryBlending

The blend coefficient for a stationary fragment. Controls the percentage of history sample blended into the final color.

Declaration

[Tooltip("The blend coefficient for a stationary fragment. Controls the percentage of history sample blended into the final color.")]
[Range(0, 0.99)]
public float stationaryBlending

Field Value

Type	Description
float

Properties

jitter

The current jitter amount

Declaration

public Vector2 jitter { get; }

Property Value

Type	Description
Vector2

sampleIndex

The current sample index.

Declaration

public int sampleIndex { get; }

Property Value

Type	Description
int

Methods

ConfigureJitteredProjectionMatrix(PostProcessRenderContext)

Prepares the jittered and non jittered projection matrices.

Declaration

public void ConfigureJitteredProjectionMatrix(PostProcessRenderContext context)

Parameters

Type	Name	Description
PostProcessRenderContext	context	The current post-processing context.

ConfigureStereoJitteredProjectionMatrices(PostProcessRenderContext)

Prepares the jittered and non jittered projection matrices for stereo rendering.

Declaration

public void ConfigureStereoJitteredProjectionMatrices(PostProcessRenderContext context)

Parameters

Type	Name	Description
PostProcessRenderContext	context	The current post-processing context.

GetJitteredProjectionMatrix(Camera)

Generates a jittered projection matrix for a given camera.

Declaration

public Matrix4x4 GetJitteredProjectionMatrix(Camera camera)

Parameters

Type	Name	Description
Camera	camera	The camera to get a jittered projection matrix for.

Returns

Type	Description
Matrix4x4	A jittered projection matrix.

IsSupported()

Returns true if the effect is currently enabled and supported.

Declaration

public bool IsSupported()

Returns

Type	Description
bool	true if the effect is currently enabled and supported