Stride

OPEN / CLOSE
  • Features
  • Blog
  • Documentation
  • Community
(icon) Download

  • Discord
  • Facebook
  • Twitter
  • YouTube

LANGUAGE

OPEN / CLOSE
  • English
  • 日本語
    Show / Hide Table of Contents

    FXAAEffect Class

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

    A FXAA anti-aliasing pass.

    System.Object → DisposeBase → ComponentBase → RendererCoreBase → RendererBase → DrawEffect → ImageEffect → ImageEffectShader → FXAAEffect
    Derived from FXAAEffect:

    [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()
    | Improve this Doc View Source

    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

    | Improve this Doc View Source

    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

    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
    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
    | Improve this Doc View Source

    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()
    Overrides
    ImageEffectShader.UpdateParameters()

    Inherited Members

    ImageEffectShader.BlendState
    ImageEffectShader.DepthStencilState
    ImageEffectShader.InitializeCore()
    ImageEffectShader.EffectInstance
    ImageEffectShader.EffectName
    ImageEffectShader.SetDefaultParameters()
    ImageEffectShader.PreDrawCore(RenderDrawContext)
    ImageEffectShader.DrawCore(RenderDrawContext)
    ImageEffect.EnableSetRenderTargets
    ImageEffect.SetInput(Int32, Texture)
    ImageEffect.Reset()
    ImageEffect.SetOutput(Texture)
    ImageEffect.SetOutput(Texture[])
    ImageEffect.SetDepthOutput(Texture, Texture)
    ImageEffect.SetDepthOutput(Texture, Texture[])
    ImageEffect.SetViewport(Nullable<Viewport>)
    ImageEffect.SetRenderTargets(RenderDrawContext)
    ImageEffect.PostDrawCore(RenderDrawContext)
    ImageEffect.DisposeCreatedRenderTargetViews(RenderDrawContext)
    ImageEffect.InputCount
    ImageEffect.GetInput(Int32)
    ImageEffect.GetSafeInput(Int32)
    ImageEffect.DepthStencil
    ImageEffect.HasDepthStencilOutput
    ImageEffect.OutputCount
    ImageEffect.GetOutput(Int32)
    ImageEffect.GetSafeOutput(Int32)
    ImageEffect.NewScopedRenderTarget2D(TextureDescription)
    ImageEffect.NewScopedRenderTarget2D(Int32, Int32, PixelFormat, TextureFlags, Int32)
    ImageEffect.NewScopedRenderTarget2D(Int32, Int32, PixelFormat, MipMapCount, TextureFlags, Int32)
    DrawEffect.SamplingPattern
    DrawEffect.Parameters
    DrawEffect.Scaler
    DrawEffect.Draw(RenderDrawContext, String)
    DrawEffect.Draw(RenderDrawContext, String, Object[])
    DrawEffect.ToString()
    RendererBase.Draw(RenderDrawContext)
    RendererCoreBase.Enabled
    RendererCoreBase.Profiling
    RendererCoreBase.ProfilingKey
    RendererCoreBase.Context
    RendererCoreBase.Services
    RendererCoreBase.Content
    RendererCoreBase.GraphicsDevice
    RendererCoreBase.EffectSystem
    RendererCoreBase.Initialized
    RendererCoreBase.Initialize(RenderContext)
    RendererCoreBase.Unload()
    RendererCoreBase.NewScopedBuffer(BufferDescription, PixelFormat)
    RendererCoreBase.NewScopedTypedBuffer(Int32, PixelFormat, Boolean, GraphicsResourceUsage)
    RendererCoreBase.PushScopedResource<T>(T)
    RendererCoreBase.CheckIsInDrawCore()
    RendererCoreBase.Destroy()
    RendererCoreBase.ToLoadAndUnload<T>(T)
    RendererCoreBase.PreDrawCoreInternal(RenderDrawContext)
    RendererCoreBase.EnsureContext(RenderContext)
    RendererCoreBase.PostDrawCoreInternal(RenderDrawContext)
    ComponentBase.Tags
    ComponentBase.Name
    ComponentBase.ICollectorHolder.Collector
    ComponentBase.OnNameChanged()
    DisposeBase.Dispose()
    DisposeBase.IsDisposed
    DisposeBase.IReferencable.ReferenceCount
    DisposeBase.IReferencable.AddReference()
    DisposeBase.IReferencable.Release()
    DisposeBase.OnAddReference()
    DisposeBase.OnReleaseReference()

    Extension Methods

    ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder)
    ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder)
    ImageEffectExtensions.SetInput(IImageEffect, Texture)
    ImageEffectExtensions.SetInput(IImageEffect, Texture, Texture)
    ImageEffectExtensions.SetInput(IImageEffect, Texture, Texture, Texture)
    • Improve this Doc
    • View Source
    In This Article

    Back to top

    Copyright © 2019-2021 .NET Foundation and Contributors
    Supported by the .NET Foundation