RenderEffect Class

    Namespace: Stride.Rendering
    Assembly: Stride.Rendering.dll

    Instantiation of an Effect for a given .

    System.Object → RenderEffect
    Derived from RenderEffect: 

    public class RenderEffect
    Name Description
    Constructors
    RenderEffect(EffectSelector)
    Fields
    Effect
    EffectSelector
    EffectValidator

    Validates if effect needs to be compiled or recompiled.
    FallbackParameters
    FallbackParameterUpdater
    IsReflectionUpdateRequired
    PendingEffect

    Pending effect being compiled.
    PipelineState

    Compiled pipeline state.
    Reflection
    RetryTime

    Describes when to try again after a previous error (UTC).
    State

    Describes what state the effect is in (compiling, error, etc..)
    Properties
    LastFrameUsed
    Methods
    ClearFallbackParameters()
    IsUsedDuringThisFrame(RenderSystem)
    MarkAsUsed(RenderSystem)

    Mark effect as used during this frame.
    | Improve this Doc View Source

    Constructors

    RenderEffect(EffectSelector)

    public RenderEffect(EffectSelector effectSelector)
    Parameters
    Type Name Description
    EffectSelector effectSelector
    | Improve this Doc View Source

    Fields

    Effect

    public Effect Effect
    Field Value
    Type Description
    Effect

    EffectSelector

    public readonly EffectSelector EffectSelector
    Field Value
    Type Description
    EffectSelector

    EffectValidator

    Validates if effect needs to be compiled or recompiled.

    public EffectValidator EffectValidator
    Field Value
    Type Description
    EffectValidator

    FallbackParameters

    public ParameterCollection FallbackParameters
    Field Value
    Type Description
    ParameterCollection

    FallbackParameterUpdater

    public EffectParameterUpdater FallbackParameterUpdater
    Field Value
    Type Description
    EffectParameterUpdater

    IsReflectionUpdateRequired

    public bool IsReflectionUpdateRequired
    Field Value
    Type Description
    System.Boolean

    PendingEffect

    Pending effect being compiled.

    public Task<Effect> PendingEffect
    Field Value
    Type Description
    System.Threading.Tasks.Task<Effect>

    PipelineState

    Compiled pipeline state.

    public PipelineState PipelineState
    Field Value
    Type Description
    PipelineState

    Reflection

    public RenderEffectReflection Reflection
    Field Value
    Type Description
    RenderEffectReflection

    RetryTime

    Describes when to try again after a previous error (UTC).

    public DateTime RetryTime
    Field Value
    Type Description
    System.DateTime

    State

    Describes what state the effect is in (compiling, error, etc..)

    public RenderEffectState State
    Field Value
    Type Description
    RenderEffectState
    | Improve this Doc View Source

    Properties

    LastFrameUsed

    public int LastFrameUsed { get; }
    Property Value
    Type Description
    System.Int32
    | Improve this Doc View Source

    Methods

    ClearFallbackParameters()

    public void ClearFallbackParameters()

    IsUsedDuringThisFrame(RenderSystem)

    public bool IsUsedDuringThisFrame(RenderSystem renderSystem)
    Parameters
    Type Name Description
    RenderSystem renderSystem
    Returns
    Type Description
    System.Boolean

    MarkAsUsed(RenderSystem)

    Mark effect as used during this frame.

    public bool MarkAsUsed(RenderSystem renderSystem)
    Parameters
    Type Name Description
    RenderSystem renderSystem
    Returns
    Type Description
    System.Boolean

    True if state changed (object was not mark as used during this frame until now), otherwise false.

    Extension Methods