Class TMaterial

clearAllCache

• clearAllCache(): void

  清理所有缓存

  Returns void

clearMaterialCache

• clearMaterialCache(): void

  清理材质缓存

  Returns void

clearTextureCache

• clearTextureCache(): void

  清理纹理缓存

  Returns void

getCacheStats

• getCacheStats(): { materials: number; textures: number }

  获取缓存统计信息

  Returns { materials: number; textures: number }

initBasicMaterial

• initBasicMaterial(
      params?: Partial<MeshBasicMaterialParameters>,
  ): MeshBasicMaterial

  创建基础材质

  Parameters

  • Optionalparams: Partial<MeshBasicMaterialParameters> = {}

    材质参数配置

  Returns MeshBasicMaterial

initCubeTexture

• initCubeTexture(params?: Partial<CubeTextureParams>): CubeTexture

  加载立方体环境贴图

  Parameters

  • Optionalparams: Partial<CubeTextureParams>

    纹理参数配置

  Returns CubeTexture

initDataTexture

• initDataTexture(params?: DataTextureParams): DataTexture

  从原始数据创建一个纹理贴图

  Parameters

  • Optionalparams: DataTextureParams

    纹理参数配置

  Returns DataTexture

initDepthMaterial

• initDepthMaterial(
      params?: Partial<MeshDepthMaterialParameters>,
  ): MeshDepthMaterial

  创建深度材质（基于距离相机的深度渲染的材质）

  Parameters

  • Optionalparams: Partial<MeshDepthMaterialParameters> = {}

    材质参数配置

  Returns MeshDepthMaterial

initDistanceMaterial

• initDistanceMaterial(
      params?: Partial<MeshDistanceMaterialParameters>,
  ): MeshDistanceMaterial

  创建距离材质（基于到参考点的距离渲染的材质）

  Parameters

  • Optionalparams: Partial<MeshDistanceMaterialParameters> = {}

    材质参数配置

  Returns MeshDistanceMaterial

initImageMaterial

• initImageMaterial(params: imageParams): Promise<MeshPhongMaterial>

  创建图片材质（带缓存优化）

  Parameters

  • params: imageParams

  Returns Promise<MeshPhongMaterial>

initLambertMaterial

• initLambertMaterial(
      params?: Partial<MeshLambertMaterialParameters>,
  ): MeshLambertMaterial

  创建漫反射材质

  Parameters

  • Optionalparams: Partial<MeshLambertMaterialParameters> = {}

    材质参数配置

  Returns MeshLambertMaterial

  Remarker

  受光照影响

initLineDashedMaterial

• initLineDashedMaterial(
      params?: Partial<LineDashedMaterialParameters>,
  ): LineDashedMaterial

  创建虚线材质

  Parameters

  • Optionalparams: Partial<LineDashedMaterialParameters> = {}

    材质参数配置

  Returns LineDashedMaterial

initLineMaterial

• initLineMaterial(
      params?: Partial<LineBasicMaterialParameters>,
  ): LineBasicMaterial

  创建线框材质

  Parameters

  • Optionalparams: Partial<LineBasicMaterialParameters> = {}

    材质参数配置

  Returns LineBasicMaterial

initNodeMaterial

• initNodeMaterial(
      nodesOrParams:
          | Partial<Record<string, any>>
          | ((api: __module) => Partial<Record<string, any>>),
      opts?: Partial<Record<string, any>>,
  ): NodeMaterial

  创建 NodeMaterial 自定义材质（WebGPU / TSL）

  Parameters

  • nodesOrParams: Partial<Record<string, any>> | ((api: __module) => Partial<Record<string, any>>)

    TSL 回调 (tsl) => ({ colorNode, positionNode, ... })，或直接传参对象（高级用法）
  • Optionalopts: Partial<Record<string, any>> = {}

    通用材质属性（仅回调模式）

  Returns NodeMaterial

  Remark

  仅支持 WebGPU 渲染器；通过 TSL 节点构建自定义着色。 推荐回调写法：库内注入 tsl，调用方无需 import 'three/tsl'。 通用属性（transparent/opacity/side/depthWrite/depthTest/blending/toneMapped/visible/alphaTest/colorWrite） 在第二参数 opts 中传入；以 "Node" 结尾的键作为 TSL 节点槽位在回调返回值中传入。

  Example

  const mat = TO.material.initNodeMaterial(({ Fn, vec3, time, sin }) => ({
    colorNode: Fn(() => vec3(sin(time).add(1).mul(0.5), 0, 0))()
  }), { transparent: true })
  Copy

initNormalMaterial

• initNormalMaterial(
      params?: Partial<MeshNormalMaterialParameters>,
  ): MeshNormalMaterial

  创建法线网格材质

  Parameters

  • Optionalparams: Partial<MeshNormalMaterialParameters> = {}

    材质参数配置

  Returns MeshNormalMaterial

initPhongMaterial

• initPhongMaterial(
      params?: Partial<MeshPhongMaterialParameters>,
  ): MeshPhongMaterial

  创建高光材质（支持高光反射）

  Parameters

  • Optionalparams: Partial<MeshPhongMaterialParameters> = {}

    材质参数配置

  Returns MeshPhongMaterial

initPhysicalMaterial

• initPhysicalMaterial(
      params?: Partial<MeshPhysicalMaterialParameters>,
  ): MeshPhysicalMaterial

  物理网格材质（PBR标准材质基于物理的渲染）

  Parameters

  • Optionalparams: Partial<MeshPhysicalMaterialParameters> = {}

    材质参数配置

  Returns MeshPhysicalMaterial

initPointsMaterial

• initPointsMaterial(params?: Partial<PointsMaterialParameters>): PointsMaterial

  创建点云材质

  Parameters

  • Optionalparams: Partial<PointsMaterialParameters> = {}

    材质参数配置

  Returns PointsMaterial

initRawShaderMaterial

• initRawShaderMaterial(
      params?: Partial<ShaderMaterialParameters>,
  ): RawShaderMaterial

  创建自定义着色器材质

  Parameters

  • Optionalparams: Partial<ShaderMaterialParameters> = {}

    材质参数配置

  Returns RawShaderMaterial

  Remark

  仅支持WebGL渲染器

initShaderMaterial

• initShaderMaterial(params?: Partial<ShaderMaterialParameters>): ShaderMaterial

  创建Shader材质

  Parameters

  • Optionalparams: Partial<ShaderMaterialParameters> = {}

    材质参数配置

  Returns ShaderMaterial

  Remark

  仅支持WebGL渲染器

initShadowMaterial

• initShadowMaterial(params?: Partial<ShadowMaterialParameters>): ShadowMaterial

  创建阴影材质（用于投射和接收阴影的特殊材质）

  Parameters

  • Optionalparams: Partial<ShadowMaterialParameters> = {}

    材质参数配置

  Returns ShadowMaterial

initSpriteMaterial

• initSpriteMaterial(params?: Partial<SpriteMaterialParameters>): SpriteMaterial

  创建Sprite材质

  Parameters

  • Optionalparams: Partial<SpriteMaterialParameters> = {}

    材质参数配置

  Returns SpriteMaterial

initStandardMaterial

• initStandardMaterial(
      params?: Partial<MeshStandardMaterialParameters>,
  ): MeshStandardMaterial

  标准网格材质（PBR标准材质基于物理的渲染）

  Parameters

  • Optionalparams: Partial<MeshStandardMaterialParameters> = {}

    材质参数配置

  Returns MeshStandardMaterial

initTextureMap

• initTextureMap(
      params: BaseMapParams,
  ): Promise<Texture<unknown, TextureEventMap>>

  创建并配置纹理贴图

  Parameters

  • params: BaseMapParams

    贴图参数

  Returns Promise<Texture<unknown, TextureEventMap>>

initTextureMaps

• initTextureMaps(
      params: MaterialMapsParams,
  ): Promise<
      {
          alphaMap?: Texture<unknown, TextureEventMap>;
          aoMap?: Texture<unknown, TextureEventMap>;
          bumpMap?: Texture<unknown, TextureEventMap>;
          displacementMap?: Texture<unknown, TextureEventMap>;
          emissiveMap?: Texture<unknown, TextureEventMap>;
          map?: Texture<unknown, TextureEventMap>;
          metalnessMap?: Texture<unknown, TextureEventMap>;
          normalMap?: Texture<unknown, TextureEventMap>;
          roughnessMap?: Texture<unknown, TextureEventMap>;
      },
  >

  批量创建材质贴图

  Parameters

  • params: MaterialMapsParams

    贴图参数集合

  Returns Promise<
      {
          alphaMap?: Texture<unknown, TextureEventMap>;
          aoMap?: Texture<unknown, TextureEventMap>;
          bumpMap?: Texture<unknown, TextureEventMap>;
          displacementMap?: Texture<unknown, TextureEventMap>;
          emissiveMap?: Texture<unknown, TextureEventMap>;
          map?: Texture<unknown, TextureEventMap>;
          metalnessMap?: Texture<unknown, TextureEventMap>;
          normalMap?: Texture<unknown, TextureEventMap>;
          roughnessMap?: Texture<unknown, TextureEventMap>;
      },
  >

initToonMaterial

• initToonMaterial(params?: Partial<MeshToonMaterialParameters>): MeshToonMaterial

  创建卡通渲染材质（Toon）

  Parameters

  • Optionalparams: Partial<MeshToonMaterialParameters> = {}

    材质参数配置

  Returns MeshToonMaterial

initVideoTexture

• initVideoTexture(params?: Partial<VideoTextureParams>): VideoTexture

  生成视频纹理

  Parameters

  • Optionalparams: Partial<VideoTextureParams>

    纹理参数配置

  Returns VideoTexture

setRenderer

• setRenderer(renderer: WebGLRenderer): void

  设置渲染器引用（用于获取设备能力）

  Parameters

  • renderer: WebGLRenderer

  Returns void

setWaterSkin

• setWaterSkin(
      geometry: PlaneGeometry,
      width: number,
      height: number,
      url: string,
      waterColor?: string | number | Color,
      sunDirection?: Vector3,
      sunColor?: string | number | Color,
  ): Mesh

  给模型设置水波纹材质

  Parameters

  • geometry: PlaneGeometry

    模型
  • width: number

    反射纹理宽度（仅 WebGL 后端生效，WebGPU 用 resolutionScale）
  • height: number

    反射纹理高度（仅 WebGL 后端生效，WebGPU 用 resolutionScale）
  • url: string

    法线贴图地址
  • OptionalwaterColor: string | number | Color

    水颜色
  • OptionalsunDirection: Vector3

    太阳方向
  • OptionalsunColor: string | number | Color

    太阳颜色

    Note

    WebGL 后端用 three 的 Water，WebGPU 后端用 three/webgpu 的 WaterMesh； 需要将色调映射 设置为 NoToneMapping

  Returns Mesh

textureLoader