Class: UnLitMaterial
UnLit材质 不计算光照,仅通过颜色与纹理信息即可渲染的基础材质
Hierarchy
MaterialBase
↳
UnLitMaterial
Properties
Accessors
- shaderState
- tintColor
- baseMap
- normalMap
- emissiveMap
- emissiveColor
- emissiveIntensity
- envIntensity
- normalScale
- alphaCutoff
- irradianceMap
- irradianceDepthMap
- baseColor
- uvTransform_1
- uvTransform_2
- sort
- shaderID
- blendMode
- frontFace
- doubleSide
- cullMode
- depthBias
- depthCompare
- envMap
- shadowMap
Methods
- useDefine
- getTextures
- setDefine
- addPass
- removePass
- destroy
- clone
- serialization
- unSerialization
- setShader
- getShader
- debug
Constructors
Properties
name
• name: string
材质名称
Inherited from
MaterialBase.name
Defined in
src/engine/materials/MaterialBase.ts:26
uuid
• uuid: string
材质唯一标识符
Inherited from
MaterialBase.uuid
Defined in
src/engine/materials/MaterialBase.ts:31
isPassMaterial
• isPassMaterial: boolean
= false
是否为PassMaterial
Inherited from
MaterialBase.isPassMaterial
Defined in
src/engine/materials/MaterialBase.ts:35
receiveEnv
• receiveEnv: boolean
= true
是否接收Env
Inherited from
MaterialBase.receiveEnv
Defined in
src/engine/materials/MaterialBase.ts:44
renderPasses
• renderPasses: Map
<RendererType
, MaterialPass
[]>
Inherited from
MaterialBase.renderPasses
Defined in
src/engine/materials/MaterialPass.ts:7
transparent
• transparent: boolean
= false
是否透明
Inherited from
MaterialBase.transparent
Defined in
src/engine/materials/MaterialPass.ts:13
enable
• enable: boolean
= true
材质是否启用
Inherited from
MaterialBase.enable
Defined in
src/engine/materials/MaterialPass.ts:18
renderShader
• renderShader: RenderShader
Inherited from
MaterialBase.renderShader
Defined in
src/engine/materials/MaterialPass.ts:20
Accessors
shaderState
• get
shaderState(): ShaderState
Returns
ShaderState
Inherited from
MaterialBase.shaderState
Defined in
src/engine/materials/MaterialBase.ts:49
• set
shaderState(value
): void
Parameters
Name | Type |
---|---|
value | ShaderState |
Returns
void
Inherited from
MaterialBase.shaderState
Defined in
src/engine/materials/MaterialBase.ts:53
tintColor
• get
tintColor(): Color
Returns
Inherited from
MaterialBase.tintColor
Defined in
src/engine/materials/MaterialBase.ts:57
• set
tintColor(value
): void
Parameters
Name | Type |
---|---|
value | Color |
Returns
void
Inherited from
MaterialBase.tintColor
Defined in
src/engine/materials/MaterialBase.ts:61
baseMap
• get
baseMap(): Texture
获取基础贴图
Returns
Inherited from
MaterialBase.baseMap
Defined in
src/engine/materials/MaterialBase.ts:89
• set
baseMap(texture
): void
设置基础贴图
Parameters
Name | Type |
---|---|
texture | Texture |
Returns
void
Inherited from
MaterialBase.baseMap
Defined in
src/engine/materials/MaterialBase.ts:82
normalMap
• get
normalMap(): Texture
获取法线贴图
Returns
Inherited from
MaterialBase.normalMap
Defined in
src/engine/materials/MaterialBase.ts:96
• set
normalMap(value
): void
设置法线贴图
Parameters
Name | Type |
---|---|
value | Texture |
Returns
void
Inherited from
MaterialBase.normalMap
Defined in
src/engine/materials/MaterialBase.ts:103
emissiveMap
• get
emissiveMap(): Texture
获取发光贴图
Returns
Inherited from
MaterialBase.emissiveMap
Defined in
src/engine/materials/MaterialBase.ts:111
• set
emissiveMap(value
): void
设置发光贴图
Parameters
Name | Type |
---|---|
value | Texture |
Returns
void
Inherited from
MaterialBase.emissiveMap
Defined in
src/engine/materials/MaterialBase.ts:162
emissiveColor
• get
emissiveColor(): Color
获取发光颜色
Returns
Inherited from
MaterialBase.emissiveColor
Defined in
src/engine/materials/MaterialBase.ts:118
• set
emissiveColor(value
): void
设置发光颜色
Parameters
Name | Type |
---|---|
value | Color |
Returns
void
Inherited from
MaterialBase.emissiveColor
Defined in
src/engine/materials/MaterialBase.ts:125
emissiveIntensity
• get
emissiveIntensity(): number
获取发光强度
Returns
number
Inherited from
MaterialBase.emissiveIntensity
Defined in
src/engine/materials/MaterialBase.ts:145
• set
emissiveIntensity(value
): void
设置发光强度
Parameters
Name | Type |
---|---|
value | number |
Returns
void
Inherited from
MaterialBase.emissiveIntensity
Defined in
src/engine/materials/MaterialBase.ts:135
envIntensity
• get
envIntensity(): number
获取环境强度
Returns
number
Inherited from
MaterialBase.envIntensity
Defined in
src/engine/materials/MaterialBase.ts:171
• set
envIntensity(value
): void
设置环境强度
Parameters
Name | Type |
---|---|
value | number |
Returns
void
Inherited from
MaterialBase.envIntensity
Defined in
src/engine/materials/MaterialBase.ts:178
normalScale
• get
normalScale(): number
获取环境强度
Returns
number
Inherited from
MaterialBase.normalScale
Defined in
src/engine/materials/MaterialBase.ts:185
• set
normalScale(value
): void
设置环境强度
Parameters
Name | Type |
---|---|
value | number |
Returns
void
Inherited from
MaterialBase.normalScale
Defined in
src/engine/materials/MaterialBase.ts:192
alphaCutoff
• get
alphaCutoff(): number
获取alphaCutoff,通道透明阈值参数
Returns
number
Inherited from
MaterialBase.alphaCutoff
Defined in
src/engine/materials/MaterialBase.ts:199
• set
alphaCutoff(value
): void
设置alphaCutoff,通道透明阈值参数
Parameters
Name | Type |
---|---|
value | number |
Returns
void
Inherited from
MaterialBase.alphaCutoff
Defined in
src/engine/materials/MaterialBase.ts:206
irradianceMap
• get
irradianceMap(): Texture
获取irradiance发光贴图
Returns
Inherited from
MaterialBase.irradianceMap
Defined in
src/engine/materials/MaterialBase.ts:213
• set
irradianceMap(value
): void
设置irradiance发光贴图
Parameters
Name | Type |
---|---|
value | Texture |
Returns
void
Inherited from
MaterialBase.irradianceMap
Defined in
src/engine/materials/MaterialBase.ts:220
irradianceDepthMap
• get
irradianceDepthMap(): Texture
获取发光深度贴图
Returns
Inherited from
MaterialBase.irradianceDepthMap
Defined in
src/engine/materials/MaterialBase.ts:229
• set
irradianceDepthMap(value
): void
设置发光深度贴图
Parameters
Name | Type |
---|---|
value | Texture |
Returns
void
Inherited from
MaterialBase.irradianceDepthMap
Defined in
src/engine/materials/MaterialBase.ts:236
baseColor
• get
baseColor(): Color
获取基础颜色
Returns
Inherited from
MaterialBase.baseColor
Defined in
src/engine/materials/MaterialBase.ts:245
• set
baseColor(value
): void
设置基础颜色
Parameters
Name | Type |
---|---|
value | Color |
Returns
void
Inherited from
MaterialBase.baseColor
Defined in
src/engine/materials/MaterialBase.ts:252
uvTransform_1
• get
uvTransform_1(): Vector4
获取uvTransform_1
Returns
Vector4
Inherited from
MaterialBase.uvTransform_1
Defined in
src/engine/materials/MaterialBase.ts:265
• set
uvTransform_1(value
): void
设置uvTransform_1
Parameters
Name | Type |
---|---|
value | Vector4 |
Returns
void
Inherited from
MaterialBase.uvTransform_1
Defined in
src/engine/materials/MaterialBase.ts:272
uvTransform_2
• get
uvTransform_2(): Vector4
获取uvTransform_2
Returns
Vector4
Inherited from
MaterialBase.uvTransform_2
Defined in
src/engine/materials/MaterialBase.ts:279
• set
uvTransform_2(value
): void
设置uvTransform_2
Parameters
Name | Type |
---|---|
value | Vector4 |
Returns
void
Inherited from
MaterialBase.uvTransform_2
Defined in
src/engine/materials/MaterialBase.ts:286
sort
• get
sort(): number
Returns
number
Inherited from
MaterialBase.sort
Defined in
src/engine/materials/MaterialPass.ts:26
• set
sort(value
): void
Parameters
Name | Type |
---|---|
value | number |
Returns
void
Inherited from
MaterialBase.sort
Defined in
src/engine/materials/MaterialPass.ts:30
shaderID
• get
shaderID(): string
Returns
string
Inherited from
MaterialBase.shaderID
Defined in
src/engine/materials/MaterialPass.ts:34
• set
shaderID(value
): void
Parameters
Name | Type |
---|---|
value | string |
Returns
void
Inherited from
MaterialBase.shaderID
Defined in
src/engine/materials/MaterialPass.ts:38
blendMode
• get
blendMode(): BlendMode
获取混合模式
Returns
Inherited from
MaterialBase.blendMode
Defined in
src/engine/materials/MaterialPass.ts:56
• set
blendMode(value
): void
设置混合模式
Parameters
Name | Type |
---|---|
value | BlendMode |
Returns
void
Inherited from
MaterialBase.blendMode
Defined in
src/engine/materials/MaterialPass.ts:63
frontFace
• get
frontFace(): GPUFrontFace
获取面朝向
Returns
GPUFrontFace
Inherited from
MaterialBase.frontFace
Defined in
src/engine/materials/MaterialPass.ts:72
• set
frontFace(value
): void
设置面朝向
Parameters
Name | Type |
---|---|
value | GPUFrontFace |
Returns
void
Inherited from
MaterialBase.frontFace
Defined in
src/engine/materials/MaterialPass.ts:79
doubleSide
• get
doubleSide(): boolean
获取是否为双面模式
Returns
boolean
Inherited from
MaterialBase.doubleSide
Defined in
src/engine/materials/MaterialPass.ts:86
• set
doubleSide(value
): void
设置是否为双面模式
Parameters
Name | Type |
---|---|
value | boolean |
Returns
void
Inherited from
MaterialBase.doubleSide
Defined in
src/engine/materials/MaterialPass.ts:93
cullMode
• get
cullMode(): GPUCullMode
获取剔除模式
Returns
GPUCullMode
Inherited from
MaterialBase.cullMode
Defined in
src/engine/materials/MaterialPass.ts:100
• set
cullMode(value
): void
设置剔除模式
Parameters
Name | Type |
---|---|
value | GPUCullMode |
Returns
void
Inherited from
MaterialBase.cullMode
Defined in
src/engine/materials/MaterialPass.ts:107
depthBias
• get
depthBias(): number
Returns
number
Inherited from
MaterialBase.depthBias
Defined in
src/engine/materials/MaterialPass.ts:111
• set
depthBias(value
): void
Parameters
Name | Type |
---|---|
value | number |
Returns
void
Inherited from
MaterialBase.depthBias
Defined in
src/engine/materials/MaterialPass.ts:115
depthCompare
• get
depthCompare(): GPUCompareFunction
获取剔除模式
Returns
GPUCompareFunction
Inherited from
MaterialBase.depthCompare
Defined in
src/engine/materials/MaterialPass.ts:122
• set
depthCompare(value
): void
设置剔除模式
Parameters
Name | Type |
---|---|
value | GPUCompareFunction |
Returns
void
Inherited from
MaterialBase.depthCompare
Defined in
src/engine/materials/MaterialPass.ts:129
envMap
• set
envMap(texture
): void
设置材质环境贴图
Parameters
Name | Type |
---|---|
texture | Texture |
Returns
void
Overrides
MaterialBase.envMap
Defined in
src/engine/materials/UnLitMaterial.ts:44
shadowMap
• set
shadowMap(texture
): void
设置材质阴影贴图
Parameters
Name | Type |
---|---|
texture | Texture |
Returns
void
Overrides
MaterialBase.shadowMap
Defined in
src/engine/materials/UnLitMaterial.ts:51
Methods
useDefine
▸ useDefine(define
, value?
): void
启用材质球的定义
Memberof
MaterialBase
Parameters
Name | Type | Default value |
---|---|---|
define | string | undefined |
value? | boolean | true |
Returns
void
Inherited from
MaterialBase.useDefine
Defined in
src/engine/materials/MaterialBase.ts:155
getTextures
▸ getTextures(): Object
获取纹理
Returns
Object
返回材质纹理
Inherited from
MaterialBase.getTextures
Defined in
src/engine/materials/MaterialBase.ts:300
setDefine
▸ setDefine(define
, bool
): void
设置当前定义状态
Parameters
Name | Type |
---|---|
define | string |
bool | boolean |
Returns
void
Inherited from
MaterialBase.setDefine
Defined in
src/engine/materials/MaterialBase.ts:309
addPass
▸ addPass(passType
, pass
, index?
): MaterialPass
[]
Parameters
Name | Type | Default value |
---|---|---|
passType | RendererType | undefined |
pass | MaterialPass | undefined |
index | number | -1 |
Returns
Inherited from
MaterialBase.addPass
Defined in
src/engine/materials/MaterialBase.ts:313
removePass
▸ removePass(passType
, index
): void
Parameters
Name | Type |
---|---|
passType | RendererType |
index | number |
Returns
void
Inherited from
MaterialBase.removePass
Defined in
src/engine/materials/MaterialBase.ts:329
destroy
▸ destroy(): void
材质球资源回收
Returns
void
Inherited from
MaterialBase.destroy
Defined in
src/engine/materials/MaterialBase.ts:342
clone
▸ clone(): any
复制材质
Returns
any
返回复制的材质
Inherited from
MaterialBase.clone
Defined in
src/engine/materials/MaterialBase.ts:353
serialization
▸ serialization(): SerializeMaterialInstance
Returns
Inherited from
MaterialBase.serialization
Defined in
src/engine/materials/MaterialBase.ts:357
unSerialization
▸ unSerialization(instance
, data
): void
Parameters
Name | Type |
---|---|
instance | SerializeMaterialInstance |
data | UnSerializeData |
Returns
void
Inherited from
MaterialBase.unSerialization
Defined in
src/engine/materials/MaterialBase.ts:373
setShader
▸ setShader(vs
, fs
): RenderShader
Parameters
Name | Type |
---|---|
vs | string |
fs | string |
Returns
Inherited from
MaterialBase.setShader
Defined in
src/engine/materials/MaterialPass.ts:42
getShader
▸ getShader(): RenderShader
Returns
Inherited from
MaterialBase.getShader
Defined in
src/engine/materials/MaterialPass.ts:49
debug
▸ debug(): void
启用GUI调试
Returns
void
Overrides
MaterialBase.debug
Defined in
src/engine/materials/UnLitMaterial.ts:58
Constructors
constructor
• new UnLitMaterial()
创建新的UnLit材质对象
Overrides
MaterialBase.constructor