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

package/src/webgl/texture/WebGlTextureFactory.ts

@@ -2,14 +2,14 @@ import {
     Color,
     type IFramework,
     type ITexture2D,
-    type ITextureFactory,
     type ITextureDescriptor,
+    type ITextureFactory,
     TextureFormat,
     TextureUsage,
     TextureUtilities
 } from "../../api/index.ts"
 import {WebGlTexture2D} from "./WebGlTexture2D.ts";
-import {type IKtx2Texture, KtxDFTransfer, KtxTranscodeFlags, KtxTranscodeFormat, VkFormat} from "ris-ktx2";
+import {type IKtx2Texture, KtxTranscodeFlags, KtxTranscodeFormat, VkFormat} from "ris-ktx2";
 import {vec2} from "gl-matrix";
 import {ColorSpace} from "../../api/rendering/enums.ts";
 import {resolveTextureDescriptor} from "../../core/rendering/texture/TextureDescriptorUtilities.ts";
@@ -34,8 +34,10 @@ export class WebGlTextureFactory implements ITextureFactory {
         let textureFormat = desc.textureFormat;
         const gpuFeatures = this._framework.graphicsDevice.features;
 
-        const srgb = ktxTexture.oetf == KtxDFTransfer.SRGB;
-        const preferSrgb = this._framework.renderer.preferredColorSpace == ColorSpace.SRGB;
+        // Textures always adapt to the framework's preferred color space, unless user defined it's preferred.
+        const preferSrgb = (descriptor?.preferredColorSpace ?? this._framework.renderer.colorSpace) == ColorSpace.SRGB;
+        // An explicit texture format overrides both color space preferences.
+        const userSpecifiedTextureFormat = desc.textureFormat != TextureFormat.UNDEFINED;
 
         if (ktxTexture.needsTranscoding && vkFormat == VkFormat.UNDEFINED)
         {
@@ -46,22 +48,22 @@ export class WebGlTextureFactory implements ITextureFactory {
                 if(gpuFeatures.supportsTextureCompressionBC)
                 {
                     transcodeFormat = KtxTranscodeFormat.BC7_RGBA;
-                    textureFormat = srgb ? TextureFormat.BC7_RGBA_SRGB : TextureFormat.BC7_RGBA_UNORM;
+                    textureFormat = preferSrgb ? TextureFormat.BC7_RGBA_SRGB : TextureFormat.BC7_RGBA_UNORM;
                 }
                 else if(gpuFeatures.supportsTextureCompressionASTC)
                 {
                     transcodeFormat = KtxTranscodeFormat.ASTC_4X4_RGBA;
-                    textureFormat = srgb ? TextureFormat.ASTC_4X4_RGBA_SRGB : TextureFormat.ASTC_4X4_RGBA_UNORM;
+                    textureFormat = preferSrgb ? TextureFormat.ASTC_4X4_RGBA_SRGB : TextureFormat.ASTC_4X4_RGBA_UNORM;
                 }
                 else if(gpuFeatures.supportsTextureCompressionS3TC)
                 {
                     transcodeFormat = KtxTranscodeFormat.BC3_RGBA;
-                    textureFormat = srgb ? TextureFormat.BC3_RGBA_SRGB : TextureFormat.BC3_RGBA_UNORM;
+                    textureFormat = preferSrgb ? TextureFormat.BC3_RGBA_SRGB : TextureFormat.BC3_RGBA_UNORM;
                 }
                 else if(gpuFeatures.supportsTextureCompressionETC2)
                 {
                     transcodeFormat = KtxTranscodeFormat.ETC2_RGBA;
-                    textureFormat = srgb ? TextureFormat.ETC2_RGBA8_SRGB : TextureFormat.ETC2_RGBA8_UNORM;
+                    textureFormat = preferSrgb ? TextureFormat.ETC2_RGBA8_SRGB : TextureFormat.ETC2_RGBA8_UNORM;
                 }
                 else if(gpuFeatures.supportsTextureCompressionPVRTC)
                 {
@@ -72,7 +74,7 @@ export class WebGlTextureFactory implements ITextureFactory {
                 else
                 {
                     transcodeFormat = KtxTranscodeFormat.RGBA32;
-                    textureFormat = srgb ? TextureFormat.RGBA_8_UNORM_SRGB : TextureFormat.RGBA_8_UNORM;
+                    textureFormat = preferSrgb ? TextureFormat.RGBA_8_UNORM_SRGB : TextureFormat.RGBA_8_UNORM;
                 }
             }
             else
@@ -83,13 +85,18 @@ export class WebGlTextureFactory implements ITextureFactory {
             ktxTexture.transcodeBasis(transcodeFormat, KtxTranscodeFlags.HIGH_QUALITY);
         }
         else {
-            // No transcoding path, the vkFormat already says linear or sRGB.
+            // No transcoding path: map the vkFormat, then switch to the preferred color space variant.
             textureFormat = TextureUtilities.convertVkFormatToTextureFormat(vkFormat);
-            if(!srgb && preferSrgb && !TextureUtilities.isSrgbFormat(textureFormat)){
-                textureFormat = TextureUtilities.convertToSrgbVariant(textureFormat);
-            }
-            else if(srgb && !preferSrgb && TextureUtilities.isSrgbFormat(textureFormat)){
-                textureFormat = TextureUtilities.convertToLinearVariant(textureFormat);
+
+            if (userSpecifiedTextureFormat) {
+                // The data can only be reinterpreted as the file's format or its sRGB/linear variant.
+                textureFormat = TextureUtilities.resolveExplicitFormat(textureFormat, desc.textureFormat);
+            } else {
+                if (preferSrgb && !TextureUtilities.isSrgbFormat(textureFormat)) {
+                    textureFormat = TextureUtilities.convertToSrgbVariant(textureFormat);
+                } else if (!preferSrgb && TextureUtilities.isSrgbFormat(textureFormat)) {
+                    textureFormat = TextureUtilities.convertToLinearVariant(textureFormat);
+                }
             }
         }
 
@@ -125,8 +132,12 @@ export class WebGlTextureFactory 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 (textureFormat == TextureFormat.UNDEFINED) {
+            textureFormat = this._framework.renderer.preferredTextureFormat;
+        }
+
 
         if (!data) {
             throw new Error("Data must not be null.");

package/src/webgl/utilities/WebGlTextureUtilities.ts

@@ -1,5 +1,5 @@
 import {WebGlConverter} from "./WebGlConverter.ts";
-import {AlignUtilities, TextureFormat} from "../../api/index.ts";
+import { TextureFormat} from "../../api/index.ts";
 import {vec2} from "gl-matrix";
 import {WebGlUtilities} from "./WebGlUtilities.ts";
 
@@ -127,6 +127,9 @@ export class WebGlTextureUtilities {
             gl.texStorage2D(gl.TEXTURE_2D, mipLevels, internalFormat, baseWidth, baseHeight);
         }
 
+        // Texture data might not be aligned to 4. So disable it.
+        gl.pixelStorei(gl.UNPACK_ALIGNMENT, 1);
+
         if (data && data.length > 0) {
 
             let width = baseWidth;
@@ -140,9 +143,9 @@ export class WebGlTextureUtilities {
                     if (useTexStorage) {
                         gl.compressedTexSubImage2D(gl.TEXTURE_2D, i, 0, 0, width, height, internalFormat, mipLevelData, 0);
                     } else {
-                        const alignedWidth = AlignUtilities.align(width, blockSize[0]);
-                        const alignedHeight = AlignUtilities.align(height, blockSize[1]);
-                        gl.compressedTexImage2D(gl.TEXTURE_2D, i, internalFormat, alignedWidth, alignedHeight, 0, mipLevelData, 0);
+                        // const alignedWidth = AlignUtilities.align(width, blockSize[0]);
+                        // const alignedHeight = AlignUtilities.align(height, blockSize[1]);
+                        gl.compressedTexImage2D(gl.TEXTURE_2D, i, internalFormat, width, height, 0, mipLevelData, 0);
                     }
                 } else {
                     throw new Error("unsupported data type");
@@ -153,6 +156,9 @@ export class WebGlTextureUtilities {
             }
         }
 
+        // Restore to default.
+        gl.pixelStorei(gl.UNPACK_ALIGNMENT, 4);
+
         gl.texParameteri(gl.TEXTURE_2D, gl.TEXTURE_WRAP_S, gl.CLAMP_TO_EDGE);
         gl.texParameteri(gl.TEXTURE_2D, gl.TEXTURE_WRAP_T, gl.CLAMP_TO_EDGE);
 

package/src/webgpu/WebGpuGraphicsDevice.ts

@@ -9,7 +9,7 @@ import {
     type ISampler,
     type ISwapChain,
     type IWindowManager,
-    PrimitiveStateDescriptor,
+    type IPrimitiveStateDescriptor,
     RenderPassDescriptor,
     SwapChainDescriptor,
 } from "../api/index.ts";
@@ -158,8 +158,8 @@ export class WebGpuGraphicsDevice extends AGraphicsDevice {
     }
 
     /** @inheritDoc */
-    public createPrimitiveState(descriptor?: PrimitiveStateDescriptor): IPrimitiveState {
-        return new WebGpuPrimitiveState(descriptor ?? new PrimitiveStateDescriptor());
+    public createPrimitiveState(descriptor?: IPrimitiveStateDescriptor): IPrimitiveState {
+        return new WebGpuPrimitiveState(descriptor);
     }
 
     /** @inheritDoc */

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

@@ -36,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) {

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/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;
-}