Class ColorTransformBase

Namespace

Stride.Rendering.Images

Assembly

Stride.Rendering.dll

Base class for a ColorTransformBase used by ColorTransform and ToneMapOperator.

[DataContract(Inherited = true)]
public abstract class ColorTransformBase

Inheritance

object

ColorTransformBase

Derived

ColorTransform

ToneMapOperator

Extension Methods

UnsafeUtilities.As<T>(object?)

Constructors

ColorTransformBase(string)

Initializes a new instance of the ColorTransformBase class.

protected ColorTransformBase(string colorTransformShader)

Parameters

colorTransformShader string

Name of the shader.

Exceptions

ArgumentNullException

shaderName

Properties

Enabled

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

[DataMember(5)]
public virtual bool Enabled { get; set; }

Property Value

bool

true if enabled; otherwise, false.

Group

Gets the group this ColorTransformBase is associated with.

public ColorTransformGroup Group { get; }

Property Value

ColorTransformGroup

Parameters

Gets the parameters.

public ParameterCollection Parameters { get; }

Property Value

ParameterCollection

The parameters.

Shader

Gets or sets the shader source for this color transform.

public ShaderSource Shader { get; set; }

Property Value

ShaderSource

Methods

PrepareParameters(ColorTransformContext, ParameterCollection, string)

Prepare copy operations for parameters.

public virtual void PrepareParameters(ColorTransformContext context, ParameterCollection parentCollection, string keyRoot)

Parameters

context ColorTransformContext

parentCollection ParameterCollection

keyRoot string

UpdateParameters(ColorTransformContext)

Updates the parameters for this transformation.

public virtual void UpdateParameters(ColorTransformContext context)

Parameters

context ColorTransformContext

The context.

Remarks

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