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

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/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 {