@predy-js/render-interface 0.1.68 → 0.1.70

package/dist/src/index.d.ts

@@ -1,17 +1 @@
-export * from '../types/constants';
-export * from '../types/RenderPass';
-export * from '../types/Texture';
-export * from '../types/GPUBuffer';
-export { constants } from './webgl/constants';
-export * from '../types/ShaderLibrary';
-export { MarsRenderFrame as RenderFrame } from './render/MarsRenderFrame';
-export { MarsRenderer as Renderer } from './render/MarsRenderer';
-export { MarsMesh as Mesh, MarsInstancedMesh as InstancedMesh } from './render/MarsMesh';
-export { MarsGeometry as Geometry } from './render/MarsGeometry';
-export { MarsRenderPass as RenderPass } from './render/MarsRenderPass';
-export { MarsTexture as Texture } from './render/MarsTexture';
-export { MarsMaterial as Material } from './render/MarsMaterial';
-export { MarsMaterialDataBlock as MaterialDataBlock } from './render/MarsMaterialDataBlock';
-export { MarsSharedGeometry as SharedGeometry } from './render/MarsSharedGeometry';
-export { getDefaultGPUCapability } from './render/MarsGPUCapability';
-export { getDefaultTextureFactory, setDefaultTextureFactory, MarsTextureFactory } from './render/MarsTextureFactory';
+export * from './module';

package/dist/src/module.d.ts

@@ -0,0 +1,18 @@
+export * from '../types/constants';
+export * from '../types/RenderPass';
+export * from '../types/Texture';
+export * from '../types/GPUBuffer';
+export { constants } from './webgl/constants';
+export * from '../types/ShaderLibrary';
+export { MarsRenderFrame as RenderFrame } from './render/MarsRenderFrame';
+export { MarsRenderer as Renderer } from './render/MarsRenderer';
+export { MarsMesh as Mesh, MarsInstancedMesh as InstancedMesh } from './render/MarsMesh';
+export { MarsGeometry as Geometry } from './render/MarsGeometry';
+export { MarsRenderPass as RenderPass } from './render/MarsRenderPass';
+export { MarsTexture as Texture } from './render/MarsTexture';
+export { MarsMaterial as Material } from './render/MarsMaterial';
+export { MarsMaterialDataBlock as MaterialDataBlock } from './render/MarsMaterialDataBlock';
+export { MarsSharedGeometry as SharedGeometry } from './render/MarsSharedGeometry';
+export { getDefaultGPUCapability } from './render/MarsGPUCapability';
+export { getDefaultTextureFactory, setDefaultTextureFactory, MarsTextureFactory } from './render/MarsTextureFactory';
+export declare const ModuleMsg = "RI Package: @predy-js/render-interface";

package/dist/src/webgl/GLProgram.d.ts

@@ -36,7 +36,7 @@ export declare class GLProgram {
     constructor(renderer: GLGPURenderer, program: WebGLProgram, shared: boolean, id: string);
     init(renderer: GLGPURenderer, program: WebGLProgram): void;
     bind(): void;
-    getSemanticValue(state: RenderState, semanticName: string): UniformValue | import("../../types").GPUBuffer | null | undefined;
+    getSemanticValue(state: RenderState, semanticName: string): import("../../types").GPUBuffer | UniformValue | null | undefined;
     setupUniforms(state: RenderState): void;
     setGLUniformValue(name: string, value: any, info: ProgramUniformInfo, gl: WebGL2RenderingContext | WebGLRenderingContext): void;
     setupAttributes(geometry: GLGeometry): GLVertexArrayObject;

package/dist/statistic.js

@@ -2,7 +2,7 @@
  * Name: @predy-js/render-interface
  * Description: undefined
  * Author: undefined
- * Version: v0.1.68
+ * Version: v0.1.70
  */
 
 // https://github.com/greggman/webgl-memory/blob/main/src/texture-utils.js

package/dist/types/Canvas.d.ts

@@ -7,6 +7,7 @@ export interface Canvas {
 export declare class CanvasEmpty implements Canvas {
     width: number;
     height: number;
+    style: {};
     addEventListener(name: string, handler: Function): void;
     removeEventListener(name: string, handler: Function): void;
 }

package/dist/types/GPUCapability.d.ts

@@ -24,14 +24,15 @@ export interface GPUCapabilityDetail {
     readableDepthStencilTextures?: boolean;
     writableFragDepth?: boolean;
 }
+export type GPUFramework = 'webgl' | 'webgl2' | 'opengles3' | 'opengles2' | 'node-gl' | 'metal' | 'none';
 export interface GPUCapability {
-    type: 'webgl' | 'webgl2' | 'native-gl' | 'node-gl' | 'metal' | 'none';
+    type: GPUFramework;
     level: number;
     capability: Immutable<GPUCapabilityDetail>;
     setup(gl: WebGLRenderingContext): void;
 }
 export declare class GPUCapabilityEmpty implements GPUCapability {
-    type: 'webgl' | 'webgl2' | 'native-gl' | 'node-gl' | 'metal' | 'none';
+    type: GPUFramework;
     level: number;
     capability: {
         maxSample: number;

package/dist/types/Geometry.d.ts

@@ -21,6 +21,10 @@ export interface GeometryBufferLayout {
  */
 export interface AttributeBase {
     size: number;
+    /**
+     * default is float
+     */
+    type?: WebGLRenderingContext['FLOAT'] | WebGLRenderingContext['INT'] | WebGLRenderingContext['SHORT'];
     stride?: number;
     offset?: number;
     instanceDivisor?: number;
@@ -39,25 +43,14 @@ export interface AttributeBase {
 export interface AttributeWithData extends AttributeBase {
     data?: TypedArray;
     releasable?: boolean;
-    type?: WebGLRenderingContext['FLOAT'] | WebGLRenderingContext['INT'] | WebGLRenderingContext['SHORT'];
 }
 export interface AttributeWithType extends AttributeBase {
     /**
        * 如果使用interleaved attribute，此字段表示数据共享的attribute
        */
     dataSource: string;
-    type: WebGLRenderingContext['FLOAT'] | WebGLRenderingContext['INT'] | WebGLRenderingContext['SHORT'];
-}
-export interface AttributeWithDataSource extends AttributeBase {
-    /**
-       * 如果使用interleaved attribute，此字段表示数据共享的attribute
-       */
-    dataSource: string;
-    /**
-       * use FLOAT by default
-       */
-    type?: WebGLRenderingContext['FLOAT'] | WebGLRenderingContext['INT'] | WebGLRenderingContext['SHORT'];
 }
+export type AttributeWithDataSource = AttributeWithType;
 export type Attribute = AttributeWithData | AttributeWithType | AttributeWithDataSource;
 export type GeometryDrawMode = WebGLRenderingContext['POINTS'] | WebGLRenderingContext['TRIANGLES'] | WebGLRenderingContext['TRIANGLE_STRIP'] | WebGLRenderingContext['TRIANGLE_FAN'] | WebGLRenderingContext['LINES'] | WebGLRenderingContext['LINE_STRIP'] | WebGLRenderingContext['LINE_LOOP'];
 export interface GeometryOptions {

package/dist/types/Material.d.ts

@@ -126,7 +126,19 @@ export declare class MaterialDataBlock implements IGPUResource {
     constructor(options: MaterialDataBlockOptions);
     hasUniformValue(name: string): boolean;
     setUniformSemantic(name: string, semantic: string | undefined): void;
+    /**
+     * 多次调用次函数只会更新JS层的数据，不会直接更新GPU数据
+     * 在下一次渲染前，会将JS层的数据更新到GPU
+     * @param name
+     * @param value
+     */
     setUniformValue(name: string, value: UniformValue): boolean;
+    /**
+     * 在JS层维持一份uniform数据，当JS数据发生变化时，数据并不会直接反应到GPU
+     * 需要调用setUniformValue更新数据到GPU
+     * 多次调用getUniformValue返回同一个Value对象
+     * @param name
+     */
     getUniformValue(name: string): UniformValue;
     getUniformValues(): {
         [key: string]: UniformValue;
@@ -136,16 +148,6 @@ export declare class MaterialDataBlock implements IGPUResource {
     }): void;
     setUniformTexture(uniformName: string, texture: Texture | Texture[] | undefined): void;
     getUniformTexture<T extends Texture[] | Texture = Texture>(uniformName: string): T | undefined;
-    /**
-       * indicate uniform data should be resent to GPU, but not the full range,
-       * only works for ubo,if not an ubo, this method has no side effect
-       * offset and count are counted by typed entry, not the number elements
-       * entry means matrix or vector in shader
-       * @param name uniform name
-       * @param offset entry offset,first entry to send to gpu, default 0
-       * @param count entry count,entry count to send to gpu,default to end
-       */
-    updateUniformSubData(name: string, offset: number, count: number): void;
     destroy(options?: MaterialDataBlockDestroyOptions): void;
     assignRenderer(renderer: GPURenderer): MaterialDataBlock;
     clone(name: string): MaterialDataBlock;

package/dist/types/Renderer.d.ts

@@ -6,8 +6,10 @@ import type { IGPURenderer } from './IGPURenderer';
 import type { Canvas } from './Canvas';
 import type { Texture } from './Texture';
 import type { RenderPass } from './RenderPass';
+import type { RendererInternal } from './native';
 export interface RendererOptions {
     gl?: WebGLRenderingContext | WebGL2RenderingContext;
+    internal?: RendererInternal;
     canvas?: HTMLCanvasElement;
     frameworks?: Array<'webgl' | 'webgl2'>;
     willCaptureImage?: boolean;

package/dist/types/ShaderLibrary.d.ts

@@ -1,12 +1,29 @@
+import type { AttributeBase, GeometryBufferLayout } from './Geometry';
 export type Shader = ShaderWithSource | ShaderUseCacheId;
 export type ShaderWithSource = InstancedShaderWithSource | SharedShaderWithSource;
-export interface MetaShaderSpec {
+interface MetalVertexAttribute extends Omit<AttributeBase, 'instanceDivisor'> {
+    location: number;
+    stride: number;
+    offset: number;
+    dataSource: string;
+}
+export interface MetalShaderSpec {
     mtlBinary?: ArrayBuffer | string;
     mtlSource?: string;
     mtlVertex?: string;
     mtlFragment?: string;
+    /**
+     * 用于提前计算pipeline，如果没有传递，则需要在mesh被assignRenderer的时候才会计算pipeline
+     * 当mesh被添加到renderPass的时候，会根据renderPass和mesh的vertexLayout寻找对应的pipeline
+     * 如果没有找到，则需要创建，创建后会被缓存
+     * 为了避免渲染卡顿，最好在编译shader的时候就进行pipeline缓存
+     */
+    mtlVertexLayout?: {
+        bufferLayouts: GeometryBufferLayout[];
+        attributes: MetalVertexAttribute[];
+    };
 }
-export interface ShaderSourceBase extends MetaShaderSpec {
+export interface ShaderSourceBase extends MetalShaderSpec {
     fragment: string;
     vertex: string;
     name?: string;
@@ -81,3 +98,4 @@ export declare class ShaderLibraryEmpty implements ShaderLibrary {
     compileShader(shaderCacheId: string): ShaderCompileResult;
     destroy(): void;
 }
+export {};

package/dist/types/native/MetalInternal.d.ts

@@ -0,0 +1,12 @@
+import type { RenderPassAttachmentStorageType } from '../RenderPass';
+type MetalRenderPassColorFormat = WebGL2RenderingContext['RGBA8'] | WebGL2RenderingContext['RGBA16F'] | WebGL2RenderingContext['RGBA32F'] | WebGL2RenderingContext['R16F'] | WebGL2RenderingContext['R32F'];
+interface MetalRenderPassAttachmentFormat {
+    colors: MetalRenderPassColorFormat[];
+    depth: RenderPassAttachmentStorageType;
+    stencil: RenderPassAttachmentStorageType;
+    id?: string;
+}
+export interface MetalInternal {
+    addRenderPassAttachmentFormat(format: MetalRenderPassAttachmentFormat): string;
+}
+export {};

package/dist/types/native/PredyNativeInternal.d.ts

@@ -1,6 +1,26 @@
 import type { ImageBitmapCallback, ImageBitmapConstructor } from './ImageBitmapInternal';
 import type { TypedArray } from '../type';
+import type { GPUCapability } from '../GPUCapability';
+export interface PredyRequestOptions {
+    url: string;
+    disableCache?: boolean;
+    timeout?: number;
+    responseType?: 'text' | 'arraybuffer';
+}
+export declare enum PredyResourceCacheStatus {
+    noCache = 0,
+    cached = 1,
+    preloaded = 2
+}
+export interface PredyRequestResponse {
+    data: ArrayBuffer | string;
+    cacheStatus: PredyResourceCacheStatus;
+    time: number;
+}
+export type PredyRequestCallback = (err: string | undefined, res: PredyRequestResponse) => void;
 export declare abstract class PredyNativeInternal {
     abstract createImageBitmap(data: TypedArray | string, //图片文件的数据
     options: ImageBitmapConstructor, callback: ImageBitmapCallback): void;
+    abstract getDefaultGPUCapability(): GPUCapability;
+    abstract requestWithCache(options: PredyRequestOptions, callback: PredyRequestCallback): void;
 }

package/dist/types/native/RendererInternal.d.ts

@@ -12,6 +12,7 @@ import type { TextureInternal, TextureInternalConstructOptions } from './Texture
 import type { ImageBitmapCallback, ImageBitmapConstructor } from './ImageBitmapInternal';
 import type { AndGLContext } from './AndGLContext';
 import type { TypedArray } from '../type';
+import type { MetalInternal } from './MetalInternal';
 /**
  * renderer 内部创建的对象，用来统计信息，排查资源泄漏的问题
  */
@@ -41,6 +42,10 @@ export declare abstract class RendererInternal implements ResourceInternal {
      * 用于Android的GL上下文, 用于测试， 不会在RI中使用
      */
     readonly gl?: AndGLContext;
+    /**
+     * metal相关设置
+     */
+    readonly metal?: MetalInternal;
     abstract destroy(): void;
     /**
        * 需要进行重新渲染

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@predy-js/render-interface",
-  "version": "0.1.68",
+  "version": "0.1.70",
   "license": "MIT",
   "module": "./dist/index.mjs",
   "main": "./dist/index.js",

package/types/Canvas.ts

@@ -1,7 +1,6 @@
 export interface Canvas {
   width: number,
   height: number,
-
   addEventListener(name: string, handler: Function): void,
 
   removeEventListener(name: string, handler: Function): void,
@@ -11,7 +10,7 @@ export interface Canvas {
 export class CanvasEmpty implements Canvas {
   width = 0;
   height = 0;
-
+  style = {};
   addEventListener (name: string, handler: Function) {
   }
 

package/types/GPUCapability.ts

@@ -1,5 +1,4 @@
 import type { Immutable } from './type';
-
 export const COMPRESSED_TEXTURE_NONE = 0;
 export const COMPRESSED_TEXTURE_PVRTC = 1;
 export const COMPRESSED_TEXTURE_ASTC = 2;
@@ -32,8 +31,10 @@ export interface GPUCapabilityDetail {
   writableFragDepth?: boolean,
 }
 
+export type GPUFramework = 'webgl' | 'webgl2' | 'opengles3' | 'opengles2' | 'node-gl' | 'metal' | 'none';
+
 export interface GPUCapability {
-  type: 'webgl' | 'webgl2' | 'native-gl' | 'node-gl' | 'metal' | 'none',
+  type: GPUFramework,
   level: number,
   capability: Immutable<GPUCapabilityDetail>,
 
@@ -41,7 +42,7 @@ export interface GPUCapability {
 }
 
 export class GPUCapabilityEmpty implements GPUCapability {
-  type: 'webgl' | 'webgl2' | 'native-gl' | 'node-gl' | 'metal' | 'none';
+  type: GPUFramework;
   level = 0;
   capability = {
     maxSample: 0,

package/types/Geometry.ts

@@ -25,6 +25,11 @@ export interface AttributeBase {
 
   size: number,
 
+  /**
+   * default is float
+   */
+  type?: WebGLRenderingContext['FLOAT'] | WebGLRenderingContext['INT'] | WebGLRenderingContext['SHORT'],
+
   stride?: number,
 
   offset?: number,
@@ -48,7 +53,6 @@ export interface AttributeBase {
 export interface AttributeWithData extends AttributeBase {
   data?: TypedArray,
   releasable?: boolean,
-  type?: WebGLRenderingContext['FLOAT'] | WebGLRenderingContext['INT'] | WebGLRenderingContext['SHORT'],
 }
 
 export interface AttributeWithType extends AttributeBase {
@@ -56,19 +60,9 @@ export interface AttributeWithType extends AttributeBase {
      * 如果使用interleaved attribute，此字段表示数据共享的attribute
      */
   dataSource: string,
-  type: WebGLRenderingContext['FLOAT'] | WebGLRenderingContext['INT'] | WebGLRenderingContext['SHORT'],
 }
 
-export interface AttributeWithDataSource extends AttributeBase {
-  /**
-     * 如果使用interleaved attribute，此字段表示数据共享的attribute
-     */
-  dataSource: string,
-  /**
-     * use FLOAT by default
-     */
-  type?: WebGLRenderingContext['FLOAT'] | WebGLRenderingContext['INT'] | WebGLRenderingContext['SHORT'],
-}
+export type AttributeWithDataSource = AttributeWithType;
 
 export type Attribute = AttributeWithData | AttributeWithType | AttributeWithDataSource;
 

package/types/Material.ts

@@ -165,8 +165,19 @@ export declare class MaterialDataBlock implements IGPUResource {
 
   setUniformSemantic (name: string, semantic: string | undefined): void;
 
+  /**
+   * 多次调用次函数只会更新JS层的数据，不会直接更新GPU数据
+   * 在下一次渲染前，会将JS层的数据更新到GPU
+   * @param name
+   * @param value
+   */
   setUniformValue (name: string, value: UniformValue): boolean;
-
+  /**
+   * 在JS层维持一份uniform数据，当JS数据发生变化时，数据并不会直接反应到GPU
+   * 需要调用setUniformValue更新数据到GPU
+   * 多次调用getUniformValue返回同一个Value对象
+   * @param name
+   */
   getUniformValue (name: string): UniformValue;
 
   getUniformValues (): { [key: string]: UniformValue };
@@ -177,16 +188,8 @@ export declare class MaterialDataBlock implements IGPUResource {
 
   getUniformTexture<T extends Texture[] | Texture = Texture>(uniformName: string): T | undefined;
 
-  /**
-     * indicate uniform data should be resent to GPU, but not the full range,
-     * only works for ubo,if not an ubo, this method has no side effect
-     * offset and count are counted by typed entry, not the number elements
-     * entry means matrix or vector in shader
-     * @param name uniform name
-     * @param offset entry offset,first entry to send to gpu, default 0
-     * @param count entry count,entry count to send to gpu,default to end
-     */
-  updateUniformSubData (name: string, offset: number, count: number): void;
+  //todo
+  // setUniformSubValue (name: string, value: TypedArray, byteOffset: number): void;
 
   destroy (options?: MaterialDataBlockDestroyOptions): void;
 

package/types/Renderer.ts

@@ -6,9 +6,11 @@ import type { IGPURenderer } from './IGPURenderer';
 import type { Canvas } from './Canvas';
 import type { Texture } from './Texture';
 import type { RenderPass } from './RenderPass';
+import type { RendererInternal } from './native';
 
 export interface RendererOptions {
   gl?: WebGLRenderingContext | WebGL2RenderingContext,
+  internal?: RendererInternal,
   canvas?: HTMLCanvasElement,
   // if use frameworks [ 'webgl2', 'webgl' ], renderer will choose webgl if webgl2 is not supported
   frameworks?: Array<'webgl' | 'webgl2'>,

package/types/ShaderLibrary.ts

@@ -1,15 +1,33 @@
+import type { AttributeBase, GeometryBufferLayout } from './Geometry';
+
 export type Shader = ShaderWithSource | ShaderUseCacheId;
 export type ShaderWithSource = InstancedShaderWithSource | SharedShaderWithSource;
 
-export interface MetaShaderSpec {
+interface MetalVertexAttribute extends Omit<AttributeBase, 'instanceDivisor'> {
+  location: number,
+  stride: number,
+  offset: number,
+  dataSource: string,
+}
+export interface MetalShaderSpec {
   mtlBinary?: ArrayBuffer | string,
   mtlSource?: string,
-
   mtlVertex?: string,
   mtlFragment?: string,
+  //todo lilong
+  /**
+   * 用于提前计算pipeline，如果没有传递，则需要在mesh被assignRenderer的时候才会计算pipeline
+   * 当mesh被添加到renderPass的时候，会根据renderPass和mesh的vertexLayout寻找对应的pipeline
+   * 如果没有找到，则需要创建，创建后会被缓存
+   * 为了避免渲染卡顿，最好在编译shader的时候就进行pipeline缓存
+   */
+  mtlVertexLayout?: {
+    bufferLayouts: GeometryBufferLayout[],
+    attributes: MetalVertexAttribute[],
+  },
 }
 
-export interface ShaderSourceBase extends MetaShaderSpec {
+export interface ShaderSourceBase extends MetalShaderSpec {
   fragment: string,
   vertex: string,
   name?: string,

package/types/native/MetalInternal.ts

@@ -0,0 +1,22 @@
+import type { RenderPassAttachmentStorageType } from '../RenderPass';
+
+type MetalRenderPassColorFormat = WebGL2RenderingContext['RGBA8'] |
+WebGL2RenderingContext['RGBA16F'] |
+WebGL2RenderingContext['RGBA32F'] |
+WebGL2RenderingContext['R16F'] |
+WebGL2RenderingContext['R32F'];
+interface MetalRenderPassAttachmentFormat {
+  colors: MetalRenderPassColorFormat[],
+  depth: RenderPassAttachmentStorageType,
+  stencil: RenderPassAttachmentStorageType,
+  id?: string,
+}
+export interface MetalInternal {
+  //通过RenderPass(RP) attachment具体数据算出id，并且返回
+  //添加后，此attachment会在shader编译阶段提前创建出pipeline
+  //对于添加到RP的Mesh，寻找此RP对应的pipeline，如果没有则创建
+  //RP销毁时，不会销毁对应的pipeline，需要调用shaderLib删除shader的时候才会销毁
+  //renderer启动时，会自动创建一个RPFormat，数据源于直接绘制到view的RP
+  addRenderPassAttachmentFormat(format: MetalRenderPassAttachmentFormat): string,
+
+}

package/types/native/PredyNativeInternal.ts

@@ -1,7 +1,35 @@
 import type { ImageBitmapCallback, ImageBitmapConstructor } from './ImageBitmapInternal';
 import type { TypedArray } from '../type';
+import type { GPUCapability } from '../GPUCapability';
+
+export interface PredyRequestOptions {
+  url: string,
+  //用于测试缓存，生产中不要使用
+  disableCache?: boolean,
+  //默认5S
+  timeout?: number,
+
+  responseType?: 'text' | 'arraybuffer',
+}
+export enum PredyResourceCacheStatus {
+  noCache = 0, // 没有缓存，走网络请求
+  cached = 1, // 命中缓存，如果请求同一个url，在关闭APP之前，一定会命中缓存，关闭APP后，清理时间由系统决定
+  preloaded = 2, // 命中预推
+}
+
+export interface PredyRequestResponse {
+  data: ArrayBuffer | string,
+  cacheStatus: PredyResourceCacheStatus,
+  time: number,
+}
+
+export type PredyRequestCallback = (err: string | undefined, res: PredyRequestResponse) => void;
 
 export declare abstract class PredyNativeInternal {
   abstract createImageBitmap (data: TypedArray | string, //图片文件的数据
     options: ImageBitmapConstructor, callback: ImageBitmapCallback): void;
+
+  abstract getDefaultGPUCapability (): GPUCapability;
+
+  abstract requestWithCache (options: PredyRequestOptions, callback: PredyRequestCallback): void;
 }

package/types/native/RendererInternal.ts

@@ -12,6 +12,7 @@ import type { TextureInternal, TextureInternalConstructOptions } from './Texture
 import type { ImageBitmapCallback, ImageBitmapConstructor } from './ImageBitmapInternal';
 import type { AndGLContext } from './AndGLContext';
 import type { TypedArray } from '../type';
+import type { MetalInternal } from './MetalInternal';
 
 /**
  * renderer 内部创建的对象，用来统计信息，排查资源泄漏的问题
@@ -48,6 +49,12 @@ export abstract class RendererInternal implements ResourceInternal {
    */
   readonly gl?: AndGLContext;
 
+  //todo lilong
+  /**
+   * metal相关设置
+   */
+  readonly metal?: MetalInternal;
+
   abstract destroy (): void;
 
   /**