Class ShaderMaterial2<E, ET>

Type Parameters

Hierarchy (view full)

Implements

Constructors

constructor

Properties

appliedMeshes assetType constructor extraUniformsToUpload isAShaderMaterial isRawShaderMaterial materialExtensions registerMaterialExtensions setDirty type unregisterMaterialExtensions userData MaterialProperties TYPE TypeSlug

Accessors

materialObject

Methods

clone customProgramCacheKey dispatchEvent dispose fromJSON onAfterRender onBeforeCompile onBeforeRender setValues toJSON

Constructors

constructor

Properties

Readonly appliedMeshes

appliedMeshes: Set<any> = ...

Managed internally, do not change manually

assetType

assetType: "material" = ...

constructor

constructor: 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

Readonly setDirty

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

Type declaration

type

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

unregisterMaterialExtensions

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

Type declaration

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

              Methods

              clone

              customProgramCacheKey

              dispatchEvent

              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

              fromJSON

              onAfterRender

              onBeforeCompile

              onBeforeRender

              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

                Returns this

              toJSON

              Settings

              Member Visibility

              Theme

              On This Page

              Generated using TypeDoc