Packageaway3d.materials.methods
Classpublic class EnvMapDiffuseMethod
InheritanceEnvMapDiffuseMethod Inheritance BasicDiffuseMethod Inheritance LightingMethodBase Inheritance ShadingMethodBase

EnvMapDiffuseMethod provides a diffuse shading method that uses a diffuse irradiance environment map to approximate global lighting rather than lights.

Public Properties
 PropertyDefined by
 InheritedalphaThreshold : Number
BasicDiffuseMethod
 InheritedbitmapData : BitmapData
The bitmapData to use to define the diffuse reflection color per texel.
BasicDiffuseMethod
 InheriteddiffuseAlpha : Number
The alpha component of the diffuse reflection.
BasicDiffuseMethod
 InheriteddiffuseColor : uint
The color of the diffuse reflection when not using a texture.
BasicDiffuseMethod
  envMap : CubeMap
The cube environment map to use for the diffuse lighting.
EnvMapDiffuseMethod
 Inheritedpasses : Vector
Any passes required that render to a texture used by this method.
ShadingMethodBase
 InheritedshadowRegister : ShaderRegisterElement
BasicDiffuseMethod
 Inherited_totalLightColorReg : ShaderRegisterElement
BasicDiffuseMethod
 InheritedviewDirVaryingReg : ShaderRegisterElement
ShadingMethodBase
Protected Properties
 PropertyDefined by
 Inherited_diffuseInputIndex : int
BasicDiffuseMethod
 Inherited_diffuseInputRegister : ShaderRegisterElement
BasicDiffuseMethod
 Inherited_globalPosVertexReg : ShaderRegisterElement
ShadingMethodBase
 Inherited_mipmap : Boolean = true
ShadingMethodBase
 Inherited_needsGlobalPos : Boolean
ShadingMethodBase
 Inherited_needsNormals : Boolean
ShadingMethodBase
 Inherited_needsProjection : Boolean
ShadingMethodBase
 Inherited_needsUV : Boolean
ShadingMethodBase
 Inherited_needsView : Boolean
ShadingMethodBase
 Inherited_normalFragmentReg : ShaderRegisterElement
ShadingMethodBase
 Inherited_numLights : int
ShadingMethodBase
 Inherited_passes : Vector
ShadingMethodBase
 Inherited_projectionReg : ShaderRegisterElement
ShadingMethodBase
 Inherited_repeat : Boolean
ShadingMethodBase
 Inherited_shadowRegister : ShaderRegisterElement
BasicDiffuseMethod
 Inherited_smooth : Boolean = true
ShadingMethodBase
 Inherited_useTexture : Boolean
BasicDiffuseMethod
 Inherited_uvFragmentReg : ShaderRegisterElement
ShadingMethodBase
 Inherited_viewDirFragmentReg : ShaderRegisterElement
ShadingMethodBase
 Inherited_viewDirVaryingReg : ShaderRegisterElement
ShadingMethodBase
Public Methods
 MethodDefined by
  
EnvMapDiffuseMethod
(envMap:CubeMap)
Creates a new EnvMapDiffuseMethod object.
EnvMapDiffuseMethod
 Inherited
copyFrom(method:ShadingMethodBase):void
Copies the state from a BasicDiffuseMethod object into the current object.
BasicDiffuseMethod
  
dispose(deep:Boolean):void
Cleans up any resources used by the current object.
EnvMapDiffuseMethod
 Inherited
invalidateBitmapData():void
Marks the texture for update next on the next render.
BasicDiffuseMethod
Protected Methods
 MethodDefined by
 Inherited
getTexSampleCode(targetReg:ShaderRegisterElement, inputReg:ShaderRegisterElement, uvReg:ShaderRegisterElement = null):String
A helper method that generates standard code for sampling from a texture using the normal uv coordinates.
ShadingMethodBase
 Inherited
invalidateShaderProgram():void
Marks the shader program as invalid, so it will be recompiled before the next render.
ShadingMethodBase
Property detail
envMapproperty
envMap:CubeMap  [read-write]

The cube environment map to use for the diffuse lighting.

Implementation
    public function get envMap():CubeMap
    public function set envMap(value:CubeMap):void
numLightsproperty 
numLights:int  [read-write]

Implementation
    arcane function get numLights():int
    arcane function set numLights(value:int):void
Constructor detail
EnvMapDiffuseMethod()constructor
public function EnvMapDiffuseMethod(envMap:CubeMap)Parameters
envMap:CubeMap — The cube environment map to use for the diffuse lighting.
Init Parameters
Method detail
activate()method
arcane override function activate(context:Context3D, contextIndex:uint):void

Sets the render state for this method.

Parameters
context:Context3D — The Context3D currently used for rendering.
 
contextIndex:uint
deactivate()method 
arcane override function deactivate(context:Context3D):void Parameters
context:Context3D
dispose()method 
public override function dispose(deep:Boolean):void

Cleans up any resources used by the current object.

Parameters
deep:Boolean — Indicates whether other resources should be cleaned up, that could potentially be shared across different instances.
getFragmentAGALPreLightingCode()method 
arcane override function getFragmentAGALPreLightingCode(regCache:ShaderRegisterCache):String

Get the fragment shader code that will be needed before any per-light code is added.

Parameters
regCache:ShaderRegisterCache — The register cache used during the compilation.

Returns
String
getFragmentCodePerLight()method 
arcane override function getFragmentCodePerLight(lightIndex:int, lightDirReg:ShaderRegisterElement, lightColReg:ShaderRegisterElement, regCache:ShaderRegisterCache):String

Get the fragment shader code that will generate the code relevant to a single light.

Parameters
lightIndex:int — The register cache used during the compilation.
 
lightDirReg:ShaderRegisterElement
 
lightColReg:ShaderRegisterElement
 
regCache:ShaderRegisterCache

Returns
String
getFragmentPostLightingCode()method 
arcane override function getFragmentPostLightingCode(regCache:ShaderRegisterCache, targetReg:ShaderRegisterElement):String

Get the fragment shader code that should be added after all per-light code. Usually composits everything to the target register.

Parameters
regCache:ShaderRegisterCache — The register cache used during the compilation.
 
targetReg:ShaderRegisterElement

Returns
String
Wiki link
Click to go to the wiki page for 'away3d.materials.methods.EnvMapDiffuseMethod'

Code examples

Comments