Class ExtendedShaderMaterial

Hierarchy (View Summary)

ShaderMaterial2
- ExtendedShaderMaterial

Constructors

constructor

new ExtendedShaderMaterial(
    parameters: ShaderMaterialParameters,
    textureIds: string[],
    isRawShaderMaterial?: boolean,
): ExtendedShaderMaterial
Parameters
- parameters: ShaderMaterialParameters
- textureIds: string[]
- isRawShaderMaterial: boolean = false
Returns ExtendedShaderMaterial
Overrides ShaderMaterial2.constructor
- Defined in src/core/material/ExtendedShaderMaterial.ts:27

Properties

`Readonly`appliedMeshes

appliedMeshes: Set<any> = ...

Managed internally, do not change manually

assetType

assetType: "material" = ...

constructor

constructor: typeof ExtendedShaderMaterial & typeof ShaderMaterial2

extraUniformsToUpload

extraUniformsToUpload: Record<string, IUniform> = {}

`Readonly`isAShaderMaterial

isAShaderMaterial: true

`Readonly`isRawShaderMaterial

isRawShaderMaterial: boolean

materialExtensions

materialExtensions: MaterialExtension[] = []

registerMaterialExtensions

registerMaterialExtensions: (
this: IMaterial,
customMaterialExtensions: MaterialExtension[],
) => void = iMaterialCommons.registerMaterialExtensions

`Readonly`setDirty

setDirty: (this: IMaterial, options?: IMaterialSetDirtyOptions) => void = iMaterialCommons.setDirty

textures

textures: { colorSpace: ColorSpace; id: string }[] = []

type

type: "ShaderMaterial" | "RawShaderMaterial" = 'ShaderMaterial'

Default

'ShaderMaterial'

unregisterMaterialExtensions

unregisterMaterialExtensions: (
this: IMaterial,
customMaterialExtensions: MaterialExtension[],
) => void = iMaterialCommons.unregisterMaterialExtensions

userData

userData: IMaterialUserData

An object that can be used to store custom data about the Material. It should not hold references to functions as these will not be cloned.

Default

{}

`Static` `Readonly`MaterialProperties

MaterialProperties: {
    alphaTest: number;
    alphaToCoverage: boolean;
    blendDst: 205;
    blendDstAlpha: null;
    blendEquation: 100;
    blendEquationAlpha: null;
    blending: 1;
    blendSrc: 204;
    blendSrcAlpha: null;
    clipIntersection: boolean;
    clipping: boolean;
    clippingPlanes: null;
    clipShadows: boolean;
    colorWrite: boolean;
    defaultAttributeValues: {};
    defines: {};
    depthFunc: 3;
    depthTest: boolean;
    depthWrite: boolean;
    dithering: boolean;
    extensions: {};
    fog: boolean;
    forceSinglePass: boolean;
    fragmentShader: string;
    glslVersion: null;
    isRawShaderMaterial: boolean;
    lights: boolean;
    name: string;
    opacity: number;
    polygonOffset: boolean;
    polygonOffsetFactor: number;
    polygonOffsetUnits: number;
    precision: null;
    premultipliedAlpha: boolean;
    shadowSide: null;
    side: 0;
    stencilFail: 7680;
    stencilFunc: 519;
    stencilFuncMask: number;
    stencilRef: number;
    stencilWrite: boolean;
    stencilWriteMask: number;
    stencilZFail: 7680;
    stencilZPass: 7680;
    toneMapped: boolean;
    transparent: boolean;
    uniforms: {};
    uniformsGroups: {};
    userData: {};
    vertexColors: boolean;
    vertexShader: string;
    visible: boolean;
    wireframe: boolean;
    wireframeLinewidth: number;
} = ...

`Static` `Readonly`TYPE

TYPE: "ShaderMaterial2" = 'ShaderMaterial2'

`Static` `Readonly`TypeSlug

TypeSlug: "shaderMat" = 'shaderMat'

Accessors

materialObject

get materialObject(): this
Returns this
Deprecated
use this directly
Inherited from ShaderMaterial2.materialObject
- Defined in src/core/material/ShaderMaterial2.ts:114

Methods

clone

clone(): this
Return a new material with the same parameters as this material.

Returns this
Inherited from ShaderMaterial2.clone
- Defined in src/core/material/ShaderMaterial2.ts:49

customProgramCacheKey

customProgramCacheKey(): string
In case onBeforeCompile is used, this callback can be used to identify values of settings used in onBeforeCompile, so three.js can reuse a cached shader or recompile the shader as needed.

Returns string
Overrides ShaderMaterial2.customProgramCacheKey
- Defined in src/core/material/ExtendedShaderMaterial.ts:84

dispatchEvent

dispatchEvent(event: IMaterialEvent): void
Fire an event type.
Parameters
- event: IMaterialEvent
  The event that gets fired.
Returns void
Inherited from ShaderMaterial2.dispatchEvent
- Defined in src/core/material/ShaderMaterial2.ts:50

dispose

dispose(): this
This disposes the material. Textures of a material don't get disposed. These needs to be disposed by Texture.

Returns this
Inherited from ShaderMaterial2.dispose
- Defined in src/core/material/ShaderMaterial2.ts:48

fromJSON

fromJSON(_: any, _2?: any): null | ExtendedShaderMaterial
Parameters
- _: any
- Optional_2: any
Returns null | ExtendedShaderMaterial
Inherited from ShaderMaterial2.fromJSON
- Defined in src/core/material/ShaderMaterial2.ts:107

onAfterRender

onAfterRender(
    renderer: WebGLRenderer,
    scene: Scene,
    camera: Camera,
    geometry: BufferGeometry,
    object: Object3D,
): void
Parameters
- renderer: WebGLRenderer
- scene: Scene
- camera: Camera
- geometry: BufferGeometry
- object: Object3D
Returns void
Inherited from ShaderMaterial2.onAfterRender
- Defined in src/core/material/ShaderMaterial2.ts:88

onBeforeCompile

onBeforeCompile(s: Shader, renderer: WebGLRenderer): void
An optional callback that is executed immediately before the shader program is compiled. This function is called with the shader source code as a parameter. Useful for the modification of built-in materials.
Parameters
- s: Shader
  Source code of the shader
- renderer: WebGLRenderer
  WebGLRenderer Context that is initializing the material
Returns void
Overrides ShaderMaterial2.onBeforeCompile
- Defined in src/core/material/ExtendedShaderMaterial.ts:69

onBeforeRender

onBeforeRender(
    renderer: WebGLRenderer,
    scene: Scene,
    camera: Camera,
    geometry: BufferGeometry,
    object: Object3D,
): void
Parameters
- renderer: WebGLRenderer
- scene: Scene
- camera: Camera
- geometry: BufferGeometry
- object: Object3D
Returns void
Overrides ShaderMaterial2.onBeforeRender
- Defined in src/core/material/ExtendedShaderMaterial.ts:51

setTextureIds

setTextureIds(ids: string[]): void
Parameters
- ids: string[]
Returns void
- Defined in src/core/material/ExtendedShaderMaterial.ts:32

setValues

setValues(parameters: Material | ShaderMaterialParameters): this
Sets the values of this material based on the values of the passed material or an object with material properties The input is expected to be a valid material or a deserialized material parameters object(including the deserialized userdata)
Parameters
- parameters: Material | ShaderMaterialParameters
  material or material parameters object
Returns this
Inherited from ShaderMaterial2.setValues
- Defined in src/core/material/ShaderMaterial2.ts:100

toJSON

toJSON(_?: any): any
Convert the material to three.js JSON format.
Parameters
- Optional_: any
  Object containing metadata such as textures or images for the material.
Returns any
Inherited from ShaderMaterial2.toJSON
- Defined in src/core/material/ShaderMaterial2.ts:104

Class ExtendedShaderMaterial

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns ExtendedShaderMaterial

Properties

ReadonlyappliedMeshes

assetType

constructor

extraUniformsToUpload

ReadonlyisAShaderMaterial

ReadonlyisRawShaderMaterial

materialExtensions

registerMaterialExtensions

ReadonlysetDirty

textures

type

Default

unregisterMaterialExtensions

userData

Default

Static ReadonlyMaterialProperties

Static ReadonlyTYPE

Static ReadonlyTypeSlug

Accessors

materialObject

Returns this

Deprecated

Methods

clone

Returns this

customProgramCacheKey

Returns string

dispatchEvent

Parameters

Returns void

dispose

Returns this

fromJSON

Parameters

Returns null | ExtendedShaderMaterial

onAfterRender

Parameters

Returns void

onBeforeCompile

Parameters

Returns void

onBeforeRender

Parameters

Returns void

setTextureIds

Parameters

Returns void

setValues

Parameters

Returns this

toJSON

Parameters

Returns any

Settings

On This Page

`Readonly`appliedMeshes

`Readonly`isAShaderMaterial

`Readonly`isRawShaderMaterial

`Readonly`setDirty

`Static` `Readonly`MaterialProperties

`Static` `Readonly`TYPE

`Static` `Readonly`TypeSlug