Skip to content

Commit da01e9e

Browse files
vanruescvanruesc
committed
Updated docs.
1 parent a9b53b3 commit da01e9e

17 files changed

+6956
-6654
lines changed

‎public/docs/ast/source/passes/ClearPass.js.json‎

Lines changed: 1415 additions & 1159 deletions
Large diffs are not rendered by default.

‎public/docs/ast/source/passes/GodRaysPass.js.json‎

Lines changed: 1184 additions & 1322 deletions
Large diffs are not rendered by default.

‎public/docs/ast/source/passes/OutlinePass.js.json‎

Lines changed: 1387 additions & 1525 deletions
Large diffs are not rendered by default.

‎public/docs/ast/source/passes/RenderPass.js.json‎

Lines changed: 1694 additions & 1507 deletions
Large diffs are not rendered by default.

‎public/docs/ast/source/passes/SMAAPass.js.json‎

Lines changed: 751 additions & 820 deletions
Large diffs are not rendered by default.

‎public/docs/class/src/passes/ClearPass.js~ClearPass.html‎

Lines changed: 81 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ <h1 data-ice="name">ClearPass</h1>
109109

110110

111111

112-
<div class="description" data-ice="description"><p>A pass that clears the output buffer or the screen.</p>
112+
<div class="description" data-ice="description"><p>A pass that clears the input buffer or the screen.</p>
113113
<p>You can prevent specific bits from being cleared by setting either the
114114
autoClearColor, autoClearStencil or autoClearDepth properties of the renderer
115115
to false.</p>
@@ -223,6 +223,34 @@ <h1 data-ice="name">ClearPass</h1>
223223
<td>
224224

225225

226+
</td>
227+
</tr>
228+
<tr data-ice="target">
229+
<td>
230+
<span class="access" data-ice="access">public</span>
231+
232+
233+
234+
<span class="override" data-ice="override"></span>
235+
</td>
236+
<td>
237+
<div>
238+
<p>
239+
240+
241+
242+
<span class="code" data-ice="name"><span><a href="class/src/passes/ClearPass.js~ClearPass.html#instance-member-needsSwap">needsSwap</a></span></span><span class="code" data-ice="signature">: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean">boolean</a></span></span>
243+
</p>
244+
</div>
245+
<div>
246+
247+
248+
249+
</div>
250+
</td>
251+
<td>
252+
253+
226254
</td>
227255
</tr>
228256
</tbody>
@@ -252,7 +280,7 @@ <h1 data-ice="name">ClearPass</h1>
252280
<div>
253281

254282

255-
<div data-ice="description"><p>Clears the output buffer or the screen.</p>
283+
<div data-ice="description"><p>Clears the input buffer or the screen.</p>
256284
</div>
257285
</div>
258286
</td>
@@ -780,7 +808,7 @@ <h3 data-ice="anchor" id="instance-member-clearAlpha">
780808
<span class="right-info">
781809

782810

783-
<span data-ice="source"><span><a href="file/src/passes/ClearPass.js.html#lineNumber49">source</a></span></span>
811+
<span data-ice="source"><span><a href="file/src/passes/ClearPass.js.html#lineNumber51">source</a></span></span>
784812
</span>
785813
</h3>
786814

@@ -824,7 +852,7 @@ <h3 data-ice="anchor" id="instance-member-clearColor">
824852
<span class="right-info">
825853

826854

827-
<span data-ice="source"><span><a href="file/src/passes/ClearPass.js.html#lineNumber41">source</a></span></span>
855+
<span data-ice="source"><span><a href="file/src/passes/ClearPass.js.html#lineNumber43">source</a></span></span>
828856
</span>
829857
</h3>
830858

@@ -855,6 +883,53 @@ <h3 data-ice="anchor" id="instance-member-clearColor">
855883

856884

857885

886+
</div>
887+
<div class="detail" data-ice="detail">
888+
<h3 data-ice="anchor" id="instance-member-needsSwap">
889+
<span class="access" data-ice="access">public</span>
890+
891+
892+
893+
894+
895+
<span class="code" data-ice="name">needsSwap</span><span class="code" data-ice="signature">: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean">boolean</a></span></span>
896+
<span class="right-info">
897+
898+
899+
<span data-ice="source"><span><a href="file/src/passes/ClearPass.js.html#lineNumber35">source</a></span></span>
900+
</span>
901+
</h3>
902+
903+
904+
905+
906+
<div data-ice="description"><p>Indicates whether the <span><a href="class/src/core/EffectComposer.js~EffectComposer.html">EffectComposer</a></span> should swap the frame
907+
buffers after this pass has finished rendering.</p>
908+
<p>Set this to <code>false</code> if this pass doesn&apos;t render to the output buffer or
909+
the screen. Otherwise, the contents of the input buffer will be lost.</p>
910+
</div>
911+
912+
<div data-ice="override"><h4>Override:</h4><span><a href="class/src/passes/Pass.js~Pass.html#instance-member-needsSwap">Pass#needsSwap</a></span></div>
913+
914+
<div data-ice="properties">
915+
</div>
916+
917+
918+
919+
920+
921+
922+
923+
924+
925+
926+
927+
928+
929+
930+
931+
932+
858933
</div>
859934
</div>
860935
<div data-ice="methodDetails"><h2 data-ice="title">Public Methods</h2>
@@ -871,14 +946,14 @@ <h3 data-ice="anchor" id="instance-method-render">
871946
<span class="right-info">
872947

873948

874-
<span data-ice="source"><span><a href="file/src/passes/ClearPass.js.html#lineNumber63">source</a></span></span>
949+
<span data-ice="source"><span><a href="file/src/passes/ClearPass.js.html#lineNumber65">source</a></span></span>
875950
</span>
876951
</h3>
877952

878953

879954

880955

881-
<div data-ice="description"><p>Clears the output buffer or the screen.</p>
956+
<div data-ice="description"><p>Clears the input buffer or the screen.</p>
882957
</div>
883958

884959
<div data-ice="override"><h4>Override:</h4><span><a href="class/src/passes/Pass.js~Pass.html#instance-method-render">Pass#render</a></span></div>

‎public/docs/class/src/passes/RenderPass.js~RenderPass.html‎

Lines changed: 80 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -258,6 +258,34 @@ <h1 data-ice="name">RenderPass</h1>
258258

259259

260260

261+
<span class="override" data-ice="override"></span>
262+
</td>
263+
<td>
264+
<div>
265+
<p>
266+
267+
268+
269+
<span class="code" data-ice="name"><span><a href="class/src/passes/RenderPass.js~RenderPass.html#instance-member-needsSwap">needsSwap</a></span></span><span class="code" data-ice="signature">: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean">boolean</a></span></span>
270+
</p>
271+
</div>
272+
<div>
273+
274+
275+
276+
</div>
277+
</td>
278+
<td>
279+
280+
281+
</td>
282+
</tr>
283+
<tr data-ice="target">
284+
<td>
285+
<span class="access" data-ice="access">public</span>
286+
287+
288+
261289
<span class="override" data-ice="override"></span>
262290
</td>
263291
<td>
@@ -874,7 +902,7 @@ <h3 data-ice="anchor" id="instance-member-clear">
874902
<span class="right-info">
875903

876904

877-
<span data-ice="source"><span><a href="file/src/passes/RenderPass.js.html#lineNumber62">source</a></span></span>
905+
<span data-ice="source"><span><a href="file/src/passes/RenderPass.js.html#lineNumber64">source</a></span></span>
878906
</span>
879907
</h3>
880908

@@ -921,7 +949,7 @@ <h3 data-ice="anchor" id="instance-member-clearDepth">
921949
<span class="right-info">
922950

923951

924-
<span data-ice="source"><span><a href="file/src/passes/RenderPass.js.html#lineNumber50">source</a></span></span>
952+
<span data-ice="source"><span><a href="file/src/passes/RenderPass.js.html#lineNumber52">source</a></span></span>
925953
</span>
926954
</h3>
927955

@@ -965,7 +993,7 @@ <h3 data-ice="anchor" id="instance-member-clearPass">
965993
<span class="right-info">
966994

967995

968-
<span data-ice="source"><span><a href="file/src/passes/RenderPass.js.html#lineNumber34">source</a></span></span>
996+
<span data-ice="source"><span><a href="file/src/passes/RenderPass.js.html#lineNumber36">source</a></span></span>
969997
</span>
970998
</h3>
971999

@@ -996,6 +1024,53 @@ <h3 data-ice="anchor" id="instance-member-clearPass">
9961024

9971025

9981026

1027+
</div>
1028+
<div class="detail" data-ice="detail">
1029+
<h3 data-ice="anchor" id="instance-member-needsSwap">
1030+
<span class="access" data-ice="access">public</span>
1031+
1032+
1033+
1034+
1035+
1036+
<span class="code" data-ice="name">needsSwap</span><span class="code" data-ice="signature">: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean">boolean</a></span></span>
1037+
<span class="right-info">
1038+
1039+
1040+
<span data-ice="source"><span><a href="file/src/passes/RenderPass.js.html#lineNumber28">source</a></span></span>
1041+
</span>
1042+
</h3>
1043+
1044+
1045+
1046+
1047+
<div data-ice="description"><p>Indicates whether the <span><a href="class/src/core/EffectComposer.js~EffectComposer.html">EffectComposer</a></span> should swap the frame
1048+
buffers after this pass has finished rendering.</p>
1049+
<p>Set this to <code>false</code> if this pass doesn&apos;t render to the output buffer or
1050+
the screen. Otherwise, the contents of the input buffer will be lost.</p>
1051+
</div>
1052+
1053+
<div data-ice="override"><h4>Override:</h4><span><a href="class/src/passes/Pass.js~Pass.html#instance-member-needsSwap">Pass#needsSwap</a></span></div>
1054+
1055+
<div data-ice="properties">
1056+
</div>
1057+
1058+
1059+
1060+
1061+
1062+
1063+
1064+
1065+
1066+
1067+
1068+
1069+
1070+
1071+
1072+
1073+
9991074
</div>
10001075
<div class="detail" data-ice="detail">
10011076
<h3 data-ice="anchor" id="instance-member-overrideMaterial">
@@ -1009,7 +1084,7 @@ <h3 data-ice="anchor" id="instance-member-overrideMaterial">
10091084
<span class="right-info">
10101085

10111086

1012-
<span data-ice="source"><span><a href="file/src/passes/RenderPass.js.html#lineNumber42">source</a></span></span>
1087+
<span data-ice="source"><span><a href="file/src/passes/RenderPass.js.html#lineNumber44">source</a></span></span>
10131088
</span>
10141089
</h3>
10151090

@@ -1056,7 +1131,7 @@ <h3 data-ice="anchor" id="instance-method-render">
10561131
<span class="right-info">
10571132

10581133

1059-
<span data-ice="source"><span><a href="file/src/passes/RenderPass.js.html#lineNumber76">source</a></span></span>
1134+
<span data-ice="source"><span><a href="file/src/passes/RenderPass.js.html#lineNumber78">source</a></span></span>
10601135
</span>
10611136
</h3>
10621137

‎public/docs/coverage.json‎

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
2-
"coverage": "92.51%",
3-
"expectCount": 414,
2+
"coverage": "92.06%",
3+
"expectCount": 416,
44
"actualCount": 383,
55
"files": {
66
"src/core/Disposable.js": {
@@ -179,9 +179,11 @@
179179
]
180180
},
181181
"src/passes/ClearPass.js": {
182-
"expectCount": 6,
182+
"expectCount": 7,
183183
"actualCount": 6,
184-
"undocumentLines": []
184+
"undocumentLines": [
185+
35
186+
]
185187
},
186188
"src/passes/DotScreenPass.js": {
187189
"expectCount": 5,
@@ -249,9 +251,11 @@
249251
]
250252
},
251253
"src/passes/RenderPass.js": {
252-
"expectCount": 7,
254+
"expectCount": 8,
253255
"actualCount": 7,
254-
"undocumentLines": []
256+
"undocumentLines": [
257+
28
258+
]
255259
},
256260
"src/passes/SavePass.js": {
257261
"expectCount": 9,

‎public/docs/file/src/passes/ClearPass.js.html‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@
9696
const color = new Color();
9797

9898
/**
99-
* A pass that clears the output buffer or the screen.
99+
* A pass that clears the input buffer or the screen.
100100
*
101101
* You can prevent specific bits from being cleared by setting either the
102102
* autoClearColor, autoClearStencil or autoClearDepth properties of the renderer
@@ -117,6 +117,8 @@
117117

118118
super(&quot;ClearPass&quot;, null, null, null);
119119

120+
this.needsSwap = false;
121+
120122
/**
121123
* The clear color.
122124
*
@@ -136,7 +138,7 @@
136138
}
137139

138140
/**
139-
* Clears the output buffer or the screen.
141+
* Clears the input buffer or the screen.
140142
*
141143
* @param {WebGLRenderer} renderer - The renderer.
142144
* @param {WebGLRenderTarget} inputBuffer - A frame buffer that contains the result of the previous pass.
@@ -159,7 +161,7 @@
159161

160162
}
161163

162-
renderer.setRenderTarget(this.renderToScreen ? null : outputBuffer);
164+
renderer.setRenderTarget(this.renderToScreen ? null : inputBuffer);
163165
renderer.clear();
164166

165167
if(clearColor !== null) {

‎public/docs/file/src/passes/GodRaysPass.js.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -493,8 +493,8 @@
493493

494494
/* First, render the light source. Then render the scene into the same
495495
buffer using a mask override material with depth test enabled. */
496-
this.renderPassLight.render(renderer, null, renderTargetMask);
497-
this.renderPassMask.render(renderer, null, renderTargetMask);
496+
this.renderPassLight.render(renderer, renderTargetMask);
497+
this.renderPassMask.render(renderer, renderTargetMask);
498498

499499
if(parent !== null) {
500500

0 commit comments

Comments
 (0)