Skip to content

Commit 2d8e4e5

Browse files
update docs
1 parent cdfd121 commit 2d8e4e5

File tree

1 file changed

+17
-17
lines changed

1 file changed

+17
-17
lines changed

README.rst

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -67,9 +67,9 @@ Usage Example
6767
``grayscale(index, gamma)``
6868

6969
Translates the normalized index value into a 24-bit RGB integer with gamma
70-
adjustment. The spectral index is a floating point value in the range of 0.0 to
71-
1.0 (inclusive); default is 0.0. The gamma value can be from 0.0 to 1.0
72-
(inclusive); default is 0.8, tuned for TFT displays. If the index or gamma
70+
visual perception control. The spectral index is a floating point value in the
71+
range of 0.0 to 1.0 (inclusive); default is 0.0. The gamma value can be from 0.0
72+
to 1.0 (inclusive); default is 0.8, tuned for TFT displays. If the index or gamma
7373
value is outside of the specified range, the 24-bit RGB output will be limited
7474
to the minimum (0x0) or maximum (0xFFFFFF) value.
7575

@@ -83,9 +83,9 @@ to the minimum (0x0) or maximum (0xFFFFFF) value.
8383
``iron(index, gamma)``
8484

8585
Translates the normalized index value into a 24-bit RGB integer with gamma
86-
adjustment. The spectral index is a floating point value in the range of 0.0 to
87-
1.0 (inclusive); default is 0.0. The gamma value can be from 0.0 to 1.0
88-
(inclusive); default is 0.5, tuned for TFT displays. If the index or gamma
86+
visual perception control. The spectral index is a floating point value in the
87+
range of 0.0 to 1.0 (inclusive); default is 0.0. The gamma value can be from 0.0
88+
to 1.0 (inclusive); default is 0.5, tuned for TFT displays. If the index or gamma
8989
value is outside of the specified range, the 24-bit RGB output will be limited
9090
to the minimum (0x0) or maximum (0xFFFFFF) value.
9191

@@ -99,9 +99,9 @@ to the minimum (0x0) or maximum (0xFFFFFF) value.
9999
``stoplight(index, gamma)``
100100

101101
Translates the normalized index value into a 24-bit RGB integer with gamma
102-
adjustment. The spectral index is a floating point value in the range of 0.0 to
103-
1.0 (inclusive); default is 0.0. The gamma value can be from 0.0 to 1.0
104-
(inclusive); default is 0.5, tuned for TFT displays. If the index or gamma
102+
visual perception control. The spectral index is a floating point value in the
103+
range of 0.0 to 1.0 (inclusive); default is 0.0. The gamma value can be from 0.0
104+
to 1.0 (inclusive); default is 0.5, tuned for TFT displays. If the index or gamma
105105
value is outside of the specified range, the 24-bit RGB output will be limited
106106
to the minimum (0x0) or maximum (0xFFFFFF) value.
107107

@@ -115,9 +115,9 @@ to the minimum (0x0) or maximum (0xFFFFFF) value.
115115
``visible(index, gamma)``
116116

117117
Translates the normalized index value into a 24-bit RGB integer with gamma
118-
adjustment. The spectral index is a floating point value in the range of 0.0 to
119-
1.0 (inclusive); default is 0.0. The gamma value can be from 0.0 to 1.0
120-
(inclusive); default is 0.5, tuned for TFT displays. If the index or gamma
118+
visual perception control. The spectral index is a floating point value in the
119+
range of 0.0 to 1.0 (inclusive); default is 0.0. The gamma value can be from 0.0
120+
to 1.0 (inclusive); default is 0.5, tuned for TFT displays. If the index or gamma
121121
value is outside of the specified range, the 24-bit RGB output will be limited
122122
to the minimum (0x0) or maximum (0xFFFFFF) value.
123123

@@ -131,11 +131,11 @@ to the minimum (0x0) or maximum (0xFFFFFF) value.
131131
``n_color(index, gamma)``
132132

133133
A class that translates the normalized index value into a 24-bit RGB integer
134-
with gamma adjustment. The spectral index is a floating point value in the
135-
range of 0.0 to 1.0 (inclusive); default is 0.0. The gamma value can be from
136-
0.0 to 3.0 (inclusive); default is 0.55, tuned for TFT displays. If the index
137-
or gamma value is outside of the specified range, the 24-bit RGB output will be
138-
limited to the minimum (0x0) or maximum (0xFFFFFF) value.
134+
with gamma visual perception control. The spectral index is a floating point
135+
value in the range of 0.0 to 1.0 (inclusive); default is 0.0. The gamma value
136+
can be from 0.0 to 3.0 (inclusive); default is 0.55, tuned for TFT displays. If
137+
the index or gamma value is outside of the specified range, the 24-bit RGB
138+
output will be limited to the minimum (0x0) or maximum (0xFFFFFF) value.
139139

140140
The class converts a spectrum index value consisting of a positive numeric
141141
value (0.0 to 1.0, modulus of 1.0) to an RGB color value that representing the

0 commit comments

Comments
 (0)