Renderer · function

sampleGlobalField

The field at a world point, from the finest cascade that holds it.

Explained in Hello world.

function sampleGlobalField(field: GlobalField, x: number, y: number, z: number): number
import { sampleGlobalField } from '@driftengine/core';

Parameters

ParameterTypeDescription
fieldGlobalField
xnumber
ynumber
znumber

In depth

A point past every cascade reads the outermost one clamped to its edge, rather than a sentinel: a caller marching outward wants a number it can step by, and the outermost cascade's own reach is the honest one.