aboutsummaryrefslogtreecommitdiff
path: root/docs/api/colors.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/api/colors.rst')
-rw-r--r--docs/api/colors.rst39
1 files changed, 24 insertions, 15 deletions
diff --git a/docs/api/colors.rst b/docs/api/colors.rst
index 937cd61..ddd1988 100644
--- a/docs/api/colors.rst
+++ b/docs/api/colors.rst
@@ -1,34 +1,43 @@
-Colors
-======
+Colors API
+==========
.. py:module:: thcolor.colors
The base class for colors is the following:
.. autoclass:: Color
- :members: alpha, assrgb, ashsl, ashwb, ascmyk, aslab, aslch, asxyz,
- replace, darker, lighter, desaturate, saturate,
- css, from_text
+ :members: alpha, assrgb, ashsl, ashsv, ashwb, ascmyk, aslab, aslch, asxyz,
+ asyiq, asyuv, fromtext, replace, darker, lighter, desaturate,
+ saturate, css
Subclasses are the following:
-.. autoclass:: SRGBColor
- :members: red, green, blue, alpha, frombytes, fromnetscapecolorname
+.. autoclass:: CMYKColor
+ :members: cyan, magenta, yellow, black, alpha
.. autoclass:: HSLColor
- :members: hue, saturation, lightness, alpha
+ :members: hue, saturation, lightness, alpha
-.. autoclass:: HWBColor
- :members: hue, whiteness, blackness, alpha
+.. autoclass:: HSVColor
+ :members: hue, saturation, value, alpha
-.. autoclass:: CMYKColor
- :members: cyan, magenta, yellow, black, alpha
+.. autoclass:: HWBColor
+ :members: hue, whiteness, blackness, alpha
.. autoclass:: LABColor
- :members: lightness, a, b, alpha
+ :members: lightness, a, b, alpha
.. autoclass:: LCHColor
- :members: lightness, chroma, hue, alpha
+ :members: lightness, chroma, hue, alpha
+
+.. autoclass:: SRGBColor
+ :members: red, green, blue, alpha, frombytes, fromnetscapecolorname
.. autoclass:: XYZColor
- :members: x, y, z, alpha
+ :members: x, y, z, alpha
+
+.. autoclass:: YIQColor
+ :members: y, i, q, alpha
+
+.. autoclass:: YUVColor
+ :members: y, u, v, alpha