Class ExtendedShaderMaterial

Hierarchy (view full)

ShaderMaterial2
- ExtendedShaderMaterial

Constructors

constructor

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

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<any>> = {}

`Readonly` isAShaderMaterial

isAShaderMaterial: true = true

`Readonly` isRawShaderMaterial

isRawShaderMaterial: boolean

materialExtensions

materialExtensions: MaterialExtension[] = []

registerMaterialExtensions

registerMaterialExtensions: ((this, customMaterialExtensions) => void) = iMaterialCommons.registerMaterialExtensions

Type declaration

- (this, customMaterialExtensions): void
- Parameters
  - this: IMaterial<IMaterialEvent<IMaterialEventTypes>, IMaterialEventTypes>
  - customMaterialExtensions: MaterialExtension[]
  Returns void

`Readonly` setDirty

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

Type declaration

- (this, options?): void
- Parameters
  - this: IMaterial<IMaterialEvent<IMaterialEventTypes>, IMaterialEventTypes>
  - Optional options: IMaterialSetDirtyOptions
  Returns void

textures

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

Type declaration

colorSpace: ColorSpace
id: string

type

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

unregisterMaterialExtensions

unregisterMaterialExtensions: ((this, customMaterialExtensions) => void) = iMaterialCommons.unregisterMaterialExtensions

Type declaration

- (this, customMaterialExtensions): void
- Parameters
  - this: IMaterial<IMaterialEvent<IMaterialEventTypes>, IMaterialEventTypes>
  - customMaterialExtensions: MaterialExtension[]
  Returns void

userData

userData: IMaterialUserData

`Static` `Readonly` MaterialProperties

MaterialProperties: {
    alphaTest: number;
    alphaToCoverage: boolean;
    blendDst: 205;
    blendDstAlpha: null;
    blendEquation: 100;
    blendEquationAlpha: null;
    blendSrc: 204;
    blendSrcAlpha: null;
    blending: 1;
    clipIntersection: boolean;
    clipShadows: boolean;
    clipping: boolean;
    clippingPlanes: null;
    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;
} = ...

Type declaration

alphaTest: number
alphaToCoverage: boolean
blendDst: 205
blendDstAlpha: null
blendEquation: 100
blendEquationAlpha: null
blendSrc: 204
blendSrcAlpha: null
blending: 1
clipIntersection: boolean
clipShadows: boolean
clipping: boolean
clippingPlanes: null
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

`Private` _setUniformTexSize

_setUniformTexSize(uniform?, t?): void
Parameters
- Optional uniform: IUniform<any>
- Optional t: {
  height: number;
  width: number;
  }
  - height: number
  - width: number
Returns void
- Defined in src/core/material/ExtendedShaderMaterial.ts:38

clone

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

customProgramCacheKey

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

dispatchEvent

dispatchEvent(event): void
Parameters
- event: IMaterialEvent
Returns void
Inherited from ShaderMaterial2.dispatchEvent
- Defined in src/core/material/ShaderMaterial2.ts:50

dispose

dispose(): this
Disposes the material from the GPU. Set force to false if not sure the material is used by any object in the scene. // todo add check for visible in scene also? or is that overkill

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

fromJSON

fromJSON(_, _2?): 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, scene, camera, geometry, object): void
Parameters
- renderer: WebGLRenderer
- scene: Scene<Event, string>
- camera: Camera<Event, string>
- geometry: BufferGeometry<NormalBufferAttributes, Event, string>
- object: Object3D<Event, string>
Returns void
Inherited from ShaderMaterial2.onAfterRender
- Defined in src/core/material/ShaderMaterial2.ts:88

onBeforeCompile

onBeforeCompile(s, renderer): void
Parameters
- s: Shader
- renderer: WebGLRenderer
Returns void
Overrides ShaderMaterial2.onBeforeCompile
- Defined in src/core/material/ExtendedShaderMaterial.ts:67

onBeforeRender

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

setTextureIds

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

setValues

setValues(parameters): 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<Event, string> | ShaderMaterialParameters
  material or material parameters object
Returns this
Inherited from ShaderMaterial2.setValues
- Defined in src/core/material/ShaderMaterial2.ts:100

toJSON

toJSON(_?): any
Parameters
- Optional _: any
Returns any
Inherited from ShaderMaterial2.toJSON
- Defined in src/core/material/ShaderMaterial2.ts:104

Class ExtendedShaderMaterial

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

parameters: ShaderMaterialParameters

textureIds: string[]

isRawShaderMaterial: boolean = false

Returns ExtendedShaderMaterial

Properties

Readonly appliedMeshes

assetType

constructor

extraUniformsToUpload

Readonly isAShaderMaterial

Readonly isRawShaderMaterial

materialExtensions

registerMaterialExtensions

Type declaration

Parameters

this: IMaterial<IMaterialEvent<IMaterialEventTypes>, IMaterialEventTypes>

customMaterialExtensions: MaterialExtension[]

Returns void

Readonly setDirty

Type declaration

Parameters

this: IMaterial<IMaterialEvent<IMaterialEventTypes>, IMaterialEventTypes>

Optional options: IMaterialSetDirtyOptions

Returns void

textures

Type declaration

colorSpace: ColorSpace

id: string

type

unregisterMaterialExtensions

Type declaration

Parameters

this: IMaterial<IMaterialEvent<IMaterialEventTypes>, IMaterialEventTypes>

customMaterialExtensions: MaterialExtension[]

Returns void

userData

Static Readonly MaterialProperties

Type declaration

alphaTest: number

alphaToCoverage: boolean

blendDst: 205

blendDstAlpha: null

blendEquation: 100

blendEquationAlpha: null

blendSrc: 204

blendSrcAlpha: null

blending: 1

clipIntersection: boolean

clipShadows: boolean

clipping: boolean

clippingPlanes: null

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

`Readonly` appliedMeshes

`Readonly` isAShaderMaterial

`Readonly` isRawShaderMaterial

`Readonly` setDirty

`Optional` options: IMaterialSetDirtyOptions

`Static` `Readonly` MaterialProperties

`Static` `Readonly` TYPE

`Static` `Readonly` TypeSlug

`Private` _setUniformTexSize

`Optional` uniform: IUniform<any>

`Optional` t: {
height: number;
width: number;
}

`Optional` _2: any