M3D / M3D / Render / ShaderMaterial

Class: ShaderMaterial

M3D.Render.ShaderMaterial

Memberof

M3D.Render

Description

着色材质

Date

2022-1-17

Version

1.0

Copyright

All Rights Reserved. Copyright (C) 2022 HOTEAMSOFT, Ltd

Hierarchy

• BaseMaterial

  ↳ ShaderMaterial

Table of contents

Constructors

• constructor

Properties

• id
• instanceRednerMaterial
• count

Methods

• addUniformMap
• addUniformTextureMap
• clearUniformMap
• clone
• compare
• getAcceptLight
• getCompare
• getDefine
• getDisplayName
• getEvents
• getFragmentShader
• getId
• getIsGammaOutpute
• getLightHash
• getMaterialType
• getMaterialTypeStr
• getName
• getNeedUpdate
• getUniformMap
• getUniformTextureMap
• getUseLight
• getUuid
• getVertexShader
• registerEvent
• removeEvent
• setAcceptLight
• setDefine
• setDisplayName
• setFragmentShader
• setId
• setIsGammaOutpute
• setLightHash
• setMaterialType
• setName
• setNeedUpdate
• setUniformMap
• setUseLight
• setUuid
• setVertexShader
• updateUniformMap

Constructors

constructor

• new ShaderMaterial(): ShaderMaterial

Returns

ShaderMaterial

Description

构造函数

Overrides

BaseMaterial.constructor

• new ShaderMaterial(org): ShaderMaterial

Parameters

Name	Type
org	ShaderMaterial

Returns

ShaderMaterial

Description

构造函数

Overrides

BaseMaterial.constructor

Properties

id

• id: number

Inherited from

BaseMaterial.id

---

instanceRednerMaterial

• instanceRednerMaterial: boolean

Inherited from

BaseMaterial.instanceRednerMaterial

---

count

▪ Static count: number

Inherited from

BaseMaterial.count

Methods

addUniformMap

▸ addUniformMap(para, uniformValue): void

Parameters

Name	Type
para	ShaderParameter
uniformValue	any

Returns

void

Description

添加Uniform参数

Inherited from

BaseMaterial.addUniformMap

---

addUniformTextureMap

▸ addUniformTextureMap(para, obj): void

Parameters

Name	Type
para	ShaderParameter
obj	TextureObject

Returns

void

Description

添加纹理Uniform参数

Inherited from

BaseMaterial.addUniformTextureMap

---

clearUniformMap

▸ clearUniformMap(): void

Returns

void

Description

清空材质UniformMap

Inherited from

BaseMaterial.clearUniformMap

---

clone

▸ clone(): ShaderMaterial

Returns

ShaderMaterial

Description

材质克隆

Overrides

BaseMaterial.clone

---

compare

▸ compare(ptrMaterial): boolean

Parameters

Name	Type
ptrMaterial	BaseMaterial

Returns

boolean

Description

比较材质是否相等

Inherited from

BaseMaterial.compare

---

getAcceptLight

▸ getAcceptLight(): boolean

Returns

boolean

Description

获取是否接收灯光配置

Inherited from

BaseMaterial.getAcceptLight

---

getCompare

▸ getCompare(smaterial): boolean

Parameters

Name	Type	Description
smaterial	BaseMaterial	基础材质类

Returns

boolean

Description

获取基础材质类和本类一致性比较

Inherited from

BaseMaterial.getCompare

---

getDefine

▸ getDefine(): Object

Returns

Object

Description

获取材质定义

Inherited from

BaseMaterial.getDefine

---

getDisplayName

▸ getDisplayName(): string

Returns

string

Inherited from

BaseMaterial.getDisplayName

---

getEvents

▸ getEvents(): M3DEvent[]

Returns

M3DEvent[]

Description

获得事件列表

Inherited from

BaseMaterial.getEvents

---

getFragmentShader

▸ getFragmentShader(): string

Returns

string

Description

获取片元着色器

---

getId

▸ getId(): number

Returns

number

Description

获取id

Inherited from

BaseMaterial.getId

---

getIsGammaOutpute

▸ getIsGammaOutpute(): boolean

Returns

boolean

Description

获取是否gamma空间输出

Inherited from

BaseMaterial.getIsGammaOutpute

---

getLightHash

▸ getLightHash(): string

Returns

string

Inherited from

BaseMaterial.getLightHash

---

getMaterialType

▸ getMaterialType(): MaterialType

Returns

MaterialType

Description

获取材质类型

Inherited from

BaseMaterial.getMaterialType

---

getMaterialTypeStr

▸ getMaterialTypeStr(material): string

Parameters

Name	Type	Description
material	MaterialType	材质类型

Returns

string

Description

获取材质类型字符串

Inherited from

BaseMaterial.getMaterialTypeStr

---

getName

▸ getName(): string

Returns

string

材质名称

Description

获取材质名称

Inherited from

BaseMaterial.getName

---

getNeedUpdate

▸ getNeedUpdate(): boolean

Returns

boolean

Description

获取材质是否更新

Inherited from

BaseMaterial.getNeedUpdate

---

getUniformMap

▸ getUniformMap(): Map<ShaderParameter, any>

Returns

Map<ShaderParameter, any>

Description

获取UniformMap

Inherited from

BaseMaterial.getUniformMap

---

getUniformTextureMap

▸ getUniformTextureMap(): Map<ShaderParameter, any>

Returns

Map<ShaderParameter, any>

Description

获取材质纹理UniformMap

Inherited from

BaseMaterial.getUniformTextureMap

---

getUseLight

▸ getUseLight(): boolean

Returns

boolean

Description

获取是否使用灯光

Inherited from

BaseMaterial.getUseLight

---

getUuid

▸ getUuid(): string

Returns

string

Description

生成随机的一个id

Inherited from

BaseMaterial.getUuid

---

getVertexShader

▸ getVertexShader(): string

Returns

string

Description

获取顶点着色器

---

registerEvent

▸ registerEvent(event): void

Parameters

Name	Type	Description
event	M3DEvent	M3D事件

Returns

void

Description

注册事件

Inherited from

BaseMaterial.registerEvent

---

removeEvent

▸ removeEvent(): void

Returns

void

Description

删除事件

Inherited from

BaseMaterial.removeEvent

---

setAcceptLight

▸ setAcceptLight(val): void

Parameters

Name	Type
val	boolean

Returns

void

Description

设置是否接收灯光

Inherited from

BaseMaterial.setAcceptLight

---

setDefine

▸ setDefine(key, val): void

Parameters

Name	Type
key	string
val	string

Returns

void

Description

设置材质定义

Inherited from

BaseMaterial.setDefine

---

setDisplayName

▸ setDisplayName(val): void

Parameters

Name	Type
val	string

Returns

void

Inherited from

BaseMaterial.setDisplayName

---

setFragmentShader

▸ setFragmentShader(val): void

Parameters

Name	Type
val	string

Returns

void

Description

设置片元着色器

---

setId

▸ setId(v): void

Parameters

Name	Type	Description
v	number	ShapeId

Returns

void

Description

设置id

Inherited from

BaseMaterial.setId

---

setIsGammaOutpute

▸ setIsGammaOutpute(val): void

Parameters

Name	Type
val	boolean

Returns

void

Description

设置是否gamma空间输出

Inherited from

BaseMaterial.setIsGammaOutpute

---

setLightHash

▸ setLightHash(val): void

Parameters

Name	Type
val	string

Returns

void

Inherited from

BaseMaterial.setLightHash

---

setMaterialType

▸ setMaterialType(types): void

Parameters

Name	Type	Description
types	MaterialType	材质类型

Returns

void

Description

设置材质类型

Inherited from

BaseMaterial.setMaterialType

---

setName

▸ setName(name): void

Parameters

Name	Type
name	string

Returns

void

Description

设置材质名称

Inherited from

BaseMaterial.setName

---

setNeedUpdate

▸ setNeedUpdate(val): void

Parameters

Name	Type
val	boolean

Returns

void

Description

设置材质是否更新

Inherited from

BaseMaterial.setNeedUpdate

---

setUniformMap

▸ setUniformMap(): void

Returns

void

Description

设置UniformMap

Inherited from

BaseMaterial.setUniformMap

---

setUseLight

▸ setUseLight(val): void

Parameters

Name	Type
val	boolean

Returns

void

Description

设置是否使用灯光

Inherited from

BaseMaterial.setUseLight

---

setUuid

▸ setUuid(uuid): void

Parameters

Name	Type
uuid	string

Returns

void

Description

设置随机的一个id

Inherited from

BaseMaterial.setUuid

---

setVertexShader

▸ setVertexShader(val): void

Parameters

Name	Type
val	string

Returns

void

Description

设置顶点着色器

---

updateUniformMap

▸ updateUniformMap(): void

Returns

void

Description

更新材质UniformMap

Inherited from

BaseMaterial.updateUniformMap