HeightfieldRequestPayload

interface HeightfieldRequestPayload extends HeightfieldRequest

A heightfield request on the wire: generateHeightfield's own request, unchanged, beside the surface it is of.

The request is the caller's type rather than a copy of its fields, so a field added to HeightfieldRequest reaches the worker without this file knowing. What a caller holds and what crosses the wire differ in the seed alone, and poolHeightfieldSource is where that conversion happens.

packages/workers/src/tasks.ts:285

Members

borderreadonly

border?: number

Rings of samples outside the patch. Default HEIGHTFIELD_BORDER.

regionreadonly

resolutionreadonly

resolution: number

Vertices per side of the patch itself; see HEIGHTFIELD_RESOLUTION.

seabedreadonly

seabed?: boolean

Whether the field is the seabed — drawnGroundElevation, the ground under any sea with the clamp left off — or the drawn surface, clamped up to the datum. The seabed is right only where the renderer lays a sheet over it at the datum; a mapped body has no sheet, its photograph is its sea, and an unclamped seabed under the photograph is a trench kilometers below the datum the ship lands on. Default false: clamped.

surfacereadonly

surface: WireSurface