DriftTexture · function

sampleOverlay

Read every channel at a coordinate into out. False where nothing has been written there.

Explained in DriftTexture.

function sampleOverlay(overlay: Overlay, u: number, v: number, out: Float32Array): boolean
import { sampleOverlay } from '@driftengine/texture';

Parameters

ParameterTypeDescription
overlayOverlay
unumber
vnumber
outFloat32Array

In depth

False is the ordinary answer and the important one: it is what tells a sampler to use the base unchanged rather than compositing a zero over it.