nucleation 0.10.22 → 0.10.23

package/renderer/RenderConfig.mjs

@@ -0,0 +1,271 @@
+// generated by diplomat-tool
+import { NucleationError } from "./NucleationError.mjs"
+import wasm from "./diplomat-wasm.mjs";
+import * as diplomatRuntime from "./diplomat-runtime.mjs";
+
+const RenderConfig_box_destroy_registry = new FinalizationRegistry((ptr) => {
+    wasm.RenderConfig_destroy(ptr);
+});
+
+/**
+ * Camera / output configuration for rendering.
+ */
+export class RenderConfig {
+    // 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("RenderConfig 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) {
+            RenderConfig_box_destroy_registry.register(this, this.#ptr);
+        }
+
+        return this;
+    }
+    /** @internal */
+    get ffiValue() {
+        return this.#ptr;
+    }
+
+
+    /**
+     * Create a config with the given output size in pixels. Camera starts
+     * at the defaults: yaw 45°, pitch 30°, zoom 1.0, fov 45°, perspective
+     * projection, default sky background.
+     */
+    static create(width, height) {
+
+        const result = wasm.RenderConfig_create(width, height);
+
+        try {
+            return new RenderConfig(diplomatRuntime.internalConstructor, result, []);
+        }
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+        }
+    }
+
+    /**
+     * Set the camera yaw (horizontal orbit angle) in degrees. Default: 45.
+     */
+    setYaw(yaw) {
+    wasm.RenderConfig_set_yaw(this.ffiValue, yaw);
+
+        try {}
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+        }
+    }
+
+    /**
+     * Set the camera pitch (downward tilt) in degrees. Default: 30.
+     */
+    setPitch(pitch) {
+    wasm.RenderConfig_set_pitch(this.ffiValue, pitch);
+
+        try {}
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+        }
+    }
+
+    /**
+     * Set the zoom factor applied to the auto-fitted framing
+     * (1.0 = frame the whole model; 2.0 = twice as close; 0.5 = twice
+     * as far). Default: 1.0.
+     */
+    setZoom(zoom) {
+    wasm.RenderConfig_set_zoom(this.ffiValue, zoom);
+
+        try {}
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+        }
+    }
+
+    /**
+     * Fit the camera to the model's bounding sphere instead of its
+     * yaw-dependent silhouette. The sphere is rotation invariant, so
+     * orbiting cameras (turntables) keep a constant distance instead
+     * of pulsing as the silhouette changes. Frames slightly looser
+     * than the default fit. Default: false.
+     */
+    setSphereFit(sphereFit) {
+    wasm.RenderConfig_set_sphere_fit(this.ffiValue, sphereFit);
+
+        try {}
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+        }
+    }
+
+    /**
+     * Set the vertical field of view in degrees (perspective projection
+     * only). Default: 45.
+     */
+    setFov(fov) {
+    wasm.RenderConfig_set_fov(this.ffiValue, fov);
+
+        try {}
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+        }
+    }
+
+    /**
+     * Set the world-space directional light and its non-negative intensity.
+     */
+    setDirectionalLight(x, y, z, intensity) {
+        const diplomatReceive = new diplomatRuntime.DiplomatReceiveBuf(wasm, 5, 4, true);
+
+
+        const result = wasm.RenderConfig_set_directional_light(diplomatReceive.buffer, this.ffiValue, x, y, z, intensity);
+
+        try {
+            if (!diplomatReceive.resultFlag) {
+                const cause = new NucleationError(diplomatRuntime.internalConstructor, diplomatRuntime.enumDiscriminant(wasm, diplomatReceive.buffer));
+                throw new globalThis.Error('NucleationError.' + cause.value, { cause });
+            }
+        }
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+            diplomatReceive.free();
+        }
+    }
+
+    /**
+     * Set the unlit floor for non-HDRI rendering, in `0..=1`.
+     */
+    setAmbientLight(ambient) {
+        const diplomatReceive = new diplomatRuntime.DiplomatReceiveBuf(wasm, 5, 4, true);
+
+
+        const result = wasm.RenderConfig_set_ambient_light(diplomatReceive.buffer, this.ffiValue, ambient);
+
+        try {
+            if (!diplomatReceive.resultFlag) {
+                const cause = new NucleationError(diplomatRuntime.internalConstructor, diplomatRuntime.enumDiscriminant(wasm, diplomatReceive.buffer));
+                throw new globalThis.Error('NucleationError.' + cause.value, { cause });
+            }
+        }
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+            diplomatReceive.free();
+        }
+    }
+
+    /**
+     * Set a solid RGBA clear color (linear 0.0–1.0). Alpha < 1.0 yields a
+     * transparent PNG. Ignored when HDRI is enabled.
+     */
+    setBackground(r, g, b, a) {
+    wasm.RenderConfig_set_background(this.ffiValue, r, g, b, a);
+
+        try {}
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+        }
+    }
+
+    /**
+     * Clear the custom background — revert to default sky / HDRI.
+     */
+    clearBackground() {
+    wasm.RenderConfig_clear_background(this.ffiValue);
+
+        try {}
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+        }
+    }
+
+    /**
+     * Configure a one-block world grid. Models are centred on integer
+     * schematic coordinates, so grid lines are placed on half-integer
+     * block boundaries automatically.
+     */
+    setGrid(halfExtent, spacing, planeY, showAxes, red, green, blue, alpha) {
+    wasm.RenderConfig_set_grid(this.ffiValue, halfExtent, spacing, planeY, showAxes, red, green, blue, alpha);
+
+        try {}
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+        }
+    }
+
+    /**
+     * Configure a compact grid fitted to half-integer block boundaries.
+     */
+    setFittedGrid(margin, spacing, planeY, showAxes, red, green, blue, alpha) {
+    wasm.RenderConfig_set_fitted_grid(this.ffiValue, margin, spacing, planeY, showAxes, red, green, blue, alpha);
+
+        try {}
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+        }
+    }
+
+    clearGrid() {
+    wasm.RenderConfig_clear_grid(this.ffiValue);
+
+        try {}
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+        }
+    }
+
+    /**
+     * Enable (`true`) or disable orthographic projection.
+     */
+    setOrthographic(orthographic) {
+    wasm.RenderConfig_set_orthographic(this.ffiValue, orthographic);
+
+        try {}
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+        }
+    }
+
+    /**
+     * Configure a true isometric view: orthographic at yaw 45° /
+     * pitch ≈35.264° (preserves the current width/height).
+     */
+    setIsometric() {
+    wasm.RenderConfig_set_isometric(this.ffiValue);
+
+        try {}
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+        }
+    }
+
+    constructor(symbol, ptr, selfEdge) {
+        return this.#internalConstructor(...arguments)
+    }
+}

package/renderer/Renderer.d.mts

@@ -0,0 +1,51 @@
+// generated by diplomat-tool
+import type { NucleationError } from "./NucleationError.mjs"
+import type { RenderConfig } from "./RenderConfig.mjs"
+import type { ResourcePack } from "./ResourcePack.mjs"
+import type { Schematic } from "./Schematic.mjs"
+import type { pointer, codepoint } from "./diplomat-runtime.d.ts";
+
+
+
+/**
+ * Namespace type for the render entry points (PORTING rule 12).
+ */
+export class Renderer {
+    /** @internal */
+    get ffiValue(): pointer;
+    /** @internal */
+    constructor();
+
+
+    /**
+     * Render a schematic to raw RGBA pixel bytes, written as base64
+     * (PORTING rule 6). `pack_zip` is a resource-pack zip in memory.
+     */
+    static renderPixelsB64(schematic: Schematic, packZip: Array<number>, config: RenderConfig): string;
+
+    /**
+     * Render a schematic to PNG bytes, written as base64 (PORTING rule 6).
+     * `pack_zip` is a resource-pack zip in memory.
+     */
+    static renderPngB64(schematic: Schematic, packZip: Array<number>, config: RenderConfig): string;
+
+    /**
+     * Render a schematic to a PNG file at `path`.
+     */
+    static renderToFile(schematic: Schematic, packZip: Array<number>, config: RenderConfig, path: string): void;
+
+    /**
+     * Render with an already parsed resource pack, avoiding repeated ZIP parsing.
+     */
+    static renderToFileWithPack(schematic: Schematic, pack: ResourcePack, config: RenderConfig, path: string): void;
+
+    /**
+     * Render raw RGBA pixels with an already parsed resource pack.
+     */
+    static renderPixelsB64WithPack(schematic: Schematic, pack: ResourcePack, config: RenderConfig): string;
+
+    /**
+     * Render PNG bytes with an already parsed resource pack.
+     */
+    static renderPngB64WithPack(schematic: Schematic, pack: ResourcePack, config: RenderConfig): string;
+}

package/renderer/Renderer.d.ts

@@ -0,0 +1,51 @@
+// generated by diplomat-tool
+import type { NucleationError } from "./NucleationError.mjs"
+import type { RenderConfig } from "./RenderConfig.mjs"
+import type { ResourcePack } from "./ResourcePack.mjs"
+import type { Schematic } from "./Schematic.mjs"
+import type { pointer, codepoint } from "./diplomat-runtime.d.ts";
+
+
+
+/**
+ * Namespace type for the render entry points (PORTING rule 12).
+ */
+export class Renderer {
+    /** @internal */
+    get ffiValue(): pointer;
+    /** @internal */
+    constructor();
+
+
+    /**
+     * Render a schematic to raw RGBA pixel bytes, written as base64
+     * (PORTING rule 6). `pack_zip` is a resource-pack zip in memory.
+     */
+    static renderPixelsB64(schematic: Schematic, packZip: Array<number>, config: RenderConfig): string;
+
+    /**
+     * Render a schematic to PNG bytes, written as base64 (PORTING rule 6).
+     * `pack_zip` is a resource-pack zip in memory.
+     */
+    static renderPngB64(schematic: Schematic, packZip: Array<number>, config: RenderConfig): string;
+
+    /**
+     * Render a schematic to a PNG file at `path`.
+     */
+    static renderToFile(schematic: Schematic, packZip: Array<number>, config: RenderConfig, path: string): void;
+
+    /**
+     * Render with an already parsed resource pack, avoiding repeated ZIP parsing.
+     */
+    static renderToFileWithPack(schematic: Schematic, pack: ResourcePack, config: RenderConfig, path: string): void;
+
+    /**
+     * Render raw RGBA pixels with an already parsed resource pack.
+     */
+    static renderPixelsB64WithPack(schematic: Schematic, pack: ResourcePack, config: RenderConfig): string;
+
+    /**
+     * Render PNG bytes with an already parsed resource pack.
+     */
+    static renderPngB64WithPack(schematic: Schematic, pack: ResourcePack, config: RenderConfig): string;
+}

package/renderer/Renderer.mjs

@@ -0,0 +1,219 @@
+// generated by diplomat-tool
+import { NucleationError } from "./NucleationError.mjs"
+import { RenderConfig } from "./RenderConfig.mjs"
+import { ResourcePack } from "./ResourcePack.mjs"
+import { Schematic } from "./Schematic.mjs"
+import wasm from "./diplomat-wasm.mjs";
+import * as diplomatRuntime from "./diplomat-runtime.mjs";
+
+const Renderer_box_destroy_registry = new FinalizationRegistry((ptr) => {
+    wasm.Renderer_destroy(ptr);
+});
+
+/**
+ * Namespace type for the render entry points (PORTING rule 12).
+ */
+export class Renderer {
+    // 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("Renderer 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) {
+            Renderer_box_destroy_registry.register(this, this.#ptr);
+        }
+
+        return this;
+    }
+    /** @internal */
+    get ffiValue() {
+        return this.#ptr;
+    }
+
+
+    /**
+     * Render a schematic to raw RGBA pixel bytes, written as base64
+     * (PORTING rule 6). `pack_zip` is a resource-pack zip in memory.
+     */
+    static renderPixelsB64(schematic, packZip, config) {
+        let functionCleanupArena = new diplomatRuntime.CleanupArena();
+
+        const packZipSlice = functionCleanupArena.alloc(diplomatRuntime.DiplomatBuf.sliceWrapper(wasm, diplomatRuntime.DiplomatBuf.slice(wasm, packZip, "u8")));
+        const diplomatReceive = new diplomatRuntime.DiplomatReceiveBuf(wasm, 5, 4, true);
+
+        const write = new diplomatRuntime.DiplomatWriteBuf(wasm);
+
+
+        const result = wasm.Renderer_render_pixels_b64(diplomatReceive.buffer, schematic.ffiValue, packZipSlice.ptr, config.ffiValue, write.buffer);
+
+        try {
+            if (!diplomatReceive.resultFlag) {
+                const cause = new NucleationError(diplomatRuntime.internalConstructor, diplomatRuntime.enumDiscriminant(wasm, diplomatReceive.buffer));
+                throw new globalThis.Error('NucleationError.' + cause.value, { cause });
+            }
+            return write.readString8();
+        }
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+            functionCleanupArena.free();
+
+            diplomatReceive.free();
+            write.free();
+        }
+    }
+
+    /**
+     * Render a schematic to PNG bytes, written as base64 (PORTING rule 6).
+     * `pack_zip` is a resource-pack zip in memory.
+     */
+    static renderPngB64(schematic, packZip, config) {
+        let functionCleanupArena = new diplomatRuntime.CleanupArena();
+
+        const packZipSlice = functionCleanupArena.alloc(diplomatRuntime.DiplomatBuf.sliceWrapper(wasm, diplomatRuntime.DiplomatBuf.slice(wasm, packZip, "u8")));
+        const diplomatReceive = new diplomatRuntime.DiplomatReceiveBuf(wasm, 5, 4, true);
+
+        const write = new diplomatRuntime.DiplomatWriteBuf(wasm);
+
+
+        const result = wasm.Renderer_render_png_b64(diplomatReceive.buffer, schematic.ffiValue, packZipSlice.ptr, config.ffiValue, write.buffer);
+
+        try {
+            if (!diplomatReceive.resultFlag) {
+                const cause = new NucleationError(diplomatRuntime.internalConstructor, diplomatRuntime.enumDiscriminant(wasm, diplomatReceive.buffer));
+                throw new globalThis.Error('NucleationError.' + cause.value, { cause });
+            }
+            return write.readString8();
+        }
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+            functionCleanupArena.free();
+
+            diplomatReceive.free();
+            write.free();
+        }
+    }
+
+    /**
+     * Render a schematic to a PNG file at `path`.
+     */
+    static renderToFile(schematic, packZip, config, path) {
+        let functionCleanupArena = new diplomatRuntime.CleanupArena();
+
+        const packZipSlice = functionCleanupArena.alloc(diplomatRuntime.DiplomatBuf.sliceWrapper(wasm, diplomatRuntime.DiplomatBuf.slice(wasm, packZip, "u8")));
+        const pathSlice = functionCleanupArena.alloc(diplomatRuntime.DiplomatBuf.sliceWrapper(wasm, diplomatRuntime.DiplomatBuf.str8(wasm, path)));
+        const diplomatReceive = new diplomatRuntime.DiplomatReceiveBuf(wasm, 5, 4, true);
+
+
+        const result = wasm.Renderer_render_to_file(diplomatReceive.buffer, schematic.ffiValue, packZipSlice.ptr, config.ffiValue, pathSlice.ptr);
+
+        try {
+            if (!diplomatReceive.resultFlag) {
+                const cause = new NucleationError(diplomatRuntime.internalConstructor, diplomatRuntime.enumDiscriminant(wasm, diplomatReceive.buffer));
+                throw new globalThis.Error('NucleationError.' + cause.value, { cause });
+            }
+        }
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+            functionCleanupArena.free();
+
+            diplomatReceive.free();
+        }
+    }
+
+    /**
+     * Render with an already parsed resource pack, avoiding repeated ZIP parsing.
+     */
+    static renderToFileWithPack(schematic, pack, config, path) {
+        let functionCleanupArena = new diplomatRuntime.CleanupArena();
+
+        const pathSlice = functionCleanupArena.alloc(diplomatRuntime.DiplomatBuf.sliceWrapper(wasm, diplomatRuntime.DiplomatBuf.str8(wasm, path)));
+        const diplomatReceive = new diplomatRuntime.DiplomatReceiveBuf(wasm, 5, 4, true);
+
+
+        const result = wasm.Renderer_render_to_file_with_pack(diplomatReceive.buffer, schematic.ffiValue, pack.ffiValue, config.ffiValue, pathSlice.ptr);
+
+        try {
+            if (!diplomatReceive.resultFlag) {
+                const cause = new NucleationError(diplomatRuntime.internalConstructor, diplomatRuntime.enumDiscriminant(wasm, diplomatReceive.buffer));
+                throw new globalThis.Error('NucleationError.' + cause.value, { cause });
+            }
+        }
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+            functionCleanupArena.free();
+
+            diplomatReceive.free();
+        }
+    }
+
+    /**
+     * Render raw RGBA pixels with an already parsed resource pack.
+     */
+    static renderPixelsB64WithPack(schematic, pack, config) {
+        const diplomatReceive = new diplomatRuntime.DiplomatReceiveBuf(wasm, 5, 4, true);
+
+        const write = new diplomatRuntime.DiplomatWriteBuf(wasm);
+
+
+        const result = wasm.Renderer_render_pixels_b64_with_pack(diplomatReceive.buffer, schematic.ffiValue, pack.ffiValue, config.ffiValue, write.buffer);
+
+        try {
+            if (!diplomatReceive.resultFlag) {
+                const cause = new NucleationError(diplomatRuntime.internalConstructor, diplomatRuntime.enumDiscriminant(wasm, diplomatReceive.buffer));
+                throw new globalThis.Error('NucleationError.' + cause.value, { cause });
+            }
+            return write.readString8();
+        }
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+            diplomatReceive.free();
+            write.free();
+        }
+    }
+
+    /**
+     * Render PNG bytes with an already parsed resource pack.
+     */
+    static renderPngB64WithPack(schematic, pack, config) {
+        const diplomatReceive = new diplomatRuntime.DiplomatReceiveBuf(wasm, 5, 4, true);
+
+        const write = new diplomatRuntime.DiplomatWriteBuf(wasm);
+
+
+        const result = wasm.Renderer_render_png_b64_with_pack(diplomatReceive.buffer, schematic.ffiValue, pack.ffiValue, config.ffiValue, write.buffer);
+
+        try {
+            if (!diplomatReceive.resultFlag) {
+                const cause = new NucleationError(diplomatRuntime.internalConstructor, diplomatRuntime.enumDiscriminant(wasm, diplomatReceive.buffer));
+                throw new globalThis.Error('NucleationError.' + cause.value, { cause });
+            }
+            return write.readString8();
+        }
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+            diplomatReceive.free();
+            write.free();
+        }
+    }
+
+    constructor(symbol, ptr, selfEdge) {
+        return this.#internalConstructor(...arguments)
+    }
+}

package/renderer/ResourcePack.d.mts

@@ -0,0 +1,105 @@
+// generated by diplomat-tool
+import type { NucleationError } from "./NucleationError.mjs"
+import type { ResourcePackList } from "./ResourcePackList.mjs"
+import type { TextureInfo } from "./TextureInfo.mjs"
+import type { pointer, codepoint } from "./diplomat-runtime.d.ts";
+
+
+
+/**
+ * A loaded (possibly merged) Minecraft resource pack.
+ * Wraps {@link crate::meshing::ResourcePackSource}.
+ */
+export class ResourcePack {
+    /** @internal */
+    get ffiValue(): pointer;
+    /** @internal */
+    constructor();
+
+
+    /**
+     * Load a resource pack from an in-memory ZIP buffer.
+     */
+    static fromBytes(data: Array<number>): ResourcePack;
+
+    /**
+     * Load and merge multiple resource packs, lowest priority first.
+     */
+    static fromList(list: ResourcePackList): ResourcePack;
+
+    /**
+     * Number of blockstate definitions in the pack.
+     */
+    blockstateCount(): number;
+
+    /**
+     * Number of model definitions in the pack.
+     */
+    modelCount(): number;
+
+    /**
+     * Number of textures in the pack.
+     */
+    textureCount(): number;
+
+    /**
+     * Namespaces present in the pack, as a JSON array string.
+     */
+    namespacesJson(): string;
+
+    /**
+     * All blockstate identifiers, as a JSON array string.
+     */
+    listBlockstatesJson(): string;
+
+    /**
+     * All model identifiers, as a JSON array string.
+     */
+    listModelsJson(): string;
+
+    /**
+     * All texture identifiers, as a JSON array string.
+     */
+    listTexturesJson(): string;
+
+    /**
+     * The blockstate definition JSON for `name`; `NotFound` if absent.
+     */
+    getBlockstateJson(name: string): string;
+
+    /**
+     * The model definition JSON for `name`; `NotFound` if absent.
+     */
+    getModelJson(name: string): string;
+
+    /**
+     * Texture metadata (size, animation flag, frame count).
+     */
+    getTextureInfo(name: string): TextureInfo;
+
+    /**
+     * Raw RGBA pixels of a texture, base64-encoded.
+     */
+    getTexturePixelsB64(name: string): string;
+
+    /**
+     * Add (or override) a blockstate definition from a JSON string.
+     */
+    addBlockstateJson(name: string, json: string): void;
+
+    /**
+     * Add (or override) a model definition from a JSON string.
+     */
+    addModelJson(name: string, json: string): void;
+
+    /**
+     * Add a raw RGBA texture (`pixels` length must be `width * height * 4`).
+     */
+    addTexture(name: string, width: number, height: number, pixels: Array<number>): void;
+
+    /**
+     * Register a MeshExporter with the FormatManager so `save_as("mesh", ...)`
+     * works. (Old ABI: `schematic_register_mesh_exporter`.)
+     */
+    registerMeshExporter(): void;
+}