docs(color): add notes about normalized hue range

thi-ng · Mar 1, 2023 · 733c3b4 · 733c3b4
1 parent cda14bf
commit 733c3b4
Show file tree

Hide file tree

Showing 5 changed files with 25 additions and 1 deletion.
diff --git a/packages/color/src/hcy/hcy.ts b/packages/color/src/hcy/hcy.ts
@@ -32,6 +32,11 @@ export declare class HCY implements TypedColor<HCY> {
 	toJSON(): number[];
 }
 
+/**
+ * @remarks
+ * Note: As with other hue-based color modes in this package, the hue is stored
+ * normalized (in [0..1] interval) and NOT as degrees.
+ */
 export const hcy = <ColorFactory<HCY>>defColor({
 	mode: "hcy",
 	channels: { h: { hue: true } },

diff --git a/packages/color/src/hsi/hsi.ts b/packages/color/src/hsi/hsi.ts
@@ -32,6 +32,11 @@ export declare class HSI implements TypedColor<HSI> {
 	toJSON(): number[];
 }
 
+/**
+ * @remarks
+ * Note: As with other hue-based color modes in this package, the hue is stored
+ * normalized (in [0..1] interval) and NOT as degrees.
+ */
 export const hsi = <ColorFactory<HSI>>defColor({
 	mode: "hsi",
 	channels: { h: { hue: true } },

diff --git a/packages/color/src/hsl/hsl.ts b/packages/color/src/hsl/hsl.ts
@@ -33,6 +33,11 @@ export declare class HSL implements TypedColor<HSL> {
 	toJSON(): number[];
 }
 
+/**
+ * @remarks
+ * Note: As with other hue-based color modes in this package, the hue is stored
+ * normalized (in [0..1] interval) and NOT as degrees.
+ */
 export const hsl = <ColorFactory<HSL>>defColor({
 	mode: "hsl",
 	channels: { h: { hue: true } },

diff --git a/packages/color/src/hsv/hsv.ts b/packages/color/src/hsv/hsv.ts
@@ -33,6 +33,11 @@ export declare class HSV implements TypedColor<HSV> {
 	toJSON(): number[];
 }
 
+/**
+ * @remarks
+ * Note: As with other hue-based color modes in this package, the hue is stored
+ * normalized (in [0..1] interval) and NOT as degrees.
+ */
 export const hsv = <ColorFactory<HSV>>defColor({
 	mode: "hsv",
 	channels: { h: { hue: true } },

diff --git a/packages/color/src/lch/lch.ts b/packages/color/src/lch/lch.ts
@@ -35,7 +35,11 @@ export declare class LCH implements TypedColor<LCH> {
 
 /**
  * Luminance Chroma Hue (conversions assume {@link D50} white point, as per CSS
- * spec).
+ * spec). Polar version of {@link labD50}.
+ *
+ * @remarks
+ * Note: As with other hue-based color modes in this package, the hue is stored
+ * normalized (in [0..1] interval) and NOT as degrees.
  */
 export const lch = <ColorFactory<LCH>>defColor({
 	mode: "lch",