Class DepthNormalMaterial

Deprecated

use GBufferMaterial instead

Hierarchy (View Summary)

GBufferMaterial
- DepthNormalMaterial

Constructors

constructor

new DepthNormalMaterial(
    multipleRT: boolean,
    parameters?: ShaderMaterialParameters & MaterialParameters & {
        customMaterialExtensions?: MaterialExtension[];
    },
): DepthNormalMaterial
Parameters
- multipleRT: boolean
- Optionalparameters: ShaderMaterialParameters & MaterialParameters & {
  customMaterialExtensions?: MaterialExtension[];
  }
Returns DepthNormalMaterial
Overrides GBufferMaterial.constructor
- Defined in src/plugins/pipeline/GBufferMaterial.ts:231

Properties

`Readonly`appliedMeshes

appliedMeshes: Set<any> = ...

Objects in the scene that are using this material. This is set in the Object3DManager when the objects are added/removed from the scene. Do not modify this set directly.

assetType

assetType: "material" = ...

constructor

constructor: typeof ShaderMaterial2

The initial value of Object.prototype.constructor is the standard built-in Object constructor.

extraUniformsToUpload

extraUniformsToUpload: Record<string, IUniform> = {}

flagUpdaters

flagUpdaters: Map<
string,
(data: Vector4, context: GBufferUpdaterContext) => void,
> = ...

flatShading

flatShading: boolean = false

`Readonly`isAShaderMaterial

isAShaderMaterial: true

`Readonly`isRawShaderMaterial

isRawShaderMaterial: boolean

materialExtensions

materialExtensions: MaterialExtension[] = []

normalMapType

normalMapType: NormalMapTypes = TangentSpaceNormalMap

registerMaterialExtensions

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

`Readonly`setDirty

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

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`InterpolateProperties

InterpolateProperties: string[] = ...

`Static` `Readonly`MaterialProperties

MaterialProperties: {
    allowOverride: boolean;
    alphaHash: boolean;
    alphaTest: number;
    alphaToCoverage: boolean;
    blendAlpha: number;
    blendColor: string;
    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 GBufferMaterial.materialObject
- Defined in src/core/material/ShaderMaterial2.ts:124

Methods

`Protected`_updateFlagsUniform

_updateFlagsUniform(
    flags: Vector4,
    material: IMaterial<IMaterialEventMap> & Partial<
        PhysicalMaterial<IMaterialEventMap>,
    >,
    renderer: WebGLRenderer,
    scene: Scene,
    camera: Camera,
    geometry: BufferGeometry,
    object: Object3D,
): void
Parameters
- flags: Vector4
- material: IMaterial<IMaterialEventMap> & Partial<PhysicalMaterial<IMaterialEventMap>>
- renderer: WebGLRenderer
- scene: Scene
- camera: Camera
- geometry: BufferGeometry
- object: Object3D
Returns void
Inherited from GBufferMaterial._updateFlagsUniform
- Defined in src/plugins/pipeline/GBufferMaterial.ts:153

clone

clone(track?: boolean): this
Return a new material with the same parameters as this material.
Parameters
- track: boolean = false
Returns this
Inherited from GBufferMaterial.clone
- Defined in src/core/material/ShaderMaterial2.ts:60

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
Inherited from GBufferMaterial.customProgramCacheKey
- Defined in src/core/material/ShaderMaterial2.ts:84

dispose

dispose(): this
Frees the GPU-related resources allocated by this instance. Call this method whenever this instance is no longer used in your app.

Material textures must be disposed of by the dispose() method of Texture.

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

fromJSON

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

onAfterRender

onAfterRender(
    renderer: WebGLRenderer,
    scene: Scene,
    camera: Camera,
    geometry: BufferGeometry,
    object: Object3D,
    group: Group,
): void
Parameters
- renderer: WebGLRenderer
- scene: Scene
- camera: Camera
- geometry: BufferGeometry
- object: Object3D
- group: Group
Returns void
Inherited from GBufferMaterial.onAfterRender
- Defined in src/plugins/pipeline/GBufferMaterial.ts:184

onBeforeCompile

onBeforeCompile(
shader: WebGLProgramParametersWithUniforms,
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. Unlike properties, the callback is not supported by .clone(), .copy() and .toJSON(). This callback is only supported in WebGLRenderer (not WebGPURenderer).
Parameters
- shader: WebGLProgramParametersWithUniforms
- renderer: WebGLRenderer
  WebGLRenderer context that is initializing the material
Returns void
Inherited from GBufferMaterial.onBeforeCompile
- Defined in src/core/material/ShaderMaterial2.ts:88

onBeforeRender

onBeforeRender(
    renderer: WebGLRenderer,
    scene: Scene,
    camera: Camera,
    geometry: BufferGeometry,
    object: Object3D,
    group: Group,
): void
An optional callback that is executed immediately before the material is used to render a 3D object. Unlike properties, the callback is not supported by .clone(), .copy() and .toJSON(). This callback is only supported in WebGLRenderer (not WebGPURenderer).
Parameters
- renderer: WebGLRenderer
- scene: Scene
- camera: Camera
- geometry: BufferGeometry
- object: Object3D
- group: Group
Returns void
Inherited from GBufferMaterial.onBeforeRender
- Defined in src/plugins/pipeline/GBufferMaterial.ts:65

reset

reset(): void
Returns void
Inherited from GBufferMaterial.reset
- Defined in src/plugins/pipeline/GBufferMaterial.ts:200

setValues

setValues(
parameters: Material<MaterialEventMap> | 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<MaterialEventMap> | ShaderMaterialParameters
  material or material parameters object
Returns this
Inherited from GBufferMaterial.setValues
- Defined in src/core/material/ShaderMaterial2.ts:110

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 GBufferMaterial.toJSON
- Defined in src/core/material/ShaderMaterial2.ts:114

Class DepthNormalMaterial

Deprecated

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns DepthNormalMaterial

Properties

ReadonlyappliedMeshes

assetType

constructor

extraUniformsToUpload

flagUpdaters

flatShading

ReadonlyisAShaderMaterial

ReadonlyisRawShaderMaterial

materialExtensions

normalMapType

registerMaterialExtensions

ReadonlysetDirty

type

Default

unregisterMaterialExtensions

userData

Default

Static ReadonlyInterpolateProperties

Static ReadonlyMaterialProperties

Static ReadonlyTYPE

Static ReadonlyTypeSlug

Accessors

materialObject

Returns this

Deprecated

Methods

Protected_updateFlagsUniform

Parameters

Returns void

clone

Parameters

Returns this

customProgramCacheKey

Returns string

dispose

Returns this

fromJSON

Parameters

Returns DepthNormalMaterial | null

onAfterRender

Parameters

Returns void

onBeforeCompile

Parameters

Returns void

onBeforeRender

Parameters

Returns void

reset

Returns void

setValues

Parameters

Returns this

toJSON

Parameters

Returns any

Settings

On This Page

`Readonly`appliedMeshes

`Readonly`isAShaderMaterial

`Readonly`isRawShaderMaterial

`Readonly`setDirty

`Static` `Readonly`InterpolateProperties

`Static` `Readonly`MaterialProperties

`Static` `Readonly`TYPE

`Static` `Readonly`TypeSlug

`Protected`_updateFlagsUniform