Skip to main content

Class: MeshBasicMaterial2<TE>

Core-API.MeshBasicMaterial2

Type parameters​

NameType
TEextends IMaterialEventMap = IMaterialEventMap

Hierarchy​

Implements​

Properties​

TypeSlug​

▪ Static Readonly TypeSlug: "bmat"


TYPE​

▪ Static Readonly TYPE: "MeshBasicMaterial2"


materialExtensions​

• materialExtensions: MaterialExtension[]

Implementation of​

IMaterial.materialExtensions


typeSlug​

• Readonly typeSlug: "bmat"

Implementation of​

IMaterial.typeSlug


assetType​

• assetType: "material"

Implementation of​

IMaterial.assetType


materialObject​

• materialObject: MeshBasicMaterial2<TE>

Implementation of​

IMaterial.materialObject


isMeshBasicMaterial2​

• isMeshBasicMaterial2: boolean = true


extraUniformsToUpload​

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

Implementation of​

IMaterial.extraUniformsToUpload

Constructors​

constructor​

• new MeshBasicMaterial2<TE>(parameters?)

Type parameters​

NameType
TEextends IMaterialEventMap = IMaterialEventMap

Parameters​

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

Overrides​

MeshBasicMaterial<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​

MeshBasicMaterial.onBeforeCompile


customProgramCacheKey​

▸ customProgramCacheKey(): string

Returns​

string

Overrides​

MeshBasicMaterial.customProgramCacheKey


onBeforeRender​

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

Parameters​

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

Returns​

void

Overrides​

MeshBasicMaterial.onBeforeRender


onAfterRender​

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

Parameters​

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

Returns​

void

Overrides​

MeshBasicMaterial.onAfterRender


copyProps​

▸ copyProps(oldMaterial, allowUnknownType?): MeshBasicMaterial2<TE>

Parameters​

NameTypeDefault value
oldMaterialMaterial<MaterialEventMap>undefined
allowUnknownTypebooleanfalse

Returns​

MeshBasicMaterial2<TE>

Implementation of​

IMaterial.copyProps


toJSON​

▸ toJSON(meta?): any

Parameters​

NameType
meta?any

Returns​

any

Implementation of​

IMaterial.toJSON

Overrides​

MeshBasicMaterial.toJSON


fromJSON​

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

Parameters​

NameTypeDefault value
dataanyundefined
meta?anyundefined
allowUnknownTypebooleanfalse

Returns​

null | MeshBasicMaterial2<TE>

Implementation of​

IMaterial.fromJSON


clone​

▸ clone(): MeshBasicMaterial2<TE>

Returns​

MeshBasicMaterial2<TE>

Implementation of​

IMaterial.clone

Overrides​

MeshBasicMaterial.clone

Accessors​

uiConfig​

• get uiConfig(): UiObjectConfig<any, string>

Returns​

UiObjectConfig<any, string>

Implementation of​

IMaterial.uiConfig