Skip to content

Commit 6085836

Browse files
vanruescvanruesc
committed
Updated docs.
1 parent 7496f2f commit 6085836

File tree

93 files changed

+7855
-1313
lines changed

Some content is hidden

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

93 files changed

+7855
-1313
lines changed

‎docs/api.js‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ YUI.add("yuidoc-meta", function(Y) {
99
"BokehMaterial",
1010
"BokehPass",
1111
"ClearMaskPass",
12+
"ClearPass",
1213
"CombineMaterial",
1314
"ConvolutionMaterial",
1415
"CopyMaterial",
@@ -28,13 +29,17 @@ YUI.add("yuidoc-meta", function(Y) {
2829
"LuminosityMaterial",
2930
"MaskPass",
3031
"Pass",
32+
"PixelationMaterial",
33+
"PixelationPass",
3134
"RenderPass",
3235
"SMAABlendMaterial",
3336
"SMAAColorEdgesMaterial",
3437
"SMAAPass",
3538
"SMAAWeightsMaterial",
3639
"SavePass",
3740
"ShaderPass",
41+
"ShockWaveMaterial",
42+
"ShockWavePass",
3843
"TexturePass",
3944
"ToneMappingMaterial",
4045
"ToneMappingPass"

‎docs/classes/AdaptiveLuminosityMaterial.html‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
<h1><img src="../assets/css/logo.png" title="postprocessing" width="117" height="52"></h1>
1818
</div>
1919
<div class="yui3-u-1-4 version">
20-
<em>API Docs for: 2.0.0</em>
20+
<em>API Docs for: 2.1.0</em>
2121
</div>
2222
</div>
2323
<div id="bd" class="yui3-g">
@@ -46,6 +46,7 @@ <h2 class="off-left">APIs</h2>
4646
<li><a href="../classes/BokehMaterial.html">BokehMaterial</a></li>
4747
<li><a href="../classes/BokehPass.html">BokehPass</a></li>
4848
<li><a href="../classes/ClearMaskPass.html">ClearMaskPass</a></li>
49+
<li><a href="../classes/ClearPass.html">ClearPass</a></li>
4950
<li><a href="../classes/CombineMaterial.html">CombineMaterial</a></li>
5051
<li><a href="../classes/ConvolutionMaterial.html">ConvolutionMaterial</a></li>
5152
<li><a href="../classes/CopyMaterial.html">CopyMaterial</a></li>
@@ -65,9 +66,13 @@ <h2 class="off-left">APIs</h2>
6566
<li><a href="../classes/LuminosityMaterial.html">LuminosityMaterial</a></li>
6667
<li><a href="../classes/MaskPass.html">MaskPass</a></li>
6768
<li><a href="../classes/Pass.html">Pass</a></li>
69+
<li><a href="../classes/PixelationMaterial.html">PixelationMaterial</a></li>
70+
<li><a href="../classes/PixelationPass.html">PixelationPass</a></li>
6871
<li><a href="../classes/RenderPass.html">RenderPass</a></li>
6972
<li><a href="../classes/SavePass.html">SavePass</a></li>
7073
<li><a href="../classes/ShaderPass.html">ShaderPass</a></li>
74+
<li><a href="../classes/ShockWaveMaterial.html">ShockWaveMaterial</a></li>
75+
<li><a href="../classes/ShockWavePass.html">ShockWavePass</a></li>
7176
<li><a href="../classes/SMAABlendMaterial.html">SMAABlendMaterial</a></li>
7277
<li><a href="../classes/SMAAColorEdgesMaterial.html">SMAAColorEdgesMaterial</a></li>
7378
<li><a href="../classes/SMAAPass.html">SMAAPass</a></li>

‎docs/classes/BloomPass.html‎

Lines changed: 63 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
<h1><img src="../assets/css/logo.png" title="postprocessing" width="117" height="52"></h1>
1818
</div>
1919
<div class="yui3-u-1-4 version">
20-
<em>API Docs for: 2.0.0</em>
20+
<em>API Docs for: 2.1.0</em>
2121
</div>
2222
</div>
2323
<div id="bd" class="yui3-g">
@@ -46,6 +46,7 @@ <h2 class="off-left">APIs</h2>
4646
<li><a href="../classes/BokehMaterial.html">BokehMaterial</a></li>
4747
<li><a href="../classes/BokehPass.html">BokehPass</a></li>
4848
<li><a href="../classes/ClearMaskPass.html">ClearMaskPass</a></li>
49+
<li><a href="../classes/ClearPass.html">ClearPass</a></li>
4950
<li><a href="../classes/CombineMaterial.html">CombineMaterial</a></li>
5051
<li><a href="../classes/ConvolutionMaterial.html">ConvolutionMaterial</a></li>
5152
<li><a href="../classes/CopyMaterial.html">CopyMaterial</a></li>
@@ -65,9 +66,13 @@ <h2 class="off-left">APIs</h2>
6566
<li><a href="../classes/LuminosityMaterial.html">LuminosityMaterial</a></li>
6667
<li><a href="../classes/MaskPass.html">MaskPass</a></li>
6768
<li><a href="../classes/Pass.html">Pass</a></li>
69+
<li><a href="../classes/PixelationMaterial.html">PixelationMaterial</a></li>
70+
<li><a href="../classes/PixelationPass.html">PixelationPass</a></li>
6871
<li><a href="../classes/RenderPass.html">RenderPass</a></li>
6972
<li><a href="../classes/SavePass.html">SavePass</a></li>
7073
<li><a href="../classes/ShaderPass.html">ShaderPass</a></li>
74+
<li><a href="../classes/ShockWaveMaterial.html">ShockWaveMaterial</a></li>
75+
<li><a href="../classes/ShockWavePass.html">ShockWavePass</a></li>
7176
<li><a href="../classes/SMAABlendMaterial.html">SMAABlendMaterial</a></li>
7277
<li><a href="../classes/SMAAColorEdgesMaterial.html">SMAAColorEdgesMaterial</a></li>
7378
<li><a href="../classes/SMAAPass.html">SMAAPass</a></li>
@@ -337,6 +342,10 @@ <h3>Properties</h3>
337342
<li class="index-item property private">
338343
<a href="#property_luminosityMaterial">luminosityMaterial</a>
339344

345+
</li>
346+
<li class="index-item property inherited">
347+
<a href="#property_name">name</a>
348+
340349
</li>
341350
<li class="index-item property private inherited">
342351
<a href="#property_needsSwap">needsSwap</a>
@@ -390,7 +399,7 @@ <h3 class="name"><code>dispose</code></h3>
390399
<div class="meta">
391400
<p>Inherited from
392401
<a href="../classes/Pass.html#method_dispose">Pass</a>:
393-
<a href="../files/src_passes_pass.js.html#l187"><code>src\passes\pass.js:187</code></a>
402+
<a href="../files/src_passes_pass.js.html#l183"><code>src\passes\pass.js:183</code></a>
394403
</p>
395404

396405

@@ -406,8 +415,8 @@ <h3 class="name"><code>dispose</code></h3>
406415
- materials
407416
- textures
408417

409-
The EffectComposer calls this method automatically when it is being
410-
destroyed. You may, however, use it independently to free memory
418+
The {{#crossLink "EffectComposer"}}{{/crossLink}} calls this method when it
419+
is being destroyed. You may, however, use it independently to free memory
411420
when you are certain that you don't need this pass anymore.
412421
</div>
413422

@@ -442,7 +451,7 @@ <h3 class="name"><code>initialise</code></h3>
442451
Pass
443452
</a>
444453
but overwritten in
445-
<a href="../files/src_passes_bloom.js.html#l204"><code>src\passes\bloom.js:204</code></a>
454+
<a href="../files/src_passes_bloom.js.html#l210"><code>src\passes\bloom.js:210</code></a>
446455
</p>
447456

448457

@@ -520,7 +529,7 @@ <h3 class="name"><code>render</code></h3>
520529
Pass
521530
</a>
522531
but overwritten in
523-
<a href="../files/src_passes_bloom.js.html#l162"><code>src\passes\bloom.js:162</code></a>
532+
<a href="../files/src_passes_bloom.js.html#l168"><code>src\passes\bloom.js:168</code></a>
524533
</p>
525534

526535

@@ -545,7 +554,7 @@ <h4>Parameters:</h4>
545554

546555
<div class="param-description">
547556
<ul>
548-
<li>The renderer to use.</li>
557+
<li>The renderer.</li>
549558
</ul>
550559

551560
</div>
@@ -610,7 +619,7 @@ <h3 class="name"><code>setSize</code></h3>
610619
Pass
611620
</a>
612621
but overwritten in
613-
<a href="../files/src_passes_bloom.js.html#l225"><code>src\passes\bloom.js:225</code></a>
622+
<a href="../files/src_passes_bloom.js.html#l231"><code>src\passes\bloom.js:231</code></a>
614623
</p>
615624

616625

@@ -675,7 +684,7 @@ <h3 class="name"><code>blurPass</code></h3>
675684
<div class="meta">
676685
<p>
677686
Defined in
678-
<a href="../files/src_passes_bloom.js.html#l30"><code>src\passes\bloom.js:30</code></a>
687+
<a href="../files/src_passes_bloom.js.html#l32"><code>src\passes\bloom.js:32</code></a>
679688
</p>
680689

681690

@@ -701,17 +710,17 @@ <h3 class="name"><code>camera</code></h3>
701710
<div class="meta">
702711
<p>Inherited from
703712
<a href="../classes/Pass.html#property_camera">Pass</a>:
704-
<a href="../files/src_passes_pass.js.html#l42"><code>src\passes\pass.js:42</code></a>
713+
<a href="../files/src_passes_pass.js.html#l48"><code>src\passes\pass.js:48</code></a>
705714
</p>
706715

707716

708717
</div>
709718

710719
<div class="description">
711-
The camera to render with.
720+
The camera.
712721
</div>
713722

714-
<p><strong>Default:</strong> OrthographicCamera(-1, 1, 1, -1, 0, 1)</p>
723+
<p><strong>Default:</strong> new OrthographicCamera(-1, 1, 1, -1, 0, 1)</p>
715724

716725

717726
</div>
@@ -727,14 +736,14 @@ <h3 class="name"><code>combineMaterial</code></h3>
727736
<div class="meta">
728737
<p>
729738
Defined in
730-
<a href="../files/src_passes_bloom.js.html#l60"><code>src\passes\bloom.js:60</code></a>
739+
<a href="../files/src_passes_bloom.js.html#l66"><code>src\passes\bloom.js:66</code></a>
731740
</p>
732741

733742

734743
</div>
735744

736745
<div class="description">
737-
<p>Combine shader material.</p>
746+
<p>A combine shader material.</p>
738747

739748
</div>
740749

@@ -752,7 +761,7 @@ <h3 class="name"><code>distinction</code></h3>
752761
<div class="meta">
753762
<p>
754763
Defined in
755-
<a href="../files/src_passes_bloom.js.html#l142"><code>src\passes\bloom.js:142</code></a>
764+
<a href="../files/src_passes_bloom.js.html#l148"><code>src\passes\bloom.js:148</code></a>
756765
</p>
757766

758767

@@ -778,7 +787,7 @@ <h3 class="name"><code>enabled</code></h3>
778787
<div class="meta">
779788
<p>Inherited from
780789
<a href="../classes/Pass.html#property_enabled">Pass</a>:
781-
<a href="../files/src_passes_pass.js.html#l89"><code>src\passes\pass.js:89</code></a>
790+
<a href="../files/src_passes_pass.js.html#l101"><code>src\passes\pass.js:101</code></a>
782791
</p>
783792

784793

@@ -803,7 +812,7 @@ <h3 class="name"><code>intensity</code></h3>
803812
<div class="meta">
804813
<p>
805814
Defined in
806-
<a href="../files/src_passes_bloom.js.html#l122"><code>src\passes\bloom.js:122</code></a>
815+
<a href="../files/src_passes_bloom.js.html#l128"><code>src\passes\bloom.js:128</code></a>
807816
</p>
808817

809818

@@ -829,7 +838,7 @@ <h3 class="name"><code>kernelSize</code></h3>
829838
<div class="meta">
830839
<p>
831840
Defined in
832-
<a href="../files/src_passes_bloom.js.html#l106"><code>src\passes\bloom.js:106</code></a>
841+
<a href="../files/src_passes_bloom.js.html#l112"><code>src\passes\bloom.js:112</code></a>
833842
</p>
834843

835844

@@ -856,15 +865,39 @@ <h3 class="name"><code>luminosityMaterial</code></h3>
856865
<div class="meta">
857866
<p>
858867
Defined in
859-
<a href="../files/src_passes_bloom.js.html#l72"><code>src\passes\bloom.js:72</code></a>
868+
<a href="../files/src_passes_bloom.js.html#l78"><code>src\passes\bloom.js:78</code></a>
860869
</p>
861870

862871

863872
</div>
864873

865874
<div class="description">
866-
<p>Luminance shader material.</p>
875+
<p>A luminosity shader material.</p>
876+
877+
</div>
878+
879+
880+
881+
</div>
882+
<div id="property_name" class="property item inherited">
883+
<h3 class="name"><code>name</code></h3>
884+
<span class="type">String</span>
885+
867886

887+
888+
889+
890+
<div class="meta">
891+
<p>Inherited from
892+
<a href="../classes/Pass.html#property_name">Pass</a>:
893+
<a href="../files/src_passes_pass.js.html#l28"><code>src\passes\pass.js:28</code></a>
894+
</p>
895+
896+
897+
</div>
898+
899+
<div class="description">
900+
The name of this pass.
868901
</div>
869902

870903

@@ -882,7 +915,7 @@ <h3 class="name"><code>needsSwap</code></h3>
882915
<div class="meta">
883916
<p>Inherited from
884917
<a href="../classes/Pass.html#property_needsSwap">Pass</a>:
885-
<a href="../files/src_passes_pass.js.html#l74"><code>src\passes\pass.js:74</code></a>
918+
<a href="../files/src_passes_pass.js.html#l86"><code>src\passes\pass.js:86</code></a>
886919
</p>
887920

888921

@@ -912,19 +945,19 @@ <h3 class="name"><code>quad</code></h3>
912945
<div class="meta">
913946
<p>Inherited from
914947
<a href="../classes/Pass.html#property_quad">Pass</a>:
915-
<a href="../files/src_passes_pass.js.html#l53"><code>src\passes\pass.js:53</code></a>
948+
<a href="../files/src_passes_pass.js.html#l59"><code>src\passes\pass.js:59</code></a>
916949
</p>
917950

918951

919952
</div>
920953

921954
<div class="description">
922-
The quad mesh to use for rendering.
955+
A quad mesh that fills the screen.
923956

924957
Assign your shader material to this mesh!
925958
</div>
926959

927-
<p><strong>Default:</strong> Mesh(PlaneBufferGeometry(2, 2), null)</p>
960+
<p><strong>Default:</strong> new Mesh(new PlaneBufferGeometry(2, 2), null)</p>
928961

929962
<div class="example">
930963
<h4>Example:</h4>
@@ -948,7 +981,7 @@ <h3 class="name"><code>renderTargetX</code></h3>
948981
<div class="meta">
949982
<p>
950983
Defined in
951-
<a href="../files/src_passes_bloom.js.html#l40"><code>src\passes\bloom.js:40</code></a>
984+
<a href="../files/src_passes_bloom.js.html#l42"><code>src\passes\bloom.js:42</code></a>
952985
</p>
953986

954987

@@ -974,7 +1007,7 @@ <h3 class="name"><code>renderTargetY</code></h3>
9741007
<div class="meta">
9751008
<p>
9761009
Defined in
977-
<a href="../files/src_passes_bloom.js.html#l50"><code>src\passes\bloom.js:50</code></a>
1010+
<a href="../files/src_passes_bloom.js.html#l54"><code>src\passes\bloom.js:54</code></a>
9781011
</p>
9791012

9801013

@@ -999,7 +1032,7 @@ <h3 class="name"><code>renderToScreen</code></h3>
9991032
<div class="meta">
10001033
<p>Inherited from
10011034
<a href="../classes/Pass.html#property_renderToScreen">Pass</a>:
1002-
<a href="../files/src_passes_pass.js.html#l99"><code>src\passes\pass.js:99</code></a>
1035+
<a href="../files/src_passes_pass.js.html#l111"><code>src\passes\pass.js:111</code></a>
10031036
</p>
10041037

10051038

@@ -1024,7 +1057,7 @@ <h3 class="name"><code>resolutionScale</code></h3>
10241057
<div class="meta">
10251058
<p>
10261059
Defined in
1027-
<a href="../files/src_passes_bloom.js.html#l86"><code>src\passes\bloom.js:86</code></a>
1060+
<a href="../files/src_passes_bloom.js.html#l92"><code>src\passes\bloom.js:92</code></a>
10281061
</p>
10291062

10301063

@@ -1054,7 +1087,7 @@ <h3 class="name"><code>scene</code></h3>
10541087
<div class="meta">
10551088
<p>Inherited from
10561089
<a href="../classes/Pass.html#property_scene">Pass</a>:
1057-
<a href="../files/src_passes_pass.js.html#l31"><code>src\passes\pass.js:31</code></a>
1090+
<a href="../files/src_passes_pass.js.html#l37"><code>src\passes\pass.js:37</code></a>
10581091
</p>
10591092

10601093

@@ -1064,7 +1097,7 @@ <h3 class="name"><code>scene</code></h3>
10641097
The scene to render.
10651098
</div>
10661099

1067-
<p><strong>Default:</strong> Scene()</p>
1100+
<p><strong>Default:</strong> new Scene()</p>
10681101

10691102

10701103
</div>

0 commit comments

Comments
 (0)