ris-framework 0.1.0-dev.7 → 0.1.0-dev.9

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

@@ -0,0 +1,14 @@
+/**
+ * The front face winding order.
+ */
+export declare enum FrontFace {
+    /**
+     * The clockwise winding order.
+     */
+    CW = 0,
+    /**
+     * The counter-clockwise winding order.
+     */
+    CCW = 1
+}
+//# sourceMappingURL=FrontFace.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"FrontFace.d.ts","sourceRoot":"","sources":["../../../../src/api/rendering/primitive/FrontFace.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,oBAAY,SAAS;IACrB;;OAEG;IACD,EAAE,IAAI;IACR;;OAEG;IACD,GAAG,IAAI;CACR"}

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

@@ -0,0 +1,22 @@
+import { FrontFace } from "./FrontFace.js";
+import { CullMode } from "./CullMode.js";
+import { PrimitiveTopology } from "./PrimitiveTopology.js";
+/**
+ * The primitive state.
+ *     Describes the primitive to be rendered and how it should be rendered.
+ */
+export interface IPrimitiveState {
+    /**
+     * The topology of the primitive.
+     */
+    readonly topology: PrimitiveTopology;
+    /**
+     * The culling mode.
+     */
+    readonly cullFace: CullMode;
+    /**
+     * The front face.
+     */
+    readonly frontFace: FrontFace;
+}
+//# sourceMappingURL=IPrimitiveState.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"IPrimitiveState.d.ts","sourceRoot":"","sources":["../../../../src/api/rendering/primitive/IPrimitiveState.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,SAAS,EAAC,MAAM,gBAAgB,CAAC;AACzC,OAAO,EAAC,QAAQ,EAAC,MAAM,eAAe,CAAC;AACvC,OAAO,EAAC,iBAAiB,EAAC,MAAM,wBAAwB,CAAC;AAEzD;;;GAGG;AACH,MAAM,WAAW,eAAe;IAE5B;;OAEG;IACH,QAAQ,CAAC,QAAQ,EAAE,iBAAiB,CAAC;IAErC;;OAEG;IACH,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC;IAE5B;;OAEG;IACH,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAC;CACjC"}

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

@@ -0,0 +1,24 @@
+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

@@ -0,0 +1 @@
+{"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/primitive/PrimitiveTopology.d.ts

@@ -0,0 +1,26 @@
+/**
+ * The primitive topology.
+ */
+export declare enum PrimitiveTopology {
+    /**
+     * Each consecutive pair of two vertices defines a line primitive.
+     */
+    LINE_LIST = 0,
+    /**
+     * Each vertex after the first defines a line primitive between it and the previous vertex.
+     */
+    LINE_STRIP = 1,
+    /**
+     * Each vertex defines a point primitive.
+     */
+    POINT_LIST = 2,
+    /**
+     * Each consecutive triplet of three vertices defines a triangle primitive.
+     */
+    TRIANGLE_LIST = 3,
+    /**
+     * Each vertex after the first two defines a triangle primitive between it and the previous two vertices.
+     */
+    TRIANGLE_STRIP = 4
+}
+//# sourceMappingURL=PrimitiveTopology.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"PrimitiveTopology.d.ts","sourceRoot":"","sources":["../../../../src/api/rendering/primitive/PrimitiveTopology.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,oBAAY,iBAAiB;IAC7B;;OAEG;IACD,SAAS,IAAI;IACf;;OAEG;IACD,UAAU,IAAI;IAChB;;OAEG;IACD,UAAU,IAAI;IAChB;;OAEG;IACD,aAAa,IAAI;IACnB;;OAEG;IACD,cAAc,IAAI;CACnB"}

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

@@ -0,0 +1,6 @@
+export * from "./CullMode.js";
+export * from "./FrontFace.js";
+export * from "./IPrimitiveState.js";
+export * from "./PrimitiveTopology.js";
+export * from "./PrimitiveStateDescriptor.js";
+//# sourceMappingURL=_export.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"_export.d.ts","sourceRoot":"","sources":["../../../../src/api/rendering/primitive/_export.ts"],"names":[],"mappings":"AAAA,cAAc,eAAe,CAAA;AAC7B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,sBAAsB,CAAA;AACpC,cAAc,wBAAwB,CAAA;AACtC,cAAc,+BAA+B,CAAA"}

package/dist/api/rendering/render-pipelines/IInspectTextureMipsRenderPipeline.d.ts

@@ -0,0 +1,33 @@
+import type { ITexture2D } from "../texture/ITexture2D.js";
+import type { ISampler } from "../sampler/ISampler.js";
+import type { IUniformBuffer } from "../buffers/IUniformBuffer.js";
+import type { IRenderPipeline } from "./IRenderPipeline.js";
+/**
+ * The pipeline for inspecting texture mip levels.
+ */
+export interface IInspectTextureMipsRenderPipeline extends IRenderPipeline {
+    /**
+     * The diffuse texture.
+     */
+    spriteTexture: ITexture2D;
+    /**
+     * The texture sampler.
+     */
+    textureSampler?: 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 buffer of texture constants.
+     * For now, it is just a single float value representing the mip level.
+     */
+    textureConstantsBuffer: IUniformBuffer;
+}
+//# sourceMappingURL=IInspectTextureMipsRenderPipeline.d.ts.map

package/dist/api/rendering/render-pipelines/IInspectTextureMipsRenderPipeline.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"IInspectTextureMipsRenderPipeline.d.ts","sourceRoot":"","sources":["../../../../src/api/rendering/render-pipelines/IInspectTextureMipsRenderPipeline.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,0BAA0B,CAAC;AAC3D,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,wBAAwB,CAAC;AACvD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,8BAA8B,CAAC;AACnE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAE5D;;GAEG;AACH,MAAM,WAAW,iCAAkC,SAAQ,eAAe;IAEtE;;OAEG;IACH,aAAa,EAAE,UAAU,CAAC;IAE1B;;OAEG;IACH,cAAc,CAAC,EAAE,QAAQ,CAAC;IAE1B;;;OAGG;IACH,oBAAoB,EAAE,cAAc,CAAC;IAErC;;;OAGG;IACH,WAAW,EAAE,cAAc,CAAC;IAE5B;;;OAGG;IACH,sBAAsB,EAAE,cAAc,CAAC;CAC1C"}

package/dist/api/rendering/render-pipelines/IMainRenderTargetRenderPipeline.d.ts

@@ -0,0 +1,18 @@
+import type { IRenderPipeline } from "./IRenderPipeline.js";
+import type { ITexture2D } from "../texture/ITexture2D.js";
+/**
+ * Pipeline that is used in renderer as
+ * a pass that renders from the main frame buffer to the screen.
+ */
+export interface IMainRenderTargetRenderPipeline extends IRenderPipeline {
+    /**
+     * The texture that is used as a main frame buffer.
+     * The pipeline will render this texture to the screen.
+     */
+    readonly mainRenderTarget: ITexture2D;
+    /**
+     * Render to the screen.
+     */
+    render(): void;
+}
+//# sourceMappingURL=IMainRenderTargetRenderPipeline.d.ts.map

package/dist/api/rendering/render-pipelines/IMainRenderTargetRenderPipeline.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"IMainRenderTargetRenderPipeline.d.ts","sourceRoot":"","sources":["../../../../src/api/rendering/render-pipelines/IMainRenderTargetRenderPipeline.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAC5D,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,0BAA0B,CAAC;AAE3D;;;GAGG;AACH,MAAM,WAAW,+BAAgC,SAAQ,eAAe;IAEpE;;;OAGG;IACH,QAAQ,CAAC,gBAAgB,EAAE,UAAU,CAAC;IAEtC;;OAEG;IACH,MAAM,IAAI,IAAI,CAAC;CAElB"}

package/dist/api/rendering/render-pipelines/IRenderPipeline.d.ts

@@ -0,0 +1,39 @@
+import type { IBlendState } from "../blending/IBlendState.js";
+import type { IDisposable } from "../../core/IDisposable.js";
+import type { IPrimitiveState } from "../primitive/IPrimitiveState.js";
+import type { IVertexBufferLayout } from "../buffers/IVertexBufferLayout.js";
+import type { IIndexBuffer } from "../buffers/IIndexBuffer.js";
+import type { IVertexBuffer } from "../buffers/IVertexBuffer.js";
+/**
+ * The render pipeline interface.
+ * Render pipelines are responsible for defining the rendering process, including the shaders,
+ * the vertex buffer layout, the render targets, and the draw calls.
+ */
+export interface IRenderPipeline extends IDisposable {
+    /**
+     * The blend state of the render pipeline.
+     */
+    readonly blendState: IBlendState;
+    /**
+     * The primitive state of the render pipeline.
+     */
+    readonly primitiveState: IPrimitiveState;
+    /**
+     * The vertex buffer layout of the render pipeline.
+     */
+    readonly vertexBufferLayouts: IVertexBufferLayout[];
+    /**
+     * Initializes the render pipeline.
+     *     This method is called by the renderer when the pipeline is added to the renderer.
+     */
+    initialize(): void;
+    /**
+     * Draw the pipeline.
+     * @param vertexBuffer - The vertex buffer.
+     * @param indexBuffer - The index buffer.
+     * @param indicesCount - The number of indices to draw. If -1 draws all indices.
+     * @param indicesOffset - Indices offset. By default, 0 for no offset.
+     */
+    render(vertexBuffer: IVertexBuffer, indexBuffer: IIndexBuffer, indicesCount?: number, indicesOffset?: number): void;
+}
+//# sourceMappingURL=IRenderPipeline.d.ts.map

package/dist/api/rendering/render-pipelines/IRenderPipeline.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"IRenderPipeline.d.ts","sourceRoot":"","sources":["../../../../src/api/rendering/render-pipelines/IRenderPipeline.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAC;AAC9D,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,2BAA2B,CAAC;AAC7D,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,iCAAiC,CAAC;AACvE,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,mCAAmC,CAAC;AAC7E,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAC;AAC/D,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,6BAA6B,CAAC;AAEjE;;;;GAIG;AACH,MAAM,WAAW,eAAgB,SAAQ,WAAW;IAEhD;;OAEG;IACH,QAAQ,CAAC,UAAU,EAAE,WAAW,CAAC;IAEjC;;OAEG;IACH,QAAQ,CAAC,cAAc,EAAE,eAAe,CAAC;IAEzC;;OAEG;IACH,QAAQ,CAAC,mBAAmB,EAAE,mBAAmB,EAAE,CAAC;IAEpD;;;OAGG;IACH,UAAU,IAAI,IAAI,CAAC;IAEnB;;;;;;OAMG;IACH,MAAM,CAAC,YAAY,EAAE,aAAa,EAAE,WAAW,EAAE,YAAY,EACtD,YAAY,CAAC,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAG/D"}

package/dist/api/rendering/render-pipelines/IRenderPipelineFactory.d.ts

@@ -0,0 +1,42 @@
+import type { ITexture2D } from "../texture/ITexture2D.js";
+import type { IMainRenderTargetRenderPipeline } from "./IMainRenderTargetRenderPipeline.js";
+import type { IUniformBuffer } from "../buffers/IUniformBuffer.js";
+import type { ISpriteRenderPipeline } from "./ISpriteRenderPipeline.js";
+import type { IInspectTextureMipsRenderPipeline } from "./IInspectTextureMipsRenderPipeline.js";
+import type { IUnlitRenderPipeline } from "./IUnlitRenderPipeline.js";
+import type { IPrimitiveState } from "../primitive/IPrimitiveState.js";
+/**
+ * The pipeline factory.
+ */
+export interface IRenderPipelineFactory {
+    /**
+     * Creates the main render target pipeline.
+     * @param mainFrameBuffer - The texture acting as a main frame buffer.
+     * @returns The main render target render pipeline.
+     */
+    createMainFrameBufferPipeline(mainFrameBuffer: ITexture2D): IMainRenderTargetRenderPipeline;
+    /**
+     * Creates the sprite render pipeline.
+     * @param projectionViewBuffer - The projection view buffer.
+     * @returns The sprite render pipeline.
+     */
+    createSpriteRenderPipeline(projectionViewBuffer: IUniformBuffer): ISpriteRenderPipeline;
+    /**
+     * Creates the inspect texture mip level pipeline.
+     * @param projectionViewBuffer - The projection view buffer.
+     * @param modelBuffer - The world buffer.
+     * @param textureConstantsBuffer - The texture constants buffer.
+     * @returns The inspect texture mips render pipeline.
+     */
+    createInspectTextureMipsRenderPipeline(projectionViewBuffer: IUniformBuffer, modelBuffer: IUniformBuffer, textureConstantsBuffer: IUniformBuffer): IInspectTextureMipsRenderPipeline;
+    /**
+     * Creates the unlit render pipeline.
+     * @param projectionViewBuffer - The projection view buffer.
+     * @param modelBuffer - The world buffer.
+     * @param materialBuffer - The material buffer.
+     * @param primitiveState - The primitive state.
+     * @returns The unlit render pipeline.
+     */
+    createUnlitRenderPipeline(projectionViewBuffer: IUniformBuffer, modelBuffer: IUniformBuffer, materialBuffer: IUniformBuffer, primitiveState?: IPrimitiveState): IUnlitRenderPipeline;
+}
+//# sourceMappingURL=IRenderPipelineFactory.d.ts.map

package/dist/api/rendering/render-pipelines/IRenderPipelineFactory.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"IRenderPipelineFactory.d.ts","sourceRoot":"","sources":["../../../../src/api/rendering/render-pipelines/IRenderPipelineFactory.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,0BAA0B,CAAC;AAC3D,OAAO,KAAK,EAAE,+BAA+B,EAAE,MAAM,sCAAsC,CAAC;AAC5F,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,8BAA8B,CAAC;AACnE,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAC;AACxE,OAAO,KAAK,EAAE,iCAAiC,EAAE,MAAM,wCAAwC,CAAC;AAChG,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAC;AACtE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,iCAAiC,CAAC;AAEvE;;GAEG;AACH,MAAM,WAAW,sBAAsB;IAEnC;;;;OAIG;IACH,6BAA6B,CAAC,eAAe,EAAE,UAAU,GAAG,+BAA+B,CAAC;IAE5F;;;;OAIG;IACH,0BAA0B,CAAC,oBAAoB,EAAE,cAAc,GAAG,qBAAqB,CAAC;IAExF;;;;;;OAMG;IACH,sCAAsC,CAAC,oBAAoB,EAAE,cAAc,EAAE,WAAW,EAAE,cAAc,EAAE,sBAAsB,EAAE,cAAc,GAAG,iCAAiC,CAAC;IAGrL;;;;;;;OAOG;IACH,yBAAyB,CAAC,oBAAoB,EAAE,cAAc,EACpC,WAAW,EAAE,cAAc,EAC3B,cAAc,EAAE,cAAc,EAC9B,cAAc,CAAC,EAAE,eAAe,GAC7B,oBAAoB,CAAC;CAErD"}

package/dist/api/rendering/render-pipelines/ISpriteRenderPipeline.d.ts

@@ -0,0 +1,22 @@
+import type { IUniformBuffer } from "../buffers/IUniformBuffer.js";
+import type { ITexture2D } from "../texture/ITexture2D.js";
+import type { ISampler } from "../sampler/ISampler.js";
+import type { IRenderPipeline } from "./IRenderPipeline.js";
+/**
+ * The pipeline for sprite rendering.
+ */
+export interface ISpriteRenderPipeline extends IRenderPipeline {
+    /**
+     * The diffuse texture.
+     */
+    spriteTexture: ITexture2D;
+    /**
+     * The sampler.
+     */
+    textureSampler?: ISampler;
+    /**
+     * The projection view uniform buffer.
+     */
+    projectionViewBuffer: IUniformBuffer;
+}
+//# sourceMappingURL=ISpriteRenderPipeline.d.ts.map

package/dist/api/rendering/render-pipelines/ISpriteRenderPipeline.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ISpriteRenderPipeline.d.ts","sourceRoot":"","sources":["../../../../src/api/rendering/render-pipelines/ISpriteRenderPipeline.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,8BAA8B,CAAC;AACnE,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,0BAA0B,CAAC;AAC3D,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,wBAAwB,CAAC;AACvD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAE5D;;GAEG;AACH,MAAM,WAAW,qBAAsB,SAAQ,eAAe;IAE1D;;OAEG;IACH,aAAa,EAAE,UAAU,CAAC;IAE1B;;OAEG;IACH,cAAc,CAAC,EAAE,QAAQ,CAAC;IAE1B;;OAEG;IACH,oBAAoB,EAAE,cAAc,CAAC;CACxC"}

package/dist/api/rendering/render-pipelines/IUnlitRenderPipeline.d.ts

@@ -0,0 +1,33 @@
+import type { ITexture2D } from "../texture/ITexture2D.js";
+import type { ISampler } from "../sampler/ISampler.js";
+import type { IRenderPipeline } from "./IRenderPipeline.js";
+import type { IUniformBuffer } from "../buffers/IUniformBuffer.js";
+/**
+ * The unlit render pipeline.
+ */
+export interface IUnlitRenderPipeline 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.
+     * - vec4 diffuseColor
+     */
+    materialBuffer: IUniformBuffer;
+}
+//# sourceMappingURL=IUnlitRenderPipeline.d.ts.map

package/dist/api/rendering/render-pipelines/IUnlitRenderPipeline.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"IUnlitRenderPipeline.d.ts","sourceRoot":"","sources":["../../../../src/api/rendering/render-pipelines/IUnlitRenderPipeline.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,0BAA0B,CAAC;AAC3D,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,wBAAwB,CAAC;AACvD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAC5D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,8BAA8B,CAAC;AAEnE;;GAEG;AACH,MAAM,WAAW,oBAAqB,SAAQ,eAAe;IAEzD;;OAEG;IACH,cAAc,EAAE,UAAU,CAAC;IAE3B;;OAEG;IACH,qBAAqB,CAAC,EAAE,QAAQ,CAAC;IAEjC;;;OAGG;IACH,oBAAoB,EAAE,cAAc,CAAC;IAErC;;;OAGG;IACH,WAAW,EAAE,cAAc,CAAC;IAE5B;;;OAGG;IACH,cAAc,EAAE,cAAc,CAAC;CAClC"}

package/dist/api/rendering/render-pipelines/_export-render-pipelines.d.ts

@@ -0,0 +1,7 @@
+export * from "./ISpriteRenderPipeline.js";
+export * from "./IMainRenderTargetRenderPipeline.js";
+export * from "./IRenderPipelineFactory.js";
+export * from "./IRenderPipeline.js";
+export * from "./IInspectTextureMipsRenderPipeline.js";
+export * from "./IUnlitRenderPipeline.js";
+//# sourceMappingURL=_export-render-pipelines.d.ts.map

package/dist/api/rendering/render-pipelines/_export-render-pipelines.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"_export-render-pipelines.d.ts","sourceRoot":"","sources":["../../../../src/api/rendering/render-pipelines/_export-render-pipelines.ts"],"names":[],"mappings":"AAAA,cAAc,4BAA4B,CAAC;AAC3C,cAAc,sCAAsC,CAAC;AACrD,cAAc,6BAA6B,CAAC;AAC5C,cAAc,sBAAsB,CAAC;AACrC,cAAc,wCAAwC,CAAA;AACtD,cAAc,2BAA2B,CAAA"}

package/dist/{core/renderer → api/rendering}/renderer-interface.d.ts

@@ -1,17 +1,21 @@
 import { vec2 } from "gl-matrix";
-import { TextureSamplerFilteringPreset } from "../rendering/enums";
+import { TextureSamplerFilteringPreset } from "../../core/rendering/enums.js";
 import type { RenderingLimits } from "./rendering-limits.js";
-import type { Color, IGraphicsDevice, IRenderer } from "ris-framework-api";
-import type { TextureFormat } from "ris-framework-api";
+import type { Color, IGraphicsDevice, IRenderer } from "../index.js";
+import type { TextureFormat } from "../index.js";
+import { PowerPreferenceType } from "./PowerPreference.js";
 export declare const RenderConfigurationSymbol: unique symbol;
 /**
  * The configuration for the renderer. This is used to initialize the renderer.
+ * @internal
  */
-export declare class RenderConfiguration {
-    /**
-     * The size of the main frame buffer. This is used to initialize the main render target.
-     */
+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.

package/dist/api/rendering/renderer-interface.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"renderer-interface.d.ts","sourceRoot":"","sources":["../../../src/api/rendering/renderer-interface.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACjC,OAAO,EAAE,6BAA6B,EAAE,MAAM,+BAA+B,CAAC;AAC9E,OAAO,KAAK,EAAC,eAAe,EAAC,MAAM,uBAAuB,CAAC;AAC3D,OAAO,KAAK,EAAC,KAAK,EAAE,eAAe,EAAE,SAAS,EAAC,MAAM,aAAa,CAAC;AACnE,OAAO,KAAK,EAAC,aAAa,EAAC,MAAM,aAAa,CAAC;AAC/C,OAAO,EAAC,mBAAmB,EAAC,MAAM,sBAAsB,CAAC;AAEzD,eAAO,MAAM,yBAAyB,eAAgC,CAAC;AAEvE;;;GAGG;AACH,MAAM,WAAW,sBAAsB;IAEnC,wCAAwC;IACxC,cAAc,EAAE,IAAI,CAAC;IAErB,oCAAoC;IACpC,KAAK,EAAE,OAAO,CAAC;IAEf,0GAA0G;IAC1G,eAAe,EAAE,mBAAmB,CAAC;IAErC;;;;OAIG;IACH,gBAAgB,EAAE,6BAA6B,CAAC;CACnD;AAED;;GAEG;AACH,MAAM,WAAW,aAAc,SAAQ,SAAS;IAE5C;;OAEG;IACH,UAAU,EAAE,KAAK,CAAA;IAEjB;;OAEG;IACH,MAAM,EAAE,eAAe,GAAG,IAAI,CAAC;IAE/B;;;OAGG;IACH,QAAQ,CAAC,cAAc,EAAE,eAAe,CAAC;IAEzC;;;OAGG;IACH,IAAI,sBAAsB,IAAI,aAAa,CAAC;IAE5C;;;OAGG;IACH,IAAI,2BAA2B,IAAI,aAAa,CAAC;IAEjD;;OAEG;IACH,cAAc,EAAE,IAAI,CAAC;IAErB;;;;OAIG;IACH,0BAA0B,EAAE,OAAO,CAAC;IAEpC;;OAEG;IACH,UAAU,IAAI,IAAI,CAAC;IAEnB;;;OAGG;IACH,eAAe,IAAI,IAAI,CAAC;IAExB;;OAEG;IACH,eAAe,IAAI,IAAI,CAAC;IAExB;;OAEG;IACH,aAAa,IAAI,IAAI,CAAC;CACzB"}

package/dist/{core/renderer → api/rendering}/rendering-limits.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"rendering-limits.d.ts","sourceRoot":"","sources":["../../../src/core/renderer/rendering-limits.ts"],"names":[],"mappings":"AAAA,qBAAa,eAAe;IAMZ,OAAO,CAAC,uBAAuB;IAJ3C;;;OAGG;gBACiB,uBAAuB,EAAE,MAAM;IAInD;;;;;OAKG;IACH,IAAW,sBAAsB,IAAK,MAAM,CAE3C;CACJ"}
+{"version":3,"file":"rendering-limits.d.ts","sourceRoot":"","sources":["../../../src/api/rendering/rendering-limits.ts"],"names":[],"mappings":"AAAA,qBAAa,eAAe;IAMZ,OAAO,CAAC,uBAAuB;IAJ3C;;;OAGG;gBACiB,uBAAuB,EAAE,MAAM;IAInD;;;;;OAKG;IACH,IAAW,sBAAsB,IAAK,MAAM,CAE3C;CACJ"}

package/dist/api/rendering/renderpass/IRenderPass.d.ts

@@ -0,0 +1,15 @@
+import type { IDisposable } from "../../core/IDisposable.js";
+/**
+ * The render pass interface.
+ */
+export interface IRenderPass extends IDisposable {
+    /**
+     * Begins the render pass. This will set up the necessary state and resources for the render pass to be executed.
+     */
+    beginPass(): void;
+    /**
+     * Ends the render pass. This will finalize the render pass and submit the recorded commands for execution.
+     */
+    endPass(): void;
+}
+//# sourceMappingURL=IRenderPass.d.ts.map

package/dist/api/rendering/renderpass/IRenderPass.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"IRenderPass.d.ts","sourceRoot":"","sources":["../../../../src/api/rendering/renderpass/IRenderPass.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,2BAA2B,CAAC;AAE7D;;GAEG;AACH,MAAM,WAAW,WAAY,SAAQ,WAAW;IAEhD;;OAEG;IACD,SAAS,IAAI,IAAI,CAAC;IAEpB;;OAEG;IACD,OAAO,IAAI,IAAI,CAAC;CAEjB"}

package/dist/api/rendering/renderpass/LoadAction.d.ts

@@ -0,0 +1,33 @@
+/**
+ * Specifies the action to take with the attachment contents at the beginning of a render pass.
+ */
+export declare enum LoadAction {
+    /**
+     * The attachment is cleared to a specified clear value at the start of the render pass.
+     *
+     *     On tile-based renderers (especially mobile),  is usually much cheaper than
+     *     because it avoids loading data from main memory into tile memory.
+     *
+     *     Recommended when the previous contents don't matter (e.g. rendering a skybox, full-screen quad, or when you know you'll overwrite everything).
+     *
+     *     Corresponds to WebGPU clear operation.
+     */
+    CLEAR = 0,
+    /**
+     * The existing contents of the attachment are loaded into the render pass.
+     *
+     *     Corresponds to WebGPU load operation.
+     */
+    LOAD = 1,
+    /**
+     * The attachment contents at the start of the render pass are undefined.
+     *     This is the fastest possible load operation if you guarantee that **every pixel** will be written before it is read.
+     *     Warning: Reading from any pixel (including via blending) before writing to it results in undefined behavior.
+     *
+     *     Backends that do not natively support "don't care" will fall back to another load operation (implementation-defined).
+     *
+     *     Corresponds to WebGPU undefined / discard (historically "dontcare").
+     */
+    UNDEFINED = 2
+}
+//# sourceMappingURL=LoadAction.d.ts.map

package/dist/api/rendering/renderpass/LoadAction.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"LoadAction.d.ts","sourceRoot":"","sources":["../../../../src/api/rendering/renderpass/LoadAction.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,oBAAY,UAAU;IACtB;;;;;;;;;OASG;IACD,KAAK,IAAI;IACX;;;;OAIG;IACD,IAAI,IAAI;IACV;;;;;;;;OAQG;IACD,SAAS,IAAI;CACd"}

package/dist/api/rendering/renderpass/RenderPassColorAttachment.d.ts

@@ -0,0 +1,53 @@
+import type { ISwapChain } from "../swapchain/ISwapChain.js";
+import { Color } from "../../data/Color.js";
+import type { ITexture2D } from "../texture/ITexture2D.js";
+import type { ITextureView } from "../texture/ITextureView.js";
+import { StoreAction } from "./StoreAction.js";
+import { LoadAction } from "./LoadAction.js";
+/**
+ * Color attachment for a render pass.
+ */
+export declare class RenderPassColorAttachment {
+    /**
+     * The swap chain to which the render pass will write for this attachment.
+     */
+    swapChain?: ISwapChain;
+    /**
+     * The texture to which the render pass will write for this attachment.
+     * Must be defined if view is not defined.
+     */
+    texture?: ITexture2D;
+    /**
+     * The view into  to which the render pass will write for this attachment.
+     * Must be defined if texture is not defined.
+     */
+    view?: ITextureView;
+    /**
+     * Whether data will be written to through this attachment.
+     * Note that resolve textures (if specified) are always written to, regardless of this setting.
+     * By default, it is set to STORE, which means that the data will be stored in memory after the render pass and can be read later.
+     */
+    storeAction: StoreAction;
+    /**
+     * How data should be read through this attachment.
+     *  By default, it is set to CLEAR, which means that the data will be cleared at the beginning of the render pass.
+     */
+    loadAction: LoadAction;
+    /**
+     * The texture that will receive the resolved output if multisampling is used.
+     * If set, it is always written to, regardless of how Self::ops is configured.
+     *
+     * Can be used instead of  if texture has default view or rendering
+     * backend does not support .
+     */
+    resolveTexture?: ITexture2D;
+    /**
+     * The texture view that will receive the resolved output if multisampling is used.
+     * If set, it is always written to, regardless of how Self::ops is configured.
+     * Can be used instead of  if rendering backend supports .
+     */
+    resolveView?: ITextureView;
+    /** Clear color for the attachment. */
+    clearColor: Color;
+}
+//# sourceMappingURL=RenderPassColorAttachment.d.ts.map

package/dist/api/rendering/renderpass/RenderPassColorAttachment.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"RenderPassColorAttachment.d.ts","sourceRoot":"","sources":["../../../../src/api/rendering/renderpass/RenderPassColorAttachment.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,4BAA4B,CAAC;AAC7D,OAAO,EAAC,KAAK,EAAC,MAAM,qBAAqB,CAAC;AAC1C,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,0BAA0B,CAAC;AAC3D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAC;AAC/D,OAAO,EAAC,WAAW,EAAC,MAAM,kBAAkB,CAAC;AAC7C,OAAO,EAAC,UAAU,EAAC,MAAM,iBAAiB,CAAC;AAE3C;;GAEG;AACH,qBAAa,yBAAyB;IAElC;;OAEG;IACI,SAAS,CAAC,EAAE,UAAU,CAAC;IAE9B;;;OAGG;IACI,OAAO,CAAC,EAAE,UAAU,CAAC;IAE5B;;;OAGG;IACI,IAAI,CAAC,EAAE,YAAY,CAAC;IAE3B;;;;OAIG;IACI,WAAW,EAAE,WAAW,CAAqB;IAEpD;;;OAGG;IACI,UAAU,EAAE,UAAU,CAAoB;IAEjD;;;;;;OAMG;IACI,cAAc,CAAC,EAAE,UAAU,CAAC;IAEnC;;;;OAIG;IACI,WAAW,CAAC,EAAE,YAAY,CAAC;IAElC,sCAAsC;IAC/B,UAAU,QAAuB;CAC3C"}

package/dist/api/rendering/renderpass/RenderPassDepthStencilAttachment.d.ts

@@ -0,0 +1,56 @@
+import type { ITextureView } from "../texture/ITextureView.js";
+import { LoadAction } from "./LoadAction.js";
+import type { ITexture2D } from "../texture/ITexture2D.js";
+import { StoreAction } from "./StoreAction.js";
+/**
+ * Describes a depth/stencil attachment used in a render pass.
+ * Controls how depth and stencil buffers are loaded, cleared, and stored.
+ */
+export declare class RenderPassDepthStencilAttachment {
+    /**
+     * The constructor.
+     */
+    constructor();
+    /**
+     * The view into depth/stencil render target.
+     */
+    view?: ITextureView;
+    /**
+     * The texture used as depth/stencil render target.
+     * Can be used instead of 'view' property if 'view' is not supported
+     *  for the rendering backend.
+     */
+    texture?: ITexture2D;
+    /**
+     * What happens to the depth buffer at the start of the render pass.
+     *     By default, it is set to , which means that the depth buffer will be cleared at the beginning of the render pass.
+     */
+    depthLoadAction: LoadAction;
+    /**
+     * What happens to the depth buffer at the end of the render pass.
+     *     By default, it is set to , which means that the depth buffer will be discarded after the render pass and cannot be read later.
+     */
+    depthStoreAction: StoreAction;
+    /**
+     * Depth value used when DepthLoadAction is Clear.
+     *     Typically, 1.0 (far plane).
+     *     Ignored otherwise.
+     */
+    depthClearValue: number;
+    /**
+     * What happens to the stencil buffer at the start of the render pass.
+     *     By default, it is set to , which means that the stencil buffer will be cleared at the beginning of the render pass.
+     */
+    stencilLoadAction: LoadAction;
+    /**
+     * What happens to the stencil buffer at the end of the render pass.
+     *     By default, it is set to , which means that the stencil buffer will be discarded after the render pass and cannot be read later.
+     */
+    stencilStoreAction: StoreAction;
+    /**
+     * Stencil value used when StencilLoadAction is Clear.
+     *     Ignored otherwise.
+     */
+    stencilClearValue: number;
+}
+//# sourceMappingURL=RenderPassDepthStencilAttachment.d.ts.map

package/dist/api/rendering/renderpass/RenderPassDepthStencilAttachment.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"RenderPassDepthStencilAttachment.d.ts","sourceRoot":"","sources":["../../../../src/api/rendering/renderpass/RenderPassDepthStencilAttachment.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAC;AAC/D,OAAO,EAAC,UAAU,EAAC,MAAM,iBAAiB,CAAC;AAC3C,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,0BAA0B,CAAC;AAC3D,OAAO,EAAC,WAAW,EAAC,MAAM,kBAAkB,CAAC;AAG7C;;;GAGG;AACH,qBAAa,gCAAgC;IAEzC;;OAEG;;IAUH;;OAEG;IACI,IAAI,CAAC,EAAE,YAAY,CAAC;IAE3B;;;;OAIG;IACI,OAAO,CAAC,EAAE,UAAU,CAAC;IAE5B;;;OAGG;IACI,eAAe,EAAE,UAAU,CAAC;IAEnC;;;OAGG;IACI,gBAAgB,EAAE,WAAW,CAAC;IAErC;;;;OAIG;IACI,eAAe,EAAE,MAAM,CAAC;IAG/B;;;OAGG;IACI,iBAAiB,EAAE,UAAU,CAAC;IAGrC;;;OAGG;IACI,kBAAkB,EAAE,WAAW,CAAC;IAEvC;;;OAGG;IACI,iBAAiB,EAAE,MAAM,CAAC;CACpC"}

package/dist/api/rendering/renderpass/RenderPassDescriptor.d.ts

@@ -0,0 +1,22 @@
+import { RenderPassDepthStencilAttachment } from "./RenderPassDepthStencilAttachment.js";
+import { RenderPassColorAttachment } from "./RenderPassColorAttachment.js";
+/**
+ * The render pass.
+ */
+export declare class RenderPassDescriptor {
+    /**
+     * The color attachments of the render pass.
+     */
+    colorAttachments?: RenderPassColorAttachment[];
+    /**
+     * The depth-stencil attachment of the render pass.
+     */
+    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.
+     */
+    label?: string;
+}
+//# sourceMappingURL=RenderPassDescriptor.d.ts.map

package/dist/api/rendering/renderpass/RenderPassDescriptor.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"RenderPassDescriptor.d.ts","sourceRoot":"","sources":["../../../../src/api/rendering/renderpass/RenderPassDescriptor.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,gCAAgC,EAAC,MAAM,uCAAuC,CAAC;AACvF,OAAO,EAAC,yBAAyB,EAAC,MAAM,gCAAgC,CAAC;AAEzE;;GAEG;AACH,qBAAa,oBAAoB;IAEjC;;OAEG;IACM,gBAAgB,CAAC,EAAE,yBAAyB,EAAE,CAAC;IAExD;;OAEG;IACO,sBAAsB,CAAC,EAAE,gCAAgC,CAAC;IAEpE;;;;OAIG;IACM,KAAK,CAAC,EAAE,MAAM,CAAC;CAEvB"}

package/dist/api/rendering/renderpass/StoreAction.d.ts

@@ -0,0 +1,24 @@
+/**
+ * Specifies the action to take with the attachment contents at the end of a render pass.
+ */
+export declare enum StoreAction {
+    /**
+     * The attachment contents generated during the render pass are written back to memory.
+     *
+     *     Corresponds to WebGPU store operation.
+     */
+    STORE = 0,
+    /**
+     * The attachment contents are discarded after the render pass.
+     *     The texture becomes uninitialized (undefined) afterward.
+     *
+     *     On tile-based GPUs (most mobile/Apple Silicon), this is significantly faster because it avoids writing data back to main memory.
+     *     Use this whenever the attachment will not be read by subsequent render passes.
+     *
+     *     Note: If only the depth or stencil aspect is discarded, the other aspect is preserved.
+     *
+     *     Corresponds to WebGPU discard operation.
+     */
+    DISCARD = 1
+}
+//# sourceMappingURL=StoreAction.d.ts.map

package/dist/api/rendering/renderpass/StoreAction.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"StoreAction.d.ts","sourceRoot":"","sources":["../../../../src/api/rendering/renderpass/StoreAction.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,oBAAY,WAAW;IACvB;;;;OAIG;IACD,KAAK,IAAI;IACX;;;;;;;;;;OAUG;IACD,OAAO,IAAI;CACZ"}

package/dist/api/rendering/renderpass/_export.d.ts

@@ -0,0 +1,7 @@
+export * from "./IRenderPass.js";
+export * from "./LoadAction.js";
+export * from "./RenderPassColorAttachment.js";
+export * from "./RenderPassDepthStencilAttachment.js";
+export * from "./RenderPassDescriptor.js";
+export * from "./StoreAction.js";
+//# sourceMappingURL=_export.d.ts.map