@predy-js/render-interface 0.3.1 → 0.3.3-beta.1

package/types/native/PredyNativeInternal.ts

@@ -1,8 +1,9 @@
 import type { ImageBitmapCallback, ImageBitmapConstructor } from './ImageBitmapInternal';
-import type { TypedArray } from '../type';
+import type { TypedArray, vec2 } from '../type';
 import type { GPUCapability } from '../GPUCapability';
 import type { PredyResizeTemplate, SDFImageOptions, SDFImage } from '@predy-js/specification';
 import type { ImageBitmapInternal } from './ImageBitmapInternal';
+
 export interface PredyRequestOptions {
   url: string,
   //用于测试缓存，生产中不要使用
@@ -15,10 +16,13 @@ export interface PredyRequestOptions {
   //使用系统网络库（仅用于试验）
   useSystemNetwork?: boolean,
 }
+
 export enum PredyResourceCacheStatus {
   noCache = 0, // 没有缓存，走网络请求
   cached = 1, // 命中缓存，如果请求同一个url，在关闭APP之前，一定会命中缓存，关闭APP后，清理时间由系统决定
   preloaded = 2, // 命中预推
+  hitCDN = 3, // 从正常CDN加载
+  missCDN = 4, // CDN异常加载（回源）
 }
 
 export interface PredyRequestResponse {
@@ -29,44 +33,84 @@ export interface PredyRequestResponse {
 
 export type PredyRequestCallback = (err: string | undefined, res: PredyRequestResponse) => void;
 
+export const DataCompressMethodZlib = 1;
+
+type DataCompressMethod = typeof DataCompressMethodZlib;
+
+export enum PredyTextEncoding {
+  utf8 = 0,
+  ascii = 1,
+}
+
 export interface PredyNativeInternal {
   webpDisabled?: boolean,
 
-  createImageBitmap (data: TypedArray | string, //图片文件的数据
+  createImageBitmap(data: TypedArray | string, //图片文件的数据
     options: ImageBitmapConstructor, callback: ImageBitmapCallback): void,
 
-  getDefaultGPUCapability (): GPUCapability,
+  getDefaultGPUCapability(): GPUCapability,
 
-  requestWithCache (options: PredyRequestOptions, callback: PredyRequestCallback): void,
+  requestWithCache(options: PredyRequestOptions, callback: PredyRequestCallback): void,
 
   /**
-   * decode utf8 text from data
-   * @param data
-   */
-  decodeText(data: Uint8Array): string,
+     * decode text from data
+     * @param data
+     * @param encoding 默认utf8
+     */
+  decodeText(data: Uint8Array, encoding?: PredyTextEncoding): string,
+
   /**
-   * 将图片绘制到画布上，同时替换文案，绘制的顺序如下
-   * 创建template.size尺寸的画布, 接下来的绘制均应用 template.offset
-   * 将images绘制到画布上，images的尺寸由image.frame决定
-   * 将数据模板content绘制到画布上,使用variables替换文案
-   * @param template
-   */
-  renderImageTemplate (template: PredyResizeTemplate): ImageBitmapInternal,
+     * 将图片绘制到画布上，同时替换文案，绘制的顺序如下
+     * 创建template.size尺寸的画布, 接下来的绘制均应用 template.offset
+     * 将images绘制到画布上，images的尺寸由image.frame决定
+     * 将数据模板content绘制到画布上,使用variables替换文案
+     * @param template
+     */
+  renderImageTemplate(template: PredyResizeTemplate): ImageBitmapInternal,
 
   /**
-   * 异步绘制图片的模板
-   * @param options
-   * @param callback 如果传入callback就是异步绘制，否则会直接返回结果
-   */
-  generateSDFImage (options: SDFImageOptions, callback?: renderSDFImageCallback): SDFImage | undefined,
+     * 异步绘制图片的模板
+     * @param options
+     * @param callback 如果传入callback就是异步绘制，否则会直接返回结果
+     */
+  generateSDFImage(options: SDFImageOptions, callback?: renderSDFImageCallback): SDFImage | undefined,
+
+  /**
+     * 下载并且执行脚本文件，此方法会缓存https的脚本内容
+     * 对于http的请求（开发环境），每次都重新请求
+     * @param url
+     * @param callback
+     */
+  evaluateScriptURL(url: string, callback: (err: Error, result: any) => void): void,
+
+  /**
+     * 将float32Array转换为half float，写入Uint16Array中,
+     * 如果提供了range参数，代表float16会被重新map到range中，以此提高精度范围
+     * 提供range参数后，算法求出source的最大最小值，然后将float16重新映射到range中
+     * 如果source和target的长度不匹配，返回false
+     */
+  float32ToFloat16(source: Float32Array, target: Uint16Array, range?: vec2): boolean,
+
+  /**
+     * 将half float转换为float32，通过Float32Array返回，
+     * 如果提供了range参数，代表float16会被重新map到range中，以此提高精度范围
+     * 如果没有提供，float16会被直接转化为float32
+     * 如果source和target的长度不匹配，返回false
+     */
+  float16ToFloat32(source: Uint16Array, target: Float32Array, range?: vec2): boolean,
+
+  /**
+     * 解压数据
+     * @param data
+     * @param method
+     */
+  inflateData(data: Uint8Array, method: DataCompressMethod): Uint8Array | undefined,
 
   /**
-   * 下载并且执行脚本文件，此方法会缓存https的脚本内容
-   * 对于http的请求（开发环境），每次都重新请求
-   * @param url
-   * @param callback
+   * 恢复当前的主JSContext,多个JSContext执行的时候会发生抢占，
+   * 调用此函数后，当前的JSContext会被恢复
    */
-  evaluateScriptURL (url: string, callback: (err: Error, result: any) => void): void,
+  restoreJSContext(): boolean,
 }
 
 type renderSDFImageCallback = (img: SDFImage) => void;

package/types/native/RendererInternal.ts

@@ -11,6 +11,7 @@ import type { GPUCapability } from '../GPUCapability';
 import type { TextureInternal, TextureInternalConstructOptions } from './TextureInternal';
 import type { AndGLContext } from './AndGLContext';
 import type { MetalInternal } from './MetalInternal';
+import type { vec2 } from '../type';
 
 /**
  * renderer 内部创建的对象，用来统计信息，排查资源泄漏的问题
@@ -109,6 +110,10 @@ export abstract class RendererInternal implements ResourceInternal {
    */
   abstract getErrors (): string[];
 
-  abstract resize (width: number, height: number): void;
+  /**
+   * resize predy view，并且相关的fbo和render pass都需要设为相应的尺寸
+   * @param size 如果不提供size，则使用当前predy view parent的尺寸
+   */
+  abstract resize (size?: vec2): void;
 }
 

package/types/native/TextureInternal.ts

@@ -55,10 +55,14 @@ export abstract class TextureInternal implements ResourceInternal {
   abstract update2DImageData (data: ImageData, mipmapLevel?: number): void;
 
   /**
-     * 上传压缩纹理数据
+     * 上传2D压缩纹理数据
      */
+  abstract update2DCompressedData (data: Uint8Array, mipmapLevel?: number): void;
 
-  abstract update2DCompressedImage (data: ImageData, mipmapLevel?: number): void;
+  /**
+     * 上传Cube压缩纹理数据
+     */
+  abstract update2DCompressedCubeData (data: Uint8Array[], mipmapLevel?: number): void;
 
   /**
      * imageBitmap的尺寸也必须和Texture相同