ColorTransformBase Class

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

    Base class for a ColorTransformBase used by ColorTransform and ToneMapOperator.

    System.Object → ColorTransformBase
    Derived from ColorTransformBase: ColorTransform ToneMapOperator 

    [DataContract(Inherited = true)]
public abstract class ColorTransformBase
    Name Description
    Constructors
    ColorTransformBase(String)

    Initializes a new instance of the ColorTransformBase class.
    Properties
    Enabled

    Gets or sets a value indicating whether this ColorTransformBase is enabled.
    GenericArguments

    Gets or sets the generic arguments used by the shader. Default is null.
    Group

    Gets the group this ColorTransformBase is associated with.
    Parameters

    Gets the parameters.
    Shader

    Gets or sets the name of the shader.
    Methods
    PrepareParameters(ColorTransformContext, ParameterCollection, String)

    Prepare copy operations for parameters.
    UpdateParameters(ColorTransformContext)

    Updates the parameters for this transformation.
    | Improve this Doc View Source

    Constructors

    ColorTransformBase(String)

    Initializes a new instance of the ColorTransformBase class.

    protected ColorTransformBase(string colorTransformShader)
    Parameters
    Type Name Description
    System.String colorTransformShader

    Name of the shader.
    Exceptions
    Type Condition
    System.ArgumentNullException

    shaderName
    | Improve this Doc View Source

    Properties

    Enabled

    Gets or sets a value indicating whether this ColorTransformBase is enabled.

    [DataMember(5)]
public virtual bool Enabled { get; set; }
    Property Value
    Type Description
    System.Boolean

    true if enabled; otherwise, false.

    GenericArguments

    Gets or sets the generic arguments used by the shader. Default is null.

    public object[] GenericArguments { get; set; }
    Property Value
    Type Description
    System.Object[]

    The generic arguments used by the shader. Default is null

    Group

    Gets the group this ColorTransformBase is associated with.

    public ColorTransformGroup Group { get; }
    Property Value
    Type Description
    ColorTransformGroup

    Parameters

    Gets the parameters.

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

    The parameters.

    Shader

    Gets or sets the name of the shader.

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

    The name of the shader.
    | Improve this Doc View Source

    Methods

    PrepareParameters(ColorTransformContext, ParameterCollection, String)

    Prepare copy operations for parameters.

    public virtual void PrepareParameters(ColorTransformContext context, ParameterCollection parentCollection, string keyRoot)
    Parameters
    Type Name Description
    ColorTransformContext context
    ParameterCollection parentCollection
    System.String keyRoot

    UpdateParameters(ColorTransformContext)

    Updates the parameters for this transformation.

    public virtual void UpdateParameters(ColorTransformContext context)
    Parameters
    Type Name Description
    ColorTransformContext context

    The context.
    Remarks

    This method is called just before rendering the ColorTransformGroup that is holding this ColorTransformBase

    Extension Methods