Skip to main content

Class: AShaderMaterial2<TE>

Extra-Helpers.AShaderMaterial2

Type parameters

NameType
TEextends IMaterialEventMap = IMaterialEventMap

Hierarchy

Implements

Properties

typeSlug

Readonly typeSlug: string = 'shaderMat'

Implementation of

IMaterial.typeSlug


assetType

assetType: "material"

Implementation of

IMaterial.assetType


materialObject

materialObject: AShaderMaterial2<TE>

Implementation of

IMaterial.materialObject


materialExtensions

materialExtensions: MaterialExtension[] = []

Implementation of

IMaterial.materialExtensions


isRawShaderMaterial

isRawShaderMaterial: boolean = false


extraUniformsToUpload

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

Implementation of

IMaterial.extraUniformsToUpload

Constructors

constructor

new AShaderMaterial2<TE>(parameters?, isRawShaderMaterial?)

Type parameters

NameType
TEextends IMaterialEventMap = IMaterialEventMap

Parameters

NameTypeDefault value
parameters?anyundefined
isRawShaderMaterialbooleanfalse

Overrides

ShaderMaterial<TE&IMaterialEventMap\>.constructor

Methods

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

ShaderMaterial.onBeforeCompile


customProgramCacheKey

customProgramCacheKey(): string

Returns

string

Overrides

ShaderMaterial.customProgramCacheKey


onBeforeRender

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

Parameters

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

Returns

void

Overrides

ShaderMaterial.onBeforeRender


onAfterRender

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

Parameters

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

Returns

void

Overrides

ShaderMaterial.onAfterRender


toJSON

Abstract toJSON(meta?): any

Parameters

NameType
meta?any

Returns

any

Implementation of

IMaterial.toJSON

Overrides

ShaderMaterial.toJSON


fromJSON

Abstract fromJSON(data, meta?): null | AShaderMaterial2<TE>

Parameters

NameType
dataany
meta?any

Returns

null | AShaderMaterial2<TE>

Implementation of

IMaterial.fromJSON


copyProps

Abstract copyProps(oldMaterial): AShaderMaterial2<TE>

Parameters

NameType
oldMaterialany

Returns

AShaderMaterial2<TE>

Implementation of

IMaterial.copyProps


setDirty

setDirty(options?): void

Parameters

NameType
options?AnyOptions

Returns

void

Implementation of

IMaterial.setDirty