color-kitnext

@pbroom/color-kit/planeQueries

PlaneSense

Query helpers bound to one plane, returned by sense.

interfaceimport type { PlaneSense } from '@pbroom/color-kit/plane';query.ts:244
interface PlaneSense {
  gamutBoundary: (query?: Omit<PlaneGamutBoundaryQuery, 'kind'>) => PlaneGamutBoundaryResult;
  gamutRegion: (query?: Omit<PlaneGamutRegionQuery, 'kind'>) => PlaneGamutRegionResult;
  contrastBoundary: (query: PlaneContrastQueryOptions) => PlaneContrastBoundaryResult;
  contrastRegion: (query: PlaneContrastQueryOptions) => PlaneContrastRegionResult;
  chromaBand: (query?: Omit<PlaneChromaBandQuery, 'kind'>) => PlaneChromaBandResult;
  fallbackPoint: (query: Omit<PlaneFallbackPointQuery, 'kind'>) => PlaneFallbackPointResult;
  gradient: (query: Omit<PlaneGradientQuery, 'kind'>) => PlaneGradientResult;
}

Each method calls the matching getPlane* function with the bound plane; the query options are the same minus kind.

Properties

gamutBoundary(query?: Omit<PlaneGamutBoundaryQuery, 'kind'>) => PlaneGamutBoundaryResult
Computes a projected gamut boundary contour.
gamutRegion(query?: Omit<PlaneGamutRegionQuery, 'kind'>) => PlaneGamutRegionResult
Computes visible gamut geometry for the current plane window.
contrastBoundary(query: PlaneContrastQueryOptions) => PlaneContrastBoundaryResult
Computes a projected contrast-threshold contour.
contrastRegion(query: PlaneContrastQueryOptions) => PlaneContrastRegionResult
Computes one or more projected filled contrast regions.
chromaBand(query?: Omit<PlaneChromaBandQuery, 'kind'>) => PlaneChromaBandResult
Computes a projected chroma-band point sequence.
fallbackPoint(query: Omit<PlaneFallbackPointQuery, 'kind'>) => PlaneFallbackPointResult
Maps a color into gamut and projects it to one plane point.
gradient(query: Omit<PlaneGradientQuery, 'kind'>) => PlaneGradientResult
Samples a gradient and projects each sample to plane coordinates.

Also exported from