Table of Contents

Class FXAAEffect

Namespace
Stride.Rendering.Images
Assembly
Stride.Rendering.dll

A FXAA anti-aliasing pass.

[DataContract("FXAAEffect")]
public class FXAAEffect : ImageEffectShader, IComponent, IReferencable, ICollectorHolder, IScreenSpaceAntiAliasingEffect, IImageEffect, IGraphicsRenderer, IGraphicsRendererBase, IGraphicsRendererCore, IDisposable
Inheritance
FXAAEffect
Implements
Inherited Members
Extension Methods

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

antialiasShaderName string

Name of the antialias shader.

Exceptions

ArgumentNullException

antialiasShaderName

Properties

Dither

The dithering type used (directly related to rendering style).

[DataMember(10)]
public FXAAEffect.DitherType Dither { get; set; }

Property Value

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

bool

true 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 

public bool NeedRangeDecompress { get; }

Property Value

bool

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

int

RequiresDepthBuffer 

public bool RequiresDepthBuffer { get; }

Property Value

bool

RequiresVelocityBuffer 

public bool RequiresVelocityBuffer { get; }

Property Value

bool

Methods

GetQualityRange(DitherType) 

public static (int, int) GetQualityRange(FXAAEffect.DitherType dither)

Parameters

dither FXAAEffect.DitherType

Returns

(int, int)

UpdateParameters()

Updates the effect Parameters from properties defined in this instance. See remarks.

protected override void UpdateParameters()

Remarks

By default, all the input textures will be remapped to Texture0...etc.

Exceptions

InvalidOperationException

Expecting less than 10 textures in input

Edit this page