Taos API Reference
    Preparing search index...

    Interface HeightmapOptions

    Maps the heightmap texture passed to TerrainSystem.setHeightmap onto world space.

    interface HeightmapOptions {
        origin: [number, number];
        extent: [number, number];
        heightScale?: number;
        floorHeight?: number;
        data?: { values: Float32Array; width: number; height: number };
    }
    Index

    Properties

    origin extent heightScale? floorHeight? data?

    Properties

    origin: [number, number]

    World XZ of the heightmap's (0,0) texel — the rect's min corner.

    extent: [number, number]

    World span (XZ) the heightmap covers.

    heightScale?: number

    Normalized height (texture R in [0,1]) is multiplied by this to reach world units. Defaults to the system's current heightScale.

    floorHeight?: number

    World-unit height returned outside the heightmap rect — the sea level a finite island sits in. Defaults to 0.

    data?: { values: Float32Array; width: number; height: number }

    Optional CPU copy of the normalized height field (row-major width × height, same data the texture was built from). When provided, TerrainSystem.heightAt / normalAt become available — character grounding, foliage seating and colliders read from it.

    Settings

    Member Visibility

    On This Page

    Properties