Package	flash.display
Class	public final dynamic class ShaderParameter
Inheritance	ShaderParameter Object

A ShaderParameter instance representing a parameter for a Shader instance is accessed as a property of the Shader instance's data property. The ShaderParameter property has the same name as the parameter's name in the shader code. For example, if a shader defines a parameter named radius, the ShaderParameter instance representing the radius parameter is available as the radius property, as shown here:

var radiusParam:ShaderParameter = myShader.data.radius;

In addition to the defined properties of the ShaderParameter class, each ShaderParameter instance has additional properties corresponding to any metadata defined for the parameter. These properties are added to the ShaderParameter object when it is created. The properties' names match the metadata names specified in the shader's source code. The data type of each property varies according to the data type of the corresponding metadata. A text metadata value such as "description" is a String instance. A metadata property with a non-string value (such as minValue or defaultValue) is represented as an Array instance. The number of elements and element data types correspond to the metadata values.

For example, suppose a shader includes the following two parameter declarations:

     parameter float2 size
     <
         description: "The size of the image to which the kernel is applied";
         minValue: float2(0.0, 0.0);
         maxValue: float2(100.0, 100.0);
         defaultValue: float2(50.0, 50.0);
     >;
     
     parameter float radius
     <
         description: "The radius of the effect";
         minValue: 0.0;
         maxValue: 50.0;
         defaultValue: 25.0;
     >;
     

The ShaderParameter instance corresponding to the size parameter has the following metadata properties in addition to its built-in properties:

The ShaderParameter corresponding to the radius parameter has the following additional properties:

Generally, developer code does not create a ShaderParameter instance directly. A ShaderParameter instance is created for each of a shader's parameters when the Shader instance is created.

See also