Package | away3d.materials.methods |
Class | public class CompositeSpecularMethod |
Inheritance | CompositeSpecularMethod ![]() ![]() ![]() ![]() ![]() |
Subclasses | CelSpecularMethod, FresnelSpecularMethod |
Property | Defined By | ||
---|---|---|---|
![]() | assetFullPath : Array [read-only] | NamedAssetBase | |
![]() | assetNamespace : String [read-only] | NamedAssetBase | |
baseMethod : BasicSpecularMethod
The base specular method on which this method's shading is based. | CompositeSpecularMethod | ||
gloss : Number [override]
The sharpness of the specular highlight. | CompositeSpecularMethod | ||
![]() | name : String | NamedAssetBase | |
![]() | originalName : String [read-only]
The original name used for this asset in the resource (e.g. | NamedAssetBase | |
passes : Vector.<MaterialPassBase> [override] [read-only]
Any passes required that render to a texture used by this method. | CompositeSpecularMethod | ||
specular : Number [override]
The overall strength of the specular highlights. | CompositeSpecularMethod | ||
![]() | specularColor : uint
The colour of the specular reflection of the surface. | BasicSpecularMethod | |
texture : Texture2DBase [override]
The bitmapData that encodes the specular highlight strength per texel in the red channel, and the sharpness
in the green channel. | CompositeSpecularMethod |
Method | Defined By | ||
---|---|---|---|
CompositeSpecularMethod(modulateMethod:Function, baseSpecularMethod:BasicSpecularMethod = null)
Creates a new WrapSpecularMethod object. | CompositeSpecularMethod | ||
![]() | assetPathEquals(name:String, ns:String):Boolean | NamedAssetBase | |
![]() | copyFrom(method:ShadingMethodBase):void [override]
Copies the state from a BasicSpecularMethod object into the current object. | BasicSpecularMethod | |
dispose():void [override]
Cleans up any resources used by the current object. | CompositeSpecularMethod | ||
![]() | resetAssetPath(name:String, ns:String = null, overrideOriginal:Boolean = true):void | NamedAssetBase |
baseMethod | property |
baseMethod:BasicSpecularMethod
The base specular method on which this method's shading is based.
public function get baseMethod():BasicSpecularMethod
public function set baseMethod(value:BasicSpecularMethod):void
gloss | property |
gloss:Number
[override] The sharpness of the specular highlight.
public function get gloss():Number
public function set gloss(value:Number):void
passes | property |
passes:Vector.<MaterialPassBase>
[read-only] [override] Any passes required that render to a texture used by this method.
public function get passes():Vector.<MaterialPassBase>
shadowRegister | property |
shadowRegister:ShaderRegisterElement
[write-only] [override] arcane function set shadowRegister(value:ShaderRegisterElement):void
sharedRegisters | property |
sharedRegisters:ShaderRegisterData
[override]
arcane function get sharedRegisters():ShaderRegisterData
arcane function set sharedRegisters(value:ShaderRegisterData):void
specular | property |
specular:Number
[override] The overall strength of the specular highlights.
public function get specular():Number
public function set specular(value:Number):void
texture | property |
texture:Texture2DBase
[override] The bitmapData that encodes the specular highlight strength per texel in the red channel, and the sharpness in the green channel. You can use SpecularBitmapTexture if you want to easily set specular and gloss maps from greyscale images, but prepared images are preffered.
public function get texture():Texture2DBase
public function set texture(value:Texture2DBase):void
CompositeSpecularMethod | () | Constructor |
public function CompositeSpecularMethod(modulateMethod:Function, baseSpecularMethod:BasicSpecularMethod = null)
Creates a new WrapSpecularMethod object.
ParametersmodulateMethod:Function — The method which will add the code to alter the base method's strength. It needs to have the signature modSpecular(t : ShaderRegisterElement, regCache : ShaderRegisterCache) : String, in which t.w will contain the specular strength and t.xyz will contain the half-vector or the reflection vector.
| |
baseSpecularMethod:BasicSpecularMethod (default = null ) — The base specular method on which this method's shading is based.
|
activate | () | method |
override arcane function activate(vo:MethodVO, stage3DProxy:Stage3DProxy):void
Parameters
vo:MethodVO | |
stage3DProxy:Stage3DProxy |
cleanCompilationData | () | method |
override arcane function cleanCompilationData():void
deactivate | () | method |
override arcane function deactivate(vo:MethodVO, stage3DProxy:Stage3DProxy):void
Parameters
vo:MethodVO | |
stage3DProxy:Stage3DProxy |
dispose | () | method |
override public function dispose():void
Cleans up any resources used by the current object.
getFragmentCodePerLight | () | method |
override arcane function getFragmentCodePerLight(vo:MethodVO, lightDirReg:ShaderRegisterElement, lightColReg:ShaderRegisterElement, regCache:ShaderRegisterCache):String
Get the fragment shader code that will generate the code relevant to a single light.
Parameters
vo:MethodVO | |
lightDirReg:ShaderRegisterElement | |
lightColReg:ShaderRegisterElement | |
regCache:ShaderRegisterCache |
String |
getFragmentCodePerProbe | () | method |
override arcane function getFragmentCodePerProbe(vo:MethodVO, cubeMapReg:ShaderRegisterElement, weightRegister:String, regCache:ShaderRegisterCache):String
Get the fragment shader code that will generate the code relevant to a single light probe object.
Parameters
vo:MethodVO — The register containing the cube map for the current probe
| |
cubeMapReg:ShaderRegisterElement — A string representation of the register + component containing the current weight
| |
weightRegister:String — The register cache providing any necessary registers to the shader
| |
regCache:ShaderRegisterCache |
String — |
getFragmentPostLightingCode | () | method |
override arcane function getFragmentPostLightingCode(vo:MethodVO, regCache:ShaderRegisterCache, targetReg:ShaderRegisterElement):String
Parameters
vo:MethodVO | |
regCache:ShaderRegisterCache | |
targetReg:ShaderRegisterElement |
String |
getFragmentPreLightingCode | () | method |
override arcane function getFragmentPreLightingCode(vo:MethodVO, regCache:ShaderRegisterCache):String
Parameters
vo:MethodVO | |
regCache:ShaderRegisterCache |
String |
getVertexCode | () | method |
override arcane function getVertexCode(vo:MethodVO, regCache:ShaderRegisterCache):String
Parameters
vo:MethodVO | |
regCache:ShaderRegisterCache |
String |
initConstants | () | method |
initVO | () | method |
reset | () | method |
override arcane function reset():void