Class GaussianBokeh

Namespace

Stride.Rendering.Images

Assembly

Stride.Rendering.dll

Applies a depth-aware gaussian blur to a texture.

public class GaussianBokeh : BokehBlur, IComponent, IReferencable, ICollectorHolder, IImageEffect, IGraphicsRenderer, IGraphicsRendererBase, IGraphicsRendererCore, IDisposable

Inheritance

object

DisposeBase

ComponentBase

RendererCoreBase

RendererBase

DrawEffect

ImageEffect

BokehBlur

GaussianBokeh

Implements

IComponent

IReferencable

ICollectorHolder

IImageEffect

IGraphicsRenderer

IGraphicsRendererBase

IGraphicsRendererCore

IDisposable

Inherited Members

BokehBlur.SetColorDepthInput(Texture, Texture)

BokehBlur.CoCStrength

ImageEffect.EnableSetRenderTargets

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.PreDrawCore(RenderDrawContext)

ImageEffect.SetRenderTargets(RenderDrawContext)

ImageEffect.PostDrawCore(RenderDrawContext)

ImageEffect.DisposeCreatedRenderTargetViews(RenderDrawContext)

ImageEffect.InputCount

ImageEffect.GetInput(int)

ImageEffect.GetSafeInput(int)

ImageEffect.DepthStencil

ImageEffect.HasDepthStencilOutput

ImageEffect.OutputCount

ImageEffect.GetOutput(int)

ImageEffect.GetSafeOutput(int)

ImageEffect.NewScopedRenderTarget2D(TextureDescription)

ImageEffect.NewScopedRenderTarget2D(int, int, PixelFormat, TextureFlags, int)

ImageEffect.NewScopedRenderTarget2D(int, int, PixelFormat, MipMapCount, TextureFlags, int)

DrawEffect.SamplingPattern

DrawEffect.Parameters

DrawEffect.Scaler

DrawEffect.SetDefaultParameters()

DrawEffect.Draw(RenderDrawContext, string)

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

DrawEffect.ToString()

RendererBase.Draw(RenderDrawContext)

RendererCoreBase.Enabled

RendererCoreBase.Profiling

RendererCoreBase.GPUProfilingKey

RendererCoreBase.CPUProfilingKey

RendererCoreBase.Context

RendererCoreBase.Services

RendererCoreBase.Content

RendererCoreBase.GraphicsDevice

RendererCoreBase.EffectSystem

RendererCoreBase.Initialized

RendererCoreBase.Initialize(RenderContext)

RendererCoreBase.Unload()

RendererCoreBase.NewScopedBuffer(BufferDescription, PixelFormat)

RendererCoreBase.NewScopedTypedBuffer(int, PixelFormat, bool, 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.OnNameChanged()

DisposeBase.Dispose()

DisposeBase.IsDisposed

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)

Remarks

This does not produce beautiful bokeh shapes, but it is quite light-weight and performance-friendly.

Constructors

GaussianBokeh()

Initializes a new instance of the GaussianBokeh class.

public GaussianBokeh()

Properties

Radius

Sets the radius of the blur. A child class can override it to do special processing when a new value is provided.

public override float Radius { get; set; }

Property Value

float

Methods

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()