Skip to main content

Class: MeshStandardMaterial2<TE>

Core-API.MeshStandardMaterial2

Type parameters

NameType
TEextends IMaterialEventMap = IMaterialEventMap

Hierarchy

Implements

Properties

TypeSlug

Static Readonly TypeSlug: "pmat"


TYPE

Static Readonly TYPE: "MeshStandardMaterial2"


materialExtensions

materialExtensions: MaterialExtension[]

Implementation of

IMaterial.materialExtensions


typeSlug

Readonly typeSlug: "pmat"

Implementation of

IMaterial.typeSlug


assetType

assetType: "material"

Implementation of

IMaterial.assetType


materialObject

materialObject: MeshStandardMaterial2<TE>

Implementation of

IMaterial.materialObject


isMeshStandardMaterial2

isMeshStandardMaterial2: boolean = true


extraUniformsToUpload

extraUniformsToUpload: Record<string, IUniform<any>> = {}

Implementation of

IMaterial.extraUniformsToUpload

Constructors

constructor

new MeshStandardMaterial2<TE>(parameters?)

Type parameters

NameType
TEextends IMaterialEventMap = IMaterialEventMap

Parameters

NameType
parameters?MeshPhysicalMaterialParameters & { customMaterialExtensions?: MaterialExtension[] }

Overrides

MeshPhysicalMaterial<TE&IMaterialEventMap\>.constructor

Methods

setDirty

setDirty(options?): void

Parameters

NameType
options?AnyOptions

Returns

void

Implementation of

IMaterial.setDirty


registerMaterialExtensions

registerMaterialExtensions(customMaterialExtensions): void

Parameters

NameType
customMaterialExtensionsMaterialExtension[]

Returns

void

Implementation of

IMaterial.registerMaterialExtensions


unregisterMaterialExtensions

unregisterMaterialExtensions(customMaterialExtensions): void

Parameters

NameType
customMaterialExtensionsMaterialExtension[]

Returns

void

Implementation of

IMaterial.unregisterMaterialExtensions


onBeforeCompile

onBeforeCompile(shader, renderer): void

Parameters

NameType
shaderShader
rendererWebGLRenderer

Returns

void

Overrides

MeshPhysicalMaterial.onBeforeCompile


customProgramCacheKey

customProgramCacheKey(): string

Returns

string

Overrides

MeshPhysicalMaterial.customProgramCacheKey


onBeforeRender

onBeforeRender(renderer, scene, camera, geometry, object): void

Parameters

NameType
rendererWebGLRenderer
sceneScene<Object3DEventMap>
cameraCamera<Object3DEventMap>
geometryBufferGeometry<NormalBufferAttributes, BufferGeometryEventMap>
objectObject3D<Object3DEventMap>

Returns

void

Overrides

MeshPhysicalMaterial.onBeforeRender


onAfterRender

onAfterRender(renderer, scene, camera, geometry, object): void

Parameters

NameType
rendererWebGLRenderer
sceneScene<Object3DEventMap>
cameraCamera<Object3DEventMap>
geometryBufferGeometry<NormalBufferAttributes, BufferGeometryEventMap>
objectObject3D<Object3DEventMap>

Returns

void

Overrides

MeshPhysicalMaterial.onAfterRender


copyProps

copyProps(oldMaterial, allowUnknownType?, clearCurrentUserData?): MeshStandardMaterial2<TE>

Parameters

NameTypeDefault value
oldMaterialMaterial<MaterialEventMap>undefined
allowUnknownTypebooleanfalse
clearCurrentUserDatabooleantrue

Returns

MeshStandardMaterial2<TE>

Implementation of

IMaterial.copyProps


toJSON

toJSON(meta?): any

Parameters

NameType
meta?any

Returns

any

Implementation of

IMaterial.toJSON

Overrides

MeshPhysicalMaterial.toJSON


fromJSON

fromJSON(data, meta?, allowUnknownType?): null | MeshStandardMaterial2<TE>

Parameters

NameTypeDefault value
dataanyundefined
meta?anyundefined
allowUnknownTypebooleanfalse

Returns

null | MeshStandardMaterial2<TE>

Implementation of

IMaterial.fromJSON


clone

clone(): MeshStandardMaterial2<TE>

Returns

MeshStandardMaterial2<TE>

Implementation of

IMaterial.clone

Overrides

MeshPhysicalMaterial.clone

Accessors

uiConfig

get uiConfig(): UiObjectConfig<any, string>

Returns

UiObjectConfig<any, string>

Implementation of

IMaterial.uiConfig