ComputeEffectShader Class

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

    A compute effect based directly on a single compute shader.

    System.Object → DisposeBase → ComponentBase → RendererCoreBase → RendererBase → DrawEffect → ComputeEffectShader
    Derived from ComputeEffectShader: 

    public class ComputeEffectShader : DrawEffect, IComponent, IReferencable, ICollectorHolder, IGraphicsRenderer, IGraphicsRendererBase, IGraphicsRendererCore, IDisposable
    Name Description
    Constructors
    ComputeEffectShader(RenderContext)
    Properties
    EffectInstance

    The current effect instance.
    ShaderSourceName

    Gets or sets the name of the input compute shader file (.sdsl)
    ThreadGroupCounts

    Gets or sets the number of group counts the shader should be dispatched to.
    ThreadNumbers

    Gets or sets the number of threads desired by thread group.
    Methods
    DrawCore(RenderDrawContext)
    PreDrawCore(RenderDrawContext)
    SetDefaultParameters()

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

    Updates the effect from properties defined in this instance. See remarks.
    | Improve this Doc View Source

    Constructors

    ComputeEffectShader(RenderContext)

    public ComputeEffectShader(RenderContext context)
    Parameters
    Type Name Description
    RenderContext context
    | Improve this Doc View Source

    Properties

    EffectInstance

    The current effect instance.

    public DynamicEffectInstance EffectInstance { get; }
    Property Value
    Type Description
    DynamicEffectInstance

    ShaderSourceName

    Gets or sets the name of the input compute shader file (.sdsl)

    public string ShaderSourceName { get; set; }
    Property Value
    Type Description
    System.String

    ThreadGroupCounts

    Gets or sets the number of group counts the shader should be dispatched to.

    public Int3 ThreadGroupCounts { get; set; }
    Property Value
    Type Description
    Int3

    ThreadNumbers

    Gets or sets the number of threads desired by thread group.

    public Int3 ThreadNumbers { get; set; }
    Property Value
    Type Description
    Int3
    | Improve this Doc View Source

    Methods

    DrawCore(RenderDrawContext)

    protected override void DrawCore(RenderDrawContext context)
    Parameters
    Type Name Description
    RenderDrawContext context
    Overrides

    PreDrawCore(RenderDrawContext)

    protected override void PreDrawCore(RenderDrawContext context)
    Parameters
    Type Name Description
    RenderDrawContext context
    Overrides

    SetDefaultParameters()

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

    protected override void SetDefaultParameters()
    Overrides

    UpdateParameters()

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

    protected virtual void UpdateParameters()

    Inherited Members

    Extension Methods