Skip to content

Commit 7939e21

Browse files
BjvanminnenBjvanminnen
committed
Documentation for hex/intensity on all lights
1 parent 6a535af commit 7939e21

6 files changed

Lines changed: 19 additions & 19 deletions

File tree

‎docs/api/lights/AmbientLight.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ <h2>Example</h2>
2424
<h2>Constructor</h2>
2525

2626

27-
<h3>[name]( [page:Float hex] )</h3>
27+
<h3>[name]( [page:Integer hex] )</h3>
2828
<div>
2929
[page:Integer hex] — Numeric value of the RGB component of the color.
3030
</div>

‎docs/api/lights/AreaLight.html‎

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -24,10 +24,10 @@ <h2>Example</h2>
2424
<h2>Constructor</h2>
2525

2626

27-
<h3>[name]( [page:Float hex], [page:Float intensity])</h3>
27+
<h3>[name]( [page:Integer hex], [page:Float intensity])</h3>
2828
<div>
2929
[page:Integer hex] — Numeric value of the RGB component of the color.<br />
30-
[page:Integer intensity] — The intensity of the light.
30+
[page:Float intensity] — Numeric value of the light's strength/intensity.
3131
</div>
3232
<div>
3333
This creates a arealight with color.
@@ -68,10 +68,11 @@ <h3>.[page:number width]</h3>
6868
todo
6969
</div>
7070

71-
<h3>.[page:number intensity]</h3>
71+
<h3>.[page:Float intensity]</h3>
7272
<div>
73-
todo
74-
</div>
73+
Light's intensity.<br />
74+
Default — *1.0*.
75+
</div>
7576

7677
<h3>.[page:number constantAttenuation]</h3>
7778
<div>

‎docs/api/lights/DirectionalLight.html‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,10 +28,10 @@ <h2>Example</h2>
2828
<h2>Constructor</h2>
2929

3030

31-
<h3>[name]([page:todo hex], [page:todo intensity])</h3>
31+
<h3>[name]([page:Integer hex], [page:Float intensity])</h3>
3232
<div>
33-
hex -- Numeric value of the RGB component of the color. <br />
34-
intensity -- todo
33+
[page:Integer hex] -- Numeric value of the RGB component of the color. <br />
34+
[page:Float intensity] -- Numeric value of the light's strength/intensity.
3535
</div>
3636
<div>
3737
Creates a light that shines from a specific direction not from a specific position. This light will behave

‎docs/api/lights/HemisphereLight.html‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,11 +16,11 @@ <h1>[name]</h1>
1616
<h2>Constructor</h2>
1717

1818

19-
<h3>[name]([page:todo skyColorHex], [page:todo groundColorHex], [page:todo intensity])</h3>
19+
<h3>[name]([page:Integer skyColorHex], [page:Integer groundColorHex], [page:Float intensity])</h3>
2020
<div>
2121
[page:Integer skyColorHex] — Numeric value of the RGB sky color.<br />
2222
[page:Integer groundColorHex] — Numeric value of the RGB ground color.<br />
23-
[page:Integer intensity] — The intensity of the light.
23+
[page:Float intensity] — Numeric value of the light's strength/intensity.
2424
</div>
2525

2626
<h2>Properties</h2>
@@ -32,10 +32,9 @@ <h3>.[page:Float groundColor]</h3>
3232
</div>
3333

3434
<h3>.[page:Float intensity]</h3>
35-
3635
<div>
3736
Light's intensity.<br />
38-
Default — *1*.
37+
Default — *1.0*.
3938
</div>
4039

4140
<h2>Methods</h2>

‎docs/api/lights/PointLight.html‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,10 +26,10 @@ <h2>Example</h2>
2626
<h2>Constructor</h2>
2727

2828

29-
<h3>[name]([page:todo hex], [page:todo intensity], [page:todo distance])</h3>
29+
<h3>[name]([page:Integer hex], [page:Float intensity], [page:todo distance])</h3>
3030
<div>
31-
hex -- Numeric value of the RGB component of the color. <br />
32-
intensity -- todo <br />
31+
[page:Integer hex] — Numeric value of the RGB component of the color. <br />
32+
[page:Float intensity] — Numeric value of the light's strength/intensity. <br />
3333
distance -- todo
3434
</div>
3535
<div>

‎docs/api/lights/SpotLight.html‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -38,10 +38,10 @@ <h2>Example</h2>
3838
<h2>Constructor</h2>
3939

4040

41-
<h3>[name]([page:todo hex], [page:todo intensity], [page:todo distance], [page:todo angle], [page:todo exponent])</h3>
41+
<h3>[name]([page:Integer hex], [page:Float intensity], [page:todo distance], [page:todo angle], [page:todo exponent])</h3>
4242
<div>
43-
hex -- todo <br />
44-
intensity -- todo <br />
43+
[page:Integer hex] — Numeric value of the RGB component of the color. <br />
44+
[page:Float intensity] — Numeric value of the light's strength/intensity. <br />
4545
distance -- todo <br />
4646
angle -- todo <br />
4747
exponent -- todo

0 commit comments

Comments
 (0)