@predy-js/render-interface 0.1.61-beta.8 → 0.1.61

package/dist/src/render/MarsGeometry.d.ts

@@ -26,7 +26,7 @@ export declare class MarsGeometry implements Geometry {
     _dirtyFlags: {
         [key: string]: BufferDirtyFlag;
     };
-    _index?: Uint8Array | Uint16Array | Uint32Array;
+    _index?: Uint16Array | Uint32Array;
     _indexReleasable: boolean;
     readonly internal: GLGeometry;
     readonly options?: GeometryOptions;
@@ -35,6 +35,7 @@ export declare class MarsGeometry implements Geometry {
     protected _drawStart: number;
     protected _mode: number;
     protected _isDestroyed: boolean;
+    indexDataType: Geometry['indexDataType'];
     get isDestroyed(): boolean;
     get mode(): number;
     set mode(n: number);
@@ -52,8 +53,8 @@ export declare class MarsGeometry implements Geometry {
     setAttributeData(name: string, data: TypedArray): void;
     getAttributeData(name: string): TypedArray | undefined;
     setAttributeSubData(name: string, offset: number, data: TypedArray): void;
-    getIndexData(): Uint8Array | Uint16Array | Uint32Array | undefined;
-    setIndexData(data: Uint8Array | Uint16Array | Uint32Array | undefined): void;
+    getIndexData(): Uint16Array | Uint32Array | undefined;
+    setIndexData(data: Uint16Array | Uint32Array | undefined): void;
     setIndexSubData(offset: number, data: TypedArray): void;
     getAttributeStride(name: string): number;
     getAttributeDataLength(name: string): number;

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

@@ -3,18 +3,15 @@ import type { GLGPURenderer } from './GLGPURenderer';
 import type { TypedArray } from '../../types/type';
 import type { MarsRenderer } from '../render/MarsRenderer';
 export declare class GLGPUBuffer implements GPUBuffer {
-    readonly bytesPerElement: number;
-    readonly target: GPUBufferTarget;
-    readonly type: WebGLRenderingContext['FLOAT'] | WebGLRenderingContext['INT'] | WebGLRenderingContext['SHORT'];
     readonly usage: WebGLRenderingContext['STATIC_DRAW'] | WebGLRenderingContext['DYNAMIC_DRAW'] | WebGLRenderingContext['STREAM_DRAW'];
     readonly renderer?: GLGPURenderer;
     readonly glBuffer: WebGLBuffer | null;
+    readonly target: GPUBufferTarget;
     private _byteLength;
     private _isDestroyed;
     readonly name: string;
     get byteLength(): number;
     get isBuffer(): boolean;
-    get elementCount(): number;
     get level(): number;
     get isDestroyed(): boolean;
     constructor(options: GPUBufferOptions, renderer: GLGPURenderer);
@@ -23,5 +20,6 @@ export declare class GLGPUBuffer implements GPUBuffer {
     bufferSubData(elementOffset: number, typedArray: TypedArray): void;
     destroy(): void;
     readSubData(elementOffset: number, typedArray: TypedArray): boolean;
+    getElementCount(bytePerElement: number): number;
     assignRenderer(renderer: MarsRenderer): GLGPUBuffer;
 }

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

@@ -26,6 +26,8 @@ export declare class GLGPURenderer implements GPURenderer {
     private _isDestroyed;
     extension: RendererExtensions;
     constructor(gl: WebGLRenderingContext | WebGL2RenderingContext);
+    requestAnimationFrame(cb: FrameRequestCallback): number;
+    cancelAnimationFrame(id: number): void;
     get isDestroyed(): boolean;
     onContextLose: (e: Event) => void;
     copy2(source: GLTexture, target: GLTexture): void;

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

@@ -7,6 +7,9 @@ import type { GLVertexArrayObject } from './GLVertexArrayObject';
 export declare const INDEX_TYPE_MAP: {
     [x: number]: number;
 };
+export declare const TYPE_BYTE_MAP: {
+    [x: number]: number;
+};
 export type GLGeometryOptions = {
     drawStart: number;
     drawCount: number;
@@ -31,6 +34,7 @@ export declare class GLGeometry {
     drawStart: number;
     drawCount: number;
     mode: GLenum;
+    indexBufferType: GLenum;
     attributes: {
         [key: string]: AttributeWithType;
     };
@@ -42,8 +46,8 @@ export declare class GLGeometry {
     constructor(option: GLGeometryOptions | GLGeometry, renderer: GLGPURenderer);
     createVao(name: string): GLVertexArrayObject;
     destroyVao(name: string): void;
-    setIndexBuffer(buffer: GLGPUBuffer): void;
-    createIndexBuffer(data: Uint16Array | Uint32Array | Uint8Array, renderer: GLGPURenderer): GLGPUBuffer;
+    setIndexBuffer(buffer: GLGPUBuffer, indexBufferType: GLenum): void;
+    createIndexBuffer(data: Uint16Array | Uint32Array | Uint8Array, renderer: GLGPURenderer): [buffer: GLGPUBuffer, type: GLenum];
     getGPUBuffer(name: string | number): GLGPUBuffer | null;
     destroy(): void;
     setAttributeBuffer(name: string, buffer: GPUBuffer): void;

package/dist/statistic.js

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

package/dist/types/GPUBuffer.d.ts

@@ -1,17 +1,22 @@
 import type { TypedArray } from './type';
 import type { IGPUResource, IGPURenderer } from './IGPURenderer';
 import type { GPURenderer } from './Renderer';
+export declare const GPUBufferOptionsMemoryShared: number;
 export type GPUBufferTarget = WebGLRenderingContext['ARRAY_BUFFER'] | WebGLRenderingContext['ELEMENT_ARRAY_BUFFER'] | WebGL2RenderingContext['COPY_READ_BUFFER'] | WebGL2RenderingContext['COPY_WRITE_BUFFER'] | WebGL2RenderingContext['TRANSFORM_FEEDBACK_BUFFER'] | WebGL2RenderingContext['UNIFORM_BUFFER'] | WebGL2RenderingContext['PIXEL_PACK_BUFFER'] | WebGL2RenderingContext['PIXEL_UNPACK_BUFFER'];
-type GPUBufferType = WebGLRenderingContext['FLOAT'] | WebGLRenderingContext['INT'] | WebGLRenderingContext['SHORT'];
 export interface GPUBufferOptions {
     name?: string;
-    target?: GPUBufferTarget;
-    type?: GPUBufferType;
     /**
-     * 数据元素的总量
+     * 数据长度，如果提供了data，忽略此参数
      */
-    elementCount?: number;
+    byteLength?: number;
     data?: TypedArray;
+    /**
+     * GL需要设置，Vulkan和Metal此属性忽略
+     */
+    target?: GPUBufferTarget;
+    /**
+     * GL需要设置，Vulkan和Metal此属性忽略
+     */
     usage?: WebGLRenderingContext['STATIC_DRAW'] | WebGLRenderingContext['DYNAMIC_DRAW'];
 }
 /**
@@ -23,16 +28,11 @@ export declare class GPUBuffer implements IGPUResource {
     readonly renderer?: IGPURenderer;
     readonly isDestroyed: boolean;
     readonly level: number;
-    readonly target: GPUBufferTarget;
-    readonly type: GPUBufferOptions['type'];
     readonly byteLength: number;
-    readonly bytesPerElement: number;
-    destroy(): void;
+    readonly target: GPUBufferTarget;
+    readonly usage?: WebGLRenderingContext['STATIC_DRAW'] | WebGLRenderingContext['DYNAMIC_DRAW'];
     constructor(options: GPUBufferOptions, renderer?: IGPURenderer);
-    /**
-     * 数据元素的总量
-     */
-    readonly elementCount: number;
+    getElementCount(bytePerElement: number): number;
     /**
      * 根据TypedArray容量，重新分配Buffer内存
      * @param typedArray
@@ -52,5 +52,5 @@ export declare class GPUBuffer implements IGPUResource {
      */
     readSubData(elementOffset: number, typedArray: TypedArray, elementCount?: number): boolean;
     assignRenderer(renderer: GPURenderer): GPUBuffer;
+    destroy(): void;
 }
-export {};

package/dist/types/Geometry.d.ts

@@ -62,7 +62,7 @@ export interface GeometryOptions {
         [key: string]: Attribute;
     };
     index?: {
-        data: Uint8Array | Uint16Array | Uint32Array;
+        data: GeometryIndexData;
         releasable?: boolean;
     };
     mode?: GeometryDrawMode;
@@ -70,6 +70,10 @@ export interface GeometryOptions {
     drawStart?: number;
     bufferUsage?: GLenum;
 }
+/**
+ * 不兼容Uint8的Index，只能使用Uin16和Uin32
+ */
+export type GeometryIndexData = Uint16Array | Uint32Array;
 export declare class Geometry implements IGPUResource {
     readonly renderer?: IGPURenderer;
     /**
@@ -80,6 +84,7 @@ export declare class Geometry implements IGPUResource {
     }>;
     readonly isDestroyed: boolean;
     readonly options?: Immutable<GeometryOptions>;
+    indexDataType?: WebGLRenderingContext['UNSIGNED_INT'] | WebGLRenderingContext['UNSIGNED_SHORT'];
     drawStart: number;
     drawCount: number;
     mode: number;
@@ -96,8 +101,8 @@ export declare class Geometry implements IGPUResource {
     setAttributeData(name: string, data: TypedArray): void;
     getAttributeData(name: string): TypedArray | undefined;
     setAttributeSubData(name: string, offset: number, data: TypedArray): void;
-    getIndexData(): Uint8Array | Uint16Array | Uint32Array | undefined;
-    setIndexData(data: Uint8Array | Uint16Array | Uint32Array | undefined): void;
+    getIndexData(): GeometryIndexData | undefined;
+    setIndexData(data: GeometryIndexData | undefined): void;
     setIndexSubData(offset: number, data: TypedArray): void;
     /**
        * 获取Attribute的数据内存长度
@@ -119,7 +124,7 @@ export interface SharedGeometryOptions {
     drawCount?: number;
     mode?: number;
     index?: {
-        data: Uint8Array | Uint16Array | Uint32Array;
+        data: GeometryIndexData;
         releasable?: boolean;
     };
     geometry: Geometry;

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

@@ -1,5 +1,6 @@
 import type { ResourceInternal } from './ResourceInternal';
 import type { TypedArray } from '../type';
+import type { TextureInternal } from './TextureInternal';
 export interface DataBlockInternalOptions {
     name: string;
 }
@@ -26,4 +27,6 @@ export declare abstract class DataBlockInternal implements ResourceInternal {
      * @param value
      */
     abstract getUniformValue(name: string, value: TypedArray): boolean;
+    abstract setUniformTextures(uniformName: string, texture: TextureInternal[] | undefined): void;
+    abstract getUniformTextures(uniformName: string): TextureInternal[] | undefined;
 }

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

@@ -1,6 +1,6 @@
 import type { ResourceInternal } from './ResourceInternal';
 import type { TypedArray } from '../type';
-export declare const GPUBufferOptionsMemoryShared: number;
+import type { GPUBufferOptionsMemoryShared } from '../GPUBuffer';
 export interface GPUBufferInternalOptions {
     data?: TypedArray;
     options?: typeof GPUBufferOptionsMemoryShared;

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

@@ -1,7 +1,6 @@
 import type { ResourceInternal } from './ResourceInternal';
 import type { MaterialRenderStates } from '../Material';
 import type { DataBlockInternal } from './DataBlockInternal';
-import type { TextureInternal } from './TextureInternal';
 export interface MaterialInternalOptions {
     states: MaterialRenderStates;
     dataBlocks: DataBlockInternal[];
@@ -15,12 +14,4 @@ export declare abstract class MaterialInternal implements ResourceInternal {
     dataBlocks: DataBlockInternal[];
     protected constructor(options: MaterialInternalOptions);
     abstract destroy(): void;
-    /**
-     * 对于 uniform sampler2D uTex
-     * 和 uniform sampler2D uTextures[4] 都使用此函数
-     * @param name
-     * @param value
-     */
-    abstract setUniformTextures(name: string, value: TextureInternal[]): void;
-    abstract getUniformTextures(name: string): TextureInternal[];
 }

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

@@ -16,6 +16,10 @@ export declare abstract class RenderFrameInternal implements ResourceInternal {
     renderPasses: RenderPassInternal[];
     protected constructor(options: RenderFrameInternalOptions);
     abstract destroy(): void;
+    /**
+     * 代表此帧会在渲染队列的下一帧被渲染，调用此函数，也会调用renderer.invalid方法
+     * 由于渲染是异步的，此函数在Metal/Vulkan实现中，并不会直接绘制
+     */
     abstract render(): void;
     abstract updateLoadAction(action: RenderPassLoadAction): void;
 }

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

@@ -4,6 +4,7 @@ import type { TypedArray } from '../type';
 import type { ImageBitmapInternal } from './ImageBitmapInternal';
 export interface TextureInternalOptions extends TextureFormatOptions, Omit<TextureConfigOptionsBase, 'keepImageSource'> {
     target: WebGLRenderingContext['TEXTURE_CUBE_MAP'] | WebGLRenderingContext['TEXTURE_2D'];
+    generateMipmap?: boolean;
 }
 export interface TextureInternalConstructOptions extends TextureInternalOptions {
     width: number;

package/package.json

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

package/types/GPUBuffer.ts

@@ -1,7 +1,7 @@
 import type { TypedArray } from './type';
 import type { IGPUResource, IGPURenderer } from './IGPURenderer';
 import type { GPURenderer } from './Renderer';
-
+export const GPUBufferOptionsMemoryShared = 1 << 1;
 export type GPUBufferTarget =
   | WebGLRenderingContext['ARRAY_BUFFER']
   | WebGLRenderingContext['ELEMENT_ARRAY_BUFFER']
@@ -12,20 +12,23 @@ export type GPUBufferTarget =
   | WebGL2RenderingContext['PIXEL_PACK_BUFFER']
   | WebGL2RenderingContext['PIXEL_UNPACK_BUFFER'];
 
-type GPUBufferType = WebGLRenderingContext['FLOAT'] | WebGLRenderingContext['INT'] | WebGLRenderingContext['SHORT'];
 export interface GPUBufferOptions {
   name?: string,
-
-  target?: GPUBufferTarget,
-
-  type?: GPUBufferType,
   /**
-   * 数据元素的总量
+   * 数据长度，如果提供了data，忽略此参数
    */
-  elementCount?: number,
+  byteLength?: number,
 
   data?: TypedArray,
 
+  /**
+   * GL需要设置，Vulkan和Metal此属性忽略
+   */
+  target?: GPUBufferTarget,
+
+  /**
+   * GL需要设置，Vulkan和Metal此属性忽略
+   */
   usage?: WebGLRenderingContext['STATIC_DRAW'] | WebGLRenderingContext['DYNAMIC_DRAW'],
 }
 
@@ -41,23 +44,15 @@ export declare class GPUBuffer implements IGPUResource {
 
   readonly level: number;
 
-  readonly target: GPUBufferTarget;
-
-  readonly type: GPUBufferOptions['type'];
-
   readonly byteLength: number;
 
-  readonly bytesPerElement: number;
+  readonly target: GPUBufferTarget;
 
-  destroy (): void;
+  readonly usage?: WebGLRenderingContext['STATIC_DRAW'] | WebGLRenderingContext['DYNAMIC_DRAW'];
 
   constructor (options: GPUBufferOptions, renderer?: IGPURenderer);
 
-  /**
-   * 数据元素的总量
-   */
-  readonly elementCount: number;
-
+  getElementCount (bytePerElement: number): number;
   /**
    * 根据TypedArray容量，重新分配Buffer内存
    * @param typedArray
@@ -81,5 +76,7 @@ export declare class GPUBuffer implements IGPUResource {
   readSubData (elementOffset: number, typedArray: TypedArray, elementCount?: number): boolean;
 
   assignRenderer (renderer: GPURenderer): GPUBuffer;
+
+  destroy (): void;
 }
 

package/types/Geometry.ts

@@ -81,7 +81,7 @@ export interface GeometryOptions {
 
   attributes: { [key: string]: Attribute },
 
-  index?: { data: Uint8Array | Uint16Array | Uint32Array, releasable?: boolean },
+  index?: { data: GeometryIndexData, releasable?: boolean },
 
   mode?: GeometryDrawMode,
 
@@ -92,6 +92,11 @@ export interface GeometryOptions {
   bufferUsage?: GLenum,
 }
 
+/**
+ * 不兼容Uint8的Index，只能使用Uin16和Uin32
+ */
+export type GeometryIndexData = Uint16Array | Uint32Array;
+
 export declare class Geometry implements IGPUResource {
 
   readonly renderer?: IGPURenderer;
@@ -105,6 +110,8 @@ export declare class Geometry implements IGPUResource {
 
   readonly options?: Immutable<GeometryOptions>;
 
+  indexDataType?: WebGLRenderingContext['UNSIGNED_INT'] | WebGLRenderingContext['UNSIGNED_SHORT'];
+
   drawStart: number;
 
   drawCount: number;
@@ -133,9 +140,9 @@ export declare class Geometry implements IGPUResource {
 
   setAttributeSubData (name: string, offset: number, data: TypedArray): void;
 
-  getIndexData (): Uint8Array | Uint16Array | Uint32Array | undefined;
+  getIndexData (): GeometryIndexData | undefined;
 
-  setIndexData (data: Uint8Array | Uint16Array | Uint32Array | undefined): void;
+  setIndexData (data: GeometryIndexData | undefined,): void;
 
   setIndexSubData (offset: number, data: TypedArray): void;
 
@@ -167,7 +174,7 @@ export interface SharedGeometryOptions {
 
   mode?: number,
 
-  index?: { data: Uint8Array | Uint16Array | Uint32Array, releasable?: boolean },
+  index?: { data: GeometryIndexData, releasable?: boolean },
 
   geometry: Geometry,
 }

package/types/native/DataBlockInternal.ts

@@ -1,5 +1,6 @@
 import type { ResourceInternal } from './ResourceInternal';
 import type { TypedArray } from '../type';
+import type { TextureInternal } from './TextureInternal';
 
 export interface DataBlockInternalOptions {
   name: string,
@@ -32,4 +33,8 @@ export abstract class DataBlockInternal implements ResourceInternal {
    */
   abstract getUniformValue (name: string, value: TypedArray): boolean;
 
+  abstract setUniformTextures (uniformName: string, texture: TextureInternal[] | undefined): void;
+
+  abstract getUniformTextures (uniformName: string): TextureInternal[] | undefined;
+
 }

package/types/native/GPUBufferInternal.ts

@@ -1,7 +1,6 @@
 import type { ResourceInternal } from './ResourceInternal';
 import type { TypedArray } from '../type';
-
-export const GPUBufferOptionsMemoryShared = 1 << 1;
+import type { GPUBufferOptionsMemoryShared } from '../GPUBuffer';
 
 export interface GPUBufferInternalOptions {
   data?: TypedArray,

package/types/native/MaterialInternal.ts

@@ -1,7 +1,6 @@
 import type { ResourceInternal } from './ResourceInternal';
 import type { MaterialRenderStates } from '../Material';
 import type { DataBlockInternal } from './DataBlockInternal';
-import type { TextureInternal } from './TextureInternal';
 export interface MaterialInternalOptions {
   states: MaterialRenderStates,
   dataBlocks: DataBlockInternal[],
@@ -18,14 +17,4 @@ export abstract class MaterialInternal implements ResourceInternal {
   protected constructor (options: MaterialInternalOptions) {
   }
   abstract destroy (): void;
-
-  /**
-   * 对于 uniform sampler2D uTex
-   * 和 uniform sampler2D uTextures[4] 都使用此函数
-   * @param name
-   * @param value
-   */
-  abstract setUniformTextures (name: string, value: TextureInternal[]): void;
-
-  abstract getUniformTextures (name: string): TextureInternal[];
 }

package/types/native/RenderFrameInternal.ts

@@ -20,6 +20,10 @@ export abstract class RenderFrameInternal implements ResourceInternal {
   }
   abstract destroy (): void;
 
+  /**
+   * 代表此帧会在渲染队列的下一帧被渲染，调用此函数，也会调用renderer.invalid方法
+   * 由于渲染是异步的，此函数在Metal/Vulkan实现中，并不会直接绘制
+   */
   abstract render (): void;
 
   abstract updateLoadAction (action: RenderPassLoadAction): void;

package/types/native/TextureInternal.ts

@@ -5,6 +5,7 @@ import type { ImageBitmapInternal } from './ImageBitmapInternal';
 
 export interface TextureInternalOptions extends TextureFormatOptions, Omit<TextureConfigOptionsBase, 'keepImageSource'> {
   target: WebGLRenderingContext['TEXTURE_CUBE_MAP'] | WebGLRenderingContext['TEXTURE_2D'],
+  generateMipmap?: boolean,
 }
 
 export interface TextureInternalConstructOptions extends TextureInternalOptions {