Class DrawEffect

Namespace

Stride.Rendering

Assembly

Stride.Rendering.dll

The base class in charge of applying and drawing an effect.

[DataContract]
public abstract class DrawEffect : RendererBase, IComponent, IReferencable, ICollectorHolder, IGraphicsRenderer, IGraphicsRendererBase, IGraphicsRendererCore, IDisposable

Inheritance

object

DisposeBase

ComponentBase

RendererCoreBase

RendererBase

DrawEffect

Implements

IComponent

IReferencable

ICollectorHolder

IGraphicsRenderer

IGraphicsRendererBase

IGraphicsRendererCore

IDisposable

Derived

ComputeEffectShader

RadiancePrefilteringGGX

RadiancePrefilteringGGXNoCompute

LambertianPrefilteringSH

ImageEffect

Inherited Members

RendererBase.DrawCore(RenderDrawContext)

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

RendererCoreBase.Unload()

RendererCoreBase.PreDrawCore(RenderDrawContext)

RendererCoreBase.PostDrawCore(RenderDrawContext)

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)

Constructors

DrawEffect()

Initializes a new instance of the DrawEffect class with the given RenderContext.

protected DrawEffect()

DrawEffect(RenderContext, string)

Initializes a new instance of the DrawEffect class.

protected DrawEffect(RenderContext context, string name = null)

Parameters

context RenderContext

The context.

name string

The name.

DrawEffect(string)

Initializes a new instance of the DrawEffect class.

protected DrawEffect(string name)

Parameters

name string

Properties

Parameters

Gets the parameters.

public ParameterCollection Parameters { get; protected set; }

Property Value

ParameterCollection

The parameters.

SamplingPattern

public SamplingPattern SamplingPattern { get; set; }

Property Value

SamplingPattern

Scaler

Gets a shared ImageScaler.

protected ImageScaler Scaler { get; }

Property Value

ImageScaler

Methods

Draw(RenderDrawContext, string)

Draws a full screen quad using iterating on each pass of this effect.

public void Draw(RenderDrawContext context, string name)

Parameters

context RenderDrawContext

name string

Draw(RenderDrawContext, string, params object[])

Draws a full screen quad using iterating on each pass of this effect.

public void Draw(RenderDrawContext context, string nameFormat, params object[] args)

Parameters

context RenderDrawContext

nameFormat string

args object[]

Reset()

Resets the state of this effect.

public virtual void Reset()

SetDefaultParameters()

Sets the default parameters (called at constructor time and if Reset() is called)

protected virtual void SetDefaultParameters()

ToString()

Returns a string that represents this instance.

public override string ToString()

Returns

string

A string that represents this instance.