Documentation / @ripl/terminal / clipPixels

Function: clipPixels()

clipPixels(mask, plot): PixelCallback

Defined in: terminal/src/clip.ts:82

Gates a plot callback on a clip mask, dropping every pixel outside it.

Parameters

Parameter	Type	Description
mask	ClipMask | null	The mask in force, or null when nothing is clipped.
plot	PixelCallback	The callback to gate.

Returns

PixelCallback

A gated callback, or plot itself when there is no mask.