Class EffectInstance

Namespace

Stride.Rendering

Assembly

Stride.Graphics.dll

A dynamic effect instance, including its values and resources.

public class EffectInstance : DisposeBase, IDisposable, IReferencable

Inheritance

object

DisposeBase

EffectInstance

Implements

IDisposable

IReferencable

Derived

DynamicEffectInstance

Inherited Members

DisposeBase.Dispose()

DisposeBase.IsDisposed

DisposeBase.OnAddReference()

DisposeBase.OnReleaseReference()

Extension Methods

ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder)

ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder)

Constructors

EffectInstance(Effect, ParameterCollection)

public EffectInstance(Effect effect, ParameterCollection parameters = null)

Parameters

effect Effect

parameters ParameterCollection

Fields

effect

protected Effect effect

Field Value

Effect

permutationCounter

protected int permutationCounter

Field Value

int

Properties

DescriptorReflection

public EffectDescriptorSetReflection DescriptorReflection { get; }

Property Value

EffectDescriptorSetReflection

Effect

public Effect Effect { get; }

Property Value

Effect

Parameters

public ParameterCollection Parameters { get; }

Property Value

ParameterCollection

RootSignature

public RootSignature RootSignature { get; }

Property Value

RootSignature

Methods

Apply(GraphicsContext)

public void Apply(GraphicsContext graphicsContext)

Parameters

graphicsContext GraphicsContext

ChooseEffect(GraphicsDevice)

protected virtual void ChooseEffect(GraphicsDevice graphicsDevice)

Parameters

graphicsDevice GraphicsDevice

Destroy()

Disposes of object resources.

protected override void Destroy()

UpdateEffect(GraphicsDevice)

Compiles or recompiles the effect if necesssary.

public bool UpdateEffect(GraphicsDevice graphicsDevice)

Parameters

graphicsDevice GraphicsDevice

Returns

bool

True if the effect was recompiled, false otherwise.