Class ImageEffectShader

Namespace

Stride.Rendering.Images

Assembly

Stride.Rendering.dll

Post effect using an Effect (either sdfx or sdsl).

[DataContract("ImageEffectShader")]
public class ImageEffectShader : ImageEffect, IComponent, IReferencable, ICollectorHolder, IImageEffect, IGraphicsRenderer, IGraphicsRendererBase, IGraphicsRendererCore, IDisposable

Inheritance

object

DisposeBase

ComponentBase

RendererCoreBase

RendererBase

DrawEffect

ImageEffect

ImageEffectShader

Implements

IComponent

IReferencable

ICollectorHolder

IImageEffect

IGraphicsRenderer

IGraphicsRendererBase

IGraphicsRendererCore

IDisposable

Derived

ColorCombiner

FXAAEffect

ImageScaler

LuminanceLogEffect

SphericalHarmonicsRendererEffect

TemporalAntiAliasEffect

Inherited Members

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.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.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

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

ImageEffectShader(string, bool)

Initializes a new instance of the ImageEffectShader class.

public ImageEffectShader(string effectName = null, bool delaySetRenderTargets = false)

Parameters

effectName string

delaySetRenderTargets bool

Properties

BlendState

public BlendStateDescription BlendState { get; set; }

Property Value

BlendStateDescription

DepthStencilState

public DepthStencilStateDescription DepthStencilState { get; set; }

Property Value

DepthStencilStateDescription

EffectInstance

The current effect instance.

public DynamicEffectInstance EffectInstance { get; }

Property Value

DynamicEffectInstance

EffectName

Effect name.

public string EffectName { get; protected set; }

Property Value

string

RasterizerState

public RasterizerStateDescription RasterizerState { get; set; }

Property Value

RasterizerStateDescription

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

PreDrawCore(RenderDrawContext)

protected override void PreDrawCore(RenderDrawContext context)

Parameters

context RenderDrawContext

SetDefaultParameters()

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

protected override void SetDefaultParameters()

UpdateParameters()

Updates the effect Parameters from properties defined in this instance. See remarks.

protected virtual void UpdateParameters()

Remarks

By default, all the input textures will be remapped to Texture0...etc.

Exceptions

InvalidOperationException

Expecting less than 10 textures in input