Schemes

Module scheme

Color schemes generate a series of colors from one or more base colors.

import colors.scheme

Every scheme implements the Scheme attribute: given an index nth, it returns the n-th color of the series. Schemes are infinite — they wrap, alternate or step further with every index — so a consumer decides how many colors it needs.

Contents

• Attributes — Scheme
• Unions — SchemeLike
• Functions — schemeFrom, prepend
• Schemes
  • Custom — CustomScheme, ConstantScheme
  • Color wheel — Complementary, Analogous, Triadic, Tetradic, GoldenSpiral, Rainbow
  • Single base — Monochromatic, Shade, Tint, Tone, Mix

---

Attributes

Scheme

`schemes/scheme.zirr:10`

attr Scheme {
  color(s: ColorScheme, nth: Int) -> Color2
}

A color scheme generates a series of colors. Types carrying this attribute supply a color implementation that maps an index to a color.

Members

Implementors

CustomScheme, ConstantScheme, Complementary, Analogous, Triadic, Tetradic, Monochromatic, Shade, Tint, Tone, Mix, GoldenSpiral, Rainbow

---

Unions

SchemeLike

`schemes/scheme.zirr:14`

union SchemeLike {
  Scheme
  Array
  ColorLike
}

Everything that can be interpreted as a scheme. Use schemeFrom to normalize a SchemeLike into a @Scheme.

Cases

---

Functions

schemeFrom

`schemes/scheme.zirr:21`

fn schemeFrom(raw: SchemeLike) -> @Scheme

Normalizes any SchemeLike value into a scheme.

Parameters

Returns

@Scheme

Errors

• "Invalid scheme type" — the value is not a member of SchemeLike.

---

prepend

`schemes/scheme.zirr:227`

fn prepend(c: Color2, s: @Scheme) -> @Scheme

Puts a fixed color in front of an existing scheme. Index 0 yields c, every further index nth yields s.color(nth - 1). Useful for layered surfaces and text, where the first color is fixed and the rest is derived.

Parameters

Returns

@Scheme — a CustomScheme wrapping s.

---

Schemes

CustomScheme

`schemes/scheme.zirr:33`

@Scheme(fn(s, nth) { s.color(nth) })
data CustomScheme {
  color(nth: Int) -> Color2
}

A custom color scheme to define their custom color generation logic. This allows for maximum flexibility in color scheme design.

Fields

---

ConstantScheme

`schemes/scheme.zirr:41`

@Scheme(fn(s, nth) { s.colors[nth % s.colors.length] })
data ConstantScheme {
  colors: Array
}

A constant color scheme always returns colors from a predefined list. When the number of requested colors exceeds the number of colors in the list, it wraps around to the beginning of the list.

Fields

---

Complementary

`schemes/scheme.zirr:58`

@Scheme(fn(s, nth) { … })
data Complementary {
  base: Color2
}

A complementary color scheme alternates between the base color and its complement. This creates a high-contrast color scheme.

Fields

Series

---

Analogous

`schemes/scheme.zirr:82`

@Scheme(fn(s, nth) { … })
data Analogous {
  base: Color2
  distance: maths.Degree
}

An analogous color scheme generates colors adjacent to the base color on the color wheel. The distance parameter controls how far apart the colors are. This creates a harmonious color scheme.

Fields

Series

---

Triadic

`schemes/scheme.zirr:106`

@Scheme(fn(s, nth) { … })
data Triadic {
  base: Color2
}

A triadic color scheme uses three colors that are evenly spaced around the color wheel. This creates a vibrant color scheme.

Fields

Series

---

Tetradic

`schemes/scheme.zirr:135`

@Scheme(fn(s, nth) { … })
data Tetradic {
  base: Color2
}

A tetradic color scheme uses four colors that are evenly spaced around the color wheel. This creates a rich color scheme with plenty of variety.

Fields

Series

---

Monochromatic

`schemes/scheme.zirr:150`

@Scheme(fn(s, nth) { … })
data Monochromatic {
  base: Color2
  delta: maths.Fraction
}

A monochromatic color scheme generates colors by varying the lightness of a single base color. This creates a cohesive and visually appealing color scheme. Brighter and darker shades are produced alternating.

Fields

Series

---

Shade

`schemes/scheme.zirr:160`

@Scheme(fn(s, nth) { shade(s.base, s.delta * nth) })
data Shade {
  base: Color2
  delta: maths.Fraction
}

A shade color scheme generates colors by reducing the lightness of a single base color. This creates a cohesive and visually appealing color scheme with progressively darker shades.

Fields

---

Tint

`schemes/scheme.zirr:170`

@Scheme(fn(s, nth) { tint(s.base, s.delta * nth) })
data Tint {
  base: Color2
  delta: maths.Fraction
}

A tint color scheme generates colors by increasing the lightness of a single base color. This creates a cohesive and visually appealing color scheme with progressively lighter tints.

Fields

---

Tone

`schemes/scheme.zirr:180`

@Scheme(fn(s, nth) { tone(s.base, s.delta * nth) })
data Tone {
  base: Color2
  delta: maths.Fraction
}

A tone color scheme generates colors by adding gray to a single base color. This creates a cohesive and visually appealing color scheme with progressively more muted tones.

Fields

---

Mix

`schemes/scheme.zirr:192`

@Scheme(fn(s, nth) { mix(s.base, s.target, s.ratio * nth) })
data Mix {
  base: Color2
  target: Color2
  ratio: maths.Fraction
}

A mix color scheme generates colors by blending a base color with a target color. The ratio parameter controls the blend between the two colors. This creates a smooth transition between the base and target colors. This is useful for creating gradients, color transitions or to simulate opacity.

Fields

---

GoldenSpiral

`schemes/scheme.zirr:209`

@Scheme(fn(s, nth) { … })
data GoldenSpiral {
  base: Color2
  scale: maths.Fraction
}

A golden spiral color scheme generates colors based on the golden angle (approximately 137.5 degrees). This creates a visually appealing and naturally balanced color scheme.

Fields

Series

---

Rainbow

`schemes/scheme.zirr:221`

@Scheme(fn(s, nth) { … })
data Rainbow {
  steps: Int
  saturation: maths.Fraction
  lightness: maths.Fraction
}

A rainbow color scheme generates colors that span the entire spectrum of the color wheel. This creates a vibrant and diverse color scheme. Colors are generated by evenly distributing hues around the color wheel.

Fields

Series

---

See also

• Colors — the color model and manipulation primitives.
• Maths — the Degree and Fraction wrappers used by every scheme.