Class PostProcessingEffects

Namespace

Stride.Rendering.Images

Assembly

Stride.Rendering.dll

A default bundle of ImageEffect.

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

Inheritance

object

DisposeBase

ComponentBase

RendererCoreBase

RendererBase

DrawEffect

ImageEffect

PostProcessingEffects

Implements

IComponent

IReferencable

ICollectorHolder

IImageEffectRenderer

IImageEffect

IGraphicsRenderer

IGraphicsRendererCore

IPostProcessingEffects

ISharedRenderer

IIdentifiable

IGraphicsRendererBase

IDisposable

Inherited Members

ImageEffect.SetInput(int, Texture)

ImageEffect.SetOutput(Texture)

ImageEffect.SetOutput(params Texture[])

ImageEffect.SetDepthOutput(Texture, Texture)

ImageEffect.SetDepthOutput(Texture, params Texture[])

ImageEffect.SetViewport(Viewport?)

ImageEffect.SetViewports(ReadOnlySpan<Viewport>)

ImageEffect.SetScissorRectangle(Rectangle?)

ImageEffect.SetScissorRectangles(ReadOnlySpan<Rectangle>)

ImageEffect.InputCount

ImageEffect.GetInput(int)

ImageEffect.OutputCount

ImageEffect.GetOutput(int)

DrawEffect.SamplingPattern

DrawEffect.Parameters

DrawEffect.Draw(RenderDrawContext, string)

DrawEffect.Draw(RenderDrawContext, string, params object[])

DrawEffect.ToString()

RendererBase.Draw(RenderDrawContext)

RendererCoreBase.Enabled

RendererCoreBase.Profiling

RendererCoreBase.GPUProfilingKey

RendererCoreBase.CPUProfilingKey

RendererCoreBase.Initialized

RendererCoreBase.Initialize(RenderContext)

ComponentBase.Tags

ComponentBase.Name

DisposeBase.Dispose()

DisposeBase.IsDisposed

Extension Methods

ImageEffectExtensions.SetInput(IImageEffect, Texture)

ImageEffectExtensions.SetInput(IImageEffect, Texture, Texture)

ImageEffectExtensions.SetInput(IImageEffect, Texture, Texture, Texture)

ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder)

ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder)

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

services IServiceRegistry

The services.

PostProcessingEffects(RenderContext)

Initializes a new instance of the PostProcessingEffects class.

public PostProcessingEffects(RenderContext context)

Parameters

context RenderContext

The context.

Properties

AmbientOcclusion

Gets the ambient occlusion effect.

[DataMember(8)]
public AmbientOcclusion AmbientOcclusion { get; }

Property Value

AmbientOcclusion

Antialiasing

Gets the antialiasing effect.

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

Property Value

IScreenSpaceAntiAliasingEffect

The antialiasing.

Bloom

Gets the bloom effect.

[DataMember(30)]
public Bloom Bloom { get; }

Property Value

Bloom

The bloom.

BrightFilter

Gets the bright pass-filter.

[DataMember(20)]
public BrightFilter BrightFilter { get; }

Property Value

BrightFilter

The bright filter.

ColorTransforms

Gets the final color transforms.

[DataMember(70)]
public ColorTransformGroup ColorTransforms { get; }

Property Value

ColorTransformGroup

The color transforms.

DepthOfField

Gets the depth of field effect.

[DataMember(10)]
public DepthOfField DepthOfField { get; }

Property Value

DepthOfField

The depth of field.

Fog

Gets the fog effect.

[DataMember(7)]
public Fog Fog { get; }

Property Value

Fog

Id

Gets the id of this instance

[DataMember(-100)]
[Display(null, null, Browsable = false)]
public Guid Id { get; set; }

Property Value

Guid

LensFlare

Gets the lens flare effect.

[DataMember(50)]
public LensFlare LensFlare { get; }

Property Value

LensFlare

The lens flare.

LightStreak

Gets the light streak effect.

[DataMember(40)]
public LightStreak LightStreak { get; }

Property Value

LightStreak

The light streak.

LocalReflections

Gets the local reflections effect.

[DataMember(9)]
public LocalReflections LocalReflections { get; }

Property Value

LocalReflections

The local reflection technique.

Outline

Gets the outline effect.

[DataMember(6)]
public Outline Outline { get; }

Property Value

Outline

RequiresNormalBuffer

public bool RequiresNormalBuffer { get; }

Property Value

bool

RequiresSpecularRoughnessBuffer

public bool RequiresSpecularRoughnessBuffer { get; }

Property Value

bool

RequiresVelocityBuffer

public bool RequiresVelocityBuffer { get; }

Property Value

bool

Methods

Collect(RenderContext)

public void Collect(RenderContext context)

Parameters

context RenderContext

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

drawContext RenderDrawContext

outputValidator RenderOutputValidator

inputs Texture[]

inputDepthStencil Texture

outputTarget Texture

DrawCore(RenderDrawContext)

Main drawing method for this renderer that must be implemented.

protected override void DrawCore(RenderDrawContext context)

Parameters

context RenderDrawContext

The context.

InitializeCore()

protected override void InitializeCore()

Reset()

Resets the state of this effect.

public override void Reset()