@predy-js/render-interface 0.1.61-beta.1 → 0.1.61-beta.3

package/types/RenderFrame.ts

@@ -1,70 +0,0 @@
-import type { UniformValue } from './Material';
-import type {
-  RenderPass,
-  RenderPassLoadAction,
-  RenderPassDestroyOptions, SemanticMap,
-} 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';
-import type { DestroyOptions } from './constants';
-import type { InstancedMesh } from './Mesh';
-
-export interface RenderState {
-  currentMesh: Mesh | InstancedMesh,
-  currentFrame: RenderFrame,
-  currentPass: RenderPass,
-}
-
-export interface RenderFrameOptions {
-  renderPasses?: RenderPass[],
-  viewport?: vec4,
-  semantics?: { [key: string]: UniformValue | SemanticFunc | GPUBuffer },
-  loadAction?: RenderPassLoadAction,
-  name?: string,
-}
-
-export type SemanticFunc = (state: RenderState) => UniformValue | GPUBuffer | null | undefined;
-
-export type RenderFrameDestroyOptions = {
-  passes?: RenderPassDestroyOptions | DestroyOptions.keep,
-  semantics?: DestroyOptions,
-};
-
-export declare class RenderFrame implements IGPUResource {
-
-  public loadAction: RenderPassLoadAction;
-
-  constructor (options: RenderFrameOptions, renderer?: GPURenderer);
-
-  readonly renderPasses: RenderPass[];
-
-  readonly viewport?: vec4;
-
-  readonly semantics: SemanticMap;
-
-  readonly renderer?: IGPURenderer;
-
-  readonly isDestroyed: boolean;
-
-  setRenderPasses (passes: RenderPass[]): void;
-
-  addRenderPass (pass: RenderPass): void;
-
-  removeRenderPass (pass: RenderPass): void;
-
-  render (): void;
-
-  destroy (options?: RenderFrameDestroyOptions): void;
-
-  assignRenderer (renderer: IGPURenderer): RenderFrame ;
-}
-
-/**
- * RenderFrame 渲染顺序如下：
- * 1. renderFrame 按照priority由底到高渲染renderPass，renderPass如果有设置attachments,则会创建frameBuffer对象
- * 2. 每个renderPass渲染时，按照meshes数组顺序进行渲染，renderPass可以制定meshes数组的排序方式，对每个mesh的priority进行排序
- * 3. 遍历Mesh时会将其Material中的Shader添加至shaderLibrary，再调用render之前，将所有shader进行编译
- */

package/types/RenderPass.ts

@@ -1,222 +0,0 @@
-import type {
-  Texture, TextureConfigOptions, TextureFormatOptions,
-} from './Texture';
-import type { Mesh, MeshDestroyOptions } from './Mesh';
-import type { vec4 } from './type';
-import type { IGPURenderer, IGPUResource } from './IGPURenderer';
-import type { GPURenderer } from './Renderer';
-import type { UniformValue } from './Material';
-import type { GPUBuffer } from './GPUBuffer';
-import type { RenderState, SemanticFunc } from './RenderFrame';
-import type { DestroyOptions } from './constants';
-
-export enum RenderPassDestroyAttachmentType {
-  force = 0,
-  keep = 1,
-  keepExternal = 2,
-  destroy = force
-}
-
-export const RenderPassPriorityPrepare = 0;
-export const RenderPassPriorityNormal = 1000;
-export const RenderPassPriorityPostprocess = 3000;
-
-export enum TextureLoadAction {
-  whatever = 0,
-  //preserve previous attachment
-  //load = 1,
-  //clear attachment
-  clear = 2,
-}
-
-export enum TextureStoreAction {
-  store = 1,
-  clear = 0
-}
-
-export enum RenderPassAttachmentStorageType {
-  none = 0,
-  color = 1,
-  //stencil 8 render buffer
-  stencil_8_opaque = 2,
-  //stencil 16 render buffer
-  depth_16_opaque = 3,
-  //depth 16 & stencil 8 render buffer
-  depth_stencil_opaque = 4,
-  //depth 16 texture, need gpu.capability.readableDepthStencilTextures
-  depth_16_texture = 5,
-  //depth 24 texture, need gpu.capability.readableDepthStencilTextures
-  depth_24_stencil_8_texture = 6,
-
-}
-
-export interface RenderPassStorageObject {
-  readonly attachment: GLenum,
-  readonly format: GLenum,
-  readonly size: [width: number, height: number],
-  readonly storageType: RenderPassAttachmentStorageType,
-  readonly multiSample: number,
-}
-
-export interface RenderPassColorAttachmentTextureOptions extends TextureFormatOptions, TextureConfigOptions {
-}
-
-export interface RenderPassColorAttachmentOptions {
-  // color storage must be texture or textureOptions
-  texture?: Texture | RenderPassColorAttachmentTextureOptions,
-  storage?: RenderPassStorageObject,
-}
-
-export interface RenderPassColorAttachment {
-  readonly storageType: RenderPassAttachmentStorageType.color,
-  readonly texture: Texture,
-  readonly isDestroyed: boolean,
-}
-
-export interface RenderPassDepthStencilAttachment {
-  readonly storageType: RenderPassAttachmentStorageType,
-  readonly texture?: Texture,
-  readonly storage: RenderPassStorageObject,
-}
-
-export interface RenderPassDepthStencilAttachmentOptions {
-  storageType: RenderPassAttachmentStorageType,
-  storage?: RenderPassStorageObject,
-  texture?: Texture,
-}
-
-export interface RenderPassStoreAction {
-  depthAction?: TextureStoreAction,
-  stencilAction?: TextureStoreAction,
-  colorAction?: TextureStoreAction,
-}
-
-export interface RenderPassLoadAction {
-  clearColor?: vec4,
-  colorAction?: TextureLoadAction,
-  clearDepth?: number,
-  depthAction?: TextureLoadAction,
-  clearStencil?: number,
-  stencilAction?: TextureLoadAction,
-}
-
-export interface RenderPassAttachmentOptions {
-  attachments?: RenderPassColorAttachmentOptions[],
-  depthStencilAttachment?: RenderPassDepthStencilAttachmentOptions,
-  //if viewport not set,it will use viewportScale
-  viewport?: [x: number, y: number, width: number, height: number],
-  //default 1 , when renderer resize, this attachment will be resized to same scale
-  //todo 增加测试：
-  // 1.viewport 提供时，忽略此参数，renderPass的尺寸由viewport决定，无论renderer是否变化尺寸
-  // 2.viewportScale 默认为1，renderPass的尺寸由renderer的尺寸决定，renderer尺寸变化时，renderPass的尺寸也会变化
-  // 3.renderPass的color/depth_stencil attachment尺寸由
-  viewportScale?: number,
-  //in webgl2 use multisample renderbuffer
-  //default is 0, means disabled
-  //only enabled in webgl2
-  multiSample?: number,
-}
-
-export type SemanticGetter = UniformValue | SemanticFunc | GPUBuffer;
-
-export interface RenderPassOptions extends RenderPassAttachmentOptions {
-  name?: string,
-  meshes?: Mesh[],
-  priority?: number,
-  meshOrder?: RenderPassMeshOrder,
-  loadAction?: RenderPassLoadAction,
-  storeAction?: RenderPassStoreAction,
-  semantics?: { [key: string]: SemanticGetter },
-  delegate?: RenderPassDelegate,
-}
-
-export enum RenderPassMeshOrder {
-  none = 1,
-  ascending = 2,
-  descending = 3
-}
-
-export type RenderPassDestroyOptions = {
-  meshes?: MeshDestroyOptions | DestroyOptions.keep,
-  depthStencilAttachment?: RenderPassDestroyAttachmentType,
-  colorAttachment?: RenderPassDestroyAttachmentType,
-  semantics?: DestroyOptions,
-};
-
-export declare class SemanticMap {
-
-  constructor (options?: { [key: string]: SemanticGetter });
-
-  setSemantic (name: string, value: SemanticGetter | undefined): void;
-
-  getSemanticValue (name: string, state: RenderState): UniformValue | GPUBuffer | null | undefined;
-
-  hasSemanticValue (name: string): boolean;
-
-  toObject (): Record<string, SemanticGetter>;
-
-  destroy (): void;
-
-}
-
-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,
-}
-
-export declare class RenderPass implements IGPUResource {
-
-  readonly isDestroyed: boolean;
-
-  readonly name: string;
-
-  readonly priority: number;
-
-  readonly attachments: RenderPassColorAttachment[];
-
-  readonly depthAttachment?: RenderPassDepthStencilAttachment;
-
-  readonly stencilAttachment?: RenderPassDepthStencilAttachment;
-
-  readonly viewport: [x: number, y: number, width: number, height: number];
-
-  readonly meshes: Mesh[];
-
-  readonly renderer?: IGPURenderer;
-
-  readonly semantics: SemanticMap;
-
-  readonly storeAction: RenderPassStoreAction;
-
-  readonly loadAction: RenderPassLoadAction;
-
-  readonly multisample: number;
-
-  delegate: RenderPassDelegate;
-
-  meshOrder: RenderPassMeshOrder;
-
-  constructor (options: RenderPassOptions, renderer?: IGPURenderer);
-
-  /**
-   * reset color/depth_stencil attachments,
-   * if color/depth_stencil texture is external, this will not destroy textures
-   * if color/depth_stencil texture is internal created, this will also delete those textures
-   * this method will delete previous fbo if exists
-   * returns previous options
-   **/
-  resetAttachments (options: RenderPassAttachmentOptions): RenderPassAttachmentOptions;
-
-  setMeshes (meshes: Mesh[]): Mesh[];
-
-  addMesh (mesh: Mesh): void;
-
-  removeMesh (mesh: Mesh): void;
-
-  destroy (options?: RenderPassDestroyOptions): void;
-
-  assignRenderer (renderer: GPURenderer): RenderPass;
-
-}

package/types/Renderer.ts

@@ -1,62 +0,0 @@
-import type { RenderFrame, RenderFrameOptions } from './RenderFrame';
-import type { ShaderLibrary } from './ShaderLibrary';
-import type { GPUCapability } from './GPUCapability';
-import type { GPUBuffer, GPUBufferOptions } from './GPUBuffer';
-import type { IGPURenderer } from './IGPURenderer';
-import type { Canvas } from './Canvas';
-import type { Texture } from './Texture';
-import type { RenderPass } from './RenderPass';
-
-export interface RendererOptions {
-  gl?: WebGLRenderingContext | WebGL2RenderingContext,
-  canvas?: HTMLCanvasElement,
-  // if use frameworks [ 'webgl2', 'webgl' ], renderer will choose webgl if webgl2 is not supported
-  frameworks?: Array<'webgl' | 'webgl2'>,
-  willCaptureImage?: boolean,
-  premultiplyAlpha?: boolean,
-}
-
-/**
- * 常用的GPU方法，不是规范必须实现的
- */
-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
-   */
-  readonly shaderLibrary: ShaderLibrary;
-  readonly gpu: GPUCapability;
-  readonly canvas: Canvas;
-
-  readonly extension: RendererExtensions;
-  readonly isDestroyed: boolean;
-
-  constructor (options: RendererOptions);
-
-  createRenderFrame (options?: RenderFrameOptions): RenderFrame;
-
-  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
-   */
-  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 (haltGL?: boolean): void;
-
-}

package/types/ShaderLibrary.ts

@@ -1,128 +0,0 @@
-export type Shader = ShaderWithSource | ShaderUseCacheId;
-export type ShaderWithSource = InstancedShaderWithSource | SharedShaderWithSource;
-
-export interface MetaShaderSpec {
-  mtlBinary?: ArrayBuffer | string,
-  mtlSource?: string,
-
-  mtlVertex?: string,
-  mtlFragment?: string,
-}
-
-export interface ShaderSourceBase extends MetaShaderSpec {
-  fragment: string,
-  vertex: string,
-  name?: string,
-  //将es300的shader in/out关键字替换为attribute/varying
-  downgrade?: boolean,
-  marcos?: ShaderMarcos,
-}
-
-export interface InstancedShaderWithSource extends ShaderSourceBase {
-  shared?: false,
-}
-
-export interface SharedShaderWithSource extends ShaderSourceBase {
-  //相同cacheId的shader会使用同一个GLProgram
-  //提供了cacheId就会认为是shared Shader
-  cacheId?: string,
-  //shared为true时，
-  //如果没有提供cacheId，会根据字符串hash计算出 cacheId，
-  //字符串相同的shader将会使用同一个GLProgram
-  //如果提供了cacheId，cacheId相同的，都会使用同一个GLProgram
-  shared: true,
-}
-
-export interface ShaderUseCacheId {
-  cacheId: string,
-}
-
-export type ShaderMarcos = [key: string, value: string | number | boolean][];
-
-export enum ShaderCompileResultStatus {
-  noShader = 0,
-  success = 1,
-  fail = 2,
-  compiling = 3
-}
-
-export interface ShaderCompileResult {
-  status: ShaderCompileResultStatus,
-  cacheId?: string,
-  error?: string | null,
-  compileTime?: number,
-  // deprecated
-  shared?: boolean,
-}
-
-/**
- * @example
- * const lib:ShaderLibrary = ...;
- * const shaderCacheId = lib.addShader({fragment:'...',vertex:'...'});
- * lib.compileShader(shaderCacheId);
- * //pre-compiled program
- * const mtl = new Material({
- *   shader:{ shaderCacheId }
- * })
- */
-export interface ShaderLibrary {
-
-  readonly cacheIds: string[],
-
-  getShaderResult(cacheId: string): ShaderCompileResult | undefined,
-
-  /**
-     * 添加shader
-     * @param shader
-     */
-  addShader(shader: Shader): string,
-
-  /**
-     * @param cacheId
-     */
-  deleteShader(cacheId: string): void,
-
-  /**
-     * 编译shader
-     * @param shaderCacheId
-     * @param asyncCallback 如果传入，则会启用异步编译，当所有编译完成后被回调
-     */
-  compileShader(shaderCacheId: string, asyncCallback?: (result: ShaderCompileResult) => void): ShaderCompileResult,
-
-  /***
-     * 编译现有的所有shader
-     * @param asyncCallback 如果传入，则会启用异步编译，当所有编译完成后被回调
-     */
-  compileAllShaders(asyncCallback?: (results: ShaderCompileResult[]) => void): void,
-
-  destroy(): void,
-}
-
-export class ShaderLibraryEmpty implements ShaderLibrary {
-
-  get cacheIds () {
-    return [];
-  }
-
-  getShaderResult (cacheId: string): ShaderCompileResult | undefined {
-    return undefined;
-  }
-
-  addShader (shader: Shader, marcos?: ShaderMarcos) {
-    return '';
-  }
-
-  compileAllShaders (asyncCallback?: (results: ShaderCompileResult[]) => void) {
-    return [];
-  }
-
-  deleteShader (cacheId: string) {
-  }
-
-  compileShader (shaderCacheId: string): ShaderCompileResult {
-    return { status: ShaderCompileResultStatus.fail };
-  }
-
-  destroy () {
-  }
-}