FXAAEffect Class
Namespace: Stride.Rendering.ImagesAssembly: Stride.Rendering.dll
A FXAA anti-aliasing pass.
[DataContract("FXAAEffect")]
public class FXAAEffect : ImageEffectShader, IComponent, IReferencable, ICollectorHolder, IScreenSpaceAntiAliasingEffect, IImageEffect, IGraphicsRenderer, IGraphicsRendererBase, IGraphicsRendererCore, IDisposable
Name | Description | |
---|---|---|
Constructors | ||
FXAAEffect() | Initializes a new instance of the FXAAEffect class. |
|
FXAAEffect(String) | Initializes a new instance of the FXAAEffect class. |
|
Properties | ||
Dither | The dithering type used (directly related to rendering style). |
|
InputLuminanceInAlpha | Gets or sets a value indicating whether the luminance will be retrieved from the alpha channel of the input color. Otherwise, the green component of the input color is used as a luminance. |
|
NeedRangeDecompress | ||
Quality | The quality of the FXAA (directly related to performance). From 0 to 5 with Medium, from 0 to 9 with Low and unavailable (should be 9) with None. |
|
RequiresDepthBuffer | ||
RequiresVelocityBuffer | ||
Methods | ||
GetQualityRange(FXAAEffect.DitherType) | ||
UpdateParameters() |
Constructors
FXAAEffect()
Initializes a new instance of the FXAAEffect class.
public FXAAEffect()
FXAAEffect(String)
Initializes a new instance of the FXAAEffect class.
public FXAAEffect(string antialiasShaderName)
Parameters
Type | Name | Description |
---|---|---|
System.String | antialiasShaderName | Name of the antialias shader. |
Exceptions
Type | Condition |
---|---|
System.ArgumentNullException | antialiasShaderName |
Properties
Dither
The dithering type used (directly related to rendering style).
[DataMember(10)]
public FXAAEffect.DitherType Dither { get; set; }
Property Value
Type | Description |
---|---|
FXAAEffect.DitherType |
InputLuminanceInAlpha
Gets or sets a value indicating whether the luminance will be retrieved from the alpha channel of the input color. Otherwise, the green component of the input color is used as a luminance.
[DataMember(30)]
[Display("Input luminance from alpha", null)]
public bool InputLuminanceInAlpha { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
|
NeedRangeDecompress
public bool NeedRangeDecompress { get; }
Property Value
Type | Description |
---|---|
System.Boolean |
Quality
The quality of the FXAA (directly related to performance). From 0 to 5 with Medium, from 0 to 9 with Low and unavailable (should be 9) with None.
[DataMember(20)]
[DataMemberRange(0, 9, 1, 2, 0)]
public int Quality { get; set; }
Property Value
Type | Description |
---|---|
System.Int32 |
RequiresDepthBuffer
public bool RequiresDepthBuffer { get; }
Property Value
Type | Description |
---|---|
System.Boolean |
RequiresVelocityBuffer
public bool RequiresVelocityBuffer { get; }
Property Value
Type | Description |
---|---|
System.Boolean |
Methods
GetQualityRange(FXAAEffect.DitherType)
public static (int, int) GetQualityRange(FXAAEffect.DitherType dither)
Parameters
Type | Name | Description |
---|---|---|
FXAAEffect.DitherType | dither |
Returns
Type | Description |
---|---|
System.ValueTuple<System.Int32, System.Int32> |
UpdateParameters()
protected override void UpdateParameters()