@predy-js/render-interface 0.1.66-beta.1 → 0.1.66-beta.11

package/dist/statistic.js

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

package/dist/types/Texture.d.ts

@@ -1,6 +1,12 @@
 import type { IGPURenderer, IGPUResource } from './IGPURenderer';
 import type { Immutable, TypedArray } from './type';
 import type { GPURenderer } from './Renderer';
+/**
+ * 图片解码的格式，默认为 WebGL2RenderingContext['RGBA8']
+ * 如果图片解码格式和texture的不一致，在非Web环境下，会产生报错，无法上传数据
+ * 一般情况由系统根据图片文件解析出图片的像素格式
+ */
+export type ImageBitmapPixelFormat = WebGL2RenderingContext['RGBA8'] | WebGL2RenderingContext['RGBA16F'] | WebGL2RenderingContext['RGBA32F'];
 export declare enum TextureSourceType {
     none = 0,
     data = 1,
@@ -57,6 +63,11 @@ export interface TextureFactorySource2DMipmapsFrom {
 }
 export type TextureFactorySourceFrom = TextureFactorySource2DBinaryMipmapsFrom | TextureFactorySourceCubeBinaryMipmapsFrom | TextureFactorySource2DFrom | TextureFactorySourceCubeFrom | TextureFactorySourceCubeMipmapsFrom | TextureFactorySource2DMipmapsFrom | TextureFactorySourceFromCompressed;
 export interface TextureFactory {
+    /**
+     * 通过TextureConfigOptions可以决定图片解码时使用的格式
+     * @param options
+     * @param config texture的属性
+     */
     loadSourceAsync(options: TextureFactorySourceFrom, config?: TextureConfigOptions): Promise<TextureOptions>;
     canOffloadTexture(texture: Texture): boolean;
     reloadTextureAsync(texture: Texture): Promise<Texture>;
@@ -80,37 +91,18 @@ export declare class Texture implements IGPUResource {
     assignRenderer(renderer: GPURenderer): Texture;
 }
 type ImageSource = ImageBitmap | HTMLImageElement | HTMLCanvasElement;
+export interface ImageData {
+    data: TypedArray;
+    width: number;
+    height: number;
+}
 export type TextureSourceCubeData = [
-    TEXTURE_CUBE_MAP_POSITIVE_X: ImageSource | {
-        data: TypedArray;
-        width: number;
-        height: number;
-    },
-    TEXTURE_CUBE_MAP_NEGATIVE_X: ImageSource | {
-        data: TypedArray;
-        width: number;
-        height: number;
-    },
-    TEXTURE_CUBE_MAP_POSITIVE_Y: ImageSource | {
-        data: TypedArray;
-        width: number;
-        height: number;
-    },
-    TEXTURE_CUBE_MAP_NEGATIVE_Y: ImageSource | {
-        data: TypedArray;
-        width: number;
-        height: number;
-    },
-    TEXTURE_CUBE_MAP_POSITIVE_Z: ImageSource | {
-        data: TypedArray;
-        width: number;
-        height: number;
-    },
-    TEXTURE_CUBE_MAP_NEGATIVE_Z: ImageSource | {
-        data: TypedArray;
-        width: number;
-        height: number;
-    }
+    TEXTURE_CUBE_MAP_POSITIVE_X: ImageSource | ImageData,
+    TEXTURE_CUBE_MAP_NEGATIVE_X: ImageSource | ImageData,
+    TEXTURE_CUBE_MAP_POSITIVE_Y: ImageSource | ImageData,
+    TEXTURE_CUBE_MAP_NEGATIVE_Y: ImageSource | ImageData,
+    TEXTURE_CUBE_MAP_POSITIVE_Z: ImageSource | ImageData,
+    TEXTURE_CUBE_MAP_NEGATIVE_Z: ImageSource | ImageData
 ];
 export type TextureSourceOptions = Texture2DSourceOptions | TextureCubeSourceOptions;
 export interface Texture2DSourceOptionsNone extends TextureOptionsBase {

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

@@ -1,11 +1,13 @@
 import type { MaterialInternal } from './MaterialInternal';
 import type { vec2 } from '../type';
 import type { TextureInternal } from './TextureInternal';
+import type { RenderPassInternal } from './RenderPassInternal';
 export interface TextureGpuInfo {
     format: number;
     type: number;
     target: number;
     mipmaps: vec2[];
+    handle: number;
 }
 export declare abstract class AndGLContext {
     abstract isEnabled(param: GLenum): boolean;
@@ -33,4 +35,6 @@ export declare abstract class AndGLContext {
      */
     abstract setupStates(mtl: MaterialInternal): void;
     abstract getTextureGpuInfo(texture: TextureInternal): TextureGpuInfo;
+    abstract getTexParameter(target: GLenum, pname: GLenum): number;
+    abstract bindRenderPass(renderPass: RenderPassInternal): void;
 }

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

@@ -1,18 +1,21 @@
+import type { ImageBitmapPixelFormat } from '../Texture';
 export interface ImageBitmapConstructor {
+    premultiplyAlpha?: boolean;
 }
 export declare abstract class ImageBitmapInternal {
     /**
-     * 释放内存，释放后不可再用,
-     * 释放后 width,height,byteLength都为0
-     */
+       * 释放内存，释放后不可再用,
+       * 释放后 width,height,byteLength都为0
+       */
     abstract close(): void;
     /**
-     * 将内存拷贝到指定的Uint8Array中
-     * @param target
-     */
+       * 将内存拷贝到指定的Uint8Array中
+       * @param target
+       */
     abstract copyTo(target: Uint8Array): void;
     abstract readonly width: number;
     abstract readonly height: number;
     abstract readonly byteLength: number;
+    abstract readonly format: ImageBitmapPixelFormat;
 }
 export type ImageBitmapCallback = (error: Error | undefined, image: ImageBitmapInternal) => void;

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

@@ -1,6 +1,5 @@
-import type { TextureFormatOptions, TextureConfigOptionsBase } from '../Texture';
+import type { TextureFormatOptions, TextureConfigOptionsBase, ImageData } from '../Texture';
 import type { ResourceInternal } from './ResourceInternal';
-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'];
@@ -10,7 +9,7 @@ export interface TextureInternalConstructOptions extends TextureInternalOptions
     width: number;
     height: number;
 }
-export type TextureInternalCubeImages<T extends ImageBitmapInternal | TypedArray = ImageBitmapInternal> = [
+export type TextureInternalCubeImages<T extends ImageBitmapInternal | ImageData = ImageBitmapInternal> = [
     positiveX: T,
     nagtiveX: T,
     positiveY: T,
@@ -30,7 +29,7 @@ export declare abstract class TextureInternal implements ResourceInternal {
     /**
        * 上传cubeImage解码后的数据
        */
-    abstract updateCubeImagesData(images: TextureInternalCubeImages<TypedArray>, mipmapLevel?: number): void;
+    abstract updateCubeImagesData(images: TextureInternalCubeImages<ImageData>, mipmapLevel?: number): void;
     /**
        * 上传cubeImage
        */
@@ -38,11 +37,11 @@ export declare abstract class TextureInternal implements ResourceInternal {
     /**
        * 上传整张解码后图片数据,数据尺寸必须和Texture尺寸定义相同
        */
-    abstract update2DImageData(data: TypedArray, mipmapLevel?: number): void;
+    abstract update2DImageData(data: ImageData, mipmapLevel?: number): void;
     /**
        * 上传压缩纹理数据
        */
-    abstract update2DCompressedImage(data: TypedArray, mipmapLevel?: number): void;
+    abstract update2DCompressedImage(data: ImageData, mipmapLevel?: number): void;
     /**
        * imageBitmap的尺寸也必须和Texture相同
        * @param image

package/package.json

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

package/types/Texture.ts

@@ -2,6 +2,15 @@ import type { IGPURenderer, IGPUResource } from './IGPURenderer';
 import type { Immutable, TypedArray } from './type';
 import type { GPURenderer } from './Renderer';
 
+/**
+ * 图片解码的格式，默认为 WebGL2RenderingContext['RGBA8']
+ * 如果图片解码格式和texture的不一致，在非Web环境下，会产生报错，无法上传数据
+ * 一般情况由系统根据图片文件解析出图片的像素格式
+ */
+export type ImageBitmapPixelFormat = WebGL2RenderingContext['RGBA8'] |
+WebGL2RenderingContext['RGBA16F'] |
+WebGL2RenderingContext['RGBA32F'] ;
+
 export enum TextureSourceType {
   none,
   data = 1,
@@ -75,6 +84,11 @@ export type TextureFactorySourceFrom =
   | TextureFactorySourceFromCompressed;
 
 export interface TextureFactory {
+  /**
+   * 通过TextureConfigOptions可以决定图片解码时使用的格式
+   * @param options
+   * @param config texture的属性
+   */
   loadSourceAsync (options: TextureFactorySourceFrom, config?: TextureConfigOptions): Promise<TextureOptions>,
 
   canOffloadTexture (texture: Texture): boolean,
@@ -112,13 +126,19 @@ export declare class Texture implements IGPUResource {
 
 type ImageSource = ImageBitmap | HTMLImageElement | HTMLCanvasElement;
 
+export interface ImageData {
+  data: TypedArray,
+  width: number,
+  height: number,
+}
+
 export type TextureSourceCubeData = [
-  TEXTURE_CUBE_MAP_POSITIVE_X: ImageSource | { data: TypedArray, width: number, height: number },
-  TEXTURE_CUBE_MAP_NEGATIVE_X: ImageSource | { data: TypedArray, width: number, height: number },
-  TEXTURE_CUBE_MAP_POSITIVE_Y: ImageSource | { data: TypedArray, width: number, height: number },
-  TEXTURE_CUBE_MAP_NEGATIVE_Y: ImageSource | { data: TypedArray, width: number, height: number },
-  TEXTURE_CUBE_MAP_POSITIVE_Z: ImageSource | { data: TypedArray, width: number, height: number },
-  TEXTURE_CUBE_MAP_NEGATIVE_Z: ImageSource | { data: TypedArray, width: number, height: number }
+  TEXTURE_CUBE_MAP_POSITIVE_X: ImageSource | ImageData,
+  TEXTURE_CUBE_MAP_NEGATIVE_X: ImageSource | ImageData,
+  TEXTURE_CUBE_MAP_POSITIVE_Y: ImageSource | ImageData,
+  TEXTURE_CUBE_MAP_NEGATIVE_Y: ImageSource | ImageData,
+  TEXTURE_CUBE_MAP_POSITIVE_Z: ImageSource | ImageData,
+  TEXTURE_CUBE_MAP_NEGATIVE_Z: ImageSource | ImageData
 ];
 
 // 为减少内存消耗，除了video之外，其余的数据内容会在texture生成后被置为undefined

package/types/native/AndGLContext.ts

@@ -1,12 +1,14 @@
 import type { MaterialInternal } from './MaterialInternal';
 import type { vec2 } from '../type';
 import type { TextureInternal } from './TextureInternal';
+import type { RenderPassInternal } from './RenderPassInternal';
 
 export interface TextureGpuInfo {
   format: number,
   type: number,
   target: number,
   mipmaps: vec2[],
+  handle: number,
 }
 
 export abstract class AndGLContext {
@@ -42,4 +44,8 @@ export abstract class AndGLContext {
   abstract setupStates (mtl: MaterialInternal): void;
 
   abstract getTextureGpuInfo (texture: TextureInternal): TextureGpuInfo;
+
+  abstract getTexParameter (target: GLenum, pname: GLenum): number;
+
+  abstract bindRenderPass (renderPass: RenderPassInternal): void;
 }

package/types/native/ImageBitmapInternal.ts

@@ -1,21 +1,24 @@
+import type { ImageBitmapPixelFormat } from '../Texture';
+
 export interface ImageBitmapConstructor {
+  premultiplyAlpha?: boolean,
 }
 
 export abstract class ImageBitmapInternal {
   /**
-   * 释放内存，释放后不可再用,
-   * 释放后 width,height,byteLength都为0
-   */
+     * 释放内存，释放后不可再用,
+     * 释放后 width,height,byteLength都为0
+     */
   abstract close (): void;
-
   /**
-   * 将内存拷贝到指定的Uint8Array中
-   * @param target
-   */
+     * 将内存拷贝到指定的Uint8Array中
+     * @param target
+     */
   abstract copyTo (target: Uint8Array): void;
   abstract readonly width: number;
   abstract readonly height: number;
   abstract readonly byteLength: number;
+  abstract readonly format: ImageBitmapPixelFormat;
 }
 
 export type ImageBitmapCallback = (

package/types/native/TextureInternal.ts

@@ -1,6 +1,5 @@
-import type { TextureFormatOptions, TextureConfigOptionsBase } from '../Texture';
+import type { TextureFormatOptions, TextureConfigOptionsBase, ImageData } from '../Texture';
 import type { ResourceInternal } from './ResourceInternal';
-import type { TypedArray } from '../type';
 import type { ImageBitmapInternal } from './ImageBitmapInternal';
 
 export interface TextureInternalOptions extends TextureFormatOptions, Omit<TextureConfigOptionsBase, 'keepImageSource'> {
@@ -13,7 +12,7 @@ export interface TextureInternalConstructOptions extends TextureInternalOptions
   height: number,
 }
 
-export type TextureInternalCubeImages<T extends ImageBitmapInternal | TypedArray = ImageBitmapInternal> = [
+export type TextureInternalCubeImages<T extends ImageBitmapInternal | ImageData = ImageBitmapInternal> = [
     positiveX: T,
     nagtiveX: T,
     positiveY: T,
@@ -43,7 +42,7 @@ export abstract class TextureInternal implements ResourceInternal {
   /**
      * 上传cubeImage解码后的数据
      */
-  abstract updateCubeImagesData (images: TextureInternalCubeImages<TypedArray>, mipmapLevel?: number): void;
+  abstract updateCubeImagesData (images: TextureInternalCubeImages<ImageData>, mipmapLevel?: number): void;
 
   /**
      * 上传cubeImage
@@ -53,13 +52,13 @@ export abstract class TextureInternal implements ResourceInternal {
   /**
      * 上传整张解码后图片数据,数据尺寸必须和Texture尺寸定义相同
      */
-  abstract update2DImageData (data: TypedArray, mipmapLevel?: number): void;
+  abstract update2DImageData (data: ImageData, mipmapLevel?: number): void;
 
   /**
      * 上传压缩纹理数据
      */
 
-  abstract update2DCompressedImage (data: TypedArray, mipmapLevel?: number): void;
+  abstract update2DCompressedImage (data: ImageData, mipmapLevel?: number): void;
 
   /**
      * imageBitmap的尺寸也必须和Texture相同