ris-framework 0.2.0-dev.13 → 0.2.0-dev.16

package/src/webgpu/primitive/WebGpuPrimitiveState.ts

@@ -2,10 +2,11 @@ import {
     type CullMode,
     type FrontFace,
     type IPrimitiveState,
-    type PrimitiveStateDescriptor,
+    type IPrimitiveStateDescriptor,
     type PrimitiveTopology,
 } from "../../api/index.ts";
 import type {GpuCullMode, GpuFrontFace, GpuPrimitiveTopology} from "../WebGpuTypes.ts";
+import {resolvePrimitiveStateDescriptor} from "../../core/rendering/primitive/PrimitiveStateDescriptorUtilities.ts";
 import {WebGpuConverter} from "../utilities/WebGpuConverter.ts";
 
 /**
@@ -18,10 +19,11 @@ export class WebGpuPrimitiveState implements IPrimitiveState {
      * The constructor.
      * @param descriptor The primitive state descriptor.
      */
-    public constructor(descriptor: PrimitiveStateDescriptor) {
-        this.topology = descriptor.topology;
-        this.cullFace = descriptor.cullFace;
-        this.frontFace = descriptor.frontFace;
+    public constructor(descriptor?: IPrimitiveStateDescriptor) {
+        const resolved = resolvePrimitiveStateDescriptor(descriptor);
+        this.topology = resolved.topology;
+        this.cullFace = resolved.cullFace;
+        this.frontFace = resolved.frontFace;
         this.gpuTopology = WebGpuConverter.convertTopology(this.topology);
         this.gpuCullMode = WebGpuConverter.convertCullMode(this.cullFace);
         this.gpuFrontFace = WebGpuConverter.convertFrontFace(this.frontFace);

package/src/webgpu/render-pipelines/WebGpuMainRenderTargetRenderPipeline.ts

@@ -1,3 +1,4 @@
+import {ColorSpace} from "../../api/rendering/enums.ts";
 import {vec2} from "gl-matrix";
 import {
     BufferUsage,
@@ -81,6 +82,11 @@ export class WebGpuMainRenderTargetRenderPipeline extends AWebGpuRenderPipeline
             this._graphicsDevice.swapChain?.textureFormat ?? this._framework.renderer.preferredTextureFormat);
     }
 
+    /**
+     * The color space. Stored only; it has no effect on WebGPU yet.
+     */
+    public colorSpace: ColorSpace = ColorSpace.LINEAR;
+
     private _getBindGroup(): GpuBindGroup {
         if (!this._bindGroup) {
             this._bindGroup = this._graphicsDevice.device.createBindGroup({

package/src/webgpu/texture/WebGpuTexture2D.ts

@@ -1,7 +1,6 @@
 import {
     type IFramework,
     State,
-    TextureDescriptor,
     TextureUsage,
     TextureUtilities,
     type ITextureView,
@@ -13,6 +12,7 @@ import type {WebGpuGraphicsDevice} from "../WebGpuGraphicsDevice.ts";
 import {GpuTextureUsage, type GpuTexture, type GpuTextureView} from "../WebGpuTypes.ts";
 import {WebGpuConverter} from "../utilities/WebGpuConverter.ts";
 import {WebGpuTextureView} from "./WebGpuTextureView.ts";
+import {type ResolvedTextureDescriptor, resolveTextureDescriptor} from "../../core/rendering/texture/TextureDescriptorUtilities.ts";
 
 /**
  * The WebGPU 2D texture.
@@ -34,7 +34,7 @@ export class WebGpuTexture2D extends ATexture2D {
      * @param descriptor The texture descriptor.
      * @param image An optional image to upload instead of `descriptor.data`.
      */
-    public constructor(framework: IFramework, descriptor: TextureDescriptor, image?: HTMLImageElement) {
+    public constructor(framework: IFramework, descriptor: ResolvedTextureDescriptor, image?: HTMLImageElement) {
         super(descriptor);
         this._graphicsDevice = framework.renderer.graphicsDevice as WebGpuGraphicsDevice;
         this._image = image;
@@ -171,13 +171,14 @@ export class WebGpuTexture2D extends ATexture2D {
     public static getOrCreateDefault(framework: IFramework): WebGpuTexture2D {
         let texture = WebGpuTexture2D._defaultFilled.get(framework);
         if (!texture || texture.state === State.DISPOSED) {
-            const desc = new TextureDescriptor();
-            desc.width = 1;
-            desc.height = 1;
-            desc.data = [new Uint8Array([255, 255, 255, 255])];
-            desc.textureFormat = framework.renderer.preferredTextureFormat;
-            desc.textureUsage = TextureUsage.TEXTURE_BINDING | TextureUsage.COPY_DST;
-            desc.label = "RisDefaultFilledTexture";
+            const desc = resolveTextureDescriptor({
+                width: 1,
+                height: 1,
+                data: [new Uint8Array([255, 255, 255, 255])],
+                textureFormat: framework.renderer.preferredTextureFormat,
+                textureUsage: TextureUsage.TEXTURE_BINDING | TextureUsage.COPY_DST,
+                label: "RisDefaultFilledTexture",
+            });
             texture = new WebGpuTexture2D(framework, desc);
             texture.initialize();
             WebGpuTexture2D._defaultFilled.set(framework, texture);

package/src/webgpu/texture/WebGpuTextureFactory.ts

@@ -3,12 +3,13 @@ import {
     type IFramework,
     type ITexture2D,
     type ITextureFactory,
-    TextureDescriptor,
+    type ITextureDescriptor,
     TextureFormat,
     TextureUsage,
 } from "../../api/index.ts";
 import type {IKtx2Texture} from "ris-ktx2";
 import {WebGpuTexture2D} from "./WebGpuTexture2D.ts";
+import {resolveTextureDescriptor} from "../../core/rendering/texture/TextureDescriptorUtilities.ts";
 
 /**
  * The WebGPU texture factory.
@@ -24,7 +25,7 @@ export class WebGpuTextureFactory implements ITextureFactory {
     }
 
     /** @inheritDoc */
-    public createFromKtx2(_ktxTexture: IKtx2Texture, _descriptor?: TextureDescriptor): ITexture2D {
+    public createFromKtx2(_ktxTexture: IKtx2Texture, _descriptor?: ITextureDescriptor): ITexture2D {
         throw new Error("createFromKtx2 is not implemented for WebGPU.");
     }
 
@@ -35,7 +36,7 @@ export class WebGpuTextureFactory implements ITextureFactory {
         channels: number = 4,
         label: string | null | undefined = null,
         textureUsage = TextureUsage.COPY_DST | TextureUsage.TEXTURE_BINDING,
-        textureFormat = TextureFormat.RGBA_8_UNORM,
+        textureFormat = TextureFormat.UNDEFINED,
         useMipMaps = false): ITexture2D {
 
         if (!data) {
@@ -51,13 +52,14 @@ export class WebGpuTextureFactory implements ITextureFactory {
             textureFormat = this._framework.renderer.preferredTextureFormat;
         }
 
-        const desc = new TextureDescriptor();
-        desc.width = width;
-        desc.height = height;
-        desc.textureFormat = textureFormat;
-        desc.textureUsage = textureUsage;
-        desc.generateMipmaps = useMipMaps;
-        desc.label = label ?? null;
+        const desc = resolveTextureDescriptor({
+            width,
+            height,
+            textureFormat,
+            textureUsage,
+            generateMipmaps: useMipMaps,
+            label: label ?? null,
+        });
 
         let image: HTMLImageElement | undefined;
         if (typeof HTMLImageElement !== "undefined" && data instanceof HTMLImageElement) {
@@ -90,13 +92,14 @@ export class WebGpuTextureFactory implements ITextureFactory {
             textureFormat = this._framework.renderer.preferredTextureFormat;
         }
 
-        const desc = new TextureDescriptor();
-        desc.width = width;
-        desc.height = height;
-        desc.textureUsage = textureUsage;
-        desc.textureFormat = textureFormat;
-        desc.label = label;
-        desc.generateMipmaps = useMipmap;
+        const desc = resolveTextureDescriptor({
+            width,
+            height,
+            textureUsage,
+            textureFormat,
+            label,
+            generateMipmaps: useMipmap,
+        });
 
         // WebGPU zero-initializes textures, so transparent black needs no upload; neither do depth textures.
         if (!color || (color.r === 0 && color.g === 0 && color.b === 0 && color.a === 0)) {

package/dist/api/material/ICameraMaterial.d.ts

@@ -1,18 +0,0 @@
-import type { IMaterial } from "./IMaterial.js";
-import type { ICamera } from "../camera/ICamera.js";
-/**
- * A material that renders with a camera (unlit, Blinn-Phong, inspect mips).
- * A `Scene` assigns its camera to these materials in `scene.update()`.
- * @public
- */
-export interface ICameraMaterial extends IMaterial {
-    /** The camera. Setting it binds the camera's buffers. */
-    camera?: ICamera;
-}
-/**
- * Whether a material is an {@link ICameraMaterial}.
- * @param material The material.
- * @public
- */
-export declare function isCameraMaterial(material: IMaterial | undefined): material is ICameraMaterial;
-//# sourceMappingURL=ICameraMaterial.d.ts.map

package/dist/api/material/ICameraMaterial.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"ICameraMaterial.d.ts","sourceRoot":"","sources":["../../../src/api/material/ICameraMaterial.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAChD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;AAEpD;;;;GAIG;AACH,MAAM,WAAW,eAAgB,SAAQ,SAAS;IAE9C,yDAAyD;IACzD,MAAM,CAAC,EAAE,OAAO,CAAC;CACpB;AAED;;;;GAIG;AACH,wBAAgB,gBAAgB,CAAC,QAAQ,EAAE,SAAS,GAAG,SAAS,GAAG,QAAQ,IAAI,eAAe,CAE7F"}

package/dist/api/rendering/primitive/PrimitiveStateDescriptor.d.ts

@@ -1,24 +0,0 @@
-import { PrimitiveTopology } from "./PrimitiveTopology.js";
-import { CullMode } from "./CullMode.js";
-import { FrontFace } from "./FrontFace.js";
-/**
- * Describes the state of a primitive.
- */
-export declare class PrimitiveStateDescriptor {
-    /**
-     * The topology of the primitive.
-     * By default, it is set to TRIANGLE_LIST.
-     */
-    topology: PrimitiveTopology;
-    /**
-     * The culling mode.
-     * By default, it is set to BACK.
-     */
-    cullFace: CullMode;
-    /**
-     * The front face.
-     * By default, it is set to CCW(counter clock-wise).
-     */
-    frontFace: FrontFace;
-}
-//# sourceMappingURL=PrimitiveStateDescriptor.d.ts.map

package/dist/api/rendering/primitive/PrimitiveStateDescriptor.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"PrimitiveStateDescriptor.d.ts","sourceRoot":"","sources":["../../../../src/api/rendering/primitive/PrimitiveStateDescriptor.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,iBAAiB,EAAC,MAAM,wBAAwB,CAAC;AACzD,OAAO,EAAC,QAAQ,EAAC,MAAM,eAAe,CAAC;AACvC,OAAO,EAAC,SAAS,EAAC,MAAM,gBAAgB,CAAC;AAEzC;;GAEG;AACH,qBAAa,wBAAwB;IAEjC;;;OAGG;IACI,QAAQ,EAAE,iBAAiB,CAAmC;IAErE;;;OAGG;IACI,QAAQ,EAAE,QAAQ,CAAiB;IAE1C;;;OAGG;IACI,SAAS,EAAE,SAAS,CAAiB;CAC/C"}

package/dist/api/rendering/texture/TextureDescriptor.d.ts

@@ -1,42 +0,0 @@
-import { TextureFormat } from "./TextureFormat.js";
-import { vec2 } from "gl-matrix";
-/**
- * The texture descriptor.
- */
-export declare class TextureDescriptor {
-    /**
-     * The texture width.
-     */
-    width: number;
-    /**
-     * The texture height.
-     */
-    height: number;
-    /**
-     * The texture format.
-     * By default, it is UNDEFINED.
-     */
-    textureFormat: TextureFormat;
-    /**
-     * The texture usage.
-     * By default, it is TEXTURE_BINDING | COPY_DST.
-     */
-    textureUsage: number;
-    /**
-     * The texture label.
-     */
-    label: string | null;
-    /**
-     * The data per mip level.
-     */
-    data?: Uint8Array[];
-    /**
-     * Should mipmaps be generated.
-     */
-    generateMipmaps: boolean;
-    /**
-     * The block size of a texture, which must be set for compressed textures.
-     */
-    blockSize?: vec2;
-}
-//# sourceMappingURL=TextureDescriptor.d.ts.map

package/dist/api/rendering/texture/TextureDescriptor.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"TextureDescriptor.d.ts","sourceRoot":"","sources":["../../../../src/api/rendering/texture/TextureDescriptor.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,aAAa,EAAC,MAAM,oBAAoB,CAAC;AAEjD,OAAO,EAAC,IAAI,EAAC,MAAM,WAAW,CAAC;AAE/B;;GAEG;AACH,qBAAa,iBAAiB;IAE1B;;OAEG;IACI,KAAK,EAAE,MAAM,CAAK;IAEzB;;OAEG;IACI,MAAM,EAAE,MAAM,CAAK;IAE1B;;;OAGG;IACI,aAAa,gBAA2B;IAE/C;;;OAGG;IACI,YAAY,SAAwD;IAE3E;;OAEG;IACI,KAAK,EAAE,MAAM,GAAG,IAAI,CAAQ;IAEnC;;OAEG;IACI,IAAI,CAAC,EAAE,UAAU,EAAE,CAAa;IAEvC;;OAEG;IACI,eAAe,UAAS;IAE/B;;OAEG;IACI,SAAS,CAAC,EAAE,IAAI,CAAC;CAE3B"}

package/src/api/material/ICameraMaterial.ts

@@ -1,22 +0,0 @@
-import type { IMaterial } from "./IMaterial.ts";
-import type { ICamera } from "../camera/ICamera.ts";
-
-/**
- * A material that renders with a camera (unlit, Blinn-Phong, inspect mips).
- * A `Scene` assigns its camera to these materials in `scene.update()`.
- * @public
- */
-export interface ICameraMaterial extends IMaterial {
-
-    /** The camera. Setting it binds the camera's buffers. */
-    camera?: ICamera;
-}
-
-/**
- * Whether a material is an {@link ICameraMaterial}.
- * @param material The material.
- * @public
- */
-export function isCameraMaterial(material: IMaterial | undefined): material is ICameraMaterial {
-    return !!material && "camera" in material;
-}

package/src/api/rendering/primitive/PrimitiveStateDescriptor.ts

@@ -1,27 +0,0 @@
-import {PrimitiveTopology} from "./PrimitiveTopology.ts";
-import {CullMode} from "./CullMode.ts";
-import {FrontFace} from "./FrontFace.ts";
-
-/**
- * Describes the state of a primitive.
- */
-export class PrimitiveStateDescriptor {
-
-    /**
-     * The topology of the primitive.
-     * By default, it is set to TRIANGLE_LIST.
-     */
-    public topology: PrimitiveTopology = PrimitiveTopology.TRIANGLE_LIST;
-
-    /**
-     * The culling mode.
-     * By default, it is set to BACK.
-     */
-    public cullFace: CullMode = CullMode.BACK;
-
-    /**
-     * The front face.
-     * By default, it is set to CCW(counter clock-wise).
-     */
-    public frontFace: FrontFace = FrontFace.CCW;
-}

package/src/api/rendering/texture/TextureDescriptor.ts

@@ -1,52 +0,0 @@
-import {TextureFormat} from "./TextureFormat.ts";
-import {TextureUsage} from "./TextureUsage.ts";
-import {vec2} from "gl-matrix";
-
-/**
- * The texture descriptor.
- */
-export class TextureDescriptor {
-
-    /**
-     * The texture width.
-     */
-    public width: number = 0;
-
-    /**
-     * The texture height.
-     */
-    public height: number = 0;
-
-    /**
-     * The texture format.
-     * By default, it is UNDEFINED.
-     */
-    public textureFormat = TextureFormat.UNDEFINED;
-
-    /**
-     * The texture usage.
-     * By default, it is TEXTURE_BINDING | COPY_DST.
-     */
-    public textureUsage = TextureUsage.TEXTURE_BINDING | TextureUsage.COPY_DST;
-
-    /**
-     * The texture label.
-     */
-    public label: string | null = null;
-
-    /**
-     * The data per mip level.
-     */
-    public data?: Uint8Array[] = undefined;
-
-    /**
-     * Should mipmaps be generated.
-     */
-    public generateMipmaps = false;
-
-    /**
-     * The block size of a texture, which must be set for compressed textures.
-     */
-    public blockSize?: vec2;
-
-}