Variable iMaterialCommonsConst

Type declaration

• Readonly clone: ((superClone) => (() => this))

  • • (superClone): (() => this)

    • Parameters

      • superClone: (() => this)

        • • (): this

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

            Returns this

      Returns (() => this)

      • • (): this

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

          Returns this

• Readonly customProgramCacheKey: ((this) => string)

  • • (this): string

    • Parameters

      • this: IMaterial<IMaterialEvent<IMaterialEventTypes>, IMaterialEventTypes>

      Returns string

• Readonly customProgramCacheKeyOverride: ((superCustomPropertyCacheKey) => (() => string))

  • • (superCustomPropertyCacheKey): (() => string)

    • Parameters

      • superCustomPropertyCacheKey: (() => string)

        • • (): 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

      Returns (() => string)

      • • (): 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

• Readonly dispatchEvent: ((superDispatchEvent) => ((event) => void))

  • • (superDispatchEvent): ((event) => void)

    • Parameters

      • superDispatchEvent: ((event) => void)

        • • (event): void

          • Fire an event type.

            Parameters

            • event: Event & {
                  [a: string]: any;
              }

              The event that gets fired.

            Returns void

      Returns ((event) => void)

      • • (event): void

        • Fire an event type.

          Parameters

          • event: Event & {
                bubbleToObject?: boolean;
                bubbleToParent?: boolean;
                material?: IMaterial<IMaterialEvent<IMaterialEventTypes>, IMaterialEventTypes>;
                oldTexture?: ITexture;
                texture?: ITexture;
                type: IMaterialEventTypes;
                uiChangeEvent?: ChangeEvent;
            } & {
                [a: string]: any;
            }

            The event that gets fired.

          Returns void

• Readonly dispose: ((superDispose) => ((force?) => void))

  • • (superDispose): ((force?) => void)

    • Parameters

      • superDispose: (() => void)

        • • (): void

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

            Returns void

      Returns ((force?) => void)

      • • (force?): void

        • 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

          Parameters

          • Optional force: boolean

            when true, same as three.js dispose. when false, only disposes if disposeOnIdle not false and not used by any object in the scene. default: true

          Returns void

• Readonly onAfterRender: ((renderer, scene, camera, geometry, object) => void)

  • • (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

• Readonly onAfterRenderOverride: ((superOnAfterRender) => ((renderer, scene, camera, geometry, object) => void))

  • • (superOnAfterRender): ((renderer, scene, camera, geometry, object) => void)

    • Parameters

      • superOnAfterRender: ((renderer, scene, camera, geometry, object) => void)

        • • (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

      Returns ((renderer, scene, camera, geometry, object) => void)

      • • (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

• Readonly onBeforeCompile: ((this, shader, renderer) => void)

  • • (this, shader, renderer): void

    • Parameters

      • this: IMaterial<IMaterialEvent<IMaterialEventTypes>, IMaterialEventTypes>

      • shader: Shader

      • renderer: WebGLRenderer

      Returns void

• Readonly onBeforeCompileOverride: ((superOnBeforeCompile) => ((shader, renderer) => void))

  • • (superOnBeforeCompile): ((shader, renderer) => void)

    • Parameters

      • superOnBeforeCompile: ((shader, renderer) => void)

        • • (shader, renderer): 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

      Returns ((shader, renderer) => void)

      • • (shader, renderer): 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

• Readonly onBeforeRender: ((renderer, scene, camera, geometry, object) => void)

  • • (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

• Readonly onBeforeRenderOverride: ((superOnBeforeRender) => ((renderer, scene, camera, geometry, object) => void))

  • • (superOnBeforeRender): ((renderer, scene, camera, geometry, object) => void)

    • Parameters

      • superOnBeforeRender: ((renderer, scene, camera, geometry, object) => void)

        • • (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

      Returns ((renderer, scene, camera, geometry, object) => void)

      • • (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

• Readonly registerMaterialExtensions: ((this, customMaterialExtensions) => void)

  • • (this, customMaterialExtensions): void

    • Parameters

      • this: IMaterial<IMaterialEvent<IMaterialEventTypes>, IMaterialEventTypes>

      • customMaterialExtensions: MaterialExtension[]

      Returns void

• Readonly setDirty: ((this, options?) => void)

  • • (this, options?): void

    • Parameters

      • this: IMaterial<IMaterialEvent<IMaterialEventTypes>, IMaterialEventTypes>

      • Optional options: IMaterialSetDirtyOptions

      Returns void

• Readonly setValues: ((superSetValues) => ((parameters, allowInvalidType?, clearCurrentUserData?) => this))

  • • (superSetValues): ((parameters, allowInvalidType?, clearCurrentUserData?) => this)

    • Parameters

      • superSetValues: ((values) => void)

        • • (values): void

          • Sets the properties based on the values.

            Parameters

            • values: MaterialParameters

              A container with parameters.

            Returns void

      Returns ((parameters, allowInvalidType?, clearCurrentUserData?) => this)

      • • (parameters, allowInvalidType?, clearCurrentUserData?): this

        • Parameters

          • parameters: Material<Event, string> | MaterialParameters & {
                type?: string;
            }

          • Optional allowInvalidType: boolean

          • Optional clearCurrentUserData: boolean

          Returns this

• threeMaterialPropList: {
      alphaTest: number;
      alphaToCoverage: boolean;
      blendDst: 205;
      blendDstAlpha: null;
      blendEquation: 100;
      blendEquationAlpha: null;
      blendSrc: 204;
      blendSrcAlpha: null;
      blending: 1;
      clipIntersection: boolean;
      clipShadows: boolean;
      clippingPlanes: null;
      colorWrite: boolean;
      depthFunc: 3;
      depthTest: boolean;
      depthWrite: boolean;
      dithering: boolean;
      forceSinglePass: 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;
      userData: {};
      vertexColors: boolean;
      visible: boolean;
  }

  • alphaTest: number

  • alphaToCoverage: boolean

  • blendDst: 205

  • blendDstAlpha: null

  • blendEquation: 100

  • blendEquationAlpha: null

  • blendSrc: 204

  • blendSrcAlpha: null

  • blending: 1

  • clipIntersection: boolean

  • clipShadows: boolean

  • clippingPlanes: null

  • colorWrite: boolean

  • depthFunc: 3

  • depthTest: boolean

  • depthWrite: boolean

  • dithering: boolean

  • forceSinglePass: 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

  • userData: {}

  • vertexColors: boolean

  • visible: boolean

• Readonly unregisterMaterialExtensions: ((this, customMaterialExtensions) => void)

  • • (this, customMaterialExtensions): void

    • Parameters

      • this: IMaterial<IMaterialEvent<IMaterialEventTypes>, IMaterialEventTypes>

      • customMaterialExtensions: MaterialExtension[]

      Returns void

• Readonly upgradeMaterial: ((this) => IMaterial)

  • • (this): IMaterial

    • Convert a standard three.js Material to IMaterial

      Parameters

      • this: IMaterial<IMaterialEvent<IMaterialEventTypes>, IMaterialEventTypes>

      Returns IMaterial