@predy-js/render-interface 0.1.61-beta.2 → 0.1.61-beta.22

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/Material.ts

@@ -1,18 +1,18 @@
-import type { Texture } from './Texture';
 import type { ShaderUseCacheId, ShaderWithSource } from './ShaderLibrary';
 import type { IGPUResource, IGPURenderer } from './IGPURenderer';
 import type { Immutable, TypedArray } from './type';
 import type { GPURenderer } from './Renderer';
 import type { DestroyOptions } from './constants';
+import type { Texture } from './Texture';
 
 export type UniformSemantic =
-  | 'VIEW'
-  | 'MODEL'
-  | 'MODELVIEW'
-  | 'PROJECTION'
-  | 'VIEWPROJECTION'
-  | 'MODELVIEWPROJECTION'
-  | string;
+    | 'VIEW'
+    | 'MODEL'
+    | 'MODELVIEW'
+    | 'PROJECTION'
+    | 'VIEWPROJECTION'
+    | 'MODELVIEWPROJECTION'
+    | string;
 
 export interface MaterialRenderStates {
   sampleAlphaToCoverage?: boolean,
@@ -24,13 +24,13 @@ export interface MaterialRenderStates {
   blendSrc?: number,
   blendDst?: number,
   /**
-   * The blend color is a state value,
-   * like the blend equations and blend parameters. Therefore,
-   * it cannot change within a single draw call;
-   * fragment shaders cannot write to, modify,
-   * or even access the blend color.
-   * All buffers share the same blend color.
-   */
+     * The blend color is a state value,
+     * like the blend equations and blend parameters. Therefore,
+     * it cannot change within a single draw call;
+     * fragment shaders cannot write to, modify,
+     * or even access the blend color.
+     * All buffers share the same blend color.
+     */
   blendColor?: [r: number, g: number, b: number, a: number],
   colorMask?: [r: boolean, g: boolean, b: boolean, a: boolean],
   depthTest?: boolean,
@@ -63,8 +63,6 @@ export interface MaterialOptions {
   shader: ShaderWithSource | ShaderUseCacheId,
   name?: string,
   dataBlocks?: MaterialDataBlockOptions[],
-  uniformSemantics?: { [key: string]: UniformSemantic },
-  uniformValues?: { [key: string]: UniformValue },
 }
 
 //使用shader即时编译,此参数会调用 shaderLibrary.addShader() 为 Material提供shaderCacheId属性值，
@@ -97,12 +95,12 @@ export interface MaterialOptions {
  * });
  * mtl2 use the same program with mtl0
  */
-export type UniformValueDataType = TypedArray | number | number[] | Texture | Texture[] | number[][];
+export type UniformValueDataType = TypedArray | number | number[] | number[][];
 // 支持结构体Uniform数据
 export type UniformValue =
-  UniformValueDataType
-  | UniformStruct
-  | UniformStruct[];
+    UniformValueDataType
+    | UniformStruct
+    | UniformStruct[];
 
 export type UniformStruct = { [key: string]: UniformValueDataType };
 
@@ -137,14 +135,14 @@ export declare class Material implements IGPUResource {
 
   destroy (options?: MaterialDestroyOptions): void;
 
-  setUniformSemantic (uniformName: string, semantic: string | undefined): void;
-
   assignRenderer (renderer: GPURenderer): Material;
 }
 
 export interface MaterialDataBlockOptions {
   uniformValues?: { [key: string]: UniformValue },
+  uniformTextures?: Record<string, Texture | Texture[]>,
   name?: string,
+  uniformSemantics?: { [key: string]: UniformSemantic },
 }
 
 export interface MaterialDataBlockDestroyOptions {
@@ -159,10 +157,14 @@ export declare class MaterialDataBlock implements IGPUResource {
 
   readonly name: string;
 
+  readonly uniformSemantics?: { [key: string]: UniformSemantic };
+
   constructor (options: MaterialDataBlockOptions);
 
   hasUniformValue (name: string): boolean;
 
+  setUniformSemantic (name: string, semantic: string | undefined): void;
+
   setUniformValue (name: string, value: UniformValue): boolean;
 
   getUniformValue (name: string): UniformValue;
@@ -171,15 +173,19 @@ export declare class MaterialDataBlock implements IGPUResource {
 
   setUniformValues (map: { [key: string]: UniformValue }): 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
-   */
+     * 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;

package/types/RenderFrame.ts

@@ -1,11 +1,9 @@
-import type { UniformValue } from './Material';
 import type {
   RenderPass,
   RenderPassLoadAction,
-  RenderPassDestroyOptions, SemanticMap,
+  RenderPassDestroyOptions, SemanticMap, SemanticGetter,
 } from './RenderPass';
 import type { Mesh } from './Mesh';
-import type { GPUBuffer } from './GPUBuffer';
 import type { vec4 } from './type';
 import type { GPURenderer } from './index';
 import type { IGPURenderer, IGPUResource } from './IGPURenderer';
@@ -21,12 +19,12 @@ export interface RenderState {
 export interface RenderFrameOptions {
   renderPasses?: RenderPass[],
   viewport?: vec4,
-  semantics?: { [key: string]: UniformValue | SemanticFunc | GPUBuffer },
+  semantics?: { [key: string]: SemanticGetter },
   loadAction?: RenderPassLoadAction,
   name?: string,
 }
 
-export type SemanticFunc = (state: RenderState) => UniformValue | GPUBuffer | null | undefined;
+export type SemanticFunc = (state: RenderState) => SemanticGetter | null | undefined;
 
 export type RenderFrameDestroyOptions = {
   passes?: RenderPassDestroyOptions | DestroyOptions.keep,

package/types/RenderPass.ts

@@ -117,7 +117,7 @@ export interface RenderPassAttachmentOptions {
   multiSample?: number,
 }
 
-export type SemanticGetter = UniformValue | SemanticFunc | GPUBuffer;
+export type SemanticGetter = UniformValue | SemanticFunc | GPUBuffer | Texture | Texture[];
 
 export interface RenderPassOptions extends RenderPassAttachmentOptions {
   name?: string,
@@ -163,7 +163,7 @@ export interface RenderPassDelegate {
   willBeginRenderPass?: (renderPass: RenderPass, state: RenderState) => void,
   didEndRenderPass?: (renderPass: RenderPass, state: RenderState) => void,
   willRenderMesh?: (mesh: Mesh, state: RenderState) => void,
-  didiRenderMesh?: (mesh: Mesh, state: RenderState) => void,
+  didRenderMesh?: (mesh: Mesh, state: RenderState) => void,
 }
 
 export declare class RenderPass implements IGPUResource {

package/types/Renderer.ts

@@ -23,13 +23,12 @@ export interface RendererExtensions {
   copyTexture?: (source: Texture, tex: Texture) => void,
   resetColorAttachments?: (rp: RenderPass, colorAttachments: Texture[]) => void,
 }
-
 export declare class GPURenderer implements IGPURenderer {
   readonly height: number;
   readonly width: number;
   /**
-   * if webgl not support, gpu.level will be 0
-   */
+     * if webgl not support, gpu.level will be 0
+     */
   readonly shaderLibrary: ShaderLibrary;
   readonly gpu: GPUCapability;
   readonly canvas: Canvas;
@@ -44,19 +43,31 @@ export declare class GPURenderer implements IGPURenderer {
   createBuffer (options: GPUBufferOptions): GPUBuffer;
 
   /**
-   * only resize when width or height is different from now,
-   * when resized,all full-screen renderPasses attached to this renderer should be resized as well
-   * 只有当宽高不同的时候，才实际进行函数
-   * 当重新调整宽高后，这个renderer创建的renderPasses，如果没有被指定 viewport（全屏），那么需要resize 所有的renderPass
-   * @param width
-   * @param height
-   */
+     * 根据不同平台封装实现 requestAnimationFrame，
+     * FrameRequestCallback函数回调中进行渲染数据更新，
+     * OpenGL/WebGL在绘制开始之前(传递此帧数据）
+     * Metal在commandBuffer提交后（传递下一帧数据）
+     * @param cb
+     */
+  requestAnimationFrame (cb: FrameRequestCallback): number;
+
+  //todo
+  cancelAnimationFrame (id: number): void;
+
+  /**
+     * only resize when width or height is different from now,
+     * when resized,all full-screen renderPasses attached to this renderer should be resized as well
+     * 只有当宽高不同的时候，才实际进行函数
+     * 当重新调整宽高后，这个renderer创建的renderPasses，如果没有被指定 viewport（全屏），那么需要resize 所有的renderPass
+     * @param width
+     * @param height
+     */
   resize (width: number, height: number): void;
 
   /**
-   * destroy all resources created by this renderer
-   * @param haltGL if true, this method will call webgl lose context extension which leads webgl absolutely halt
-   */
+     * destroy all resources created by this renderer
+     * @param haltGL if true, this method will call webgl lose context extension which leads webgl absolutely halt
+     */
   destroy (haltGL?: boolean): void;
 
 }

package/types/ShaderLibrary.ts

@@ -2,7 +2,7 @@ export type Shader = ShaderWithSource | ShaderUseCacheId;
 export type ShaderWithSource = InstancedShaderWithSource | SharedShaderWithSource;
 
 export interface MetaShaderSpec {
-  mtlBinary?: ArrayBuffer,
+  mtlBinary?: ArrayBuffer | string,
   mtlSource?: string,
 
   mtlVertex?: string,
@@ -72,9 +72,9 @@ export interface ShaderLibrary {
   getShaderResult(cacheId: string): ShaderCompileResult | undefined,
 
   /**
-   * 添加shader
-   * @param shader
-   */
+     * 添加shader
+     * @param shader
+     */
   addShader(shader: Shader): string,
 
   /**

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/ImageBitmapInternal.ts

@@ -1,6 +1,4 @@
 export interface ImageBitmapConstructor {
-  flipY?: boolean,
-  premultiplyAlpha?: boolean,
   resizeWidth?: number,
   resizeHeight?: number,
 }

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

@@ -19,16 +19,12 @@ export abstract class RenderFrameInternal implements ResourceInternal {
   protected constructor (options: RenderFrameInternalOptions) {
   }
   abstract destroy (): void;
-  /**
-   * warp层完成所有数据传输后，通知客户端，可以进行实际渲染，
-   * 实际渲染根据客户端时机进行,在调用end()之前，客户端会根据实际刷新进行绘制
-   */
-  abstract begin (): void;
 
   /**
-   * 将RenderFrame移除渲染队列
+   * 代表此帧会在渲染队列的下一帧被渲染，调用此函数，也会调用renderer.invalid方法
+   * 由于渲染是异步的，此函数在Metal/Vulkan实现中，并不会直接绘制
    */
-  abstract end (): void;
+  abstract render (): void;
 
   abstract updateLoadAction (action: RenderPassLoadAction): void;
 }

package/types/native/RendererInternal.ts

@@ -35,6 +35,11 @@ export abstract class RendererInternal implements ResourceInternal {
 
   abstract destroy (): void;
 
+  /**
+     * 需要进行重新渲染
+     */
+  abstract invalid (): void;
+
   abstract createBuffer (options: GPUBufferInternalOptions): GPUBufferInternal;
 
   abstract createGeometry (options: GeometryInternalOptions): GeometryInternal;
@@ -57,6 +62,14 @@ export abstract class RendererInternal implements ResourceInternal {
 
   abstract cancelAnimationFrame (id: number): void;
 
+  /**
+     * 获取错误信息，目前支持最大获取5条，
+     * 每次调用此函数后，清空错误队列
+     */
+  abstract getErrors (): string[];
+
+  abstract resize (width: number, height: number): void;
+
   abstract createImageBitmap (
     data: ArrayBuffer | string, //图片文件的数据
     options: ImageBitmapConstructor,

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 {