nucleation 0.6.0 → 0.7.0

package/MeshConfig.d.mts

@@ -0,0 +1,101 @@
+// generated by diplomat-tool
+import type { NucleationError } from "./NucleationError.mjs"
+import type { pointer, codepoint } from "./diplomat-runtime.d.ts";
+
+
+
+/**
+ * Mesh generation configuration. Wraps {@link crate::meshing::MeshConfig}.
+ */
+export class MeshConfig {
+    /** @internal */
+    get ffiValue(): pointer;
+    /** @internal */
+    constructor();
+
+
+    /**
+     * Create a config with default settings: hidden-face culling on,
+     * ambient occlusion on (intensity 0.4), no biome, atlas max size 4096,
+     * occluded-block culling on, greedy meshing off.
+     */
+    static create(): MeshConfig;
+
+    /**
+     * Enable face culling between adjacent solid blocks (default: true).
+     */
+    setCullHiddenFaces(val: boolean): void;
+
+    /**
+     * Whether hidden-face culling is enabled.
+     */
+    cullHiddenFaces(): boolean;
+
+    /**
+     * Enable ambient occlusion (default: true).
+     */
+    setAmbientOcclusion(val: boolean): void;
+
+    /**
+     * Whether ambient occlusion is enabled.
+     */
+    ambientOcclusion(): boolean;
+
+    /**
+     * Set ambient-occlusion intensity, 0.0 (no darkening) to 1.0 (full
+     * darkening). Default: 0.4.
+     */
+    setAoIntensity(val: number): void;
+
+    /**
+     * The ambient-occlusion intensity (0.0–1.0).
+     */
+    aoIntensity(): number;
+
+    /**
+     * Set the biome used for tinting (e.g. "plains", "swamp").
+     */
+    setBiome(biome: string): void;
+
+    /**
+     * Clear the biome (old ABI: `meshconfig_set_biome(NULL)`).
+     */
+    clearBiome(): void;
+
+    /**
+     * The configured biome; `NotFound` if none is set.
+     */
+    biome(): string;
+
+    /**
+     * Set the maximum texture-atlas dimension in pixels (default: 4096).
+     */
+    setAtlasMaxSize(size: number): void;
+
+    /**
+     * The maximum texture-atlas dimension in pixels.
+     */
+    atlasMaxSize(): number;
+
+    /**
+     * Skip blocks fully hidden by opaque neighbors on all 6 sides
+     * (default: true).
+     */
+    setCullOccludedBlocks(val: boolean): void;
+
+    /**
+     * Whether occluded-block culling is enabled.
+     */
+    cullOccludedBlocks(): boolean;
+
+    /**
+     * Merge adjacent coplanar faces into larger quads to reduce triangle
+     * count (default: false).
+     */
+    setGreedyMeshing(val: boolean): void;
+
+    /**
+     * Whether greedy meshing is enabled.
+     */
+    greedyMeshing(): boolean;
+}

package/MeshConfig.d.ts

@@ -1,5 +1,5 @@
 // generated by diplomat-tool
-import type { NucleationError } from "./NucleationError"
+import type { NucleationError } from "./NucleationError.mjs"
 import type { pointer, codepoint } from "./diplomat-runtime.d.ts";
 
 

package/MeshJob.d.mts

@@ -0,0 +1,44 @@
+// generated by diplomat-tool
+import type { ChunkMeshResult } from "./ChunkMeshResult.mjs"
+import type { MeshConfig } from "./MeshConfig.mjs"
+import type { MeshProgress } from "./MeshProgress.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";
+
+
+
+/**
+ * A chunk-meshing job running on a background thread. Replaces the old
+ * `schematic_mesh_chunks_with_atlas_progress` C callback: poll it from a
+ * timer loop with {@link MeshJob::poll_progress}, then call
+ * {@link MeshJob::take_result} once (it blocks until the job finishes and
+ * consumes the job — a second call returns `AlreadyConsumed`).
+ */
+export class MeshJob {
+    /** @internal */
+    get ffiValue(): pointer;
+    /** @internal */
+    constructor();
+
+
+    /**
+     * Kick off chunk meshing with a shared atlas on a background thread
+     * and return immediately. Takes the same parameters as
+     * {@link ChunkMeshResult::create_with_atlas}.
+     */
+    static start(schematic: Schematic, pack: ResourcePack, config: MeshConfig, chunkSize: number, atlas: TextureAtlas): MeshJob;
+
+    /**
+     * Cheap, non-blocking progress snapshot. Call from a timer/poll loop.
+     */
+    pollProgress(): MeshProgress;
+
+    /**
+     * Block until the job finishes (if it hasn't already) and return the
+     * result. Consumes the job: a second call returns `AlreadyConsumed`.
+     */
+    takeResult(): ChunkMeshResult;
+}

package/MeshJob.d.ts

@@ -1,11 +1,11 @@
 // generated by diplomat-tool
-import type { ChunkMeshResult } from "./ChunkMeshResult"
-import type { MeshConfig } from "./MeshConfig"
-import type { MeshProgress } from "./MeshProgress"
-import type { NucleationError } from "./NucleationError"
-import type { ResourcePack } from "./ResourcePack"
-import type { Schematic } from "./Schematic"
-import type { TextureAtlas } from "./TextureAtlas"
+import type { ChunkMeshResult } from "./ChunkMeshResult.mjs"
+import type { MeshConfig } from "./MeshConfig.mjs"
+import type { MeshProgress } from "./MeshProgress.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";
 
 

package/MeshPhase.d.mts

@@ -0,0 +1,38 @@
+// generated by diplomat-tool
+import type { pointer, codepoint } from "./diplomat-runtime.d.ts";
+
+
+
+/**
+ * Phase of a running {@link MeshJob}.
+ */
+export class MeshPhase {
+
+    /** @internal */
+    static fromValue(value: MeshPhase | string): MeshPhase;
+
+    get value(): string;
+
+    /** @internal */
+    get ffiValue(): number;
+
+    /**
+     * Scanning palettes / building the shared texture atlas.
+     */
+    static BuildingAtlas : MeshPhase;
+    /**
+     * Meshing individual chunks (`current` / `total` advance here).
+     */
+    static MeshingChunks : MeshPhase;
+    /**
+     * All chunks meshed; `take_result` will not block.
+     */
+    static Complete : MeshPhase;
+    /**
+     * The job failed; `take_result` returns the error.
+     */
+    static Failed : MeshPhase;
+
+
+    constructor(value: MeshPhase | string );
+}

package/MeshProgress.d.mts

@@ -0,0 +1,32 @@
+// generated by diplomat-tool
+import type { MeshPhase } from "./MeshPhase.mjs"
+import type { pointer, codepoint } from "./diplomat-runtime.d.ts";
+
+export type MeshProgress_obj = {
+    phase: MeshPhase;
+    current: number;
+    total: number;
+};
+
+
+
+/**
+ * Snapshot of a {@link MeshJob}'s progress.
+ */
+export class MeshProgress {
+    get phase(): MeshPhase;
+    set phase(value: MeshPhase);
+    get current(): number;
+    set current(value: number);
+    get total(): number;
+    set total(value: number);
+    /** @internal */
+    static fromFields(structObj : MeshProgress_obj) : MeshProgress;
+
+    /**
+    * Create `MeshProgress` from an object that contains all of `MeshProgress`s fields.
+    * Optional fields do not need to be included in the provided object.
+    */
+    constructor(structObj: MeshProgress_obj);
+
+}

package/MeshProgress.d.ts

@@ -1,5 +1,5 @@
 // generated by diplomat-tool
-import type { MeshPhase } from "./MeshPhase"
+import type { MeshPhase } from "./MeshPhase.mjs"
 import type { pointer, codepoint } from "./diplomat-runtime.d.ts";
 
 export type MeshProgress_obj = {

package/MeshResult.d.mts

@@ -0,0 +1,65 @@
+// generated by diplomat-tool
+import type { MeshBounds } from "./MeshBounds.mjs"
+import type { MeshConfig } from "./MeshConfig.mjs"
+import type { NucleationError } from "./NucleationError.mjs"
+import type { ResourcePack } from "./ResourcePack.mjs"
+import type { Schematic } from "./Schematic.mjs"
+import type { pointer, codepoint } from "./diplomat-runtime.d.ts";
+
+
+
+/**
+ * A single mesh output. Wraps {@link crate::meshing::MeshResult}.
+ */
+export class MeshResult {
+    /** @internal */
+    get ffiValue(): pointer;
+    /** @internal */
+    constructor();
+
+
+    /**
+     * Mesh an entire schematic in one pass (old ABI: `schematic_to_mesh`).
+     */
+    static create(schematic: Schematic, pack: ResourcePack, config: MeshConfig): MeshResult;
+
+    /**
+     * Mesh a schematic with USDZ-compatible output (old ABI: `schematic_to_usdz`).
+     */
+    static createUsdz(schematic: Schematic, pack: ResourcePack, config: MeshConfig): MeshResult;
+
+    /**
+     * The mesh as a binary GLB, base64-encoded.
+     */
+    glbDataB64(): string;
+
+    /**
+     * The mesh as a USDZ archive, base64-encoded.
+     */
+    usdzDataB64(): string;
+
+    /**
+     * The mesh serialized in the NUCM cache format, base64-encoded.
+     */
+    nucmDataB64(): string;
+
+    /**
+     * Total number of vertices in the mesh.
+     */
+    vertexCount(): number;
+
+    /**
+     * Total number of triangles in the mesh.
+     */
+    triangleCount(): number;
+
+    /**
+     * Whether the mesh contains any transparent or translucent geometry.
+     */
+    hasTransparency(): boolean;
+
+    /**
+     * Axis-aligned bounding box of the mesh, in world units.
+     */
+    bounds(): MeshBounds;
+}

package/MeshResult.d.ts

@@ -1,9 +1,9 @@
 // generated by diplomat-tool
-import type { MeshBounds } from "./MeshBounds"
-import type { MeshConfig } from "./MeshConfig"
-import type { NucleationError } from "./NucleationError"
-import type { ResourcePack } from "./ResourcePack"
-import type { Schematic } from "./Schematic"
+import type { MeshBounds } from "./MeshBounds.mjs"
+import type { MeshConfig } from "./MeshConfig.mjs"
+import type { NucleationError } from "./NucleationError.mjs"
+import type { ResourcePack } from "./ResourcePack.mjs"
+import type { Schematic } from "./Schematic.mjs"
 import type { pointer, codepoint } from "./diplomat-runtime.d.ts";
 
 

package/MultiMeshResult.d.mts

@@ -0,0 +1,50 @@
+// generated by diplomat-tool
+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 { pointer, codepoint } from "./diplomat-runtime.d.ts";
+
+
+
+/**
+ * Per-region mesh results. Wraps {@link crate::meshing::MultiMeshResult}.
+ */
+export class MultiMeshResult {
+    /** @internal */
+    get ffiValue(): pointer;
+    /** @internal */
+    constructor();
+
+
+    /**
+     * Mesh each region separately (old ABI: `schematic_mesh_by_region`).
+     */
+    static create(schematic: Schematic, pack: ResourcePack, config: MeshConfig): MultiMeshResult;
+
+    /**
+     * Region names, as a JSON array string.
+     */
+    regionNamesJson(): string;
+
+    /**
+     * The mesh for one region (cloned).
+     */
+    getMesh(regionName: string): MeshResult;
+
+    /**
+     * Total vertex count across all region meshes.
+     */
+    totalVertexCount(): number;
+
+    /**
+     * Total triangle count across all region meshes.
+     */
+    totalTriangleCount(): number;
+
+    /**
+     * Number of region meshes.
+     */
+    meshCount(): number;
+}

package/MultiMeshResult.d.ts

@@ -1,9 +1,9 @@
 // generated by diplomat-tool
-import type { MeshConfig } from "./MeshConfig"
-import type { MeshResult } from "./MeshResult"
-import type { NucleationError } from "./NucleationError"
-import type { ResourcePack } from "./ResourcePack"
-import type { Schematic } from "./Schematic"
+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 { pointer, codepoint } from "./diplomat-runtime.d.ts";
 
 

package/Nbt.d.mts

@@ -0,0 +1,50 @@
+// generated by diplomat-tool
+import type { NucleationError } from "./NucleationError.mjs"
+import type { pointer, codepoint } from "./diplomat-runtime.d.ts";
+
+
+
+/**
+ * Namespace type for the free-standing NBT builder helpers (the old
+ * `nbt_text_build` / `nbt_chest_build` / `nbt_sign_build`), following the
+ * static-methods-on-a-dummy-opaque pattern.
+ */
+export class Nbt {
+    /** @internal */
+    get ffiValue(): pointer;
+    /** @internal */
+    constructor();
+
+
+    /**
+     * Build a Minecraft JSON text-component string.
+     *
+     * `color` may be empty (no color). `bold` and `italic` use `-1` for
+     * unset, `0` for false, nonzero for true.
+     */
+    static textBuild(s: string, color: string, bold: number, italic: number): string;
+
+    /**
+     * Build a chest-NBT SNBT string for use as the `{...}` portion of a block
+     * string.
+     *
+     * `items_json` is a JSON array of `{"id": string, "count"?: int,
+     * "slot"?: int}` entries (may be empty or `[]`); a missing/non-positive
+     * `count` defaults to 1, a missing/negative `slot` auto-assigns
+     * positionally. `name` is an optional plain-text custom name (empty = no
+     * `CustomName`); it is wrapped in a JSON text component automatically
+     * unless it already starts with `{`.
+     */
+    static chestBuild(itemsJson: string, name: string): string;
+
+    /**
+     * Build a modern (1.20+) sign-NBT SNBT string.
+     *
+     * `front_json` and `back_json` are JSON arrays of up to 4 line strings
+     * (either may be empty or `[]`). Each line may be a plain string
+     * (auto-wrapped via `text_build`) or an already-built JSON component
+     * (starts with `{`). `color` is the dye color string (empty defaults to
+     * `"black"`).
+     */
+    static signBuild(frontJson: string, backJson: string, color: string, glowing: boolean, waxed: boolean): string;
+}

package/Nbt.d.ts

@@ -1,5 +1,5 @@
 // generated by diplomat-tool
-import type { NucleationError } from "./NucleationError"
+import type { NucleationError } from "./NucleationError.mjs"
 import type { pointer, codepoint } from "./diplomat-runtime.d.ts";
 
 

package/NucleationError.d.mts

@@ -0,0 +1,41 @@
+// generated by diplomat-tool
+import type { pointer, codepoint } from "./diplomat-runtime.d.ts";
+
+
+
+/**
+ * Every fallible method in the bridge returns `Result<T, NucleationError>` —
+ * see `stencil/docs/nucleation-error.md` for how these variants were derived from
+ * the three error conventions the old hand-written `ffi` module mixed.
+ */
+export class NucleationError {
+
+    /** @internal */
+    static fromValue(value: NucleationError | string): NucleationError;
+
+    get value(): string;
+
+    /** @internal */
+    get ffiValue(): number;
+
+    static NullArgument : NucleationError;
+    static InvalidArgument : NucleationError;
+    static Parse : NucleationError;
+    static Serialize : NucleationError;
+    static Io : NucleationError;
+    static Lock : NucleationError;
+    static Store : NucleationError;
+    static Mesh : NucleationError;
+    static Render : NucleationError;
+    static Simulation : NucleationError;
+    static AlreadyConsumed : NucleationError;
+    static NotFound : NucleationError;
+    /**
+     * A world-generation source failed while producing a chunk, even though
+     * the request itself was well-formed (see `world_generation`).
+     */
+    static Generation : NucleationError;
+
+
+    constructor(value: NucleationError | string );
+}

package/NucleationError.d.ts

@@ -30,6 +30,11 @@ export class NucleationError {
     static Simulation : NucleationError;
     static AlreadyConsumed : NucleationError;
     static NotFound : NucleationError;
+    /**
+     * A world-generation source failed while producing a chunk, even though
+     * the request itself was well-formed (see `world_generation`).
+     */
+    static Generation : NucleationError;
 
 
     constructor(value: NucleationError | string );

package/NucleationError.mjs

@@ -24,7 +24,8 @@ export class NucleationError {
         ["Render", 8],
         ["Simulation", 9],
         ["AlreadyConsumed", 10],
-        ["NotFound", 11]
+        ["NotFound", 11],
+        ["Generation", 12]
     ]);
 
     static getAllEntries() {
@@ -82,6 +83,7 @@ export class NucleationError {
         new NucleationError(diplomatRuntime.internalConstructor, diplomatRuntime.internalConstructor, 9),
         new NucleationError(diplomatRuntime.internalConstructor, diplomatRuntime.internalConstructor, 10),
         new NucleationError(diplomatRuntime.internalConstructor, diplomatRuntime.internalConstructor, 11),
+        new NucleationError(diplomatRuntime.internalConstructor, diplomatRuntime.internalConstructor, 12),
     ];
 
     static NullArgument = NucleationError.#objectValues[0];
@@ -96,6 +98,11 @@ export class NucleationError {
     static Simulation = NucleationError.#objectValues[9];
     static AlreadyConsumed = NucleationError.#objectValues[10];
     static NotFound = NucleationError.#objectValues[11];
+    /**
+     * A world-generation source failed while producing a chunk, even though
+     * the request itself was well-formed (see `world_generation`).
+     */
+    static Generation = NucleationError.#objectValues[12];
 
 
     constructor(value) {

package/OutputCondition.d.mts

@@ -0,0 +1,45 @@
+// generated by diplomat-tool
+import type { Value } from "./Value.mjs"
+import type { pointer, codepoint } from "./diplomat-runtime.d.ts";
+
+
+
+/**
+ * A condition on an output value, for `ExecutionMode::until_condition`
+ * (PORTING rule 10).
+ */
+export class OutputCondition {
+    /** @internal */
+    get ffiValue(): pointer;
+    /** @internal */
+    constructor();
+
+
+    /**
+     * Met when the output equals `value`.
+     */
+    static equals(value: Value): OutputCondition;
+
+    /**
+     * Met when the output does not equal `value`.
+     */
+    static notEquals(value: Value): OutputCondition;
+
+    /**
+     * Met when the output is greater than `value`. Numeric only: both
+     * sides must be the same numeric type (u32/i32/f32), else never met.
+     */
+    static greaterThan(value: Value): OutputCondition;
+
+    /**
+     * Met when the output is less than `value`. Numeric only: both sides
+     * must be the same numeric type (u32/i32/f32), else never met.
+     */
+    static lessThan(value: Value): OutputCondition;
+
+    /**
+     * Met when `output & mask` is non-zero (flag checking). Integer
+     * outputs (u32/i32) only; never met for other types.
+     */
+    static bitwiseAnd(mask: number): OutputCondition;
+}

package/OutputCondition.d.ts

@@ -1,5 +1,5 @@
 // generated by diplomat-tool
-import type { Value } from "./Value"
+import type { Value } from "./Value.mjs"
 import type { pointer, codepoint } from "./diplomat-runtime.d.ts";