DrawEffect Class

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

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

    System.Object → DisposeBase → ComponentBase → RendererCoreBase → RendererBase → DrawEffect
    Derived from DrawEffect: ComputeEffectShader RadiancePrefilteringGGX RadiancePrefilteringGGXNoCompute LambertianPrefilteringSH ImageEffect 

    [DataContract]
public abstract class DrawEffect : RendererBase, IComponent, IReferencable, ICollectorHolder, IGraphicsRenderer, IGraphicsRendererBase, IGraphicsRendererCore, IDisposable
    Name Description
    Constructors
    DrawEffect()

    Initializes a new instance of the DrawEffect class with the given RenderContext.
    DrawEffect(RenderContext, String)

    Initializes a new instance of the DrawEffect class.
    DrawEffect(String)

    Initializes a new instance of the DrawEffect class.
    Properties
    Parameters

    Gets the parameters.
    SamplingPattern
    Scaler

    Gets a shared ImageScaler.
    Methods
    Draw(RenderDrawContext, String)

    Draws a full screen quad using iterating on each pass of this effect.
    Draw(RenderDrawContext, String, Object[])

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

    Resets the state of this effect.
    SetDefaultParameters()

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

    Returns a System.String that represents this instance.
    | Improve this Doc View Source

    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
    Type Name Description
    RenderContext context

    The context.
    System.String name

    The name.

    DrawEffect(String)

    Initializes a new instance of the DrawEffect class.

    protected DrawEffect(string name)
    Parameters
    Type Name Description
    System.String name
    | Improve this Doc View Source

    Properties

    Parameters

    Gets the parameters.

    public ParameterCollection Parameters { get; protected set; }
    Property Value
    Type Description
    ParameterCollection

    The parameters.

    SamplingPattern

    public SamplingPattern SamplingPattern { get; set; }
    Property Value
    Type Description
    SamplingPattern

    Scaler

    Gets a shared ImageScaler.

    protected ImageScaler Scaler { get; }
    Property Value
    Type Description
    ImageScaler
    | Improve this Doc View Source

    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
    Type Name Description
    RenderDrawContext context
    System.String name

    Draw(RenderDrawContext, String, 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
    Type Name Description
    RenderDrawContext context
    System.String nameFormat
    System.Object[] args

    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 System.String that represents this instance.

    public override string ToString()
    Returns
    Type Description
    System.String

    A System.String that represents this instance.
    Overrides

    Inherited Members

    Extension Methods