Skip to content

Commit 98b31d8

Browse files
mrdoobmrdoob
committed
Updated docs.
1 parent 4f12fc2 commit 98b31d8

16 files changed

Lines changed: 162 additions & 115 deletions

‎docs/index.html‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -689,9 +689,7 @@ <h3>Loaders</h3>
689689
<li><a href="ThreeMFLoader.html">ThreeMFLoader</a></li>
690690
<li><a href="USDLoader.html">USDLoader</a></li>
691691
<li><a href="UltraHDRLoader.html">UltraHDRLoader</a></li>
692-
<li><a href="VOXData3DTexture.html">VOXData3DTexture</a></li>
693692
<li><a href="VOXLoader.html">VOXLoader</a></li>
694-
<li><a href="VOXMesh.html">VOXMesh</a></li>
695693
<li><a href="VRMLLoader.html">VRMLLoader</a></li>
696694
<li><a href="VTKLoader.html">VTKLoader</a></li>
697695
<li><a href="XYZLoader.html">XYZLoader</a></li>
@@ -1567,7 +1565,6 @@ <h2>Global</h2>
15671565
<li><a href="global.html#GreaterEqualStencilFunc">GreaterEqualStencilFunc</a></li>
15681566
<li><a href="global.html#GreaterStencilFunc">GreaterStencilFunc</a></li>
15691567
<li><a href="global.html#HalfFloatType">HalfFloatType</a></li>
1570-
<li><a href="global.html#IdentityDepthPacking">IdentityDepthPacking</a></li>
15711568
<li><a href="global.html#IncrementStencilOp">IncrementStencilOp</a></li>
15721569
<li><a href="global.html#IncrementWrapStencilOp">IncrementWrapStencilOp</a></li>
15731570
<li><a href="global.html#IntType">IntType</a></li>
@@ -1733,6 +1730,8 @@ <h2>Global</h2>
17331730
<li><a href="global.html#ZeroFactor">ZeroFactor</a></li>
17341731
<li><a href="global.html#ZeroSlopeEnding">ZeroSlopeEnding</a></li>
17351732
<li><a href="global.html#ZeroStencilOp">ZeroStencilOp</a></li>
1733+
<li><a href="global.html#buildData3DTexture">buildData3DTexture</a></li>
1734+
<li><a href="global.html#buildMesh">buildMesh</a></li>
17361735
<li><a href="global.html#ceilPowerOfTwo">ceilPowerOfTwo</a></li>
17371736
<li><a href="global.html#contain">contain</a></li>
17381737
<li><a href="global.html#convertArray">convertArray</a></li>
@@ -1741,6 +1740,7 @@ <h2>Global</h2>
17411740
<li><a href="global.html#damp">damp</a></li>
17421741
<li><a href="global.html#degToRad">degToRad</a></li>
17431742
<li><a href="global.html#denormalize">denormalize</a></li>
1743+
<li><a href="global.html#disposeShadowMaterial">disposeShadowMaterial</a></li>
17441744
<li><a href="global.html#euclideanModulo">euclideanModulo</a></li>
17451745
<li><a href="global.html#fill">fill</a></li>
17461746
<li><a href="global.html#flattenJSON">flattenJSON</a></li>

‎docs/pages/AnalyticLightNode.html‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -100,6 +100,12 @@ <h3 class="name" id="updateType" translate="no">.<a href="#updateType">updateTyp
100100
</dl>
101101
</div>
102102
<h2 class="subsection-title">Methods</h2>
103+
<h3 class="name name-method" id="disposeShadow" translate="no">.<a href="#disposeShadow">disposeShadow</a><span class="signature">()</span> </h3>
104+
<div class="method">
105+
<div class="description">
106+
<p>Frees internal resources related to shadows.</p>
107+
</div>
108+
</div>
103109
<h3 class="name name-method" id="getLightVector" translate="no">.<a href="#getLightVector">getLightVector</a><span class="signature">( builder : <span class="param-type"><a href="NodeBuilder.html">NodeBuilder</a></span> )</span><span class="type-signature"> : <a href="Node.html">Node</a>.&lt;vec3></span> </h3>
104110
<div class="method">
105111
<div class="description">

‎docs/pages/BloomNode.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ <h3 class="name" id="inputNode" translate="no">.<a href="#inputNode">inputNode</
9898
<div class="member">
9999
<h3 class="name" id="radius" translate="no">.<a href="#radius">radius</a><span class="type-signature"> : <a href="UniformNode.html">UniformNode</a>.&lt;float></span> </h3>
100100
<div class="description">
101-
<p>The radius of the bloom.</p>
101+
<p>The radius of the bloom. Must be in the range <code>[0,1]</code>.</p>
102102
</div>
103103
</div>
104104
<div class="member">

‎docs/pages/BufferGeometry.html‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -111,9 +111,9 @@ <h3 class="name" id="indirect" translate="no">.<a href="#indirect">indirect</a><
111111
</div>
112112
</div>
113113
<div class="member">
114-
<h3 class="name" id="indirectOffset" translate="no">.<a href="#indirectOffset">indirectOffset</a><span class="type-signature"> : number</span> </h3>
114+
<h3 class="name" id="indirectOffset" translate="no">.<a href="#indirectOffset">indirectOffset</a><span class="type-signature"> : number | Array.&lt;number></span> </h3>
115115
<div class="description">
116-
<p>The offset, in bytes, into the indirect drawing buffer where the value data begins.</p>
116+
<p>The offset, in bytes, into the indirect drawing buffer where the value data begins. If an array is provided, multiple indirect draw calls will be made for each offset.</p>
117117
<p>Can only be used with <a href="WebGPURenderer.html">WebGPURenderer</a> and a WebGPU backend.</p>
118118
<p>Default is <code>0</code>.</p>
119119
</div>
@@ -130,7 +130,7 @@ <h3 class="name" id="morphAttributes" translate="no">.<a href="#morphAttributes"
130130
<div class="description">
131131
<p>This dictionary holds the morph targets of the geometry.</p>
132132
<p>Note: Once the geometry has been rendered, the morph attribute data cannot
133-
be changed. You will have to call `dispose()?, and create a new geometry instance.</p>
133+
be changed. You will have to call <code>dispose()</code>, and create a new geometry instance.</p>
134134
</div>
135135
</div>
136136
<div class="member">
@@ -652,7 +652,7 @@ <h3 class="name name-method" id="setIndex" translate="no">.<a href="#setIndex">s
652652
<dt class="tag-returns"><strong>Returns:</strong> A reference to this instance.</dt>
653653
</dl>
654654
</div>
655-
<h3 class="name name-method" id="setIndirect" translate="no">.<a href="#setIndirect">setIndirect</a><span class="signature">( indirect : <span class="param-type"><a href="BufferAttribute.html">BufferAttribute</a></span>, indirectOffset : <span class="param-type">number</span> )</span><span class="type-signature"> : <a href="BufferGeometry.html">BufferGeometry</a></span> </h3>
655+
<h3 class="name name-method" id="setIndirect" translate="no">.<a href="#setIndirect">setIndirect</a><span class="signature">( indirect : <span class="param-type"><a href="BufferAttribute.html">BufferAttribute</a></span>, indirectOffset : <span class="param-type">number | Array.&lt;number></span> )</span><span class="type-signature"> : <a href="BufferGeometry.html">BufferGeometry</a></span> </h3>
656656
<div class="method">
657657
<div class="description">
658658
<p>Sets the given indirect attribute to this geometry.</p>
@@ -672,7 +672,7 @@ <h3 class="name name-method" id="setIndirect" translate="no">.<a href="#setIndir
672672
<strong>indirectOffset</strong>
673673
</td>
674674
<td class="description last">
675-
<p>The offset, in bytes, into the indirect drawing buffer where the value data begins.</p>
675+
<p>The offset, in bytes, into the indirect drawing buffer where the value data begins. If an array is provided, multiple indirect draw calls will be made for each offset.</p>
676676
<p>Default is <code>0</code>.</p>
677677
</td>
678678
</tr>

‎docs/pages/LightProbe.html‎

Lines changed: 0 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -72,28 +72,6 @@ <h3 class="name" id="sh" translate="no">.<a href="#sh">sh</a><span class="type-s
7272
<p>A light probe uses spherical harmonics to encode lighting information.</p>
7373
</div>
7474
</div>
75-
<h2 class="subsection-title">Methods</h2>
76-
<h3 class="name name-method" id="fromJSON" translate="no">.<a href="#fromJSON">fromJSON</a><span class="signature">( json : <span class="param-type">Object</span> )</span><span class="type-signature"> : <a href="LightProbe.html">LightProbe</a></span> </h3>
77-
<div class="method">
78-
<div class="description">
79-
<p>Deserializes the light prove from the given JSON.</p>
80-
</div>
81-
<table class="params">
82-
<tbody>
83-
<tr>
84-
<td class="name">
85-
<strong>json</strong>
86-
</td>
87-
<td class="description last">
88-
<p>The JSON holding the serialized light probe.</p>
89-
</td>
90-
</tr>
91-
</tbody>
92-
</table>
93-
<dl class="details">
94-
<dt class="tag-returns"><strong>Returns:</strong> A reference to this light probe.</dt>
95-
</dl>
96-
</div>
9775
<h2 class="subsection-title">Source</h2>
9876
<p>
9977
<a href="https://github.com/mrdoob/three.js/blob/master/src/lights/LightProbe.js" translate="no" target="_blank" rel="noopener">src/lights/LightProbe.js</a>

‎docs/pages/PointLightHelper.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ <h3 class="name" id="color" translate="no">.<a href="#color">color</a><span clas
7373
</div>
7474
</div>
7575
<div class="member">
76-
<h3 class="name" id="light" translate="no">.<a href="#light">light</a><span class="type-signature"> : <a href="HemisphereLight.html">HemisphereLight</a></span> </h3>
76+
<h3 class="name" id="light" translate="no">.<a href="#light">light</a><span class="type-signature"> : <a href="PointLight.html">PointLight</a></span> </h3>
7777
<div class="description">
7878
<p>The light being visualized.</p>
7979
</div>

‎docs/pages/PointLightShadow.html‎

Lines changed: 0 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -33,37 +33,6 @@ <h3 class="name" id="isPointLightShadow" translate="no">.<a href="#isPointLightS
3333
<p>Default is <code>true</code>.</p>
3434
</div>
3535
</div>
36-
<h2 class="subsection-title">Methods</h2>
37-
<h3 class="name name-method" id="updateMatrices" translate="no">.<a href="#updateMatrices">updateMatrices</a><span class="signature">( light : <span class="param-type"><a href="Light.html">Light</a></span>, faceIndex : <span class="param-type">number</span> )</span> </h3>
38-
<div class="method">
39-
<div class="description">
40-
<p>Update the matrices for the camera and shadow, used internally by the renderer.</p>
41-
</div>
42-
<table class="params">
43-
<tbody>
44-
<tr>
45-
<td class="name">
46-
<strong>light</strong>
47-
</td>
48-
<td class="description last">
49-
<p>The light for which the shadow is being rendered.</p>
50-
</td>
51-
</tr>
52-
<tr>
53-
<td class="name">
54-
<strong>faceIndex</strong>
55-
</td>
56-
<td class="description last">
57-
<p>The cube face index (0-5).</p>
58-
<p>Default is <code>0</code>.</p>
59-
</td>
60-
</tr>
61-
</tbody>
62-
</table>
63-
<dl class="details">
64-
<dt class="tag-overrides"><strong>Overrides:</strong> <a href="LightShadow.html#updateMatrices">LightShadow#updateMatrices</a></dt>
65-
</dl>
66-
</div>
6736
<h2 class="subsection-title">Source</h2>
6837
<p>
6938
<a href="https://github.com/mrdoob/three.js/blob/master/src/lights/PointLightShadow.js" translate="no" target="_blank" rel="noopener">src/lights/PointLightShadow.js</a>

‎docs/pages/Renderer.html‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1634,7 +1634,7 @@ <h3 class="name name-method" id="setScissor" translate="no">.<a href="#setScisso
16341634
<strong>x</strong>
16351635
</td>
16361636
<td class="description last">
1637-
<p>The horizontal coordinate for the lower left corner of the box in logical pixel unit.
1637+
<p>The horizontal coordinate for the upper left corner of the box in logical pixel unit.
16381638
Instead of passing four arguments, the method also works with a single four-dimensional vector.</p>
16391639
</td>
16401640
</tr>
@@ -1643,7 +1643,7 @@ <h3 class="name name-method" id="setScissor" translate="no">.<a href="#setScisso
16431643
<strong>y</strong>
16441644
</td>
16451645
<td class="description last">
1646-
<p>The vertical coordinate for the lower left corner of the box in logical pixel unit.</p>
1646+
<p>The vertical coordinate for the upper left corner of the box in logical pixel unit.</p>
16471647
</td>
16481648
</tr>
16491649
<tr>
@@ -1749,15 +1749,15 @@ <h3 class="name name-method" id="setViewport" translate="no">.<a href="#setViewp
17491749
<strong>x</strong>
17501750
</td>
17511751
<td class="description last">
1752-
<p>The horizontal coordinate for the lower left corner of the viewport origin in logical pixel unit.</p>
1752+
<p>The horizontal coordinate for the upper left corner of the viewport origin in logical pixel unit.</p>
17531753
</td>
17541754
</tr>
17551755
<tr>
17561756
<td class="name">
17571757
<strong>y</strong>
17581758
</td>
17591759
<td class="description last">
1760-
<p>The vertical coordinate for the lower left corner of the viewport origin in logical pixel unit.</p>
1760+
<p>The vertical coordinate for the upper left corner of the viewport origin in logical pixel unit.</p>
17611761
</td>
17621762
</tr>
17631763
<tr>

‎docs/pages/Skeleton.html‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,14 @@ <h3 class="name" id="bones" translate="no">.<a href="#bones">bones</a><span clas
8888
<p>An array of bones defining the skeleton.</p>
8989
</div>
9090
</div>
91+
<div class="member">
92+
<h3 class="name" id="previousBoneMatrices" translate="no">.<a href="#previousBoneMatrices">previousBoneMatrices</a><span class="type-signature"> : Float32Array</span> </h3>
93+
<div class="description">
94+
<p>An array buffer holding the bone data of the previous frame.
95+
Required for computing velocity. Maintained in <a href="SkinningNode.html">SkinningNode</a>.</p>
96+
<p>Default is <code>null</code>.</p>
97+
</div>
98+
</div>
9199
<h2 class="subsection-title">Methods</h2>
92100
<h3 class="name name-method" id="calculateInverses" translate="no">.<a href="#calculateInverses">calculateInverses</a><span class="signature">()</span> </h3>
93101
<div class="method">

‎docs/pages/StackNode.html‎

Lines changed: 31 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -219,11 +219,41 @@ <h3 class="name name-method" id="Switch" translate="no">.<a href="#Switch">Switc
219219
<dt class="tag-returns"><strong>Returns:</strong> A reference to this stack node.</dt>
220220
</dl>
221221
</div>
222-
<h3 class="name name-method" id="addToStack" translate="no">.<a href="#addToStack">addToStack</a><span class="signature">( node : <span class="param-type"><a href="Node.html">Node</a></span> )</span><span class="type-signature"> : <a href="StackNode.html">StackNode</a></span> </h3>
222+
<h3 class="name name-method" id="addToStack" translate="no">.<a href="#addToStack">addToStack</a><span class="signature">( node : <span class="param-type"><a href="Node.html">Node</a></span>, index : <span class="param-type">number</span> )</span><span class="type-signature"> : <a href="StackNode.html">StackNode</a></span> </h3>
223223
<div class="method">
224224
<div class="description">
225225
<p>Adds a node to this stack.</p>
226226
</div>
227+
<table class="params">
228+
<tbody>
229+
<tr>
230+
<td class="name">
231+
<strong>node</strong>
232+
</td>
233+
<td class="description last">
234+
<p>The node to add.</p>
235+
</td>
236+
</tr>
237+
<tr>
238+
<td class="name">
239+
<strong>index</strong>
240+
</td>
241+
<td class="description last">
242+
<p>The index where the node should be added.</p>
243+
<p>Default is <code>this.nodes.length</code>.</p>
244+
</td>
245+
</tr>
246+
</tbody>
247+
</table>
248+
<dl class="details">
249+
<dt class="tag-returns"><strong>Returns:</strong> A reference to this stack node.</dt>
250+
</dl>
251+
</div>
252+
<h3 class="name name-method" id="addToStackBefore" translate="no">.<a href="#addToStackBefore">addToStackBefore</a><span class="signature">( node : <span class="param-type"><a href="Node.html">Node</a></span> )</span><span class="type-signature"> : <a href="StackNode.html">StackNode</a></span> </h3>
253+
<div class="method">
254+
<div class="description">
255+
<p>Adds a node to the stack before the current node.</p>
256+
</div>
227257
<table class="params">
228258
<tbody>
229259
<tr>

0 commit comments

Comments
 (0)