Class ShaderMaterial2<E, ET>

constructor

• new ShaderMaterial2<
      E extends IMaterialEvent = IMaterialEvent,
      ET = IMaterialEventTypes,
  >(
      __namedParameters?: ShaderMaterialParameters & MaterialParameters & {
          customMaterialExtensions?: MaterialExtension[];
      },
      isRawShaderMaterial?: boolean,
  ): ShaderMaterial2<E, ET>

• Type Parameters

  • E extends IMaterialEvent = IMaterialEvent
  • ET = IMaterialEventTypes

  Parameters

  • __namedParameters: ShaderMaterialParameters & MaterialParameters & {
        customMaterialExtensions?: MaterialExtension[];
    } = {}
  • isRawShaderMaterial: boolean = false

  Returns ShaderMaterial2<E, ET>

ReadonlyappliedMeshes

assetType

constructor

extraUniformsToUpload

ReadonlyisAShaderMaterial

ReadonlyisRawShaderMaterial

materialExtensions

registerMaterialExtensions

ReadonlysetDirty

type

'ShaderMaterial'
Copy

unregisterMaterialExtensions

userData

{}
Copy

Static ReadonlyMaterialProperties

Static ReadonlyTYPE

Static ReadonlyTypeSlug

materialObject

• get materialObject(): this

• Returns this

  Deprecated

  use this directly

clone

• clone(): this

• Return a new material with the same parameters as this material.

  Returns this

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

dispatchEvent

• dispatchEvent(event: IMaterialEvent): void

• Fire an event type.

  Parameters

  • event: IMaterialEvent

    The event that gets fired.

  Returns void

dispose

• dispose(): this

• This disposes the material. Textures of a material don't get disposed. These needs to be disposed by Texture.

  Returns this

fromJSON

• fromJSON(_: any, _2?: any): null | ShaderMaterial2<E, ET>

• Parameters

  • _: any
  • Optional_2: any

  Returns null | ShaderMaterial2<E, ET>

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

onBeforeCompile

• onBeforeCompile(shader: 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

  • shader: Shader

    Source code of the shader
  • renderer: WebGLRenderer

    WebGLRenderer Context that is initializing the material

  Returns void

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

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

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