Skip to content

Commit c5b29f9

Browse files
committed
Documentation: Improved Color.
1 parent fe7f25a commit c5b29f9

File tree

2 files changed

+9
-159
lines changed

2 files changed

+9
-159
lines changed

docs/api/core/Color.html

Lines changed: 9 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -16,17 +16,17 @@ <h2>Properties</h2>
1616

1717
<h3>.[page:Number r]</h3>
1818
<div>
19-
Red channel value (between 0 and 1).
19+
Red channel value between 0 and 1. Default is 1.
2020
</div>
2121

2222
<h3>.[page:Number g]</h3>
2323
<div>
24-
Green channel value (between 0 and 1).
24+
Green channel value between 0 and 1. Default is 1.
2525
</div>
2626

2727
<h3>.[page:Number b]</h3>
2828
<div>
29-
Blue channel value (between 0 and 1).
29+
Blue channel value between 0 and 1. Default is 1.
3030
</div>
3131

3232
<h2>Methods</h2>
@@ -57,35 +57,29 @@ <h3>.copyLinearToGamma( [page:Color color] ) [page:this]</h3>
5757

5858
<h3>.convertGammaToLinear() [page:this]</h3>
5959
<div>
60-
color — Color to copy.
61-
</div>
62-
<div>
6360
Converts this color from gamma to linear space.
6461
</div>
6562

6663
<h3>.convertLinearToGamma() [page:this]</h3>
6764
<div>
68-
color — Color to copy.
69-
</div>
70-
<div>
7165
Converts this color from linear to gamma space.
7266
</div>
7367

7468
<h3>.setRGB( [page:Number r], [page:Number g], [page:Number b] ) [page:this]</h3>
7569
<div>
76-
r — Red channel value (between 0 and 1).<br />
77-
g — Green channel value (between 0 and 1).<br />
78-
b — Blue channel value (between 0 and 1).
70+
r — Red channel value between 0 and 1.<br />
71+
g — Green channel value between 0 and 1.<br />
72+
b — Blue channel value between 0 and 1.
7973
</div>
8074
<div>
8175
Sets this color from RGB values.
8276
</div>
8377

8478
<h3>.setHSV( [page:Number h], [page:Number s], [page:Number v] ) [page:this]</h3>
8579
<div>
86-
h — Hue channel (between 0 and 1).<br />
87-
s — Saturation channel (between 0 and 1).<br />
88-
v — Value channel (between 0 and 1).
80+
h — Hue channel value between 0 and 1.<br />
81+
s — Saturation value channel between 0 and 1.<br />
82+
v — Value channel value between 0 and 1.
8983
</div>
9084
<div>
9185
Sets this color from HSV values.<br />

docs/api/core/Color.rst

Lines changed: 0 additions & 144 deletions
This file was deleted.

0 commit comments

Comments
 (0)