ColorSourceField

Turns a colour source's brightness into a field weight — the bridge that lets a paper texture or ramp act as a mask for shading and colour.

Declarative element: <sk-color-source-field>

Not on the sk.* global — construct via the declarative element or a module import.

Remarks

This is the texture-driven member of the SpatialField family: like every field it turns where into how much — a scalar weight that a shader consumer uses to modulate what it does — but instead of computing weight from geometry, it reads a ColorSource's relative luminance, so a procedural colour source becomes a mask. Like any field it is a by-id resource: give it an id, and a consumer (a sk-tonemap, a colour-map, or a material) points its field at it with field="#id".

Key attributes. source names the ColorSource to sample by #id. strength scales the mask around mid-grey (weight = clamp(0.5 + (luma − 0.5) × strength, 0, 1)): at 1 a full-range source passes through unchanged, while a subtle source needs more — the paper texture's ±0.1 swing around mid-grey wants strength ≈ 3–5 to read. The inherited remap-curve can reshape or invert the weight. Point the field at the SAME source a material renders (its base-color-source) and the mask lines up pixel-for-pixel with the visible texture, so ink density follows the paper's relief rather than an unrelated field.

Supported sources. It samples the parameter-backed colour sources whose evaluator reads only the params buffer this field forwards — a sk-paper-texture-color-source, a sk-color-map-source, or a composite of those. A source that needs its own texture or data buffer (a raster image, a compute-buffer source) is rejected, because that private resource cannot be routed into the host consumer's bind group.

GPU-only. The weight needs the source's shader evaluator, so it works only in the shader-backed field slots — a material, sk-tonemap, or colour-map field. Evaluated on the CPU (as a sk-field-constraint does) it returns a neutral weight, so it has no effect there; in a compute-evaluated per-clone point constraint it is rejected outright. This field masks shading and colour — it does not drive geometry.

Related. Its source is a sk-paper-texture-color-source or sk-color-map-source (see ColorSource); its usual consumer is a sk-tonemap masked by the source's luminance.

Constructor

constructor(config?: { source?: ColorSource | string; strength?: number; remapCurve?: SampledCurve; visualize?: boolean; interactiveControls?: boolean; visualizationMarkerSize?: number; visualizationColor?: string; visualizationZeroWeightColor?: string; visualizationSplineThickness?: number; visualizationSplineOccludedOpacity?: number; visualizationMarkerOpacity?: number; id?: string; x?: number; y?: number; z?: number; h?: number; p?: number; b?: number; quaternion?: Quaternion; sx?: number; sy?: number; sz?: number; s?: number; class?: string; style?: string })

Inherited from: SpatialField, VisualizableSceneNode, SceneNode, SkenraAnimatable — see those pages for inherited members.

Properties

Config Properties

Other Properties

Methods

Example

const paper = new PaperTextureColorSource({ tooth: 10 });
paper.id = 'paper';
scene.appendChild(paper);

const mask = new ColorSourceField({ source: paper, strength: 4 });
tonemap.field = mask;   // ink coverage now follows the paper's relief

↑ Documentation home · ← All classes