Packageflare.flsl
Classpublic class FLSLParam
InheritanceFLSLParam Inheritance FLSL Inheritance Object

FLSLParam defines a float register to be used as a parameter The length of the value vector of the parameter always be modulo of 4.



Public Properties
 PropertyDefined By
 InheritedagalVersion : int = 1
[static]
FLSL
  format : String
The data format of the parameter.
FLSLParam
  length : int
The length of the parameter indices for array values.
FLSLParam
  max : Number = 0
The maximum value allowed for this parameter.
FLSLParam
  min : Number = 0
The minimum value allowed for this parameter.
FLSLParam
 Inheritedname : String
The name of the flsl object.
FLSL
  order : int = 0
The order in which this parameter should be place in the editor UI.
FLSLParam
 Inheritedsemantic : String
The semantic which the object is associated.
FLSL
  ui : String
The kind of control to be placed in the editor UI.
FLSLParam
  value : Vector.<Number>
A vector of float values to be used as a parameter.
FLSLParam
Public Methods
 MethodDefined By
  
FLSLParam(value:Vector.<Number> = null, length:int = 1)
Creates a new FLSLParam object.
FLSLParam
  
Clones the FLSLParam.
FLSLParam
Property Detail
formatproperty
public var format:String

The data format of the parameter. Sould be float1, float2, float3 or float4.

lengthproperty 
public var length:int

The length of the parameter indices for array values. For example and array of two float4 values would be 2, a float4x4 would be 4.

maxproperty 
public var max:Number = 0

The maximum value allowed for this parameter. This value will be only used in the editor UI.

minproperty 
public var min:Number = 0

The minimum value allowed for this parameter. This value will be only used in the editor UI.

orderproperty 
public var order:int = 0

The order in which this parameter should be place in the editor UI.

uiproperty 
public var ui:String

The kind of control to be placed in the editor UI. Possible values are color or none.

valueproperty 
public var value:Vector.<Number>

A vector of float values to be used as a parameter. The length of the vector should be modulo of 4.

Constructor Detail
FLSLParam()Constructor
public function FLSLParam(value:Vector.<Number> = null, length:int = 1)

Creates a new FLSLParam object.

Parameters
value:Vector.<Number> (default = null) — A vector of float values to be used as a parameter. The length of the vector should be modulo of 4.
 
length:int (default = 1) — The length of the parameter indices for array values. For example and array of two float4 values would be 2, a float4x4 would be 4.
Method Detail
clone()method
public function clone():FLSLParam

Clones the FLSLParam.

Returns
FLSLParam — A cloned FLSLParam object.