Taos API Reference
    Preparing search index...

    Interface TerrainSystemOptions

    interface TerrainSystemOptions {
        heightScale?: number;
        quality?: TerrainQuality;
        worldOrigin?: [number, number];
        worldExtent?: number;
        pagesPerSide?: number;
        numSlots?: number;
        bounded?: boolean;
    }
    Index

    Properties

    heightScale?: number

    Vertical height-map scale in world units. Defaults to DEFAULT_HEIGHT_SCALE.

    quality?: TerrainQuality

    Mesh + heightmap detail preset. Defaults to TerrainQuality.Medium, which matches the previous fixed settings — safe baseline for any device.

    worldOrigin?: [number, number]

    World-rect origin (XZ of the rect's min corner). Defaults to a rect centered on the origin (-worldExtent / 2).

    worldExtent?: number

    Square world extent in world units. Defaults to WORLD_EXTENT (8192). The CDLOD quadtree root and the VT page grid both cover exactly this rect, so shrinking it produces a finite slab — e.g. a small island.

    pagesPerSide?: number

    Virtual pages per side. Defaults to 32. For a bounded world pick a value whose square fits the resident slot count so the whole terrain stays resident (e.g. 4 → 16 pages).

    numSlots?: number

    Resident atlas slots (texture-array layers). Defaults to 16, or to pagesPerSide² when bounded is set and this is omitted.

    bounded?: boolean

    When true, every page is marked resident once (no camera-centered streaming), so a finite region is always fully baked at atlas detail. Requires numSlots >= pagesPerSide². Defaults to false (streaming).