Skip to content

Commit cd704f2

Browse files
mrdoobmrdoob
committed
Updated docs.
1 parent 8bc910a commit cd704f2

File tree

7 files changed

+182
-1
lines changed

7 files changed

+182
-1
lines changed

‎docs/index.html‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1313,6 +1313,7 @@ <h2>TSL</h2>
13131313
<li><a href="TSL.html#quadSwapDiagonal">quadSwapDiagonal</a></li>
13141314
<li><a href="TSL.html#quadSwapX">quadSwapX</a></li>
13151315
<li><a href="TSL.html#quadSwapY">quadSwapY</a></li>
1316+
<li><a href="TSL.html#radialBlur">radialBlur</a></li>
13161317
<li><a href="TSL.html#radians">radians</a></li>
13171318
<li><a href="TSL.html#rand">rand</a></li>
13181319
<li><a href="TSL.html#range">range</a></li>
@@ -1462,6 +1463,7 @@ <h2>TSL</h2>
14621463
<li><a href="TSL.html#uniformFlow">uniformFlow</a></li>
14631464
<li><a href="TSL.html#uniformGroup">uniformGroup</a></li>
14641465
<li><a href="TSL.html#uniformTexture">uniformTexture</a></li>
1466+
<li><a href="TSL.html#unpackNormal">unpackNormal</a></li>
14651467
<li><a href="TSL.html#unpremultiplyAlpha">unpremultiplyAlpha</a></li>
14661468
<li><a href="TSL.html#userData">userData</a></li>
14671469
<li><a href="TSL.html#uv">uv</a></li>
@@ -1594,13 +1596,16 @@ <h2>Global</h2>
15941596
<li><a href="global.html#NeverStencilFunc">NeverStencilFunc</a></li>
15951597
<li><a href="global.html#NoBlending">NoBlending</a></li>
15961598
<li><a href="global.html#NoColorSpace">NoColorSpace</a></li>
1599+
<li><a href="global.html#NoNormalPacking">NoNormalPacking</a></li>
15971600
<li><a href="global.html#NoToneMapping">NoToneMapping</a></li>
15981601
<li><a href="global.html#NodeAccess">NodeAccess</a></li>
15991602
<li><a href="global.html#NodeShaderStage">NodeShaderStage</a></li>
16001603
<li><a href="global.html#NodeType">NodeType</a></li>
16011604
<li><a href="global.html#NodeUpdateType">NodeUpdateType</a></li>
16021605
<li><a href="global.html#NormalAnimationBlendMode">NormalAnimationBlendMode</a></li>
16031606
<li><a href="global.html#NormalBlending">NormalBlending</a></li>
1607+
<li><a href="global.html#NormalGAPacking">NormalGAPacking</a></li>
1608+
<li><a href="global.html#NormalRGPacking">NormalRGPacking</a></li>
16041609
<li><a href="global.html#NotEqualCompare">NotEqualCompare</a></li>
16051610
<li><a href="global.html#NotEqualDepth">NotEqualDepth</a></li>
16061611
<li><a href="global.html#NotEqualStencilFunc">NotEqualStencilFunc</a></li>

‎docs/pages/MaterialLoader.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
<h1 translate="no">MaterialLoader</h1>
1414
<section>
1515
<header>
16-
<div class="class-description"><p>Class for loading geometries. The files are internally
16+
<div class="class-description"><p>Class for loading materials. The files are internally
1717
loaded via <a href="FileLoader.html">FileLoader</a>.</p>
1818
<p>This loader does not support node materials. Use <a href="NodeMaterialLoader.html">NodeMaterialLoader</a> instead.</p></div>
1919
<h2>Code Example</h2>

‎docs/pages/NormalMapNode.html‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,13 @@ <h3 class="name" id="scaleNode" translate="no">.<a href="#scaleNode">scaleNode</
7070
<p>Default is <code>null</code>.</p>
7171
</div>
7272
</div>
73+
<div class="member">
74+
<h3 class="name" id="unpackNormalMode" translate="no">.<a href="#unpackNormalMode">unpackNormalMode</a><span class="type-signature"> : string</span> </h3>
75+
<div class="description">
76+
<p>Controls how to unpack the sampled normal map values.</p>
77+
<p>Default is <code>NoNormalPacking</code>.</p>
78+
</div>
79+
</div>
7380
<h2 class="subsection-title">Source</h2>
7481
<p>
7582
<a href="https://github.com/mrdoob/three.js/blob/master/src/nodes/display/NormalMapNode.js" translate="no" target="_blank" rel="noopener">src/nodes/display/NormalMapNode.js</a>

‎docs/pages/PhysicalLightingModel.html‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -140,6 +140,20 @@ <h3 class="name" id="iridescenceF0" translate="no">.<a href="#iridescenceF0">iri
140140
<p>Default is <code>null</code>.</p>
141141
</div>
142142
</div>
143+
<div class="member">
144+
<h3 class="name" id="iridescenceF0Dielectric" translate="no">.<a href="#iridescenceF0Dielectric">iridescenceF0Dielectric</a><span class="type-signature"> : <a href="Node.html">Node</a></span> </h3>
145+
<div class="description">
146+
<p>The iridescence F0 dielectric.</p>
147+
<p>Default is <code>null</code>.</p>
148+
</div>
149+
</div>
150+
<div class="member">
151+
<h3 class="name" id="iridescenceF0Metallic" translate="no">.<a href="#iridescenceF0Metallic">iridescenceF0Metallic</a><span class="type-signature"> : <a href="Node.html">Node</a></span> </h3>
152+
<div class="description">
153+
<p>The iridescence F0 metallic.</p>
154+
<p>Default is <code>null</code>.</p>
155+
</div>
156+
</div>
143157
<div class="member">
144158
<h3 class="name" id="iridescenceFresnel" translate="no">.<a href="#iridescenceFresnel">iridescenceFresnel</a><span class="type-signature"> : <a href="Node.html">Node</a></span> </h3>
145159
<div class="description">

‎docs/pages/TSL.html‎

Lines changed: 105 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7513,6 +7513,89 @@ <h3 class="name name-method" id="quadSwapY" translate="no">.<a href="#quadSwapY"
75137513
<dt class="tag-returns"><strong>Returns:</strong> The value received from the swap operation.</dt>
75147514
</dl>
75157515
</div>
7516+
<h3 class="name name-method" id="radialBlur" translate="no">.<a href="#radialBlur">radialBlur</a><span class="signature">( textureNode : <span class="param-type"><a href="Node.html">Node</a>.&lt;vec4></span>, options : <span class="param-type">Object</span> )</span><span class="type-signature"> : <a href="Node.html">Node</a>.&lt;vec4></span> </h3>
7517+
<div class="method">
7518+
<div class="description">
7519+
<p>This TSL function blurs an image in a circular pattern, radiating from a configurable center point in screen space.</p>
7520+
<p>Radial blurs can be used for different kind of effects like producing simple faked lighting effects also known as
7521+
&quot;light shafts&quot;. The major limitation of this specific usage is the center point can only be defined in 2D so the
7522+
effect does not honor the depth of 3D objects. Consequently, it is not intended for physically correct lit scenes.</p>
7523+
</div>
7524+
<table class="params">
7525+
<tbody>
7526+
<tr>
7527+
<td class="name">
7528+
<strong>textureNode</strong>
7529+
</td>
7530+
<td class="description last">
7531+
<p>The texture node that should be blurred.</p>
7532+
</td>
7533+
</tr>
7534+
<tr>
7535+
<td class="name">
7536+
<strong>options</strong>
7537+
</td>
7538+
<td class="description last">
7539+
<p>Additional options for the radial blur effect.</p>
7540+
<p>Default is <code>{}</code>.</p>
7541+
<table class="params">
7542+
<tbody>
7543+
<tr>
7544+
<td class="name">
7545+
<strong>center</strong>
7546+
</td>
7547+
<td class="description last">
7548+
<p>The center of the light in screen uvs.</p>
7549+
<p>Default is <code>vec2(0.5, 0.5)</code>.</p>
7550+
</td>
7551+
</tr>
7552+
<tr>
7553+
<td class="name">
7554+
<strong>weight</strong>
7555+
</td>
7556+
<td class="description last">
7557+
<p>Base weight factor for each sample in the range <code>[0,1]</code>.</p>
7558+
<p>Default is <code>float(0.9)</code>.</p>
7559+
</td>
7560+
</tr>
7561+
<tr>
7562+
<td class="name">
7563+
<strong>decay</strong>
7564+
</td>
7565+
<td class="description last">
7566+
<p>Decreases the weight factor so each iteration adds less to the sum. Must be in the range <code>[0,1]</code>.
7567+
If you increase the sample count, you have to increase this option as well to avoid a darking effect.</p>
7568+
<p>Default is <code>float(0.95)</code>.</p>
7569+
</td>
7570+
</tr>
7571+
<tr>
7572+
<td class="name">
7573+
<strong>count</strong>
7574+
</td>
7575+
<td class="description last">
7576+
<p>The number if iterations. Should be in the range <code>[16,64]</code>.</p>
7577+
<p>Default is <code>int(32)</code>.</p>
7578+
</td>
7579+
</tr>
7580+
<tr>
7581+
<td class="name">
7582+
<strong>exposure</strong>
7583+
</td>
7584+
<td class="description last">
7585+
<p>Exposure control of the blur.</p>
7586+
<p>Default is <code>float(5)</code>.</p>
7587+
</td>
7588+
</tr>
7589+
</tbody>
7590+
</table>
7591+
</td>
7592+
</tr>
7593+
</tbody>
7594+
</table>
7595+
<dl class="details">
7596+
<dt class="tag-returns"><strong>Returns:</strong> The blurred texture node.</dt>
7597+
</dl>
7598+
</div>
75167599
<h3 class="name name-method" id="radians" translate="no">.<a href="#radians">radians</a><span class="signature">( x : <span class="param-type"><a href="Node.html">Node</a> | number</span> )</span><span class="type-signature"> : <a href="Node.html">Node</a></span> </h3>
75177600
<div class="method">
75187601
<div class="description">
@@ -11011,6 +11094,28 @@ <h3 class="name name-method" id="uniformTexture" translate="no">.<a href="#unifo
1101111094
</tbody>
1101211095
</table>
1101311096
</div>
11097+
<h3 class="name name-method" id="unpackNormal" translate="no">.<a href="#unpackNormal">unpackNormal</a><span class="signature">( xy : <span class="param-type"><a href="Node.html">Node</a>.&lt;vec2></span> )</span><span class="type-signature"> : <a href="Node.html">Node</a>.&lt;vec3></span> </h3>
11098+
<div class="method">
11099+
<div class="description">
11100+
<p>Unpacks a tangent space normal, reconstructing the Z component by projecting the X,Y coordinates onto the hemisphere.
11101+
The X,Y coordinates are expected to be in the [-1, 1] range.</p>
11102+
</div>
11103+
<table class="params">
11104+
<tbody>
11105+
<tr>
11106+
<td class="name">
11107+
<strong>xy</strong>
11108+
</td>
11109+
<td class="description last">
11110+
<p>The X,Y coordinates of the normal.</p>
11111+
</td>
11112+
</tr>
11113+
</tbody>
11114+
</table>
11115+
<dl class="details">
11116+
<dt class="tag-returns"><strong>Returns:</strong> The resulting normal.</dt>
11117+
</dl>
11118+
</div>
1101411119
<h3 class="name name-method" id="unpremultiplyAlpha" translate="no">.<a href="#unpremultiplyAlpha">unpremultiplyAlpha</a><span class="signature">( color : <span class="param-type"><a href="Node.html">Node</a>.&lt;vec4></span> )</span><span class="type-signature"> : <a href="Node.html">Node</a>.&lt;vec4></span> </h3>
1101511120
<div class="method">
1101611121
<div class="description">

‎docs/pages/global.html‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -646,6 +646,12 @@ <h3 class="name" id="NoColorSpace" translate="no">.<a href="#NoColorSpace">NoCol
646646
<p>No color space.</p>
647647
</div>
648648
</div>
649+
<div class="member">
650+
<h3 class="name" id="NoNormalPacking" translate="no">.<a href="#NoNormalPacking">NoNormalPacking</a><span class="type-signature"> : string</span> <span class="type-signature">(constant) </span></h3>
651+
<div class="description">
652+
<p>No normal map packing.</p>
653+
</div>
654+
</div>
649655
<div class="member">
650656
<h3 class="name" id="NoToneMapping" translate="no">.<a href="#NoToneMapping">NoToneMapping</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
651657
<div class="description">
@@ -884,6 +890,18 @@ <h3 class="name" id="NormalBlending" translate="no">.<a href="#NormalBlending">N
884890
<p>The default blending.</p>
885891
</div>
886892
</div>
893+
<div class="member">
894+
<h3 class="name" id="NormalGAPacking" translate="no">.<a href="#NormalGAPacking">NormalGAPacking</a><span class="type-signature"> : string</span> <span class="type-signature">(constant) </span></h3>
895+
<div class="description">
896+
<p>Normal GA packing.</p>
897+
</div>
898+
</div>
899+
<div class="member">
900+
<h3 class="name" id="NormalRGPacking" translate="no">.<a href="#NormalRGPacking">NormalRGPacking</a><span class="type-signature"> : string</span> <span class="type-signature">(constant) </span></h3>
901+
<div class="description">
902+
<p>Normal RG packing.</p>
903+
</div>
904+
</div>
887905
<div class="member">
888906
<h3 class="name" id="NotEqualCompare" translate="no">.<a href="#NotEqualCompare">NotEqualCompare</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
889907
<div class="description">

‎docs/search.json‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9028,6 +9028,10 @@
90289028
"title": "NormalMapNode#scaleNode",
90299029
"kind": "member"
90309030
},
9031+
{
9032+
"title": "NormalMapNode#unpackNormalMode",
9033+
"kind": "member"
9034+
},
90319035
{
90329036
"title": "NumberKeyframeTrack",
90339037
"kind": "class"
@@ -9924,6 +9928,14 @@
99249928
"title": "PhysicalLightingModel#iridescenceF0",
99259929
"kind": "member"
99269930
},
9931+
{
9932+
"title": "PhysicalLightingModel#iridescenceF0Dielectric",
9933+
"kind": "member"
9934+
},
9935+
{
9936+
"title": "PhysicalLightingModel#iridescenceF0Metallic",
9937+
"kind": "member"
9938+
},
99279939
{
99289940
"title": "PhysicalLightingModel#iridescenceFresnel",
99299941
"kind": "member"
@@ -25024,6 +25036,10 @@
2502425036
"title": "NoColorSpace",
2502525037
"kind": "member"
2502625038
},
25039+
{
25040+
"title": "NoNormalPacking",
25041+
"kind": "member"
25042+
},
2502725043
{
2502825044
"title": "NoToneMapping",
2502925045
"kind": "member"
@@ -25052,6 +25068,14 @@
2505225068
"title": "NormalBlending",
2505325069
"kind": "member"
2505425070
},
25071+
{
25072+
"title": "NormalGAPacking",
25073+
"kind": "member"
25074+
},
25075+
{
25076+
"title": "NormalRGPacking",
25077+
"kind": "member"
25078+
},
2505525079
{
2505625080
"title": "NotEqualCompare",
2505725081
"kind": "member"
@@ -27486,6 +27510,10 @@
2748627510
"title": "quadSwapY",
2748727511
"kind": "function"
2748827512
},
27513+
{
27514+
"title": "radialBlur",
27515+
"kind": "function"
27516+
},
2748927517
{
2749027518
"title": "radians",
2749127519
"kind": "function"
@@ -28090,6 +28118,10 @@
2809028118
"title": "uniformTexture",
2809128119
"kind": "function"
2809228120
},
28121+
{
28122+
"title": "unpackNormal",
28123+
"kind": "function"
28124+
},
2809328125
{
2809428126
"title": "unpremultiplyAlpha",
2809528127
"kind": "function"

0 commit comments

Comments
 (0)