color-kitnext

@pbroom/color-kit/planeQueries

sense

Binds a plane to a set of query helpers, so queries read as sense(plane).gamutRegion().

functionimport { sense } from '@pbroom/color-kit/plane';query.ts:298
function sense(  planeDefinition: PlaneDefinition,): PlaneSense;

Each helper forwards to the matching function (getPlaneGamutBoundary, getPlaneGamutRegion, getPlaneContrastBoundary, getPlaneContrastRegion, getPlaneChromaBand, getPlaneFallbackPoint, samplePlaneGradient). Nothing is cached: the definition is captured as given and resolved on every call.

Parameters

planeDefinitionPlaneDefinition
Plane captured by every helper; a Plane or any PlaneDefinition.

Returns

PlaneSenseA new PlaneSense object.

Example

TypeScript
import { parse } from '@pbroom/color-kit';
import { definePlane, sense } from '@pbroom/color-kit/plane';

const plane = sense(definePlane({ fixed: { h: 264 } }));
const white = parse('#ffffff');
plane.gamutBoundary({ gamut: 'display-p3' }).points.length; // → 101
plane.contrastRegion({ reference: white, level: 'AA' }).paths.length; // → 1

Also exported from