Interface: IMaterial<TMaterial, TE>

Core-API.IMaterial

Type parameters

Name	Type
TMaterial	any
TE	extends IMaterialEventMap = IMaterialEventMap

Hierarchy

• EventDispatcher<TE>

• IUiConfigContainer

• IJSONSerializable

• IDisposable

  ↳ IMaterial

Implemented by

• AShaderMaterial2
• DiamondMaterial
• FSShadowMaterial
• MeshBasicMaterial2
• MeshStandardMaterial2
• ShaderMaterial2

Properties

assetType

• assetType: "material"

---

name

• name: string

---

uuid

• uuid: string

---

materialObject

• materialObject: TMaterial

---

userData

• userData: any

---

typeSlug

• Readonly typeSlug: string

---

extraUniformsToUpload

• Optional extraUniformsToUpload: Record<string, IUniform<any>>

---

materialExtensions

• Optional materialExtensions: MaterialExtension[]

---

needsUpdate

• needsUpdate: boolean

---

uiConfig

• Optional uiConfig: UiObjectConfig<any, string>

Inherited from

IUiConfigContainer.uiConfig

Methods

registerMaterialExtensions

▸ Optional registerMaterialExtensions(customMaterialExtensions): void

Parameters

Name	Type
customMaterialExtensions	MaterialExtension[]

Returns

void

---

unregisterMaterialExtensions

▸ Optional unregisterMaterialExtensions(customMaterialExtensions): void

Parameters

Name	Type
customMaterialExtensions	MaterialExtension[]

Returns

void

---

copyProps

▸ copyProps(oldMaterial): IMaterial<TMaterial, TE>

Parameters

Name	Type
oldMaterial	any

Returns

IMaterial<TMaterial, TE>

---

clone

▸ Optional clone(): any

Returns

any

---

setDirty

▸ setDirty(options?): void

Parameters

Name	Type
options?	AnyOptions

Returns

void