Skip to content

webgl_loader_texture_ktx2

对应 three.js 示例地址

仅需关注 init 函数的内容,其他部分都是示例小程序所使用的描述配置。

js
import * as THREE from "three";
import { KTX2Loader } from "three/examples/jsm/loaders/KTX2Loader.js";
import { OrbitControls } from "three/examples/jsm/controls/OrbitControls.js";

/** @type {import("@minisheeep/mp-three-examples").OfficialExampleInfo} */
const exampleInfo = {
  name: "webgl_loader_texture_ktx2",
  useLoaders: [KTX2Loader],
  info: [
    [
      { tag: "a", link: "https://threejs.org", content: "three.js" },
      { tag: "text", content: "- webgl - KTX2 texture loader" }
    ],
    [
      { tag: "a", link: "http://github.khronos.org/KTX-Specification/", content: "KTX2" },
      { tag: "text", content: "with" },
      {
        tag: "a",
        link: "https://github.com/binomialLLC/basis_universal",
        content: "Basis Universal GPU Texture Codec"
      }
    ]
  ],
  init: ({ window, canvas, GUI, Stats, needToDispose, useFrame }) => {
    let camera, scene, renderer, controls, loader, material;
    const SAMPLES = {
      "BasisU ETC1S": "2d_etc1s.ktx2",
      "BasisU UASTC": "2d_uastc.ktx2",
      "RGBA8 sRGB": "2d_rgba8.ktx2",
      "RGBA8 Linear": "2d_rgba8_linear.ktx2",
      // 'RGBA8 Display P3': '2d_rgba8_displayp3.ktx2',
      "RGBA16 Linear": "2d_rgba16_linear.ktx2",
      "RGBA32 Linear": "2d_rgba32_linear.ktx2",
      "ASTC 6x6 (mobile)": "2d_astc_6x6.ktx2"
    };
    const FORMAT_LABELS = {
      [THREE.RGBAFormat]: "RGBA",
      [THREE.RGBA_BPTC_Format]: "RGBA_BPTC",
      [THREE.RGBA_ASTC_4x4_Format]: "RGBA_ASTC_4x4",
      [THREE.RGB_S3TC_DXT1_Format]: "RGB_S3TC_DXT1",
      [THREE.RGBA_S3TC_DXT5_Format]: "RGBA_S3TC_DXT5",
      [THREE.RGB_PVRTC_4BPPV1_Format]: "RGB_PVRTC_4BPPV1",
      [THREE.RGBA_PVRTC_4BPPV1_Format]: "RGBA_PVRTC_4BPPV1",
      [THREE.RGB_ETC1_Format]: "RGB_ETC1",
      [THREE.RGB_ETC2_Format]: "RGB_ETC2",
      [THREE.RGBA_ETC2_EAC_Format]: "RGB_ETC2_EAC"
    };
    const TYPE_LABELS = {
      [THREE.UnsignedByteType]: "UnsignedByteType",
      [THREE.ByteType]: "ByteType",
      [THREE.ShortType]: "ShortType",
      [THREE.UnsignedShortType]: "UnsignedShortType",
      [THREE.IntType]: "IntType",
      [THREE.UnsignedIntType]: "UnsignedIntType",
      [THREE.FloatType]: "FloatType",
      [THREE.HalfFloatType]: "HalfFloatType"
    };
    const params = {
      sample: Object.values(SAMPLES)[0]
    };
    init();
    async function init() {
      const width = window.innerWidth;
      const height = window.innerHeight;
      renderer = new THREE.WebGLRenderer({ antialias: true, canvas });
      renderer.setPixelRatio(window.devicePixelRatio);
      renderer.setSize(width, height);
      window.addEventListener("resize", onWindowResize);
      scene = new THREE.Scene();
      scene.background = new THREE.Color(2105376);
      camera = new THREE.PerspectiveCamera(60, width / height, 0.1, 100);
      camera.position.set(0, 0, 2.5);
      camera.lookAt(scene.position);
      scene.add(camera);
      controls = new OrbitControls(camera, renderer.domElement);
      const geometry = flipY(new THREE.PlaneGeometry());
      material = new THREE.MeshBasicMaterial({
        color: 16777215,
        side: THREE.DoubleSide,
        transparent: true
      });
      const mesh = new THREE.Mesh(geometry, material);
      scene.add(mesh);
      loader = new KTX2Loader().setTranscoderPath("jsm/libs/basis/").detectSupport(renderer);
      const gui = new GUI();
      gui.add(params, "sample", SAMPLES).onChange(loadTexture);
      await loadTexture(params.sample);
      renderer.setAnimationLoop(animate);
      needToDispose(renderer, scene, controls, loader);
    }
    function animate() {
      controls.update();
      renderer.render(scene, camera);
    }
    function onWindowResize() {
      const width = window.innerWidth;
      const height = window.innerHeight;
      camera.aspect = width / height;
      camera.updateProjectionMatrix();
      renderer.setSize(width, height);
    }
    async function loadTexture(path) {
      try {
        const texture = await loader.loadAsync(`./textures/compressed/${path}`);
        texture.minFilter = THREE.NearestMipmapNearestFilter;
        material.map = texture;
        material.needsUpdate = true;
        console.info(`format: ${FORMAT_LABELS[texture.format]}`);
        console.info(`type: ${TYPE_LABELS[texture.type]}`);
        console.info(`colorSpace: ${texture.colorSpace}`);
      } catch (e) {
        console.error(e);
      }
    }
    function flipY(geometry) {
      const uv = geometry.attributes.uv;
      for (let i = 0; i < uv.count; i++) {
        uv.setY(i, 1 - uv.getY(i));
      }
      return geometry;
    }
  }
};
export {
  exampleInfo as default
};
ts
import { Loader, TypedArray } from 'three';
/**
 * 官网示例的多端使用封装把版本
 * */
export interface OfficialExampleInfo extends MiniProgramMeta {
  /*** 示例名称(保持和官网一致)*/
  name: string;
  /** main */
  init: (context: LoadContext) => void;
}

export interface LoadContext {
  //为了减少官方代码的改动,实际上等同于 canvas
  window: EventTarget & { innerWidth: number; innerHeight: number; devicePixelRatio: number };
  /** HTMLCanvasElement */
  canvas: any;
  /** https://www.npmjs.com/package/lil-gui */
  GUI: any;
  /**
   * https://www.npmjs.com/package/stats.js
   * 也可以使用其他受支持的版本
   * */
  Stats: any;
  /** 收集需要 dispose 的对象(官方示例没有处理这部分)*/
  needToDispose: (...objs: any[]) => void | ((fromFn: () => any[]) => void);

  /**基于 raq 的通用封装 */
  useFrame(animateFunc: (/** ms */ delta: number) => void): { cancel: () => void };

  /** 显示加载模态框 */
  requestLoading(text?: string): Promise<void>;

  /** 隐藏加载模态框*/
  cancelLoading(): void;

  /** 保存文件的通用封装*/
  saveFile(
    fileName: string,
    data: ArrayBuffer | TypedArray | DataView | string
  ): Promise<string | null>;

  /** 示例使用 DracoDecoder 时的资源路径 */
  DecoderPath: {
    GLTF: string;
    STANDARD: string;
  };

  /** 为资源路径拼上 CDN 前缀 */
  withCDNPrefix(path: string): string;

  /**
   * 在小程序中应使用 import { VideoTexture } from '@minisheep/three-platform-adapter/override/jsm/textures/VideoTexture.js';
   * 正常情况(web) 可直接使用 THREE.VideoTexture
   * */
  getVideoTexture(videoOptions: VideoOptions): Promise<[{ isVideoTexture: true }, video: any]>;

  /**
   * 在小程序中应使用 import { CameraTexture } from '@minisheep/three-platform-adapter/override/jsm/textures/CameraTexture.js';
   * 正常情况(web) 可参考示例 webgl_materials_video_webcam
   * */
  getCameraTexture(): { isVideoTexture: true };

  /** 用于动态修改 info 中的占位符*/
  bindInfoText(template: `$${string}$`, initValue?: string): { value: string };

  /** 分屏控件对应的事件回调 */
  onSlideStart(handle: () => void): void;
  /** 分屏控件对应的事件回调 */
  onSlideEnd(handle: () => void): void;
  /** 分屏控件对应的事件回调 */
  onSlideChange(handle: (offset: number, boxSize: number) => void): void;
}

export type VideoOptions = {
  src: string;
  /** 相当于 HTMLVideoElement 的 naturalWidth (小程序中获取不到)*/
  width: number;
  /** 相当于 HTMLVideoElement 的 naturalHeight (小程序中获取不到)*/
  height: number;
  loop?: boolean;
  autoplay?: boolean;
  muted?: boolean;
};

/** 示例小程序中使用的一些配置 */
export interface MiniProgramMeta {
  /** 用于统计加载相关信息 */
  useLoaders: Loader[];
  /** 通用 info */
  info: TagItem[][];
  /** 特殊 info */
  infoPanel?: {
    left?: [string, string][];
    right?: [string, string][];
  };
  /** 分屏控件配置 */
  needSlider?: {
    /** 方向 */
    direction?: 'horizontal' | 'vertical';
    /** 初始偏移 0-100 */
    initPosition?: number;
  };
  /** 操作摇杆控件 */
  needArrowControls?: boolean;
  /** 默认需要的画布类型 */
  canvasType?: '2d' | 'webgl' | 'webgl2';
  /** 为保持效果一致所需要的画布样式 */
  canvasStyle?: {
    bgColor?: string;
    width?: number | string;
    height?: number | string;
  };
  /** 部分示例需要在加载前进行一些提示 */
  initAfterConfirm?: {
    /**
     * 提示类型
     * @default 'default'
     * */
    type?: 'warning' | 'default';
    text: string[];
  };
}

export interface BaseTag<T extends string> {
  tag: T;
  content: string;
}

export interface ATag extends BaseTag<'a'> {
  link: string;
}

export type TextTag = BaseTag<'text'>;

export type TagItem = TextTag | ATag;