Stride

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

  • Discord
  • Facebook
  • Twitter
  • YouTube

LANGUAGE

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

    PostProcessingEffects Class

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

    A default bundle of ImageEffect.

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

    [DataContract("PostProcessingEffects")]
    [Display("Post-processing effects", null)]
    public sealed class PostProcessingEffects : ImageEffect, IComponent, IReferencable, ICollectorHolder, IImageEffectRenderer, IImageEffect, IGraphicsRenderer, IGraphicsRendererCore, IPostProcessingEffects, ISharedRenderer, IIdentifiable, IGraphicsRendererBase, IDisposable
    Name Description
    Constructors
    PostProcessingEffects()

    Initializes a new instance of the PostProcessingEffects class.

    PostProcessingEffects(IServiceRegistry)

    Initializes a new instance of the PostProcessingEffects class.

    PostProcessingEffects(RenderContext)

    Initializes a new instance of the PostProcessingEffects class.

    Properties
    AmbientOcclusion

    Gets the ambient occlusion effect.

    Antialiasing

    Gets the antialiasing effect.

    Bloom

    Gets the bloom effect.

    BrightFilter

    Gets the bright pass-filter.

    ColorTransforms

    Gets the final color transforms.

    DepthOfField

    Gets the depth of field effect.

    Fog

    Gets the fog effect.

    Id

    Gets the id of this instance

    LensFlare

    Gets the lens flare effect.

    LightStreak

    Gets the light streak effect.

    LocalReflections

    Gets the local reflections effect.

    Outline

    Gets the outline effect.

    RequiresNormalBuffer
    RequiresSpecularRoughnessBuffer
    RequiresVelocityBuffer
    Methods
    Collect(RenderContext)
    DisableAll()

    Disables all post processing effects.

    Draw(RenderDrawContext, RenderOutputValidator, Texture[], Texture, Texture)
    DrawCore(RenderDrawContext)
    InitializeCore()
    Reset()
    | Improve this Doc View Source

    Constructors


    PostProcessingEffects()

    Initializes a new instance of the PostProcessingEffects class.

    public PostProcessingEffects()

    PostProcessingEffects(IServiceRegistry)

    Initializes a new instance of the PostProcessingEffects class.

    public PostProcessingEffects(IServiceRegistry services)
    Parameters
    Type Name Description
    IServiceRegistry services

    The services.


    PostProcessingEffects(RenderContext)

    Initializes a new instance of the PostProcessingEffects class.

    public PostProcessingEffects(RenderContext context)
    Parameters
    Type Name Description
    RenderContext context

    The context.

    | Improve this Doc View Source

    Properties


    AmbientOcclusion

    Gets the ambient occlusion effect.

    [DataMember(8)]
    public AmbientOcclusion AmbientOcclusion { get; }
    Property Value
    Type Description
    AmbientOcclusion

    Antialiasing

    Gets the antialiasing effect.

    [DataMember(80)]
    [Display("Type", "Antialiasing")]
    public IScreenSpaceAntiAliasingEffect Antialiasing { get; set; }
    Property Value
    Type Description
    IScreenSpaceAntiAliasingEffect

    The antialiasing.


    Bloom

    Gets the bloom effect.

    [DataMember(30)]
    public Bloom Bloom { get; }
    Property Value
    Type Description
    Bloom

    The bloom.


    BrightFilter

    Gets the bright pass-filter.

    [DataMember(20)]
    public BrightFilter BrightFilter { get; }
    Property Value
    Type Description
    BrightFilter

    The bright filter.


    ColorTransforms

    Gets the final color transforms.

    [DataMember(70)]
    public ColorTransformGroup ColorTransforms { get; }
    Property Value
    Type Description
    ColorTransformGroup

    The color transforms.


    DepthOfField

    Gets the depth of field effect.

    [DataMember(10)]
    public DepthOfField DepthOfField { get; }
    Property Value
    Type Description
    DepthOfField

    The depth of field.


    Fog

    Gets the fog effect.

    [DataMember(7)]
    public Fog Fog { get; }
    Property Value
    Type Description
    Fog

    Id

    Gets the id of this instance

    [DataMember(-100)]
    [Display(null, null, Browsable = false)]
    public Guid Id { get; set; }
    Property Value
    Type Description
    System.Guid

    LensFlare

    Gets the lens flare effect.

    [DataMember(50)]
    public LensFlare LensFlare { get; }
    Property Value
    Type Description
    LensFlare

    The lens flare.


    LightStreak

    Gets the light streak effect.

    [DataMember(40)]
    public LightStreak LightStreak { get; }
    Property Value
    Type Description
    LightStreak

    The light streak.


    LocalReflections

    Gets the local reflections effect.

    [DataMember(9)]
    public LocalReflections LocalReflections { get; }
    Property Value
    Type Description
    LocalReflections

    The local reflection technique.


    Outline

    Gets the outline effect.

    [DataMember(6)]
    public Outline Outline { get; }
    Property Value
    Type Description
    Outline

    RequiresNormalBuffer

    public bool RequiresNormalBuffer { get; }
    Property Value
    Type Description
    System.Boolean

    RequiresSpecularRoughnessBuffer

    public bool RequiresSpecularRoughnessBuffer { get; }
    Property Value
    Type Description
    System.Boolean

    RequiresVelocityBuffer

    public bool RequiresVelocityBuffer { get; }
    Property Value
    Type Description
    System.Boolean
    | Improve this Doc View Source

    Methods


    Collect(RenderContext)

    public void Collect(RenderContext context)
    Parameters
    Type Name Description
    RenderContext context

    DisableAll()

    Disables all post processing effects.

    public void DisableAll()

    Draw(RenderDrawContext, RenderOutputValidator, Texture[], Texture, Texture)

    public void Draw(RenderDrawContext drawContext, RenderOutputValidator outputValidator, Texture[] inputs, Texture inputDepthStencil, Texture outputTarget)
    Parameters
    Type Name Description
    RenderDrawContext drawContext
    RenderOutputValidator outputValidator
    Texture[] inputs
    Texture inputDepthStencil
    Texture outputTarget

    DrawCore(RenderDrawContext)

    protected override void DrawCore(RenderDrawContext context)
    Parameters
    Type Name Description
    RenderDrawContext context
    Overrides
    RendererBase.DrawCore(RenderDrawContext)

    InitializeCore()

    protected override void InitializeCore()
    Overrides
    RendererCoreBase.InitializeCore()

    Reset()

    public override void Reset()
    Overrides
    ImageEffect.Reset()

    Inherited Members

    ImageEffect.EnableSetRenderTargets
    ImageEffect.SetInput(Int32, Texture)
    ImageEffect.SetOutput(Texture)
    ImageEffect.SetOutput(Texture[])
    ImageEffect.SetDepthOutput(Texture, Texture)
    ImageEffect.SetDepthOutput(Texture, Texture[])
    ImageEffect.SetViewport(Nullable<Viewport>)
    ImageEffect.PreDrawCore(RenderDrawContext)
    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.SetDefaultParameters()
    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