Skip to content

Added new docs generated with JSDocs #32118

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mrdoob merged 12 commits into from
Oct 23, 2025
Merged

Added new docs generated with JSDocs #32118

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
8de3fd3
New Docs: Add translation disable flags.
mrdoob Oct 13, 2025
0f1cc3f
Clean up.
mrdoob Oct 13, 2025
d80be70
Merge branch 'dev' into docs
mrdoob Oct 23, 2025
4f41a3a
Improved tables rendering.
mrdoob Oct 23, 2025
c853f80
Exclude WebGPURenderer.Nodes.js for now.
mrdoob Oct 23, 2025
dfb5f5a
Merge branch 'dev' into docs
mrdoob Oct 23, 2025
00dc8b2
Changed jsdocs destination folder to docs.
mrdoob Oct 23, 2025
4847b79
Fixed navigation indentation.
mrdoob Oct 23, 2025
722ddd1
Generated docs.
mrdoob Oct 23, 2025
aa85332
Replaced prettify.js with highlight.js
mrdoob Oct 23, 2025
9670833
Clean up.
mrdoob Oct 23, 2025
1d6f5f8
Updated docs.
mrdoob Oct 23, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
2,405 changes: 2,405 additions & 0 deletions docs/index.html
View file
Open in desktop

Large diffs are not rendered by default.

106 changes: 106 additions & 0 deletions docs/pages/AMFLoader.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,106 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>AMFLoader - Three.js Docs</title>
<meta name="viewport" content="width=device-width, user-scalable=no, minimum-scale=1.0, maximum-scale=1.0">
<script src="../scripts/highlight.min.js"></script>
<link type="text/css" rel="stylesheet" href="../styles/highlight-three.css">
<link type="text/css" rel="stylesheet" href="../styles/page.css">
</head>
<body>
<p class="inheritance" translate="no"><a href="Loader.html">Loader</a> → </p>
<h1 translate="no">AMFLoader</h1>
<section>
<header>
<div class="class-description"><p>A loader for the AMF format.</p>
<p>The loader supports materials, color and ZIP compressed files.
No constellation support (yet).</p></div>
<h2>Code Example</h2>
<div translate="no"><pre><code class="language-js">const loader = new AMFLoader();
const object = await loader.loadAsync( './models/amf/rook.amf' );
scene.add( object );
</code></pre></div>
</header>
<article>
<h2 class="subsection-title">Import</h2>
<p><span translate="no">AMFLoader</span> is an addon, and must be imported explicitly, see <a href="https://threejs.org/manual/#en/installation" target="_blank">Installation#Addons</a>.</p>
<pre><code class="language-js">import { AMFLoader } from 'three/addons/loaders/AMFLoader.js';</code></pre>
<div class="container-overview">
<h2>Constructor</h2>
<h3 class="name name-method" id="AMFLoader" translate="no">new <a href="#AMFLoader">AMFLoader</a><span class="signature">( manager : <span class="param-type">LoadingManager</span> )</span> </h3>
<div class="method">
<div class="description">
<p>Constructs a new AMF loader.</p>
</div>
<table class="params">
<tbody>
<tr>
<td class="name"><code>manager</code></td>
<td class="description last"><p>The loading manager.</p></td>
</tr>
</tbody>
</table>
</div>
</div>
<h2 class="subsection-title">Methods</h2>
<h3 class="name name-method" id="load" translate="no">.<a href="#load">load</a><span class="signature">( url : <span class="param-type">string</span>, onLoad : <span class="param-type">function</span>, onProgress : <span class="param-type">onProgressCallback</span>, onError : <span class="param-type">onErrorCallback</span> )</span> </h3>
<div class="method">
<div class="description">
<p>Starts loading from the given URL and passes the loaded AMF asset
to the <code>onLoad()</code> callback.</p>
</div>
<table class="params">
<tbody>
<tr>
<td class="name"><code>url</code></td>
<td class="description last"><p>The path/URL of the file to be loaded. This can also be a data URI.</p></td>
</tr>
<tr>
<td class="name"><code>onLoad</code></td>
<td class="description last"><p>Executed when the loading process has been finished.</p></td>
</tr>
<tr>
<td class="name"><code>onProgress</code></td>
<td class="description last"><p>Executed while the loading is in progress.</p></td>
</tr>
<tr>
<td class="name"><code>onError</code></td>
<td class="description last"><p>Executed when errors occur.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-overrides"><strong>Overrides:</strong> <a href="Loader.html#load">Loader#load</a></dt>
</dl>
</div>
<h3 class="name name-method" id="parse" translate="no">.<a href="#parse">parse</a><span class="signature">( data : <span class="param-type">ArrayBuffer</span> )</span><span class="type-signature"> : <a href="Group.html">Group</a></span> </h3>
<div class="method">
<div class="description">
<p>Parses the given AMF data and returns the resulting group.</p>
</div>
<table class="params">
<tbody>
<tr>
<td class="name"><code>data</code></td>
<td class="description last"><p>The raw AMF asset data as an array buffer.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-overrides"><strong>Overrides:</strong> <a href="Loader.html#parse">Loader#parse</a></dt>
</dl>
<dl class="details">
<dt class="tag-returns"><strong>Returns:</strong> A group representing the parsed asset.</dt>
</dl>
</div>
<h2 class="subsection-title">Source</h2>
<p>
<a href="https://github.com/mrdoob/three.js/blob/master/examples/jsm/loaders/AMFLoader.js" target="_blank" rel="noopener" translate="no">examples/jsm/loaders/AMFLoader.js</a>
</p>
</article>
</section>
<script src="../scripts/linenumber.js"></script>
<script src="../scripts/page.js"></script>
</body>
</html>
54 changes: 54 additions & 0 deletions docs/pages/AONode.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>AONode - Three.js Docs</title>
<meta name="viewport" content="width=device-width, user-scalable=no, minimum-scale=1.0, maximum-scale=1.0">
<script src="../scripts/highlight.min.js"></script>
<link type="text/css" rel="stylesheet" href="../styles/highlight-three.css">
<link type="text/css" rel="stylesheet" href="../styles/page.css">
</head>
<body>
<p class="inheritance" translate="no"><a href="EventDispatcher.html">EventDispatcher</a> → <a href="Node.html">Node</a> → <a href="LightingNode.html">LightingNode</a> → </p>
<h1 translate="no">AONode</h1>
<section>
<header>
<div class="class-description"><p>A generic class that can be used by nodes which contribute
ambient occlusion to the scene. E.g. an ambient occlusion map
node can be used as input for this module. Used in <a href="NodeMaterial.html">NodeMaterial</a>.</p></div>
</header>
<article>
<div class="container-overview">
<h2>Constructor</h2>
<h3 class="name name-method" id="AONode" translate="no">new <a href="#AONode">AONode</a><span class="signature">( aoNode : <span class="param-type">Node.&lt;float></span> )</span> </h3>
<div class="method">
<div class="description">
<p>Constructs a new AO node.</p>
</div>
<table class="params">
<tbody>
<tr>
<td class="name"><code>aoNode</code></td>
<td class="description last"><p>The ambient occlusion node.<br/>Default is <code>null</code>.</p></td>
</tr>
</tbody>
</table>
</div>
</div>
<h2 class="subsection-title">Properties</h2>
<div class="member">
<h3 class="name" id="aoNode" translate="no">.<a href="#aoNode">aoNode</a><span class="type-signature"> : <a href="Node.html">Node</a>.&lt;float></span> </h3>
<div class="description">
<p>The ambient occlusion node.<br/>Default is <code>null</code>.</p>
</div>
</div>
<h2 class="subsection-title">Source</h2>
<p>
<a href="https://github.com/mrdoob/three.js/blob/master/src/nodes/lighting/AONode.js" target="_blank" rel="noopener" translate="no">src/nodes/lighting/AONode.js</a>
</p>
</article>
</section>
<script src="../scripts/linenumber.js"></script>
<script src="../scripts/page.js"></script>
</body>
</html>
61 changes: 61 additions & 0 deletions docs/pages/ARButton.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>ARButton - Three.js Docs</title>
<meta name="viewport" content="width=device-width, user-scalable=no, minimum-scale=1.0, maximum-scale=1.0">
<script src="../scripts/highlight.min.js"></script>
<link type="text/css" rel="stylesheet" href="../styles/highlight-three.css">
<link type="text/css" rel="stylesheet" href="../styles/page.css">
</head>
<body>
<h1 translate="no">ARButton</h1>
<section>
<header>
<div class="class-description"><p>A utility class for creating a button that allows to initiate
immersive AR sessions based on WebXR. The button can be created
with a factory method and then appended ot the website's DOM.</p></div>
<h2>Code Example</h2>
<div translate="no"><pre><code class="language-js">document.body.appendChild( ARButton.createButton( renderer ) );
</code></pre></div>
</header>
<article>
<h2 class="subsection-title">Import</h2>
<p><span translate="no">ARButton</span> is an addon, and must be imported explicitly, see <a href="https://threejs.org/manual/#en/installation" target="_blank">Installation#Addons</a>.</p>
<pre><code class="language-js">import { ARButton } from 'three/addons/webxr/ARButton.js';</code></pre>
<div class="container-overview">
<div class="method">
</div>
</div>
<h2 class="subsection-title">Static Methods</h2>
<h3 class="name name-method" id=".createButton" translate="no">.<a href="#.createButton">createButton</a><span class="signature">( renderer : <span class="param-type">WebGLRenderer | WebGPURenderer</span>, sessionInit : <span class="param-type">XRSessionInit</span> )</span><span class="type-signature"> : HTMLElement</span> </h3>
<div class="method">
<div class="description">
<p>Constructs a new AR button.</p>
</div>
<table class="params">
<tbody>
<tr>
<td class="name"><code>renderer</code></td>
<td class="description last"><p>The renderer.</p></td>
</tr>
<tr>
<td class="name"><code>sessionInit</code></td>
<td class="description last"><p>The a configuration object for the AR session.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-returns"><strong>Returns:</strong> The button or an error message if <code>immersive-ar</code> isn't supported.</dt>
</dl>
</div>
<h2 class="subsection-title">Source</h2>
<p>
<a href="https://github.com/mrdoob/three.js/blob/master/examples/jsm/webxr/ARButton.js" target="_blank" rel="noopener" translate="no">examples/jsm/webxr/ARButton.js</a>
</p>
</article>
</section>
<script src="../scripts/linenumber.js"></script>
<script src="../scripts/page.js"></script>
</body>
</html>
158 changes: 158 additions & 0 deletions docs/pages/AfterImageNode.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,158 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>AfterImageNode - Three.js Docs</title>
<meta name="viewport" content="width=device-width, user-scalable=no, minimum-scale=1.0, maximum-scale=1.0">
<script src="../scripts/highlight.min.js"></script>
<link type="text/css" rel="stylesheet" href="../styles/highlight-three.css">
<link type="text/css" rel="stylesheet" href="../styles/page.css">
</head>
<body>
<p class="inheritance" translate="no"><a href="EventDispatcher.html">EventDispatcher</a> → <a href="Node.html">Node</a> → <a href="TempNode.html">TempNode</a> → </p>
<h1 translate="no">AfterImageNode</h1>
<section>
<header>
<div class="class-description"><p>Post processing node for creating an after image effect.</p></div>
</header>
<article>
<h2 class="subsection-title">Import</h2>
<p><span translate="no">AfterImageNode</span> is an addon, and must be imported explicitly, see <a href="https://threejs.org/manual/#en/installation" target="_blank">Installation#Addons</a>.</p>
<pre><code class="language-js">import { afterImage } from 'three/addons/tsl/display/AfterImageNode.js';</code></pre>
<div class="container-overview">
<h2>Constructor</h2>
<h3 class="name name-method" id="AfterImageNode" translate="no">new <a href="#AfterImageNode">AfterImageNode</a><span class="signature">( textureNode : <span class="param-type">TextureNode</span>, damp : <span class="param-type">Node.&lt;float></span> )</span> </h3>
<div class="method">
<div class="description">
<p>Constructs a new after image node.</p>
</div>
<table class="params">
<tbody>
<tr>
<td class="name"><code>textureNode</code></td>
<td class="description last"><p>The texture node that represents the input of the effect.</p></td>
</tr>
<tr>
<td class="name"><code>damp</code></td>
<td class="description last"><p>The damping intensity. A higher value means a stronger after image effect.<br/>Default is <code>0.96</code>.</p></td>
</tr>
</tbody>
</table>
</div>
</div>
<h2 class="subsection-title">Properties</h2>
<div class="member">
<h3 class="name" id="damp" translate="no">.<a href="#damp">damp</a><span class="type-signature"> : <a href="Node.html">Node</a>.&lt;float></span> </h3>
<div class="description">
<p>How quickly the after-image fades. A higher value means the after-image
persists longer, while a lower value means it fades faster. Should be in
the range <code>[0, 1]</code>.</p>
</div>
</div>
<div class="member">
<h3 class="name" id="textureNode" translate="no">.<a href="#textureNode">textureNode</a><span class="type-signature"> : <a href="TextureNode.html">TextureNode</a></span> </h3>
<div class="description">
<p>The texture node that represents the input of the effect.</p>
</div>
</div>
<div class="member">
<h3 class="name" id="textureNodeOld" translate="no">.<a href="#textureNodeOld">textureNodeOld</a><span class="type-signature"> : <a href="TextureNode.html">TextureNode</a></span> </h3>
<div class="description">
<p>The texture represents the pervious frame.</p>
</div>
</div>
<div class="member">
<h3 class="name" id="updateBeforeType" translate="no">.<a href="#updateBeforeType">updateBeforeType</a><span class="type-signature"> : string</span> </h3>
<div class="description">
<p>The <code>updateBeforeType</code> is set to <code>NodeUpdateType.FRAME</code> since the node renders
its effect once per frame in <code>updateBefore()</code>.<br/>Default is <code>'frame'</code>.</p>
</div>
<dl class="details">
<dt class="tag-overrides"><strong>Overrides:</strong> <a href="TempNode.html#updateBeforeType">TempNode#updateBeforeType</a></dt>
</dl>
</div>
<h2 class="subsection-title">Methods</h2>
<h3 class="name name-method" id="dispose" translate="no">.<a href="#dispose">dispose</a><span class="signature">()</span> </h3>
<div class="method">
<div class="description">
<p>Frees internal resources. This method should be called
when the effect is no longer required.</p>
</div>
<dl class="details">
<dt class="tag-overrides"><strong>Overrides:</strong> <a href="TempNode.html#dispose">TempNode#dispose</a></dt>
</dl>
</div>
<h3 class="name name-method" id="getTextureNode" translate="no">.<a href="#getTextureNode">getTextureNode</a><span class="signature">()</span><span class="type-signature"> : <a href="PassTextureNode.html">PassTextureNode</a></span> </h3>
<div class="method">
<div class="description">
<p>Returns the result of the effect as a texture node.</p>
</div>
<dl class="details">
<dt class="tag-returns"><strong>Returns:</strong> A texture node that represents the result of the effect.</dt>
</dl>
</div>
<h3 class="name name-method" id="setSize" translate="no">.<a href="#setSize">setSize</a><span class="signature">( width : <span class="param-type">number</span>, height : <span class="param-type">number</span> )</span> </h3>
<div class="method">
<div class="description">
<p>Sets the size of the effect.</p>
</div>
<table class="params">
<tbody>
<tr>
<td class="name"><code>width</code></td>
<td class="description last"><p>The width of the effect.</p></td>
</tr>
<tr>
<td class="name"><code>height</code></td>
<td class="description last"><p>The height of the effect.</p></td>
</tr>
</tbody>
</table>
</div>
<h3 class="name name-method" id="setup" translate="no">.<a href="#setup">setup</a><span class="signature">( builder : <span class="param-type">NodeBuilder</span> )</span><span class="type-signature"> : <a href="PassTextureNode.html">PassTextureNode</a></span> </h3>
<div class="method">
<div class="description">
<p>This method is used to setup the effect's TSL code.</p>
</div>
<table class="params">
<tbody>
<tr>
<td class="name"><code>builder</code></td>
<td class="description last"><p>The current node builder.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-overrides"><strong>Overrides:</strong> <a href="TempNode.html#setup">TempNode#setup</a></dt>
</dl>
<dl class="details">
<dt class="tag-returns"><strong>Returns:</strong> </dt>
</dl>
</div>
<h3 class="name name-method" id="updateBefore" translate="no">.<a href="#updateBefore">updateBefore</a><span class="signature">( frame : <span class="param-type">NodeFrame</span> )</span> </h3>
<div class="method">
<div class="description">
<p>This method is used to render the effect once per frame.</p>
</div>
<table class="params">
<tbody>
<tr>
<td class="name"><code>frame</code></td>
<td class="description last"><p>The current node frame.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-overrides"><strong>Overrides:</strong> <a href="TempNode.html#updateBefore">TempNode#updateBefore</a></dt>
</dl>
</div>
<h2 class="subsection-title">Source</h2>
<p>
<a href="https://github.com/mrdoob/three.js/blob/master/examples/jsm/tsl/display/AfterImageNode.js" target="_blank" rel="noopener" translate="no">examples/jsm/tsl/display/AfterImageNode.js</a>
</p>
</article>
</section>
<script src="../scripts/linenumber.js"></script>
<script src="../scripts/page.js"></script>
</body>
</html>
Loading
Loading