Class GaussianBlur

Namespace

Stride.Rendering.Images

Assembly

Stride.Rendering.dll

Provides a gaussian blur effect.

[DataContract("GaussianBlur")]
[Display("Gaussian Blur", null)]
public sealed class GaussianBlur : ImageEffect, IComponent, IReferencable, ICollectorHolder, IImageEffectRenderer, IImageEffect, IGraphicsRenderer, IGraphicsRendererBase, IGraphicsRendererCore, IDisposable

Inheritance

object

DisposeBase

ComponentBase

RendererCoreBase

RendererBase

DrawEffect

ImageEffect

GaussianBlur

Implements

IComponent

IReferencable

ICollectorHolder

IImageEffectRenderer

IImageEffect

IGraphicsRenderer

IGraphicsRendererBase

IGraphicsRendererCore

IDisposable

Inherited Members

ImageEffect.SetInput(int, Texture)

ImageEffect.Reset()

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

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)

Remarks

To improve performance of this gaussian blur is using:

• a separable 1D horizontal and vertical blur
• linear filtering to reduce the number of taps

Constructors

GaussianBlur()

Initializes a new instance of the GaussianBlur class.

public GaussianBlur()

Properties

Radius

Gets or sets the radius.

[DataMember(10)]
public int Radius { get; set; }

Property Value

int

The radius.

SigmaRatio

Gets or sets the sigma ratio. The sigma ratio is used to calculate the sigma based on the radius: The actual formula is sigma = radius / SigmaRatio. The default value is 2.0f.

[DataMember(20)]
public float SigmaRatio { get; set; }

Property Value

float

The sigma ratio.

Methods

Collect(RenderContext)

public void Collect(RenderContext context)

Parameters

context RenderContext

DrawCore(RenderDrawContext)

Main drawing method for this renderer that must be implemented.

protected override void DrawCore(RenderDrawContext context)

Parameters

context RenderDrawContext

The context.