Taos API Reference
    Preparing search index...

    Interface OceanClipRegion

    A circular clip-surface region bounding the water body (Crest's clip surface, as a procedural disc).

    interface OceanClipRegion {
        x: number;
        z: number;
        radius: number;
        mode?: "keep" | "cut";
        feather?: number;
    }
    Index

    Properties

    x z radius mode? feather?

    Properties

    x: number

    Region center, world X.

    z: number

    Region center, world Z.

    radius: number

    Radius (m).

    mode?: "keep" | "cut"

    'keep' shows water only INSIDE this disc (a finite water body — pixels outside every keep disc are clipped); 'cut' punches a hole INSIDE it (e.g. a boat-hull cutout). Default 'keep'.

    feather?: number

    Edge feather width (m) over which the surface fades out. Default 2.

    Settings

    Member Visibility

    On This Page

    Properties