Skip to content

Commit

Permalink
Updated docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
@vanruesc
vanruesc committed Mar 15, 2017
1 parent 7496f2f commit 6085836
Showing 93 changed files with 7,855 additions and 1,313 deletions.
5 changes: 5 additions & 0 deletions docs/api.js
View file
Original file line number Diff line number Diff line change
@@ -9,6 +9,7 @@ YUI.add("yuidoc-meta", function(Y) {
"BokehMaterial",
"BokehPass",
"ClearMaskPass",
"ClearPass",
"CombineMaterial",
"ConvolutionMaterial",
"CopyMaterial",
@@ -28,13 +29,17 @@ YUI.add("yuidoc-meta", function(Y) {
"LuminosityMaterial",
"MaskPass",
"Pass",
"PixelationMaterial",
"PixelationPass",
"RenderPass",
"SMAABlendMaterial",
"SMAAColorEdgesMaterial",
"SMAAPass",
"SMAAWeightsMaterial",
"SavePass",
"ShaderPass",
"ShockWaveMaterial",
"ShockWavePass",
"TexturePass",
"ToneMappingMaterial",
"ToneMappingPass"
7 changes: 6 additions & 1 deletion docs/classes/AdaptiveLuminosityMaterial.html
View file
Original file line number Diff line number Diff line change
@@ -17,7 +17,7 @@
<h1><img src="../assets/css/logo.png" title="postprocessing" width="117" height="52"></h1>
</div>
<div class="yui3-u-1-4 version">
<em>API Docs for: 2.0.0</em>
<em>API Docs for: 2.1.0</em>
</div>
</div>
<div id="bd" class="yui3-g">
@@ -46,6 +46,7 @@ <h2 class="off-left">APIs</h2>
<li><a href="../classes/BokehMaterial.html">BokehMaterial</a></li>
<li><a href="../classes/BokehPass.html">BokehPass</a></li>
<li><a href="../classes/ClearMaskPass.html">ClearMaskPass</a></li>
<li><a href="../classes/ClearPass.html">ClearPass</a></li>
<li><a href="../classes/CombineMaterial.html">CombineMaterial</a></li>
<li><a href="../classes/ConvolutionMaterial.html">ConvolutionMaterial</a></li>
<li><a href="../classes/CopyMaterial.html">CopyMaterial</a></li>
@@ -65,9 +66,13 @@ <h2 class="off-left">APIs</h2>
<li><a href="../classes/LuminosityMaterial.html">LuminosityMaterial</a></li>
<li><a href="../classes/MaskPass.html">MaskPass</a></li>
<li><a href="../classes/Pass.html">Pass</a></li>
<li><a href="../classes/PixelationMaterial.html">PixelationMaterial</a></li>
<li><a href="../classes/PixelationPass.html">PixelationPass</a></li>
<li><a href="../classes/RenderPass.html">RenderPass</a></li>
<li><a href="../classes/SavePass.html">SavePass</a></li>
<li><a href="../classes/ShaderPass.html">ShaderPass</a></li>
<li><a href="../classes/ShockWaveMaterial.html">ShockWaveMaterial</a></li>
<li><a href="../classes/ShockWavePass.html">ShockWavePass</a></li>
<li><a href="../classes/SMAABlendMaterial.html">SMAABlendMaterial</a></li>
<li><a href="../classes/SMAAColorEdgesMaterial.html">SMAAColorEdgesMaterial</a></li>
<li><a href="../classes/SMAAPass.html">SMAAPass</a></li>
93 changes: 63 additions & 30 deletions docs/classes/BloomPass.html
View file
Original file line number Diff line number Diff line change
@@ -17,7 +17,7 @@
<h1><img src="../assets/css/logo.png" title="postprocessing" width="117" height="52"></h1>
</div>
<div class="yui3-u-1-4 version">
<em>API Docs for: 2.0.0</em>
<em>API Docs for: 2.1.0</em>
</div>
</div>
<div id="bd" class="yui3-g">
@@ -46,6 +46,7 @@ <h2 class="off-left">APIs</h2>
<li><a href="../classes/BokehMaterial.html">BokehMaterial</a></li>
<li><a href="../classes/BokehPass.html">BokehPass</a></li>
<li><a href="../classes/ClearMaskPass.html">ClearMaskPass</a></li>
<li><a href="../classes/ClearPass.html">ClearPass</a></li>
<li><a href="../classes/CombineMaterial.html">CombineMaterial</a></li>
<li><a href="../classes/ConvolutionMaterial.html">ConvolutionMaterial</a></li>
<li><a href="../classes/CopyMaterial.html">CopyMaterial</a></li>
@@ -65,9 +66,13 @@ <h2 class="off-left">APIs</h2>
<li><a href="../classes/LuminosityMaterial.html">LuminosityMaterial</a></li>
<li><a href="../classes/MaskPass.html">MaskPass</a></li>
<li><a href="../classes/Pass.html">Pass</a></li>
<li><a href="../classes/PixelationMaterial.html">PixelationMaterial</a></li>
<li><a href="../classes/PixelationPass.html">PixelationPass</a></li>
<li><a href="../classes/RenderPass.html">RenderPass</a></li>
<li><a href="../classes/SavePass.html">SavePass</a></li>
<li><a href="../classes/ShaderPass.html">ShaderPass</a></li>
<li><a href="../classes/ShockWaveMaterial.html">ShockWaveMaterial</a></li>
<li><a href="../classes/ShockWavePass.html">ShockWavePass</a></li>
<li><a href="../classes/SMAABlendMaterial.html">SMAABlendMaterial</a></li>
<li><a href="../classes/SMAAColorEdgesMaterial.html">SMAAColorEdgesMaterial</a></li>
<li><a href="../classes/SMAAPass.html">SMAAPass</a></li>
@@ -337,6 +342,10 @@ <h3>Properties</h3>
<li class="index-item property private">
<a href="#property_luminosityMaterial">luminosityMaterial</a>

</li>
<li class="index-item property inherited">
<a href="#property_name">name</a>

</li>
<li class="index-item property private inherited">
<a href="#property_needsSwap">needsSwap</a>
@@ -390,7 +399,7 @@ <h3 class="name"><code>dispose</code></h3>
<div class="meta">
<p>Inherited from
<a href="../classes/Pass.html#method_dispose">Pass</a>:
<a href="../files/src_passes_pass.js.html#l187"><code>src\passes\pass.js:187</code></a>
<a href="../files/src_passes_pass.js.html#l183"><code>src\passes\pass.js:183</code></a>
</p>


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

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

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


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


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

<div class="param-description">
<ul>
<li>The renderer to use.</li>
<li>The renderer.</li>
</ul>

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


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


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


</div>

<div class="description">
The camera to render with.
The camera.
</div>

<p><strong>Default:</strong> OrthographicCamera(-1, 1, 1, -1, 0, 1)</p>
<p><strong>Default:</strong> new OrthographicCamera(-1, 1, 1, -1, 0, 1)</p>


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


</div>

<div class="description">
<p>Combine shader material.</p>
<p>A combine shader material.</p>

</div>

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


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


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


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


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


</div>

<div class="description">
<p>Luminance shader material.</p>
<p>A luminosity shader material.</p>

</div>



</div>
<div id="property_name" class="property item inherited">
<h3 class="name"><code>name</code></h3>
<span class="type">String</span>





<div class="meta">
<p>Inherited from
<a href="../classes/Pass.html#property_name">Pass</a>:
<a href="../files/src_passes_pass.js.html#l28"><code>src\passes\pass.js:28</code></a>
</p>


</div>

<div class="description">
The name of this pass.
</div>


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


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


</div>

<div class="description">
The quad mesh to use for rendering.
A quad mesh that fills the screen.

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

<p><strong>Default:</strong> Mesh(PlaneBufferGeometry(2, 2), null)</p>
<p><strong>Default:</strong> new Mesh(new PlaneBufferGeometry(2, 2), null)</p>

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


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


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


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


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


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

<p><strong>Default:</strong> Scene()</p>
<p><strong>Default:</strong> new Scene()</p>


</div>
Loading

0 comments on commit 6085836

Please sign in to comment.