Packageflare.flsl
Classpublic class FLSLShader
InheritanceFLSLShader Inheritance FLSLScope Inheritance FLSL Inheritance Object

The FLSLShader class is an utiliy helper used to proccess different flsl filters that are in different scopes. Do not use this class directly, see Shader3D on materials package.

See also

Shader3D


Public Properties
 PropertyDefined By
 InheritedagalVersion : int = 1
[static]
FLSL
  currentPass : int
[read-only] Returns the current pass index being proccessed.
FLSLShader
 Inheritedname : String
The name of the flsl object.
FLSL
  outputFragment : uint
Pointer to the output fragment register.
FLSLShader
  outputVertex : uint
Pointer to the output vertex register.
FLSLShader
 Inheritedparams : Object
Contains a collection of flsl public declarations.
FLSLScope
 Inheritedsemantic : String
The semantic which the object is associated.
FLSL
Public Methods
 MethodDefined By
  
FLSLShader(name:String = null)
FLSLShader
 Inherited
bind(byteCode:ByteArray):void
Bind the compiled flsl code to be executed by the scope.
FLSLScope
  
Builds and compile the shader.
FLSLShader
 Inherited
call(ns:String, params:Array = null):uint
Call to a function stored in the scope.
FLSLScope
  
getNumPasses(technique:String = null):int
Returns the number of passes for a specified technique.
FLSLShader
 Inherited
Retirms all technique names available in the scope.
FLSLScope
  
init(pass:int):void
Initializes and sets the specified pass to be processed.
FLSLShader
  
process(filter:FLSLFilter):void
Filters are small pieces of code that can be executed consecutively to affect the current state of the shader.
FLSLShader
Property Detail
currentPassproperty
currentPass:int  [read-only]

Returns the current pass index being proccessed.


Implementation
    public function get currentPass():int
outputFragmentproperty 
public var outputFragment:uint

Pointer to the output fragment register.

outputVertexproperty 
public var outputVertex:uint

Pointer to the output vertex register.

Constructor Detail
FLSLShader()Constructor
public function FLSLShader(name:String = null)



Parameters
name:String (default = null)
Method Detail
build()method
public function build():FLSLProgram

Builds and compile the shader.

Returns
FLSLProgram — A program which contains the resulted byte code and defines the structure of the compiled shader.
getNumPasses()method 
public function getNumPasses(technique:String = null):int

Returns the number of passes for a specified technique.

Parameters

technique:String (default = null) — The name of the technique.

Returns
int — The number of passes.
init()method 
public function init(pass:int):void

Initializes and sets the specified pass to be processed. This also resets the current outputVertex and outputFragment variables.

Parameters

pass:int — The number of the pass to be processed.

process()method 
public function process(filter:FLSLFilter):void

Filters are small pieces of code that can be executed consecutively to affect the current state of the shader. Filters may return a value into outputVertex or outputFragment or affect an existing register in a shared namespace.

Parameters

filter:FLSLFilter — The filter to process.