Packageaway3d.materials.passes
Classpublic class DefaultScreenPass
InheritanceDefaultScreenPass Inheritance MaterialPassBase Inheritance flash.events.EventDispatcher

DefaultScreenPass is a shader pass that uses shader methods to compile a complete program.

See also

away3d.materials.methods.ShadingMethodBase


Public Properties
 PropertyDefined By
 InheritedalphaPremultiplied : Boolean
MaterialPassBase
  ambientMethod : BasicAmbientMethod
DefaultScreenPass
  animateUVs : Boolean
DefaultScreenPass
 InheritedanimationSet : IAnimationSet
The animation used to add vertex code to the shader code.
MaterialPassBase
 InheritedbothSides : Boolean
Defines whether or not the material should perform backface culling.
MaterialPassBase
  colorTransform : ColorTransform
The ColorTransform object to transform the colour of the material with.
DefaultScreenPass
 InheriteddepthCompareMode : String
MaterialPassBase
  diffuseLightSources : uint
DefaultScreenPass
  diffuseMethod : BasicDiffuseMethod
The method to perform diffuse shading.
DefaultScreenPass
 Inheritedmaterial : MaterialBase
The material to which this pass belongs.
MaterialPassBase
  mipmap : Boolean
[override] Defines whether any used textures should use mipmapping.
DefaultScreenPass
  normalMap : Texture2DBase
The tangent space normal map to influence the direction of the surface for each texel.
DefaultScreenPass
  normalMethod : BasicNormalMethod
DefaultScreenPass
  numMethods : int
[read-only]
DefaultScreenPass
 InheritednumUsedStreams : uint
[read-only] The amount of used vertex streams in the vertex code.
MaterialPassBase
 InheritednumUsedVertexConstants : uint
[read-only] The amount of used vertex constants in the vertex code.
MaterialPassBase
 InheritedrenderToTexture : Boolean
[read-only] Specifies whether this pass renders to texture
MaterialPassBase
 Inheritedrepeat : Boolean
Defines whether textures should be tiled.
MaterialPassBase
  shadowMethod : ShadowMapMethodBase
DefaultScreenPass
 Inheritedsmooth : Boolean
Defines whether smoothing should be applied to any used textures.
MaterialPassBase
  specularLightSources : uint
DefaultScreenPass
  specularMethod : BasicSpecularMethod
The method to perform specular shading.
DefaultScreenPass
Protected Properties
 PropertyDefined By
 Inherited_alphaPremultiplied : Boolean
MaterialPassBase
 Inherited_animatableAttributes : Array
MaterialPassBase
 Inherited_animationSet : IAnimationSet
MaterialPassBase
 Inherited_animationTargetRegisters : Array
MaterialPassBase
  _cameraPositionIndex : int
DefaultScreenPass
 Inherited_defaultCulling : String = back
MaterialPassBase
 Inherited_depthCompareMode : String = less
MaterialPassBase
  _lightDataIndex : int
DefaultScreenPass
 Inherited_material : MaterialBase
MaterialPassBase
 Inherited_mipmap : Boolean = true
MaterialPassBase
  _normalBufferIndex : int
DefaultScreenPass
 Inherited_numDirectionalLights : uint
MaterialPassBase
 Inherited_numLightProbes : uint
MaterialPassBase
 Inherited_numPointLights : uint
MaterialPassBase
 Inherited_numUsedFragmentConstants : uint
MaterialPassBase
 Inherited_numUsedStreams : uint
MaterialPassBase
 Inherited_numUsedTextures : uint
MaterialPassBase
 Inherited_numUsedVertexConstants : uint
MaterialPassBase
 Inherited_repeat : Boolean = false
MaterialPassBase
  _sceneMatrixIndex : int
DefaultScreenPass
  _sceneNormalMatrixIndex : int
DefaultScreenPass
  _secondaryUVBufferIndex : int
DefaultScreenPass
 Inherited_smooth : Boolean = true
MaterialPassBase
  _tangentBufferIndex : int
DefaultScreenPass
  _uvBufferIndex : int
DefaultScreenPass
  _uvTransformIndex : int
DefaultScreenPass
Public Methods
 MethodDefined By
  
Creates a new DefaultScreenPass objects.
DefaultScreenPass
  
Adds a method to change the material after all lighting is performed.
DefaultScreenPass
  
addMethodAt(method:EffectMethodBase, index:int):void
Inserts a method to change the material after all lighting is performed at the given index.
DefaultScreenPass
  
dispose():void
[override] Cleans up any resources used by the current object.
DefaultScreenPass
  
DefaultScreenPass
  
hasMethod(method:EffectMethodBase):Boolean
DefaultScreenPass
  
Removes a method from the pass.
DefaultScreenPass
Property Detail
_cameraPositionIndexproperty
protected var _cameraPositionIndex:int

_lightDataIndexproperty 
protected var _lightDataIndex:int

_normalBufferIndexproperty 
protected var _normalBufferIndex:int

_passesproperty 
arcane var _passes:Vector.<MaterialPassBase>

_passesDirtyproperty 
arcane var _passesDirty:Boolean

_sceneMatrixIndexproperty 
protected var _sceneMatrixIndex:int

_sceneNormalMatrixIndexproperty 
protected var _sceneNormalMatrixIndex:int

_secondaryUVBufferIndexproperty 
protected var _secondaryUVBufferIndex:int

_tangentBufferIndexproperty 
protected var _tangentBufferIndex:int

_uvBufferIndexproperty 
protected var _uvBufferIndex:int

_uvTransformIndexproperty 
protected var _uvTransformIndex:int

ambientMethodproperty 
ambientMethod:BasicAmbientMethod


Implementation
    public function get ambientMethod():BasicAmbientMethod
    public function set ambientMethod(value:BasicAmbientMethod):void
animateUVsproperty 
animateUVs:Boolean


Implementation
    public function get animateUVs():Boolean
    public function set animateUVs(value:Boolean):void
colorTransformproperty 
colorTransform:ColorTransform

The ColorTransform object to transform the colour of the material with.


Implementation
    public function get colorTransform():ColorTransform
    public function set colorTransform(value:ColorTransform):void
colorTransformMethodproperty 
colorTransformMethod:ColorTransformMethod


Implementation
    arcane function get colorTransformMethod():ColorTransformMethod
    arcane function set colorTransformMethod(value:ColorTransformMethod):void
diffuseLightSourcesproperty 
diffuseLightSources:uint


Implementation
    public function get diffuseLightSources():uint
    public function set diffuseLightSources(value:uint):void
diffuseMethodproperty 
diffuseMethod:BasicDiffuseMethod

The method to perform diffuse shading.


Implementation
    public function get diffuseMethod():BasicDiffuseMethod
    public function set diffuseMethod(value:BasicDiffuseMethod):void
mipmapproperty 
mipmap:Boolean[override]

Defines whether any used textures should use mipmapping.


Implementation
    public function get mipmap():Boolean
    public function set mipmap(value:Boolean):void
normalMapproperty 
normalMap:Texture2DBase

The tangent space normal map to influence the direction of the surface for each texel.


Implementation
    public function get normalMap():Texture2DBase
    public function set normalMap(value:Texture2DBase):void
normalMethodproperty 
normalMethod:BasicNormalMethod


Implementation
    public function get normalMethod():BasicNormalMethod
    public function set normalMethod(value:BasicNormalMethod):void
numDirectionalLightsproperty 
numDirectionalLights:uint[override]


Implementation
    arcane function get numDirectionalLights():uint
    arcane function set numDirectionalLights(value:uint):void
numLightProbesproperty 
numLightProbes:uint  [write-only] [override]


Implementation
    arcane function set numLightProbes(value:uint):void
numMethodsproperty 
numMethods:int  [read-only]


Implementation
    public function get numMethods():int
numPointLightsproperty 
numPointLights:uint[override]


Implementation
    arcane function get numPointLights():uint
    arcane function set numPointLights(value:uint):void
shadowMethodproperty 
shadowMethod:ShadowMapMethodBase


Implementation
    public function get shadowMethod():ShadowMapMethodBase
    public function set shadowMethod(value:ShadowMapMethodBase):void
specularLightSourcesproperty 
specularLightSources:uint


Implementation
    public function get specularLightSources():uint
    public function set specularLightSources(value:uint):void
specularMethodproperty 
specularMethod:BasicSpecularMethod

The method to perform specular shading.


Implementation
    public function get specularMethod():BasicSpecularMethod
    public function set specularMethod(value:BasicSpecularMethod):void
Constructor Detail
DefaultScreenPass()Constructor
public function DefaultScreenPass(material:MaterialBase)

Creates a new DefaultScreenPass objects.

Parameters
material:MaterialBase
Method Detail
activate()method
override arcane function activate(stage3DProxy:Stage3DProxy, camera:Camera3D, textureRatioX:Number, textureRatioY:Number):void

Parameters

stage3DProxy:Stage3DProxy
 
camera:Camera3D
 
textureRatioX:Number
 
textureRatioY:Number

addMethod()method 
public function addMethod(method:EffectMethodBase):void

Adds a method to change the material after all lighting is performed.

Parameters

method:EffectMethodBase — The method to be added.

addMethodAt()method 
public function addMethodAt(method:EffectMethodBase, index:int):void

Inserts a method to change the material after all lighting is performed at the given index.

Parameters

method:EffectMethodBase — The method to be added.
 
index:int — The index of the method's occurrence

deactivate()method 
override arcane function deactivate(stage3DProxy:Stage3DProxy):void

Parameters

stage3DProxy:Stage3DProxy

dispose()method 
override public function dispose():void

Cleans up any resources used by the current object.

getFragmentCode()method 
override arcane function getFragmentCode():String

Returns
String
getMethodAt()method 
public function getMethodAt(index:int):EffectMethodBase

Parameters

index:int

Returns
EffectMethodBase
getVertexCode()method 
override arcane function getVertexCode(code:String):String

Parameters

code:String

Returns
String
hasMethod()method 
public function hasMethod(method:EffectMethodBase):Boolean

Parameters

method:EffectMethodBase

Returns
Boolean
invalidateShaderProgram()method 
override arcane function invalidateShaderProgram(updateMaterial:Boolean = true):void

Marks the shader program as invalid, so it will be recompiled before the next render.

Parameters

updateMaterial:Boolean (default = true)

removeMethod()method 
public function removeMethod(method:EffectMethodBase):void

Removes a method from the pass.

Parameters

method:EffectMethodBase — The method to be removed.

render()method 
override arcane function render(renderable:IRenderable, stage3DProxy:Stage3DProxy, camera:Camera3D, lightPicker:LightPickerBase):void

Parameters

renderable:IRenderable
 
stage3DProxy:Stage3DProxy
 
camera:Camera3D
 
lightPicker:LightPickerBase

updateProgram()method 
override arcane function updateProgram(stage3DProxy:Stage3DProxy):void

Compiles the shader program.

Parameters

stage3DProxy:Stage3DProxy — An optional register that contains an amount by which to inflate the model (used in single object depth map rendering).