Skip to content

Commit d921484

Browse files
committed
Updated docs.
1 parent 9c11dda commit d921484

File tree

114 files changed

+16057
-12642
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

114 files changed

+16057
-12642
lines changed

public/docs/ast/source/core/Disposable.js.json

Lines changed: 567 additions & 0 deletions
Large diffs are not rendered by default.

public/docs/ast/source/core/EffectComposer.js.json

Lines changed: 10196 additions & 9885 deletions
Large diffs are not rendered by default.

public/docs/ast/source/core/Resizable.js.json

Lines changed: 680 additions & 0 deletions
Large diffs are not rendered by default.

public/docs/ast/source/core/index.js.json

Lines changed: 584 additions & 44 deletions
Large diffs are not rendered by default.

public/docs/ast/source/index.js.json

Lines changed: 1284 additions & 1082 deletions
Large diffs are not rendered by default.

public/docs/ast/source/passes/Pass.js.json

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

public/docs/class/src/core/Disposable.js~Disposable.html

Lines changed: 234 additions & 0 deletions
Large diffs are not rendered by default.

public/docs/class/src/core/EffectComposer.js~EffectComposer.html

Lines changed: 31 additions & 63 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,8 @@
3030
<ul>
3131

3232
<li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#core">core</a><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/core/EffectComposer.js~EffectComposer.html">EffectComposer</a></span></span></li>
33+
<li data-ice="doc"><span data-ice="kind" class="kind-interface">I</span><span data-ice="name"><span><a href="class/src/core/Disposable.js~Disposable.html">Disposable</a></span></span></li>
34+
<li data-ice="doc"><span data-ice="kind" class="kind-interface">I</span><span data-ice="name"><span><a href="class/src/core/Resizable.js~Resizable.html">Resizable</a></span></span></li>
3335
<li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#materials">materials</a><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/materials/AdaptiveLuminosityMaterial.js~AdaptiveLuminosityMaterial.html">AdaptiveLuminosityMaterial</a></span></span></li>
3436
<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/materials/BokehMaterial.js~BokehMaterial.html">BokehMaterial</a></span></span></li>
3537
<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/materials/ColorEdgesMaterial.js~ColorEdgesMaterial.html">ColorEdgesMaterial</a></span></span></li>
@@ -81,13 +83,13 @@
8183
</nav>
8284

8385
<div class="content" data-ice="content"><div class="header-notice">
84-
<div data-ice="importPath" class="import-path"><pre class="prettyprint"><code data-ice="importPathCode">import {EffectComposer} from &apos;<span><a href="file/src/core/EffectComposer.js.html#lineNumber25">postprocessing/src/core/EffectComposer.js</a></span>&apos;</code></pre></div>
86+
<div data-ice="importPath" class="import-path"><pre class="prettyprint"><code data-ice="importPathCode">import {EffectComposer} from &apos;<span><a href="file/src/core/EffectComposer.js.html#lineNumber28">postprocessing/src/core/EffectComposer.js</a></span>&apos;</code></pre></div>
8587
<span data-ice="access">public</span>
8688
<span data-ice="kind">class</span>
8789

8890

8991

90-
<span data-ice="source">| <span><a href="file/src/core/EffectComposer.js.html#lineNumber25">source</a></span></span>
92+
<span data-ice="source">| <span><a href="file/src/core/EffectComposer.js.html#lineNumber28">source</a></span></span>
9193
</div>
9294

9395
<div class="self-detail detail">
@@ -100,7 +102,7 @@ <h1 data-ice="name">EffectComposer</h1>
100102

101103

102104

103-
105+
<div class="flat-list" data-ice="implements"><h4>Implements:</h4><ul><li><span><a href="class/src/core/Resizable.js~Resizable.html">Resizable</a></span></li>, <li><span><a href="class/src/core/Disposable.js~Disposable.html">Disposable</a></span></li></ul></div>
104106

105107

106108

@@ -458,13 +460,13 @@ <h1 data-ice="name">EffectComposer</h1>
458460

459461

460462

461-
<span class="code" data-ice="name"><span><a href="class/src/core/EffectComposer.js~EffectComposer.html#instance-method-dispose">dispose</a></span></span><span class="code" data-ice="signature">(renderTarget: <span>WebGLRenderTarget</span>)</span>
463+
<span class="code" data-ice="name"><span><a href="class/src/core/EffectComposer.js~EffectComposer.html#instance-method-dispose">dispose</a></span></span><span class="code" data-ice="signature">()</span>
462464
</p>
463465
</div>
464466
<div>
465467

466468

467-
<div data-ice="description"><p>Destroys all passes and render targets.</p>
469+
<div data-ice="description"><p>Destroys this composer and all passes.</p>
468470
</div>
469471
</div>
470472
</td>
@@ -574,7 +576,7 @@ <h1 data-ice="name">EffectComposer</h1>
574576

575577

576578

577-
<span class="code" data-ice="name"><span><a href="class/src/core/EffectComposer.js~EffectComposer.html#instance-method-reset">reset</a></span></span><span class="code" data-ice="signature">(renderTarget: <span>WebGLRenderTarget</span>)</span>
579+
<span class="code" data-ice="name"><span><a href="class/src/core/EffectComposer.js~EffectComposer.html#instance-method-reset">reset</a></span></span><span class="code" data-ice="signature">()</span>
578580
</p>
579581
</div>
580582
<div>
@@ -642,7 +644,7 @@ <h3 data-ice="anchor" id="instance-constructor-constructor">
642644
<span class="right-info">
643645

644646

645-
<span data-ice="source"><span><a href="file/src/core/EffectComposer.js.html#lineNumber37">source</a></span></span>
647+
<span data-ice="source"><span><a href="file/src/core/EffectComposer.js.html#lineNumber40">source</a></span></span>
646648
</span>
647649
</h3>
648650

@@ -737,7 +739,7 @@ <h3 data-ice="anchor" id="instance-get-depthTexture">
737739
<span class="right-info">
738740

739741

740-
<span data-ice="source"><span><a href="file/src/core/EffectComposer.js.html#lineNumber111">source</a></span></span>
742+
<span data-ice="source"><span><a href="file/src/core/EffectComposer.js.html#lineNumber114">source</a></span></span>
741743
</span>
742744
</h3>
743745

@@ -781,7 +783,7 @@ <h3 data-ice="anchor" id="instance-set-depthTexture">
781783
<span class="right-info">
782784

783785

784-
<span data-ice="source"><span><a href="file/src/core/EffectComposer.js.html#lineNumber129">source</a></span></span>
786+
<span data-ice="source"><span><a href="file/src/core/EffectComposer.js.html#lineNumber132">source</a></span></span>
785787
</span>
786788
</h3>
787789

@@ -830,7 +832,7 @@ <h3 data-ice="anchor" id="instance-member-renderer">
830832
<span class="right-info">
831833

832834

833-
<span data-ice="source"><span><a href="file/src/core/EffectComposer.js.html#lineNumber48">source</a></span></span>
835+
<span data-ice="source"><span><a href="file/src/core/EffectComposer.js.html#lineNumber51">source</a></span></span>
834836
</span>
835837
</h3>
836838

@@ -878,7 +880,7 @@ <h3 data-ice="anchor" id="instance-member-copyPass">
878880
<span class="right-info">
879881

880882

881-
<span data-ice="source"><span><a href="file/src/core/EffectComposer.js.html#lineNumber92">source</a></span></span>
883+
<span data-ice="source"><span><a href="file/src/core/EffectComposer.js.html#lineNumber95">source</a></span></span>
882884
</span>
883885
</h3>
884886

@@ -922,7 +924,7 @@ <h3 data-ice="anchor" id="instance-member-passes">
922924
<span class="right-info">
923925

924926

925-
<span data-ice="source"><span><a href="file/src/core/EffectComposer.js.html#lineNumber101">source</a></span></span>
927+
<span data-ice="source"><span><a href="file/src/core/EffectComposer.js.html#lineNumber104">source</a></span></span>
926928
</span>
927929
</h3>
928930

@@ -966,7 +968,7 @@ <h3 data-ice="anchor" id="instance-member-readBuffer">
966968
<span class="right-info">
967969

968970

969-
<span data-ice="source"><span><a href="file/src/core/EffectComposer.js.html#lineNumber60">source</a></span></span>
971+
<span data-ice="source"><span><a href="file/src/core/EffectComposer.js.html#lineNumber63">source</a></span></span>
970972
</span>
971973
</h3>
972974

@@ -1012,7 +1014,7 @@ <h3 data-ice="anchor" id="instance-member-writeBuffer">
10121014
<span class="right-info">
10131015

10141016

1015-
<span data-ice="source"><span><a href="file/src/core/EffectComposer.js.html#lineNumber69">source</a></span></span>
1017+
<span data-ice="source"><span><a href="file/src/core/EffectComposer.js.html#lineNumber72">source</a></span></span>
10161018
</span>
10171019
</h3>
10181020

@@ -1059,7 +1061,7 @@ <h3 data-ice="anchor" id="instance-method-addPass">
10591061
<span class="right-info">
10601062

10611063

1062-
<span data-ice="source"><span><a href="file/src/core/EffectComposer.js.html#lineNumber232">source</a></span></span>
1064+
<span data-ice="source"><span><a href="file/src/core/EffectComposer.js.html#lineNumber235">source</a></span></span>
10631065
</span>
10641066
</h3>
10651067

@@ -1127,7 +1129,7 @@ <h3 data-ice="anchor" id="instance-method-createBuffer">
11271129
<span class="right-info">
11281130

11291131

1130-
<span data-ice="source"><span><a href="file/src/core/EffectComposer.js.html#lineNumber197">source</a></span></span>
1132+
<span data-ice="source"><span><a href="file/src/core/EffectComposer.js.html#lineNumber200">source</a></span></span>
11311133
</span>
11321134
</h3>
11331135

@@ -1214,42 +1216,25 @@ <h3 data-ice="anchor" id="instance-method-dispose">
12141216

12151217

12161218

1217-
<span class="code" data-ice="name">dispose</span><span class="code" data-ice="signature">(renderTarget: <span>WebGLRenderTarget</span>)</span>
1219+
<span class="code" data-ice="name">dispose</span><span class="code" data-ice="signature">()</span>
12181220
<span class="right-info">
12191221

12201222

1221-
<span data-ice="source"><span><a href="file/src/core/EffectComposer.js.html#lineNumber398">source</a></span></span>
1223+
<span data-ice="source"><span><a href="file/src/core/EffectComposer.js.html#lineNumber401">source</a></span></span>
12221224
</span>
12231225
</h3>
12241226

12251227

12261228

12271229

1228-
<div data-ice="description"><p>Destroys all passes and render targets.</p>
1229-
<p>This method deallocates all render targets, textures and materials created
1230-
by the passes. It also deletes this composer&apos;s frame buffers.</p>
1230+
<div data-ice="description"><p>Destroys this composer and all passes.</p>
1231+
<p>This method deallocates all disposable objects created by the passes. It
1232+
also deletes the main frame buffers of this composer.</p>
12311233
</div>
12321234

12331235

12341236

1235-
<div data-ice="properties"><div data-ice="properties">
1236-
<h4 data-ice="title">Params:</h4>
1237-
<table class="params">
1238-
<thead>
1239-
<tr><td>Name</td><td>Type</td><td>Attribute</td><td>Description</td></tr>
1240-
</thead>
1241-
<tbody>
1242-
1243-
<tr data-ice="property" data-depth="0">
1244-
<td data-ice="name" class="code" data-depth="0">renderTarget</td>
1245-
<td data-ice="type" class="code"><span>WebGLRenderTarget</span></td>
1246-
<td data-ice="appendix"><ul><li>optional</li></ul></td>
1247-
<td data-ice="description"><p>A new render target. If none is provided, the composer will become inoperative.</p>
1248-
</td>
1249-
</tr>
1250-
</tbody>
1251-
</table>
1252-
</div>
1237+
<div data-ice="properties">
12531238
</div>
12541239

12551240

@@ -1281,7 +1266,7 @@ <h3 data-ice="anchor" id="instance-method-removePass">
12811266
<span class="right-info">
12821267

12831268

1284-
<span data-ice="source"><span><a href="file/src/core/EffectComposer.js.html#lineNumber258">source</a></span></span>
1269+
<span data-ice="source"><span><a href="file/src/core/EffectComposer.js.html#lineNumber261">source</a></span></span>
12851270
</span>
12861271
</h3>
12871272

@@ -1342,7 +1327,7 @@ <h3 data-ice="anchor" id="instance-method-render">
13421327
<span class="right-info">
13431328

13441329

1345-
<span data-ice="source"><span><a href="file/src/core/EffectComposer.js.html#lineNumber270">source</a></span></span>
1330+
<span data-ice="source"><span><a href="file/src/core/EffectComposer.js.html#lineNumber273">source</a></span></span>
13461331
</span>
13471332
</h3>
13481333

@@ -1403,7 +1388,7 @@ <h3 data-ice="anchor" id="instance-method-replaceRenderer">
14031388
<span class="right-info">
14041389

14051390

1406-
<span data-ice="source"><span><a href="file/src/core/EffectComposer.js.html#lineNumber150">source</a></span></span>
1391+
<span data-ice="source"><span><a href="file/src/core/EffectComposer.js.html#lineNumber153">source</a></span></span>
14071392
</span>
14081393
</h3>
14091394

@@ -1478,11 +1463,11 @@ <h3 data-ice="anchor" id="instance-method-reset">
14781463

14791464

14801465

1481-
<span class="code" data-ice="name">reset</span><span class="code" data-ice="signature">(renderTarget: <span>WebGLRenderTarget</span>)</span>
1466+
<span class="code" data-ice="name">reset</span><span class="code" data-ice="signature">()</span>
14821467
<span class="right-info">
14831468

14841469

1485-
<span data-ice="source"><span><a href="file/src/core/EffectComposer.js.html#lineNumber376">source</a></span></span>
1470+
<span data-ice="source"><span><a href="file/src/core/EffectComposer.js.html#lineNumber377">source</a></span></span>
14861471
</span>
14871472
</h3>
14881473

@@ -1494,24 +1479,7 @@ <h3 data-ice="anchor" id="instance-method-reset">
14941479

14951480

14961481

1497-
<div data-ice="properties"><div data-ice="properties">
1498-
<h4 data-ice="title">Params:</h4>
1499-
<table class="params">
1500-
<thead>
1501-
<tr><td>Name</td><td>Type</td><td>Attribute</td><td>Description</td></tr>
1502-
</thead>
1503-
<tbody>
1504-
1505-
<tr data-ice="property" data-depth="0">
1506-
<td data-ice="name" class="code" data-depth="0">renderTarget</td>
1507-
<td data-ice="type" class="code"><span>WebGLRenderTarget</span></td>
1508-
<td data-ice="appendix"><ul><li>optional</li></ul></td>
1509-
<td data-ice="description"><p>A new render target. If none is provided, the settings of the renderer will be used.</p>
1510-
</td>
1511-
</tr>
1512-
</tbody>
1513-
</table>
1514-
</div>
1482+
<div data-ice="properties">
15151483
</div>
15161484

15171485

@@ -1543,7 +1511,7 @@ <h3 data-ice="anchor" id="instance-method-setSize">
15431511
<span class="right-info">
15441512

15451513

1546-
<span data-ice="source"><span><a href="file/src/core/EffectComposer.js.html#lineNumber337">source</a></span></span>
1514+
<span data-ice="source"><span><a href="file/src/core/EffectComposer.js.html#lineNumber340">source</a></span></span>
15471515
</span>
15481516
</h3>
15491517

0 commit comments

Comments
 (0)