nucleation 0.10.22 → 0.10.24

package/renderer/ChunkMeshResult.d.ts

@@ -0,0 +1,75 @@
+// generated by diplomat-tool
+import type { BlockPos } from "./BlockPos.mjs"
+import type { MeshConfig } from "./MeshConfig.mjs"
+import type { MeshResult } from "./MeshResult.mjs"
+import type { NucleationError } from "./NucleationError.mjs"
+import type { ResourcePack } from "./ResourcePack.mjs"
+import type { Schematic } from "./Schematic.mjs"
+import type { TextureAtlas } from "./TextureAtlas.mjs"
+import type { pointer, codepoint } from "./diplomat-runtime.d.ts";
+
+
+
+/**
+ * Per-chunk mesh results. Wraps {@link crate::meshing::ChunkMeshResult}.
+ */
+export class ChunkMeshResult {
+    /** @internal */
+    get ffiValue(): pointer;
+    /** @internal */
+    constructor();
+
+
+    /**
+     * Mesh with the default chunk size (old ABI: `schematic_mesh_by_chunk`).
+     */
+    static create(schematic: Schematic, pack: ResourcePack, config: MeshConfig): ChunkMeshResult;
+
+    /**
+     * Mesh with an explicit chunk size (old ABI: `schematic_mesh_by_chunk_size`).
+     */
+    static createWithSize(schematic: Schematic, pack: ResourcePack, config: MeshConfig, chunkSize: number): ChunkMeshResult;
+
+    /**
+     * Mesh chunks against a pre-built shared atlas, synchronously
+     * (old ABI: `schematic_mesh_chunks_with_atlas`). For progress
+     * reporting use {@link MeshJob::start} instead.
+     */
+    static createWithAtlas(schematic: Schematic, pack: ResourcePack, config: MeshConfig, chunkSize: number, atlas: TextureAtlas): ChunkMeshResult;
+
+    /**
+     * Number of chunk meshes.
+     */
+    chunkCount(): number;
+
+    /**
+     * Coordinate of the `index`-th chunk (old ABI:
+     * `chunkmeshresult_chunk_coordinates` returned all of them flat).
+     */
+    chunkCoordinateAt(index: number): BlockPos;
+
+    /**
+     * The mesh for one chunk coordinate (cloned).
+     */
+    getMesh(cx: number, cy: number, cz: number): MeshResult;
+
+    /**
+     * Total vertex count across all chunk meshes.
+     */
+    totalVertexCount(): number;
+
+    /**
+     * Total triangle count across all chunk meshes.
+     */
+    totalTriangleCount(): number;
+
+    /**
+     * All chunk meshes serialized in the NUCM cache format, base64-encoded.
+     */
+    nucmDataB64(): string;
+
+    /**
+     * NUCM v2 with a shared atlas, base64-encoded.
+     */
+    nucmDataWithAtlasB64(atlas: TextureAtlas): string;
+}

package/renderer/ChunkMeshResult.mjs

@@ -0,0 +1,253 @@
+// generated by diplomat-tool
+import { BlockPos } from "./BlockPos.mjs"
+import { MeshConfig } from "./MeshConfig.mjs"
+import { MeshResult } from "./MeshResult.mjs"
+import { NucleationError } from "./NucleationError.mjs"
+import { ResourcePack } from "./ResourcePack.mjs"
+import { Schematic } from "./Schematic.mjs"
+import { TextureAtlas } from "./TextureAtlas.mjs"
+import wasm from "./diplomat-wasm.mjs";
+import * as diplomatRuntime from "./diplomat-runtime.mjs";
+
+const ChunkMeshResult_box_destroy_registry = new FinalizationRegistry((ptr) => {
+    wasm.ChunkMeshResult_destroy(ptr);
+});
+
+/**
+ * Per-chunk mesh results. Wraps {@link crate::meshing::ChunkMeshResult}.
+ */
+export class ChunkMeshResult {
+    // Internal ptr reference:
+    #ptr = null;
+
+    // Lifetimes are only to keep dependencies alive.
+    // Since JS won't garbage collect until there are no incoming edges.
+    #selfEdge = [];
+
+    #internalConstructor(symbol, ptr, selfEdge) {
+        if (symbol !== diplomatRuntime.internalConstructor) {
+            console.error("ChunkMeshResult is an Opaque type. You cannot call its constructor.");
+            return;
+        }
+        this.#ptr = ptr;
+        this.#selfEdge = selfEdge;
+
+        // Are we being borrowed? If not, we can register.
+        if (this.#selfEdge.length === 0) {
+            ChunkMeshResult_box_destroy_registry.register(this, this.#ptr);
+        }
+
+        return this;
+    }
+    /** @internal */
+    get ffiValue() {
+        return this.#ptr;
+    }
+
+
+    /**
+     * Mesh with the default chunk size (old ABI: `schematic_mesh_by_chunk`).
+     */
+    static create(schematic, pack, config) {
+        const diplomatReceive = new diplomatRuntime.DiplomatReceiveBuf(wasm, 5, 4, true);
+
+
+        const result = wasm.ChunkMeshResult_create(diplomatReceive.buffer, schematic.ffiValue, pack.ffiValue, config.ffiValue);
+
+        try {
+            if (!diplomatReceive.resultFlag) {
+                const cause = new NucleationError(diplomatRuntime.internalConstructor, diplomatRuntime.enumDiscriminant(wasm, diplomatReceive.buffer));
+                throw new globalThis.Error('NucleationError.' + cause.value, { cause });
+            }
+            return new ChunkMeshResult(diplomatRuntime.internalConstructor, diplomatRuntime.ptrRead(wasm, diplomatReceive.buffer), []);
+        }
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+            diplomatReceive.free();
+        }
+    }
+
+    /**
+     * Mesh with an explicit chunk size (old ABI: `schematic_mesh_by_chunk_size`).
+     */
+    static createWithSize(schematic, pack, config, chunkSize) {
+        const diplomatReceive = new diplomatRuntime.DiplomatReceiveBuf(wasm, 5, 4, true);
+
+
+        const result = wasm.ChunkMeshResult_create_with_size(diplomatReceive.buffer, schematic.ffiValue, pack.ffiValue, config.ffiValue, chunkSize);
+
+        try {
+            if (!diplomatReceive.resultFlag) {
+                const cause = new NucleationError(diplomatRuntime.internalConstructor, diplomatRuntime.enumDiscriminant(wasm, diplomatReceive.buffer));
+                throw new globalThis.Error('NucleationError.' + cause.value, { cause });
+            }
+            return new ChunkMeshResult(diplomatRuntime.internalConstructor, diplomatRuntime.ptrRead(wasm, diplomatReceive.buffer), []);
+        }
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+            diplomatReceive.free();
+        }
+    }
+
+    /**
+     * Mesh chunks against a pre-built shared atlas, synchronously
+     * (old ABI: `schematic_mesh_chunks_with_atlas`). For progress
+     * reporting use {@link MeshJob::start} instead.
+     */
+    static createWithAtlas(schematic, pack, config, chunkSize, atlas) {
+        const diplomatReceive = new diplomatRuntime.DiplomatReceiveBuf(wasm, 5, 4, true);
+
+
+        const result = wasm.ChunkMeshResult_create_with_atlas(diplomatReceive.buffer, schematic.ffiValue, pack.ffiValue, config.ffiValue, chunkSize, atlas.ffiValue);
+
+        try {
+            if (!diplomatReceive.resultFlag) {
+                const cause = new NucleationError(diplomatRuntime.internalConstructor, diplomatRuntime.enumDiscriminant(wasm, diplomatReceive.buffer));
+                throw new globalThis.Error('NucleationError.' + cause.value, { cause });
+            }
+            return new ChunkMeshResult(diplomatRuntime.internalConstructor, diplomatRuntime.ptrRead(wasm, diplomatReceive.buffer), []);
+        }
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+            diplomatReceive.free();
+        }
+    }
+
+    /**
+     * Number of chunk meshes.
+     */
+    chunkCount() {
+
+        const result = wasm.ChunkMeshResult_chunk_count(this.ffiValue);
+
+        try {
+            return result;
+        }
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+        }
+    }
+
+    /**
+     * Coordinate of the `index`-th chunk (old ABI:
+     * `chunkmeshresult_chunk_coordinates` returned all of them flat).
+     */
+    chunkCoordinateAt(index) {
+        const diplomatReceive = new diplomatRuntime.DiplomatReceiveBuf(wasm, 13, 4, true);
+
+
+        const result = wasm.ChunkMeshResult_chunk_coordinate_at(diplomatReceive.buffer, this.ffiValue, index);
+
+        try {
+            if (!diplomatReceive.resultFlag) {
+                const cause = new NucleationError(diplomatRuntime.internalConstructor, diplomatRuntime.enumDiscriminant(wasm, diplomatReceive.buffer));
+                throw new globalThis.Error('NucleationError.' + cause.value, { cause });
+            }
+            return BlockPos._fromFFI(diplomatRuntime.internalConstructor, diplomatReceive.buffer);
+        }
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+            diplomatReceive.free();
+        }
+    }
+
+    /**
+     * The mesh for one chunk coordinate (cloned).
+     */
+    getMesh(cx, cy, cz) {
+        const diplomatReceive = new diplomatRuntime.DiplomatReceiveBuf(wasm, 5, 4, true);
+
+
+        const result = wasm.ChunkMeshResult_get_mesh(diplomatReceive.buffer, this.ffiValue, cx, cy, cz);
+
+        try {
+            if (!diplomatReceive.resultFlag) {
+                const cause = new NucleationError(diplomatRuntime.internalConstructor, diplomatRuntime.enumDiscriminant(wasm, diplomatReceive.buffer));
+                throw new globalThis.Error('NucleationError.' + cause.value, { cause });
+            }
+            return new MeshResult(diplomatRuntime.internalConstructor, diplomatRuntime.ptrRead(wasm, diplomatReceive.buffer), []);
+        }
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+            diplomatReceive.free();
+        }
+    }
+
+    /**
+     * Total vertex count across all chunk meshes.
+     */
+    totalVertexCount() {
+
+        const result = wasm.ChunkMeshResult_total_vertex_count(this.ffiValue);
+
+        try {
+            return result;
+        }
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+        }
+    }
+
+    /**
+     * Total triangle count across all chunk meshes.
+     */
+    totalTriangleCount() {
+
+        const result = wasm.ChunkMeshResult_total_triangle_count(this.ffiValue);
+
+        try {
+            return result;
+        }
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+        }
+    }
+
+    /**
+     * All chunk meshes serialized in the NUCM cache format, base64-encoded.
+     */
+    nucmDataB64() {
+        const write = new diplomatRuntime.DiplomatWriteBuf(wasm);
+
+    wasm.ChunkMeshResult_nucm_data_b64(this.ffiValue, write.buffer);
+
+        try {
+            return write.readString8();
+        }
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+            write.free();
+        }
+    }
+
+    /**
+     * NUCM v2 with a shared atlas, base64-encoded.
+     */
+    nucmDataWithAtlasB64(atlas) {
+        const write = new diplomatRuntime.DiplomatWriteBuf(wasm);
+
+    wasm.ChunkMeshResult_nucm_data_with_atlas_b64(this.ffiValue, atlas.ffiValue, write.buffer);
+
+        try {
+            return write.readString8();
+        }
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+            write.free();
+        }
+    }
+
+    constructor(symbol, ptr, selfEdge) {
+        return this.#internalConstructor(...arguments)
+    }
+}

package/renderer/CircuitBuilder.d.mts

@@ -0,0 +1,118 @@
+// generated by diplomat-tool
+import type { IoType } from "./IoType.mjs"
+import type { LayoutFunction } from "./LayoutFunction.mjs"
+import type { NucleationError } from "./NucleationError.mjs"
+import type { Schematic } from "./Schematic.mjs"
+import type { SortStrategy } from "./SortStrategy.mjs"
+import type { TypedCircuitExecutor } from "./TypedCircuitExecutor.mjs"
+import type { pointer, codepoint } from "./diplomat-runtime.d.ts";
+
+
+
+/**
+ * High-level circuit builder. `build`/`build_validated` consume it
+ * (PORTING rule 11). Regions are given as flat `[x,y,z,...]` positions
+ * (see module notes).
+ */
+export class CircuitBuilder {
+    /** @internal */
+    get ffiValue(): pointer;
+    /** @internal */
+    constructor();
+
+
+    /**
+     * Create a builder for a schematic (cloned; no IO defined yet).
+     */
+    static create(schematic: Schematic): CircuitBuilder;
+
+    /**
+     * Create a builder pre-populated from Insign annotations.
+     */
+    static fromInsign(schematic: Schematic): CircuitBuilder;
+
+    /**
+     * Add an input with full control.
+     */
+    withInput(name: string, ioType: IoType, layout: LayoutFunction, regionPositions: Array<number>): void;
+
+    /**
+     * Add an input with full control and a custom sort strategy.
+     */
+    withInputSorted(name: string, ioType: IoType, layout: LayoutFunction, regionPositions: Array<number>, sort: SortStrategy): void;
+
+    /**
+     * Add an input with automatic layout inference.
+     */
+    withInputAuto(name: string, ioType: IoType, regionPositions: Array<number>): void;
+
+    /**
+     * Add an input with automatic layout inference and a custom sort.
+     */
+    withInputAutoSorted(name: string, ioType: IoType, regionPositions: Array<number>, sort: SortStrategy): void;
+
+    /**
+     * Add an output with full control.
+     */
+    withOutput(name: string, ioType: IoType, layout: LayoutFunction, regionPositions: Array<number>): void;
+
+    /**
+     * Add an output with full control and a custom sort strategy.
+     */
+    withOutputSorted(name: string, ioType: IoType, layout: LayoutFunction, regionPositions: Array<number>, sort: SortStrategy): void;
+
+    /**
+     * Add an output with automatic layout inference.
+     */
+    withOutputAuto(name: string, ioType: IoType, regionPositions: Array<number>): void;
+
+    /**
+     * Add an output with automatic layout inference and a custom sort.
+     */
+    withOutputAutoSorted(name: string, ioType: IoType, regionPositions: Array<number>, sort: SortStrategy): void;
+
+    /**
+     * Set simulation options.
+     */
+    withOptions(optimize: boolean, ioOnly: boolean): void;
+
+    /**
+     * Set the state mode ("stateless" | "stateful" | "manual").
+     */
+    withStateMode(mode: string): void;
+
+    /**
+     * Validate the configuration without consuming the builder.
+     */
+    validate(): void;
+
+    /**
+     * Build the executor. Consumes the builder.
+     */
+    build(): TypedCircuitExecutor;
+
+    /**
+     * Build the executor with validation. Consumes the builder.
+     */
+    buildValidated(): TypedCircuitExecutor;
+
+    /**
+     * Number of inputs defined so far (0 if the builder was consumed).
+     */
+    inputCount(): number;
+
+    /**
+     * Number of outputs defined so far (0 if the builder was consumed).
+     */
+    outputCount(): number;
+
+    /**
+     * Input names as a JSON array string.
+     */
+    inputNamesJson(): string;
+
+    /**
+     * Output names as a JSON array string.
+     */
+    outputNamesJson(): string;
+}

package/renderer/CircuitBuilder.d.ts

@@ -0,0 +1,118 @@
+// generated by diplomat-tool
+import type { IoType } from "./IoType.mjs"
+import type { LayoutFunction } from "./LayoutFunction.mjs"
+import type { NucleationError } from "./NucleationError.mjs"
+import type { Schematic } from "./Schematic.mjs"
+import type { SortStrategy } from "./SortStrategy.mjs"
+import type { TypedCircuitExecutor } from "./TypedCircuitExecutor.mjs"
+import type { pointer, codepoint } from "./diplomat-runtime.d.ts";
+
+
+
+/**
+ * High-level circuit builder. `build`/`build_validated` consume it
+ * (PORTING rule 11). Regions are given as flat `[x,y,z,...]` positions
+ * (see module notes).
+ */
+export class CircuitBuilder {
+    /** @internal */
+    get ffiValue(): pointer;
+    /** @internal */
+    constructor();
+
+
+    /**
+     * Create a builder for a schematic (cloned; no IO defined yet).
+     */
+    static create(schematic: Schematic): CircuitBuilder;
+
+    /**
+     * Create a builder pre-populated from Insign annotations.
+     */
+    static fromInsign(schematic: Schematic): CircuitBuilder;
+
+    /**
+     * Add an input with full control.
+     */
+    withInput(name: string, ioType: IoType, layout: LayoutFunction, regionPositions: Array<number>): void;
+
+    /**
+     * Add an input with full control and a custom sort strategy.
+     */
+    withInputSorted(name: string, ioType: IoType, layout: LayoutFunction, regionPositions: Array<number>, sort: SortStrategy): void;
+
+    /**
+     * Add an input with automatic layout inference.
+     */
+    withInputAuto(name: string, ioType: IoType, regionPositions: Array<number>): void;
+
+    /**
+     * Add an input with automatic layout inference and a custom sort.
+     */
+    withInputAutoSorted(name: string, ioType: IoType, regionPositions: Array<number>, sort: SortStrategy): void;
+
+    /**
+     * Add an output with full control.
+     */
+    withOutput(name: string, ioType: IoType, layout: LayoutFunction, regionPositions: Array<number>): void;
+
+    /**
+     * Add an output with full control and a custom sort strategy.
+     */
+    withOutputSorted(name: string, ioType: IoType, layout: LayoutFunction, regionPositions: Array<number>, sort: SortStrategy): void;
+
+    /**
+     * Add an output with automatic layout inference.
+     */
+    withOutputAuto(name: string, ioType: IoType, regionPositions: Array<number>): void;
+
+    /**
+     * Add an output with automatic layout inference and a custom sort.
+     */
+    withOutputAutoSorted(name: string, ioType: IoType, regionPositions: Array<number>, sort: SortStrategy): void;
+
+    /**
+     * Set simulation options.
+     */
+    withOptions(optimize: boolean, ioOnly: boolean): void;
+
+    /**
+     * Set the state mode ("stateless" | "stateful" | "manual").
+     */
+    withStateMode(mode: string): void;
+
+    /**
+     * Validate the configuration without consuming the builder.
+     */
+    validate(): void;
+
+    /**
+     * Build the executor. Consumes the builder.
+     */
+    build(): TypedCircuitExecutor;
+
+    /**
+     * Build the executor with validation. Consumes the builder.
+     */
+    buildValidated(): TypedCircuitExecutor;
+
+    /**
+     * Number of inputs defined so far (0 if the builder was consumed).
+     */
+    inputCount(): number;
+
+    /**
+     * Number of outputs defined so far (0 if the builder was consumed).
+     */
+    outputCount(): number;
+
+    /**
+     * Input names as a JSON array string.
+     */
+    inputNamesJson(): string;
+
+    /**
+     * Output names as a JSON array string.
+     */
+    outputNamesJson(): string;
+}