Skip to content

Commit 887eb82

Browse files
mrdoobmrdoob
committed
Updated docs.
1 parent f799dc4 commit 887eb82

File tree

11 files changed

+163
-10
lines changed

11 files changed

+163
-10
lines changed

‎docs/pages/BufferNode.html‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,45 @@ <h3 class="name" id="isBufferNode" translate="no">.<a href="#isBufferNode">isBuf
8383
<p>Default is <code>true</code>.</p>
8484
</div>
8585
</div>
86+
<div class="member">
87+
<h3 class="name" id="updateRanges" translate="no">.<a href="#updateRanges">updateRanges</a><span class="type-signature"> : Array.&lt;{start: number, count: number}></span> </h3>
88+
<div class="description">
89+
<p>An array of update ranges.</p>
90+
</div>
91+
</div>
8692
<h2 class="subsection-title">Methods</h2>
93+
<h3 class="name name-method" id="addUpdateRange" translate="no">.<a href="#addUpdateRange">addUpdateRange</a><span class="signature">( start : <span class="param-type">number</span>, count : <span class="param-type">number</span> )</span> </h3>
94+
<div class="method">
95+
<div class="description">
96+
<p>Adds a range of data in the data array to be updated on the GPU.</p>
97+
</div>
98+
<table class="params">
99+
<tbody>
100+
<tr>
101+
<td class="name">
102+
<strong>start</strong>
103+
</td>
104+
<td class="description last">
105+
<p>Position at which to start update.</p>
106+
</td>
107+
</tr>
108+
<tr>
109+
<td class="name">
110+
<strong>count</strong>
111+
</td>
112+
<td class="description last">
113+
<p>The number of components to update.</p>
114+
</td>
115+
</tr>
116+
</tbody>
117+
</table>
118+
</div>
119+
<h3 class="name name-method" id="clearUpdateRanges" translate="no">.<a href="#clearUpdateRanges">clearUpdateRanges</a><span class="signature">()</span> </h3>
120+
<div class="method">
121+
<div class="description">
122+
<p>Clears the update ranges.</p>
123+
</div>
124+
</div>
87125
<h3 class="name name-method" id="getElementType" translate="no">.<a href="#getElementType">getElementType</a><span class="signature">( builder : <span class="param-type"><a href="NodeBuilder.html">NodeBuilder</a></span> )</span><span class="type-signature"> : string</span> </h3>
88126
<div class="method">
89127
<div class="description">

‎docs/pages/InstanceNode.html‎

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ <h1 translate="no">InstanceNode</h1>
2121
<article>
2222
<div class="container-overview">
2323
<h2>Constructor</h2>
24-
<h3 class="name name-method" id="InstanceNode" translate="no">new <a href="#InstanceNode">InstanceNode</a><span class="signature">( count : <span class="param-type">number</span>, instanceMatrix : <span class="param-type"><a href="InstancedBufferAttribute.html">InstancedBufferAttribute</a></span>, instanceColor : <span class="param-type"><a href="InstancedBufferAttribute.html">InstancedBufferAttribute</a></span> )</span> </h3>
24+
<h3 class="name name-method" id="InstanceNode" translate="no">new <a href="#InstanceNode">InstanceNode</a><span class="signature">( count : <span class="param-type">number</span>, instanceMatrix : <span class="param-type"><a href="InstancedBufferAttribute.html">InstancedBufferAttribute</a> | <a href="StorageInstancedBufferAttribute.html">StorageInstancedBufferAttribute</a></span>, instanceColor : <span class="param-type"><a href="InstancedBufferAttribute.html">InstancedBufferAttribute</a> | <a href="StorageInstancedBufferAttribute.html">StorageInstancedBufferAttribute</a></span> )</span> </h3>
2525
<div class="method">
2626
<div class="description">
2727
<p>Constructs a new instance node.</p>
@@ -101,6 +101,18 @@ <h3 class="name" id="instanceMatrixNode" translate="no">.<a href="#instanceMatri
101101
<p>The node that represents the instance matrix data.</p>
102102
</div>
103103
</div>
104+
<div class="member">
105+
<h3 class="name" id="isStorageColor" translate="no">.<a href="#isStorageColor">isStorageColor</a><span class="type-signature"> : boolean</span> </h3>
106+
<div class="description">
107+
<p>Tracks whether the color data is provided via a storage buffer.</p>
108+
</div>
109+
</div>
110+
<div class="member">
111+
<h3 class="name" id="isStorageMatrix" translate="no">.<a href="#isStorageMatrix">isStorageMatrix</a><span class="type-signature"> : boolean</span> </h3>
112+
<div class="description">
113+
<p>Tracks whether the matrix data is provided via a storage buffer.</p>
114+
</div>
115+
</div>
104116
<div class="member">
105117
<h3 class="name" id="updateType" translate="no">.<a href="#updateType">updateType</a><span class="type-signature"> : string</span> </h3>
106118
<div class="description">
@@ -139,7 +151,7 @@ <h3 class="name name-method" id="setup" translate="no">.<a href="#setup">setup</
139151
<h3 class="name name-method" id="update" translate="no">.<a href="#update">update</a><span class="signature">( frame : <span class="param-type"><a href="NodeFrame.html">NodeFrame</a></span> )</span> </h3>
140152
<div class="method">
141153
<div class="description">
142-
<p>Checks if the internal buffers required an update.</p>
154+
<p>Checks if the internal buffers require an update.</p>
143155
</div>
144156
<table class="params">
145157
<tbody>

‎docs/pages/LDrawLoader.html‎

Lines changed: 28 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,34 @@ <h1 translate="no">LDrawLoader</h1>
1414
<section>
1515
<header>
1616
<div class="class-description"><p>A loader for the LDraw format.</p>
17-
<p>[LDraw](https://ldraw.org/} (LEGO Draw) is an <a href="https://ldraw.org/article/218.html)" target="_blank" rel="noopener">open format specification</a> from 'three/addons/loaders/LDrawLoader.js';</code></pre>
17+
<p>[LDraw](https://ldraw.org/} (LEGO Draw) is an <a href="https://ldraw.org/article/218.html" target="_blank" rel="noopener">open format specification</a>
18+
for describing LEGO and other construction set 3D models.</p>
19+
<p>An LDraw asset (a text file usually with extension .ldr, .dat or .txt) can describe just a single construction
20+
piece, or an entire model. In the case of a model the LDraw file can reference other LDraw files, which are
21+
loaded from a library path set with <code>setPartsLibraryPath</code>. You usually download the LDraw official parts library,
22+
extract to a folder and point setPartsLibraryPath to it.</p>
23+
<p>Library parts will be loaded by trial and error in subfolders 'parts', 'p' and 'models'. These file accesses
24+
are not optimal for web environment, so a script tool has been made to pack an LDraw file with all its dependencies
25+
into a single file, which loads much faster. See section 'Packing LDraw models'. The LDrawLoader example loads
26+
several packed files. The official parts library is not included due to its large size.</p>
27+
<p><code>LDrawLoader</code> supports the following extensions:</p>
28+
<ul>
29+
<li>!COLOUR: Color and surface finish declarations.</li>
30+
<li>BFC: Back Face Culling specification.</li>
31+
<li>!CATEGORY: Model/part category declarations.</li>
32+
<li>!KEYWORDS: Model/part keywords declarations.</li>
33+
</ul></div>
34+
<h2>Code Example</h2>
35+
<div translate="no"><pre><code class="language-js">const loader = new LDrawLoader();
36+
loader.setConditionalLineMaterial( LDrawConditionalLineMaterial ); // the type of line material depends on the used renderer
37+
const object = await loader.loadAsync( 'models/ldraw/officialLibrary/models/car.ldr_Packed.mpd' );
38+
scene.add( object );
39+
</code></pre></div>
40+
</header>
41+
<article>
42+
<h2 class="subsection-title">Import</h2>
43+
<p><span translate="no">LDrawLoader</span> is an addon, and must be imported explicitly, see <a href="https://threejs.org/manual/#en/installation" target="_blank" rel="noopener">Installation#Addons</a>.</p>
44+
<pre><code class="language-js">import { LDrawLoader } from 'three/addons/loaders/LDrawLoader.js';</code></pre>
1845
<div class="container-overview">
1946
<h2>Constructor</h2>
2047
<h3 class="name name-method" id="LDrawLoader" translate="no">new <a href="#LDrawLoader">LDrawLoader</a><span class="signature">( manager : <span class="param-type"><a href="LoadingManager.html">LoadingManager</a></span> )</span> </h3>

‎docs/pages/NodeBuilder.html‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1992,6 +1992,27 @@ <h3 class="name name-method" id="getSharedContext" translate="no">.<a href="#get
19921992
<dt class="tag-returns"><strong>Returns:</strong> The builder's current context without material.</dt>
19931993
</dl>
19941994
</div>
1995+
<h3 class="name name-method" id="getSharedDataFromNode" translate="no">.<a href="#getSharedDataFromNode">getSharedDataFromNode</a><span class="signature">( node : <span class="param-type"><a href="Node.html">Node</a></span> )</span><span class="type-signature"> : Object</span> </h3>
1996+
<div class="method">
1997+
<div class="description">
1998+
<p>Returns shared data object for the given node.</p>
1999+
</div>
2000+
<table class="params">
2001+
<tbody>
2002+
<tr>
2003+
<td class="name">
2004+
<strong>node</strong>
2005+
</td>
2006+
<td class="description last">
2007+
<p>The node to get shared data from.</p>
2008+
</td>
2009+
</tr>
2010+
</tbody>
2011+
</table>
2012+
<dl class="details">
2013+
<dt class="tag-returns"><strong>Returns:</strong> The shared data.</dt>
2014+
</dl>
2015+
</div>
19952016
<h3 class="name name-method" id="getSignature" translate="no">.<a href="#getSignature">getSignature</a><span class="signature">()</span><span class="type-signature"> : string</span> </h3>
19962017
<div class="method">
19972018
<div class="description">

‎docs/pages/PMREMGenerator.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -200,7 +200,7 @@ <h3 class="name name-method" id="fromScene" translate="no">.<a href="#fromScene"
200200
</tr>
201201
<tr>
202202
<td class="name">
203-
<strong>renderTarget</strong>
203+
<strong>position</strong>
204204
</td>
205205
<td class="description last">
206206
<p>The position of the internal cube camera that renders the scene.</p>

‎docs/pages/Raycaster.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -375,7 +375,7 @@ <h3 class="name" id="~Intersection" translate="no">.<a href="#~Intersection">Int
375375
</tr>
376376
<tr>
377377
<td class="name">
378-
<strong>uv1</strong>
378+
<strong>normal</strong>
379379
<br>
380380
<span class="param-type"><a href="Vector3.html">Vector3</a></span>
381381
</td>

‎docs/pages/SkyMesh.html‎

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@ <h1 translate="no">SkyMesh</h1>
1515
<header>
1616
<div class="class-description"><p>Represents a skydome for scene backgrounds. Based on <a href="https://www.researchgate.net/publication/220720443_A_Practical_Analytic_Model_for_Daylight" target="_blank" rel="noopener">A Practical Analytic Model for Daylight</a>
1717
aka The Preetham Model, the de facto standard for analytical skydomes.</p>
18-
<p>Note that this class can only be used with <a href="WebGLRenderer.html">WebGLRenderer</a>.
19-
When using <a href="WebGPURenderer.html">WebGPURenderer</a>, use <a href="SkyMesh.html">SkyMesh</a>.</p>
18+
<p>Note that this class can only be used with <a href="WebGPURenderer.html">WebGPURenderer</a>.
19+
When using <a href="WebGLRenderer.html">WebGLRenderer</a>, use <a href="Sky.html">Sky</a>.</p>
2020
<p>More references:</p>
2121
<ul>
2222
<li><a href="http://simonwallner.at/project/atmospheric-scattering/" target="_blank" rel="noopener">http://simonwallner.at/project/atmospheric-scattering/</a></li>
@@ -44,6 +44,16 @@ <h3 class="name name-method" id="SkyMesh" translate="no">new <a href="#SkyMesh">
4444
<h2 class="subsection-title">Properties</h2>
4545
<div class="member">
4646
<h3 class="name" id="isSky" translate="no">.<a href="#isSky">isSky</a><span class="type-signature"> : boolean</span> <span class="type-signature">(readonly) </span></h3>
47+
<div class="description">
48+
<p>This flag can be used for type testing.</p>
49+
<p>Default is <code>true</code>.</p>
50+
</div>
51+
<dl class="details">
52+
<dt class="important tag-deprecated"><strong>Deprecated:</strong> Use isSkyMesh instead.</dt>
53+
</dl>
54+
</div>
55+
<div class="member">
56+
<h3 class="name" id="isSkyMesh" translate="no">.<a href="#isSkyMesh">isSkyMesh</a><span class="type-signature"> : boolean</span> <span class="type-signature">(readonly) </span></h3>
4757
<div class="description">
4858
<p>This flag can be used for type testing.</p>
4959
<p>Default is <code>true</code>.</p>

‎docs/pages/TSL.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5173,7 +5173,7 @@ <h3 class="name name-method" id="inspector" translate="no">.<a href="#inspector"
51735173
<dt class="tag-returns"><strong>Returns:</strong> The inspector node.</dt>
51745174
</dl>
51755175
</div>
5176-
<h3 class="name name-method" id="instance" translate="no">.<a href="#instance">instance</a><span class="signature">( count : <span class="param-type">number</span>, instanceMatrix : <span class="param-type"><a href="InstancedBufferAttribute.html">InstancedBufferAttribute</a></span>, instanceColor : <span class="param-type"><a href="InstancedBufferAttribute.html">InstancedBufferAttribute</a></span> )</span><span class="type-signature"> : <a href="InstanceNode.html">InstanceNode</a></span> </h3>
5176+
<h3 class="name name-method" id="instance" translate="no">.<a href="#instance">instance</a><span class="signature">( count : <span class="param-type">number</span>, instanceMatrix : <span class="param-type"><a href="InstancedBufferAttribute.html">InstancedBufferAttribute</a> | <a href="StorageInstancedBufferAttribute.html">StorageInstancedBufferAttribute</a></span>, instanceColor : <span class="param-type"><a href="InstancedBufferAttribute.html">InstancedBufferAttribute</a> | <a href="StorageInstancedBufferAttribute.html">StorageInstancedBufferAttribute</a></span> )</span><span class="type-signature"> : <a href="InstanceNode.html">InstanceNode</a></span> </h3>
51775177
<div class="method">
51785178
<div class="description">
51795179
<p>TSL function for creating an instance node.</p>

‎docs/pages/Tab.html‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,23 @@ <h3 class="name name-method" id="Tab" translate="no">new <a href="#Tab">Tab</a><
4646
<p>Default is <code>true</code>.</p>
4747
</td>
4848
</tr>
49+
<tr>
50+
<td class="name">
51+
<strong>builtin</strong>
52+
</td>
53+
<td class="description last">
54+
<p>Whether the tab should appear in the profiler-toggle button</p>
55+
<p>Default is <code>false</code>.</p>
56+
</td>
57+
</tr>
58+
<tr>
59+
<td class="name">
60+
<strong>icon</strong>
61+
</td>
62+
<td class="description last">
63+
<p>SVG icon HTML for the builtin button</p>
64+
</td>
65+
</tr>
4966
</tbody>
5067
</table>
5168
</td>

‎docs/pages/global.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2609,7 +2609,7 @@ <h3 class="name name-method" id="isPowerOfTwo" translate="no">.<a href="#isPower
26092609
<dt class="tag-returns"><strong>Returns:</strong> Whether the given number is a power of two or not.</dt>
26102610
</dl>
26112611
</div>
2612-
<h3 class="name name-method" id="isTypedArray" translate="no">.<a href="#isTypedArray">isTypedArray</a><span class="signature">( object : <span class="param-type"><a href="global.html#any">any</a></span> )</span><span class="type-signature"> : boolean</span> </h3>
2612+
<h3 class="name name-method" id="isTypedArray" translate="no">.<a href="#isTypedArray">isTypedArray</a><span class="signature">( array : <span class="param-type"><a href="global.html#any">any</a></span> )</span><span class="type-signature"> : boolean</span> </h3>
26132613
<div class="method">
26142614
<div class="description">
26152615
<p>Returns <code>true</code> if the given object is a typed array.</p>
@@ -2618,7 +2618,7 @@ <h3 class="name name-method" id="isTypedArray" translate="no">.<a href="#isTyped
26182618
<tbody>
26192619
<tr>
26202620
<td class="name">
2621-
<strong>object</strong>
2621+
<strong>array</strong>
26222622
</td>
26232623
<td class="description last">
26242624
<p>The object to check.</p>

0 commit comments

Comments
 (0)