Class AntiAliasingSettings

Contains settings for Anti Aliasing effect rendering.

System.Object
AntiAliasingSettings
Namespace: FlaxEngine
Assembly: FlaxEngine.CSharp.dll
Syntax
[Unmanaged]
public sealed class AntiAliasingSettings : ValueType

Fields

CAS_EdgeSharpening

The edge sharpening strength for the Contrast Adaptive Sharpening (CAS) pass. Ignored when using TAA that contains own contrast filter.

Declaration
[Limit(0F, 10F, 0.001F)]
[EditorOrder(11)]
[EditorDisplay(null, "CAS Edge Sharpening")]
[VisibleIf("ShowTAASettings", true)]
public float CAS_EdgeSharpening
Field Value
System.Single

CAS_MinEdgeThreshold

The minimum edge threshold for the Contrast Adaptive Sharpening (CAS) pass. Ignored when using TAA that contains own contrast filter.

Declaration
[Limit(0F, 10F, 0.001F)]
[EditorOrder(12)]
[EditorDisplay(null, "CAS Min Edge Threshold")]
[VisibleIf("ShowTAASettings", true)]
public float CAS_MinEdgeThreshold
Field Value
System.Single

CAS_OverBlurLimit

The over-blur limit for the Contrast Adaptive Sharpening (CAS) pass. Ignored when using TAA that contains own contrast filter.

Declaration
[Limit(0F, 100F, 0.001F)]
[EditorOrder(13)]
[EditorDisplay(null, "CAS Over-blur Limit")]
[VisibleIf("ShowTAASettings", true)]
public float CAS_OverBlurLimit
Field Value
System.Single

CAS_SharpeningAmount

The sharpening strength for the Contrast Adaptive Sharpening (CAS) pass. Ignored when using TAA that contains own contrast filter.

Declaration
[Limit(0F, 10F, 0.001F)]
[EditorOrder(10)]
[EditorDisplay(null, "CAS Sharpening Amount")]
[VisibleIf("ShowTAASettings", true)]
public float CAS_SharpeningAmount
Field Value
System.Single

Mode

The anti-aliasing effect mode.

Declaration
[EditorOrder(0)]
public AntialiasingMode Mode
Field Value
AntialiasingMode

TAA_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
[Limit(0.1F, 1F, 0.001F)]
[EditorOrder(1)]
[EditorDisplay(null, "TAA Jitter Spread")]
[VisibleIf("ShowTAASettings", false)]
public float TAA_JitterSpread
Field Value
System.Single

TAA_MotionBlending

The blending coefficient for moving fragments. Controls the percentage of history samples blended into the final color for fragments with significant active motion.

Declaration
[Limit(0F, 0.99F, 0.001F)]
[EditorOrder(4)]
[EditorDisplay(null, "TAA Motion Blending")]
[VisibleIf("ShowTAASettings", false)]
public float TAA_MotionBlending
Field Value
System.Single

TAA_Sharpness

Controls the amount of sharpening applied to the color buffer. TAA can induce a slight loss of details in high frequency regions. Sharpening alleviates this issue. High values may introduce dark-border artifacts.

Declaration
[Limit(0F, 3F, 0.001F)]
[EditorOrder(2)]
[EditorDisplay(null, "TAA Sharpness")]
[VisibleIf("ShowTAASettings", false)]
public float TAA_Sharpness
Field Value
System.Single

TAA_StationaryBlending

The blend coefficient for stationary fragments. Controls the percentage of history samples blended into the final color for fragments with minimal active motion.

Declaration
[Limit(0F, 0.99F, 0.001F)]
[EditorOrder(3)]
[EditorDisplay(null, "TAA Stationary Blending")]
[VisibleIf("ShowTAASettings", false)]
public float TAA_StationaryBlending
Field Value
System.Single

Properties

Default

The default AntiAliasingSettings.

Declaration
public static AntiAliasingSettings Default { get; }
Property Value
AntiAliasingSettings

ShowTAASettings

Whether or not to show the TAA settings.

Declaration
public bool ShowTAASettings { get; }
Property Value
System.Boolean

Extension Methods