ris-framework 0.1.0 → 0.2.0-dev.12

package/src/api/rendering/render-pipelines/IForwardBlinnPhongRenderPipeline.ts

@@ -0,0 +1,66 @@
+import type { ITexture2D } from "../texture/ITexture2D.ts";
+import type { ISampler } from "../sampler/ISampler.ts";
+import type { IRenderPipeline } from "./IRenderPipeline.ts";
+import type { IUniformBuffer } from "../buffers/IUniformBuffer.ts";
+
+/**
+ * The Blinn-Phong render pipeline with forward lighting.
+ */
+export interface IForwardBlinnPhongRenderPipeline extends IRenderPipeline {
+
+    /**
+     * The diffuse texture.
+     */
+    diffuseTexture: ITexture2D;
+
+    /**
+     * The texture sampler.
+     */
+    diffuseTextureSampler?: ISampler;
+
+    /**
+     * The projection view uniform buffer.
+     * Contains a single matrix representing the projection view matrix.
+     */
+    projectionViewBuffer: IUniformBuffer;
+
+    /**
+     * The world matrix uniform buffer.
+     * Contains a single matrix representing the world matrix.
+     */
+    modelBuffer: IUniformBuffer;
+
+    /**
+     * The material buffer that contains the material properties.
+     * - vec3 ambientColor
+     * - vec3 diffuseColor
+     * - vec3 specularColor
+     * - float shininess
+     */
+    materialBuffer: IUniformBuffer;
+
+    /** The camera position buffer: std140 `vec3` world-space eye, e.g. `camera.positionBuffer`. */
+    cameraPositionBuffer: IUniformBuffer;
+
+    /**
+     * The lights buffer, `LightsBuffer.buffer`, bound to the shader's `LightsBuffer` block.
+     * - vec3 ambientLight
+     * - DirectionalLight[DIRECTIONAL_LIGHTS_COUNT] { vec3 light; vec3 direction; }
+     * - PointLight[POINT_LIGHTS_COUNT] { vec3 light; float constant; vec3 position; float linear; float quadratic; }
+     */
+    lightsBuffer: IUniformBuffer;
+
+    /** The directional light slots the shader was compiled with. */
+    readonly maxDirectionalLights: number;
+
+    /** The point light slots the shader was compiled with. */
+    readonly maxPointLights: number;
+
+    /**
+     * Sets the light slot counts. They must match the lights buffer (`LightsBuffer.maxDirectionalLights`/`maxPointLights`).
+     * When they change after initialization the shader variant for the new counts is loaded.
+     * @param maxDirectionalLights The directional light slots.
+     * @param maxPointLights The point light slots.
+     */
+    setLightCounts(maxDirectionalLights: number, maxPointLights: number): void;
+}

package/src/api/rendering/render-pipelines/IRenderPipeline.ts

@@ -4,6 +4,7 @@ import type { IPrimitiveState } from "../primitive/IPrimitiveState.ts";
 import type { IVertexBufferLayout } from "../buffers/IVertexBufferLayout.ts";
 import type { IIndexBuffer } from "../buffers/IIndexBuffer.ts";
 import type { IVertexBuffer } from "../buffers/IVertexBuffer.ts";
+import type { GeometryFormat } from "../../geometry/GeometryFormat.ts";
 
 /**
  * The render pipeline interface.
@@ -27,6 +28,9 @@ export interface IRenderPipeline extends IDisposable {
      */
     readonly vertexBufferLayouts: IVertexBufferLayout[];
 
+    /** The geometry format required by the render pipeline. */
+    readonly geometryFormat: GeometryFormat;
+
     /**
      * Initializes the render pipeline.
      *     This method is called by the renderer when the pipeline is added to the renderer.

package/src/api/rendering/render-pipelines/IRenderPipelineFactory.ts

@@ -5,6 +5,38 @@ import type { ISpriteRenderPipeline } from "./ISpriteRenderPipeline.ts";
 import type { IInspectTextureMipsRenderPipeline } from "./IInspectTextureMipsRenderPipeline.ts";
 import type { IUnlitRenderPipeline } from "./IUnlitRenderPipeline.ts";
 import type { IPrimitiveState } from "../primitive/IPrimitiveState.ts";
+import type { IForwardBlinnPhongRenderPipeline } from "./IForwardBlinnPhongRenderPipeline.ts";
+
+/** The descriptor for the forward Blinn-Phong render pipeline. */
+export interface ForwardBlinnPhongRenderPipelineDescriptor {
+
+    /** The projection view buffer, e.g. `camera.projectionViewBuffer`. */
+    projectionViewBuffer: IUniformBuffer;
+
+    /** The world buffer. */
+    modelBuffer: IUniformBuffer;
+
+    /** The camera position buffer, e.g. `camera.positionBuffer`: std140 `vec3` world-space eye. */
+    cameraPositionBuffer: IUniformBuffer;
+
+    /** The material buffer (ambient and diffuse color). */
+    materialBuffer: IUniformBuffer;
+
+    /**
+     * The lights buffer, e.g. `lightsBuffer.buffer`.
+     * Optional: it can be set later through `pipeline.lightsBuffer`.
+     */
+    lightsBuffer?: IUniformBuffer;
+
+    /** Directional light slots to compile the shader with; must match the lights buffer. Defaults to `DEFAULT_DIRECTIONAL_LIGHTS_COUNT`. */
+    maxDirectionalLights?: number;
+
+    /** Point light slots to compile the shader with; must match the lights buffer. Defaults to `DEFAULT_POINT_LIGHTS_COUNT`. */
+    maxPointLights?: number;
+
+    /** The primitive state. */
+    primitiveState?: IPrimitiveState;
+}
 
 /**
  * The pipeline factory.
@@ -49,4 +81,11 @@ export interface IRenderPipelineFactory {
                               primitiveState?: IPrimitiveState
                               ): IUnlitRenderPipeline;
 
+    /**
+     * Creates the forward Blinn-Phong render pipeline.
+     * @param descriptor - The buffers and primitive state for the pipeline.
+     * @returns The forward Blinn-Phong render pipeline.
+     */
+    createForwardBlinnPhongRenderPipeline(descriptor: ForwardBlinnPhongRenderPipelineDescriptor): IForwardBlinnPhongRenderPipeline;
+
 }

package/src/api/rendering/render-pipelines/_export-render-pipelines.ts

@@ -3,4 +3,5 @@ export * from "./IMainRenderTargetRenderPipeline.ts";
 export * from "./IRenderPipelineFactory.ts";
 export * from "./IRenderPipeline.ts";
 export * from "./IInspectTextureMipsRenderPipeline.ts"
-export * from "./IUnlitRenderPipeline.ts"
+export * from "./IUnlitRenderPipeline.ts"
+export * from "./IForwardBlinnPhongRenderPipeline.ts"

package/src/api/rendering/renderer-interface.ts

@@ -1,56 +1,21 @@
 import { vec2 } from "gl-matrix";
-import { TextureSamplerFilteringPreset } from "../../core/rendering/enums.ts";
 import type {RenderingLimits} from "./rendering-limits.ts";
-import type {Color, IGraphicsDevice, IRenderer} from "../index.ts";
+import type { IRenderer} from "../index.ts";
 import type {TextureFormat} from "../index.ts";
-import {PowerPreferenceType} from "./PowerPreference.ts";
 
-export const RenderConfigurationSymbol = Symbol("RenderConfiguration");
 
-/**
- * The configuration for the renderer. This is used to initialize the renderer.
- * @internal
- */
-export interface IRendererConfiguration {
-
-    /**The size of the main frame buffer. */
-    backBufferSize: vec2;
 
-    /** Should back buffer use alpha. */
-    alpha: boolean;
-
-    /** The preference when it comes to selecting GPU device. Only makes sense to set on multi-GPU devices. */
-    powerPreference: PowerPreferenceType;
-
-    /**
-     * The preset for texture sampler filtering.
-     *  This is used to configure the default texture sampler in the graphics device. 
-     * The default texture sampler is used when a texture is sampled without a specific sampler being bound.
-     */
-    textureFiltering: TextureSamplerFilteringPreset;
-}
 
 /**
  * The interface for renderers.
  */
 export interface ITempRenderer extends IRenderer {
 
-    /**
-     * The clear color used by the renderer.
-     */
-    clearColor: Color
-
     /**
      * The rendering limits of the renderer.
      */
     limits: RenderingLimits | null;
 
-    /**
-     * The graphics device used by the renderer. 
-     * This is used to create resources and manage the rendering context.
-     */
-    readonly graphicsDevice: IGraphicsDevice;
-
     /**
      * The preferred texture format for the renderer.
      * @returns The preferred texture format for the renderer.

package/src/api/rendering/renderpass/RenderPassDescriptor.ts

@@ -6,21 +6,17 @@ import {RenderPassColorAttachment} from "./RenderPassColorAttachment.ts";
  */
 export class RenderPassDescriptor {
 
-/**
- * The color attachments of the render pass.
- */
-  public colorAttachments?: RenderPassColorAttachment[];
+    /** The color attachments of the render pass. */
+    public colorAttachments?: RenderPassColorAttachment[];
 
-/**
- * The depth-stencil attachment of the render pass.
- */
-  public  depthStencilAttachment?: RenderPassDepthStencilAttachment;
+    /** The depth-stencil attachment of the render pass. */
+    public depthStencilAttachment?: RenderPassDepthStencilAttachment;
 
-/**
- * The label of the render pass.
- * This is used for debugging purposes and can be set to any string that helps identify the render pass in graphics debuggers or profiling tools.
- * It does not affect the functionality of the render pass and can be left empty if not needed.
- */
-  public label?: string;
+    /**
+     * The label of the render pass.
+     * This is used for debugging purposes and can be set to any string that helps identify the render pass in graphics debuggers or profiling tools.
+     * It does not affect the functionality of the render pass and can be left empty if not needed.
+     */
+    public label?: string;
 
 }

package/src/api/rendering/swapchain/ISwapChain.ts

@@ -12,9 +12,7 @@ export interface ISwapChain extends IDisposable {
      */
     readonly backBufferSize: vec2;
 
-    /**
-     * The texture format of the back buffer.
-     */
+    /** The texture format of the back buffer. */
     readonly textureFormat: TextureFormat;
 
     /**

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

@@ -6,53 +6,167 @@ export enum TextureFormat {
      * Default value.
      For unknown texture format.
      */
-    UNDEFINED = 0,
+    UNDEFINED = "UNDEFINED",
 
     /**
      * Red, green, blue, and alpha channels.
      * 8-bit integer per channel.
      * [0, 255] converted to/from float [0, 1] in shader.
      * */
-    RGBA_8_UNORM = 1,
+    RGBA_8_UNORM = "RGBA_8_UNORM",
 
     /**
      * Red, green, blue, and alpha channels.
      * 8-bit integer per channel.
      * Srgb-color [0, 255] converted to/from linear-color float [0, 1] in shader.
      */
-    RGBA_8_UNORM_SRGB = 2,
+    RGBA_8_UNORM_SRGB = "RGBA_8_UNORM_SRGB",
 
     /**
      * Depth 24 and stencil 8.
      */
-    DEPTH_24_STENCIL_8 = 3,
+    DEPTH_24_STENCIL_8 = "DEPTH_24_STENCIL_8",
 
     /**
      * The depth 32 float.
      */
-    DEPTH_32_FLOAT = 4,
+    DEPTH_32_FLOAT = "DEPTH_32_FLOAT_8",
 
-    RED_32_FLOAT = 5,
+    RED_32_FLOAT = "RED_32_FLOAT_8",
     /**
      * The 32-bit float format with one red component. It is typeless.
 
      Valid only for D3D11.
      */
-    RED_32_TYPELESS = 6,
+    RED_32_TYPELESS = "RED_32_TYPELE_8",
     /**
      * The BC7 compressed format with four 8-bit normalized unsigned integer components in RGBA order.
      */
-    BC7_RGBA_UNORM = 7,
+    BC7_RGBA_UNORM = "BC7_RGBA_UNORM",
     /**
      * The BC3 compressed format with four 8-bit normalized unsigned integer components in RGBA order.
      */
-    BC3_RGBA_UNORM = 8,
+    BC3_RGBA_UNORM = "BC3_RGBA_UNORM",
     /**
      * The ETC2 compressed format with four 8-bit normalized unsigned integer components in RGBA order.
      */
-    ETC2_RGBA8_UNORM = 9,
-    /**
-     * The ASTC 4x4 compressed format with four 8-bit normalized unsigned integer components in RGBA order.
-     */
-    ASTC_4X4_RGBA = 10
+    ETC2_RGBA8_UNORM = "ETC2_RGBA8_UNORM",
+
+    /** BC7 RGBA, sRGB. Requires EXT_texture_compression_bptc (WebGL) or texture-compression-bc (WebGPU). */
+    BC7_RGBA_SRGB = "BC7_RGBA_SRGB",
+
+    /** BC3 (DXT5) RGBA, sRGB. Requires WEBGL_compressed_texture_s3tc_srgb (WebGL) or texture-compression-bc (WebGPU). */
+    BC3_RGBA_SRGB = "BC3_RGBA_SRGB",
+
+    /** BC1 (DXT1) RGB. Requires WEBGL_compressed_texture_s3tc (WebGL) or texture-compression-bc (WebGPU). */
+    BC1_RGB_UNORM = "BC1_RGB_UNORM",
+
+    /** BC1 (DXT1) RGB, sRGB. Requires WEBGL_compressed_texture_s3tc_srgb (WebGL). WebGPU only has BC1 RGBA, which is used instead. */
+    BC1_RGB_SRGB = "BC1_RGB_SRGB",
+
+    /** ETC2 RGBA8 with EAC alpha, sRGB. Requires WEBGL_compressed_texture_etc (WebGL) or texture-compression-etc2 (WebGPU). */
+    ETC2_RGBA8_SRGB = "ETC2_RGBA8_SRGB",
+
+    /** ETC2 RGB8. Requires WEBGL_compressed_texture_etc (WebGL) or texture-compression-etc2 (WebGPU). */
+    ETC2_RGB8_UNORM = "ETC2_RGB8_UNORM",
+
+    /** ETC2 RGB8, sRGB. Requires WEBGL_compressed_texture_etc (WebGL) or texture-compression-etc2 (WebGPU). */
+    ETC2_RGB8_SRGB = "ETC2_RGB8_SRGB",
+
+
+    /** The ASTC 4x4 compressed format with four 8-bit normalized unsigned integer components in RGBA order. */
+    ASTC_4X4_RGBA_UNORM = "ASTC_4X4_RGBA_UNORM",
+
+    /** The ASTC 4x4 compressed format with four 8-bit normalized unsigned integer components in RGBA order, sRGB-encoded color. */
+    ASTC_4X4_RGBA_SRGB = "ASTC_4X4_RGBA_SRGB",
+
+    /** The ASTC 5x4 compressed format with four 8-bit normalized unsigned integer components in RGBA order. */
+    ASTC_5X4_RGBA_UNORM = "ASTC_5X4_RGBA_UNORM",
+
+    /** The ASTC 5x4 compressed format with four 8-bit normalized unsigned integer components in RGBA order, sRGB-encoded color. */
+    ASTC_5X4_RGBA_SRGB = "ASTC_5X4_RGBA_SRGB",
+
+    /** The ASTC 5x5 compressed format with four 8-bit normalized unsigned integer components in RGBA order. */
+    ASTC_5X5_RGBA_UNORM = "ASTC_5X5_RGBA_UNORM",
+
+    /** The ASTC 5x5 compressed format with four 8-bit normalized unsigned integer components in RGBA order, sRGB-encoded color. */
+    ASTC_5X5_RGBA_SRGB = "ASTC_5X5_RGBA_SRGB",
+
+    /** The ASTC 6x5 compressed format with four 8-bit normalized unsigned integer components in RGBA order. */
+    ASTC_6X5_RGBA_UNORM = "ASTC_6X5_RGBA_UNORM",
+
+    /** The ASTC 6x5 compressed format with four 8-bit normalized unsigned integer components in RGBA order, sRGB-encoded color. */
+    ASTC_6X5_RGBA_SRGB = "ASTC_6X5_RGBA_SRGB",
+
+    /** The ASTC 6x6 compressed format with four 8-bit normalized unsigned integer components in RGBA order. */
+    ASTC_6X6_RGBA_UNORM = "ASTC_6X6_RGBA_UNORM",
+
+    /** The ASTC 6x6 compressed format with four 8-bit normalized unsigned integer components in RGBA order, sRGB-encoded color. */
+    ASTC_6X6_RGBA_SRGB = "ASTC_6X6_RGBA_SRGB",
+
+    /** The ASTC 8x5 compressed format with four 8-bit normalized unsigned integer components in RGBA order. */
+    ASTC_8X5_RGBA_UNORM = "ASTC_8X5_RGBA_UNORM",
+
+    /** The ASTC 8x5 compressed format with four 8-bit normalized unsigned integer components in RGBA order, sRGB-encoded color. */
+    ASTC_8X5_RGBA_SRGB = "ASTC_8X5_RGBA_SRGB",
+
+    /** The ASTC 8x6 compressed format with four 8-bit normalized unsigned integer components in RGBA order. */
+    ASTC_8X6_RGBA_UNORM = "ASTC_8X6_RGBA_UNORM",
+
+    /** The ASTC 8x6 compressed format with four 8-bit normalized unsigned integer components in RGBA order, sRGB-encoded color. */
+    ASTC_8X6_RGBA_SRGB = "ASTC_8X6_RGBA_SRGB",
+
+    /** The ASTC 8x8 compressed format with four 8-bit normalized unsigned integer components in RGBA order. */
+    ASTC_8X8_RGBA_UNORM = "ASTC_8X8_RGBA_UNORM",
+
+    /** The ASTC 8x8 compressed format with four 8-bit normalized unsigned integer components in RGBA order, sRGB-encoded color. */
+    ASTC_8X8_RGBA_SRGB = "ASTC_8X8_RGBA_SRGB",
+
+    /** The ASTC 10x5 compressed format with four 8-bit normalized unsigned integer components in RGBA order. */
+    ASTC_10X5_RGBA_UNORM = "ASTC_10X5_RGBA_UNORM",
+
+    /** The ASTC 10x5 compressed format with four 8-bit normalized unsigned integer components in RGBA order, sRGB-encoded color. */
+    ASTC_10X5_RGBA_SRGB = "ASTC_10X5_RGBA_SRGB",
+
+    /** The ASTC 10x6 compressed format with four 8-bit normalized unsigned integer components in RGBA order. */
+    ASTC_10X6_RGBA_UNORM = "ASTC_10X6_RGBA_UNORM",
+
+    /** The ASTC 10x6 compressed format with four 8-bit normalized unsigned integer components in RGBA order, sRGB-encoded color. */
+    ASTC_10X6_RGBA_SRGB = "ASTC_10X6_RGBA_SRGB",
+
+    /** The ASTC 10x8 compressed format with four 8-bit normalized unsigned integer components in RGBA order. */
+    ASTC_10X8_RGBA_UNORM = "ASTC_10X8_RGBA_UNORM",
+
+    /** The ASTC 10x8 compressed format with four 8-bit normalized unsigned integer components in RGBA order, sRGB-encoded color. */
+    ASTC_10X8_RGBA_SRGB = "ASTC_10X8_RGBA_SRGB",
+
+    /** The ASTC 10x10 compressed format with four 8-bit normalized unsigned integer components in RGBA order. */
+    ASTC_10X10_RGBA_UNORM = "ASTC_10X10_RGBA_UNORM",
+
+    /** The ASTC 10x10 compressed format with four 8-bit normalized unsigned integer components in RGBA order, sRGB-encoded color. */
+    ASTC_10X10_RGBA_SRGB = "ASTC_10X10_RGBA_SRGB",
+
+    /** The ASTC 12x10 compressed format with four 8-bit normalized unsigned integer components in RGBA order. */
+    ASTC_12X10_RGBA_UNORM = "ASTC_12X10_RGBA_UNORM",
+
+    /** The ASTC 12x10 compressed format with four 8-bit normalized unsigned integer components in RGBA order, sRGB-encoded color. */
+    ASTC_12X10_RGBA_SRGB = "ASTC_12X10_RGBA_SRGB",
+
+    /** The ASTC 12x12 compressed format with four 8-bit normalized unsigned integer components in RGBA order. */
+    ASTC_12X12_RGBA_UNORM = "ASTC_12X12_RGBA_UNORM",
+
+    /** The ASTC 12x12 compressed format with four 8-bit normalized unsigned integer components in RGBA order, sRGB-encoded color. */
+    ASTC_12X12_RGBA_SRGB = "ASTC_12X12_RGBA_SRGB",
+
+    /** The PVRTC1 compressed format at 4 bits per pixel with RGBA components. Requires WEBGL_compressed_texture_pvrtc. */
+    PVRTC_4BPPV1_RGBA = "PVRTC_4BPPV1_RGBA",
+
+    /** The PVRTC1 compressed format at 4 bits per pixel with RGB components. Requires WEBGL_compressed_texture_pvrtc. */
+    PVRTC_4BPPV1_RGB = "PVRTC_4BPPV1_RGB",
+
+    /** The PVRTC1 compressed format at 2 bits per pixel with RGBA components. Requires WEBGL_compressed_texture_pvrtc. */
+    PVRTC_2BPPV1_RGBA = "PVRTC_2BPPV1_RGBA",
+
+    /** The PVRTC1 compressed format at 2 bits per pixel with RGB components. Requires WEBGL_compressed_texture_pvrtc. */
+    PVRTC_2BPPV1_RGB = "PVRTC_2BPPV1_RGB",
 }