three.js

https://threejs.org/docs
Admin
three.js is a JavaScript 3D library that makes it easy to create and display animated 3D computer...
Tokens:839,311
Snippets:11,267
Trust Score:9.5
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### setViewOffset multi-monitor setup example

Source: https://threejs.org/docs/pages/PerspectiveCamera.html

Shows a 3x2 monitor grid layout and the corresponding setViewOffset calls for each monitor (A-F) to create a multi-window/multi-monitor setup. The example uses 1920x1080 monitors and computes fullWidth and fullHeight as w*3 and h*2.

```text
+---+---+---+
  | A | B | C |
  +---+---+---+
  | D | E | F |
  +---+---+---+

```

```javascript
const w = 1920;
const h = 1080;
const fullWidth = w * 3;
const fullHeight = h * 2;
// --A--
camera.setViewOffset( fullWidth, fullHeight, w * 0, h * 0, w, h );
// --B--
camera.setViewOffset( fullWidth, fullHeight, w * 1, h * 0, w, h );
// --C--
camera.setViewOffset( fullWidth, fullHeight, w * 2, h * 0, w, h );
// --D--
camera.setViewOffset( fullWidth, fullHeight, w * 0, h * 1, w, h );
// --E--
camera.setViewOffset( fullWidth, fullHeight, w * 1, h * 1, w, h );
// --F--
camera.setViewOffset( fullWidth, fullHeight, w * 2, h * 1, w, h );

```

--------------------------------

### .setupWebGLXRFallback

Source: https://threejs.org/docs/pages/global.html

Sets up a WebGL fallback for WebGPU XR examples.

```APIDOC
## .setupWebGLXRFallback( renderer : WebGPURenderer, createFallbackRenderer : function, onFallback : function )

### Description
Sets up a construction-time WebGL fallback for WebGPU XR examples.

### Parameters
- **renderer** (WebGPURenderer) - Required - The initial renderer.
- **createFallbackRenderer** (function) - Required - A function that returns a new renderer with a WebGL backend.
- **onFallback** (function) - Required - A function that installs the new renderer in the app.
```

--------------------------------

### Basic RenderPipeline setup

Source: https://threejs.org/docs/pages/RenderPipeline.html

Creates a RenderPipeline instance and sets its output node to a scene pass. This is the basic setup for using the rendering pipeline with post-processing effects.

```js
const renderPipeline = new RenderPipeline( renderer );
const scenePass = pass( scene, camera );
renderPipeline.outputNode = scenePass;
```

--------------------------------

### ShadowNode.setupShadow( builder )

Source: https://threejs.org/docs/pages/ShadowNode.html

Setups the shadow output node.

```APIDOC
## setupShadow( builder )

### Description
Setups the shadow output node.

### Parameters
- **builder** (NodeBuilder) - Required - A reference to the current node builder.

### Returns
- **Node.<vec3>** - The shadow output node.
```

--------------------------------

### .setupHardwareClipping( builder : NodeBuilder )

Source: https://threejs.org/docs/pages/NodeMaterial.html

Setups the hardware clipping if available on the current device.

```APIDOC
## .setupHardwareClipping( builder : NodeBuilder )

### Description
Setups the hardware clipping if available on the current device.

### Parameters
- **builder** (NodeBuilder) - Required - The current node builder.

```

--------------------------------

### .setup( builder : NodeBuilder )

Source: https://threejs.org/docs/pages/NodeMaterial.html

Setups the vertex and fragment stage of this node material.

```APIDOC
## .setup( builder : NodeBuilder )

### Description
Setups the vertex and fragment stage of this node material.

### Parameters
- **builder** (NodeBuilder) - Required - The current node builder.

```

--------------------------------

### BatchedMesh usage example

Source: https://threejs.org/docs/pages/BatchedMesh.html

Shows how to create a BatchedMesh, add geometries and instances, and position them using setMatrixAt. The example uses BoxGeometry, SphereGeometry, and MeshBasicMaterial.

```js
const box = new THREE.BoxGeometry( 1, 1, 1 );
const sphere = new THREE.SphereGeometry( 1, 12, 12 );
const material = new THREE.MeshBasicMaterial( { color: 0x00ff00 } );
// initialize and add geometries into the batched mesh
const batchedMesh = new BatchedMesh( 10, 5000, 10000, material );
const boxGeometryId = batchedMesh.addGeometry( box );
const sphereGeometryId = batchedMesh.addGeometry( sphere );
// create instances of those geometries
const boxInstancedId1 = batchedMesh.addInstance( boxGeometryId );
const boxInstancedId2 = batchedMesh.addInstance( boxGeometryId );
const sphereInstancedId1 = batchedMesh.addInstance( sphereGeometryId );
const sphereInstancedId2 = batchedMesh.addInstance( sphereGeometryId );
// position the geometries
batchedMesh.setMatrixAt( boxInstancedId1, boxMatrix1 );
batchedMesh.setMatrixAt( boxInstancedId2, boxMatrix2 );
batchedMesh.setMatrixAt( sphereInstancedId1, sphereMatrix1 );
batchedMesh.setMatrixAt( sphereInstancedId2, sphereMatrix2 );
scene.add( batchedMesh );
```

--------------------------------

### ShadowNode.setupShadowFilter( builder, inputs )

Source: https://threejs.org/docs/pages/ShadowNode.html

Setups the shadow filtering.

```APIDOC
## setupShadowFilter( builder, inputs )

### Description
Setups the shadow filtering.

### Parameters
- **builder** (NodeBuilder) - Required - A reference to the current node builder.
- **inputs** (Object) - Required - A configuration object that defines the shadow filtering.
  - **filterFn** (function) - Required - This function defines the filtering type of the shadow map e.g. PCF.
  - **depthTexture** (Texture) - Required - A reference to the shadow map's texture data.
  - **shadowCoord** (Node.<vec3>) - Required - Shadow coordinates which are used to sample from the shadow map.
  - **shadow** (LightShadow) - Required - The light shadow.

### Returns
- **Node.<float>** - The result node of the shadow filtering.
```

--------------------------------

### .setupDepth( builder : NodeBuilder )

Source: https://threejs.org/docs/pages/NodeMaterial.html

Setups the depth of this material.

```APIDOC
## .setupDepth( builder : NodeBuilder )

### Description
Setups the depth of this material.

### Parameters
- **builder** (NodeBuilder) - Required - The current node builder.

```

--------------------------------

### .setupClipping( builder : NodeBuilder ) : ClippingNode

Source: https://threejs.org/docs/pages/NodeMaterial.html

Setups the clipping node.

```APIDOC
## .setupClipping( builder : NodeBuilder ) : ClippingNode

### Description
Setups the clipping node.

### Parameters
- **builder** (NodeBuilder) - Required - The current node builder.

### Returns
The clipping node.

```

--------------------------------

### ShadowNode.setupShadowCoord( builder, shadowPosition )

Source: https://threejs.org/docs/pages/ShadowNode.html

Setups the shadow coordinates.

```APIDOC
## setupShadowCoord( builder, shadowPosition )

### Description
Setups the shadow coordinates.

### Parameters
- **builder** (NodeBuilder) - Required - A reference to the current node builder.
- **shadowPosition** (Node.<vec3>) - Required - A node representing the shadow position.

### Returns
- **Node.<vec3>** - The shadow coordinates.
```

--------------------------------

### .setupLighting( builder : NodeBuilder ) : Node.<vec3>

Source: https://threejs.org/docs/pages/NodeMaterial.html

Setups the outgoing light node.

```APIDOC
## .setupLighting( builder : NodeBuilder ) : Node.<vec3>

### Description
Setups the outgoing light node.

### Parameters
- **builder** (NodeBuilder) - Required - The current node builder.

### Returns
The outgoing light node.

```

--------------------------------

### .setupEnvironment( builder : NodeBuilder ) : Node.<vec4>

Source: https://threejs.org/docs/pages/NodeMaterial.html

Setups the environment node from the material.

```APIDOC
## .setupEnvironment( builder : NodeBuilder ) : Node.<vec4>

### Description
Setups the environment node from the material.

### Parameters
- **builder** (NodeBuilder) - Required - The current node builder.

### Returns
The environment node.

```

--------------------------------

### .setupModelViewProjection( builder : NodeBuilder ) : Node.<vec4>

Source: https://threejs.org/docs/pages/NodeMaterial.html

Setups the position in clip space.

```APIDOC
## .setupModelViewProjection( builder : NodeBuilder ) : Node.<vec4>

### Description
Setups the position in clip space.

### Parameters
- **builder** (NodeBuilder) - Required - The current node builder.

### Returns
The position in view space.

```

--------------------------------

### .setup()

Source: https://threejs.org/docs/pages/SampleNode.html

Sets up the node by sampling with the default UV accessor.

```APIDOC
## .setup()

### Description
Sets up the node by sampling with the default UV accessor.

### Method
`setup() : Node`

### Overrides
[Node#setup](Node.html#setup)

### Returns
- **Node** - The result of the callback function when called with the UV node.
```

--------------------------------

### Extending EventDispatcher with a custom class

Source: https://threejs.org/docs/pages/EventDispatcher.html

Shows how to extend EventDispatcher to create a custom class that can dispatch events. The Car class dispatches a 'start' event with a message, and the example listens for that event and alerts the message when the car starts.

```js
class Car extends EventDispatcher {
	start() {
		this.dispatchEvent( { type: 'start', message: 'vroom vroom!' } );
	}
};
// Using events with the custom object
const car = new Car();
car.addEventListener( 'start', function ( event ) {
	alert( event.message );
} );
car.start();
```

--------------------------------

### .setupFog( builder : NodeBuilder, outputNode : Node.<vec4> ) : Node.<vec4>

Source: https://threejs.org/docs/pages/NodeMaterial.html

Setup the fog.

```APIDOC
## .setupFog( builder : NodeBuilder, outputNode : Node.<vec4> ) : Node.<vec4>

### Description
Setup the fog.

### Parameters
- **builder** (NodeBuilder) - Required - The current node builder.
- **outputNode** (Node.<vec4>) - Required - The existing output node.

### Returns
The output node.

```

--------------------------------

### SSGINode Methods

Source: https://threejs.org/docs/pages/SSGINode.html

Methods for the SSGINode class, including disposal, getting AO/GI nodes, setting size, setup, and updateBefore.

```APIDOC
## .dispose()

### Description
Frees internal resources. This method should be called when the effect is no longer required.

### Method
.dispose()

### Parameters
None

### Returns
None

### Overrides
[TempNode#dispose](TempNode.html#dispose)

```

```APIDOC
## .getAONode() : PassTextureNode

### Description
Returns the AO result of the effect as a texture node.

### Method
.getAONode()

### Parameters
None

### Returns
- **PassTextureNode** - A texture node that represents the AO result of the effect.

```

```APIDOC
## .getGINode() : PassTextureNode

### Description
Returns the GI result of the effect as a texture node.

### Method
.getGINode()

### Parameters
None

### Returns
- **PassTextureNode** - A texture node that represents the GI result of the effect.

```

```APIDOC
## .setSize( width : number, height : number )

### Description
Sets the size of the effect.

### Method
.setSize( width, height )

### Parameters
- **width** (number) - Required - The width of the effect.
- **height** (number) - Required - The height of the effect.

```

```APIDOC
## .setup( builder : NodeBuilder ) : PassTextureNode

### Description
This method is used to setup the effect's TSL code.

### Method
.setup( builder )

### Parameters
- **builder** (NodeBuilder) - Required - The current node builder.

### Returns
- **PassTextureNode** - The resulting texture node.

### Overrides
[TempNode#setup](TempNode.html#setup)

```

```APIDOC
## .updateBefore( frame : NodeFrame )

### Description
This method is used to render the effect once per frame.

### Method
.updateBefore( frame )

### Parameters
- **frame** (NodeFrame) - Required - The current node frame.

### Overrides
[TempNode#updateBefore](TempNode.html#updateBefore)

```

--------------------------------

### Import GTAOPass from three/addons

Source: https://threejs.org/docs/pages/GTAOPass.html

Imports the GTAOPass addon. Must be imported explicitly as an addon; see the Installation#Addons guide.

```javascript
import { GTAOPass } from 'three/addons/postprocessing/GTAOPass.js';
```

--------------------------------

### .setup( builder )

Source: https://threejs.org/docs/pages/ReferenceNode.html

Returns the internal uniform node as the output of the reference node.

```APIDOC
## .setup( builder )

### Description
The output of the reference node is the internal uniform node.

### Parameters
- **builder** (NodeBuilder) - Required - The current node builder.

### Returns
- **UniformNode** - The output node.

```

--------------------------------

### Import DecoratedTorusKnot4b from three/addons

Source: https://threejs.org/docs/pages/DecoratedTorusKnot4b.html

Import the DecoratedTorusKnot4b class from the 'three/addons/curves/CurveExtras.js' module. This addon must be imported explicitly as noted in the installation guide.

```javascript
import { DecoratedTorusKnot4b } from 'three/addons/curves/CurveExtras.js';
```

--------------------------------

### Import LineSegments2 from three/addons

Source: https://threejs.org/docs/pages/LineSegments2.html

Shows the explicit import statement for LineSegments2 as an addon. Must be imported explicitly as per the Installation#Addons guide.

```javascript
import { LineSegments2 } from 'three/addons/lines/LineSegments2.js';
```

--------------------------------

### .setupLightingModel() : BasicLightingModel

Source: https://threejs.org/docs/pages/MeshBasicNodeMaterial.html

Sets up the lighting model for the material.

```APIDOC
## .setupLightingModel() : BasicLightingModel

### Description
Setups the lighting model.

### Method
`setupLightingModel()`

### Parameters
None.

### Returns
- **BasicLightingModel** - The lighting model.
```

--------------------------------

### Import Reflector addon

Source: https://threejs.org/docs/pages/Reflector.html

Explicit import statement required for the Reflector addon, as it is not part of the core three.js module. Follows the installation guide for addons.

```javascript
import { Reflector } from 'three/addons/objects/Reflector.js';
```

--------------------------------

### Create AudioAnalyser and get average frequency

Source: https://threejs.org/docs/pages/AudioAnalyser.html

Shows how to set up an AudioAnalyser with an AudioListener and Audio object, load a sound, and retrieve the average frequency. The fftSize is set to 32 in this example, overriding the default of 2048.

```javascript
// create an AudioListener and add it to the camera
const listener = new THREE.AudioListener();
camera.add( listener );
// create an Audio source
const sound = new THREE.Audio( listener );
// load a sound and set it as the Audio object's buffer
const audioLoader = new THREE.AudioLoader();
audioLoader.load( 'sounds/ambient.ogg', function( buffer ) {
	sound.setBuffer( buffer );
	sound.setLoop(true);
	sound.setVolume(0.5);
	sound.play();
});
// create an AudioAnalyser, passing in the sound and desired fftSize
const analyser = new THREE.AudioAnalyser( sound, 32 );
// get the average frequency of the sound
const data = analyser.getAverageFrequency();
```

--------------------------------

### .setupMaterial( material : Material )

Source: https://threejs.org/docs/pages/CSM.html

Sets up a material for CSM support.

```APIDOC
## .setupMaterial( material : Material )

### Description
Applications must call this method for all materials that should be affected by CSM.

### Parameters
- **material** (Material) - Required - The material to setup for CSM support.
```

--------------------------------

### GodraysNode usage example

Source: https://threejs.org/docs/pages/GodraysNode.html

Shows the recommended pipeline for using the GodraysNode: create the godrays pass, optionally blur it with bilateralBlur, and composite with depthAwareBlend to mitigate aliasing and light leaking. Requires a full shadow setup and only point/directional lights are supported.

```js
const godraysPass = godrays( scenePassDepth, camera, light );
const blurPass = bilateralBlur( godraysPassColor ); // optional blur
const outputBlurred = depthAwareBlend( scenePassColor, blurPassColor, scenePassDepth, camera, { blendColor, edgeRadius, edgeStrength } ); // composite
```

--------------------------------

### .setup( builder : Builder ) : Node

Source: https://threejs.org/docs/pages/TileShadowNode.html

Sets up the shadow node for rendering.

```APIDOC
## Method: .setup( builder : Builder ) : Node

### Description
Sets up the shadow node for rendering.

### Parameters
- **builder** (Builder) - Required - The builder used to set up the shadow node.

### Returns
A node representing the shadow value.

### Overrides
[ShadowBaseNode#setup](ShadowBaseNode.html#setup)
```

--------------------------------

### .setup( builder )

Source: https://threejs.org/docs/pages/BufferAttributeNode.html

Sets up the node, creating an internal attribute if necessary.

```APIDOC
## .setup( builder : NodeBuilder )

### Description
Depending on which value was passed to the node, `setup()` behaves differently. If no instance of `BufferAttribute` was passed, the method creates an internal attribute and configures it respectively.

### Parameters
- **builder** (NodeBuilder) - Required - The current node builder.
```

--------------------------------

### Define and use a custom struct with StructNode

Source: https://threejs.org/docs/pages/StructNode.html

Shows how to define a custom struct using the `struct` function, create instances with two different styles, access a member with `get`, and assign a new value with `assign`. The example uses `vec3` for member types and values.

```javascript
// Define a custom struct
const BoundingBox = struct( { min: 'vec3', max: 'vec3' } );
// Create a new instance of the struct
const bb = BoundingBox( vec3( 0 ), vec3( 1 ) ); // style 1
const bb = BoundingBox( { min: vec3( 0 ), max: vec3( 1 ) } ); // style 2
// Access the struct members
const min = bb.get( 'min' );
// Assign a new value to a member
min.assign( vec3() );
```

--------------------------------

### .setup( builder : NodeBuilder )

Source: https://threejs.org/docs/pages/TextureNode.html

Setups texture node by preparing the internal nodes for code generation.

```APIDOC
## .setup( builder : NodeBuilder )

### Description
Setups texture node by preparing the internal nodes for code generation.

### Parameters
- **builder** (NodeBuilder) - Required - The current node builder.

### Overrides
[UniformNode#setup](UniformNode.html#setup)
```

--------------------------------

### .set( start, end )

Source: https://threejs.org/docs/pages/Line3.html

Sets the start and end points of the line segment.

```APIDOC
## .set( start : Vector3, end : Vector3 ) : Line3

### Description
Sets the start and end values by copying the given vectors.

### Method
`.set( start, end )`

### Parameters
- **start** (Vector3) - Required - The start point.
- **end** (Vector3) - Required - The end point.

### Returns
A reference to this line segment.
```

--------------------------------

### new Capsule( start, end, radius )

Source: https://threejs.org/docs/pages/Capsule.html

Constructs a new capsule with the given start and end vectors and radius.

```APIDOC
## new Capsule( start : Vector3, end : Vector3, radius : number )

### Description
Constructs a new capsule with the given start and end vectors and radius.

### Parameters
- **start** (Vector3) - Required - The start vector.
- **end** (Vector3) - Required - The end vector.
- **radius** (number) - Optional - The capsule's radius. Default is `1`.

### Returns
No return value (constructor).
```

--------------------------------

### .setupLightingModel() : PhongLightingModel

Source: https://threejs.org/docs/pages/MeshPhongNodeMaterial.html

Sets up the lighting model for the material.

```APIDOC
## .setupLightingModel() : PhongLightingModel

### Description
Setups the lighting model.

### Method
`setupLightingModel() : PhongLightingModel`

### Returns
- **PhongLightingModel** - The lighting model.

```

--------------------------------

### .setupLightingModel() : PhysicalLightingModel

Source: https://threejs.org/docs/pages/MeshStandardNodeMaterial.html

Sets up the lighting model for the material.

```APIDOC
## .setupLightingModel() : PhysicalLightingModel

### Description
Setups the lighting model.

### Returns
- **PhysicalLightingModel** - The lighting model.

**Overrides:** [NodeMaterial#setupLightingModel](NodeMaterial.html#setupLightingModel)

```

--------------------------------

### .setLoopStart( value : number )

Source: https://threejs.org/docs/pages/Audio.html

Sets the loop start value which defines where in the audio buffer the replay should start, in seconds.

```APIDOC
## .setLoopStart( value : number )

### Description
Sets the loop start value which defines where in the audio buffer the replay should start, in seconds.

### Method
setLoopStart( value : number )

### Parameters
- **value** (number) - Required - The loop start value.

### Returns
- **Audio** - A reference to this instance.
```

--------------------------------

### .setupShadow( builder )

Source: https://threejs.org/docs/pages/SunShadowNode.html

Sets up the atlas render target and shadow output node.

```APIDOC
## .setupShadow( builder : NodeBuilder ) : Node.<float>

### Description
Sets up the atlas render target and shadow output node.

### Parameters
- **builder** (NodeBuilder) - Required - A reference to the current node builder.

### Returns
The shadow output node.
```

--------------------------------

### setup( builder )

Source: https://threejs.org/docs/pages/VelocityNode.html

Implements the velocity computation based on the previous and current vertex data.

```APIDOC
## setup( builder )

### Description
Implements the velocity computation based on the previous and current vertex data.

### Method
`setup( builder )`

### Parameters
- **builder** (NodeBuilder) - Required - A reference to the current node builder.

### Returns
Node.<vec2> - The motion vector.
```

--------------------------------

### Loop with Start, End, Type, and Condition

Source: https://threejs.org/docs/pages/LoopNode.html

Defines a loop with explicit start, end, data type, and comparison condition. The loop runs while the condition is true.

```javascript
Loop( { start: int( 0 ), end: int( 10 ), type: 'int', condition: '<' }, ( { i } ) => {
} );
```

--------------------------------

### .setupUV(builder, uvNode)

Source: https://threejs.org/docs/pages/CubeTextureNode.html

Setups the uv node, modifying it if necessary for correct sampling.

```APIDOC
## Method: .setupUV(builder, uvNode)

### Description
Setups the uv node. Depending on the backend as well as the texture type, it might be necessary to modify the uv node for correct sampling.

### Parameters
- **builder** (NodeBuilder) - Required - The current node builder.
- **uvNode** (Node) - Required - The uv node to setup.

### Returns
- **Node** - The updated uv node.
```

--------------------------------

### Audio#play()

Source: https://threejs.org/docs/pages/Audio.html

Starts playback of the audio.

```APIDOC
## Audio#play()

### Description
Starts playback of the audio.

```

--------------------------------

### LightsNode.setup(builder)

Source: https://threejs.org/docs/pages/LightsNode.html

The implementation makes sure that for each light in the scene there is a corresponding light node. By building the light nodes and evaluating the lighting model the outgoing light is computed.

```APIDOC
## Method: setup(builder)

### Description
The implementation makes sure that for each light in the scene there is a corresponding light node. By building the light nodes and evaluating the lighting model the outgoing light is computed.

### Parameters
- **builder** (NodeBuilder) - Required - A reference to the current node builder.

### Returns
- **Node.<vec3>** - A node representing the outgoing light.
```

--------------------------------

### .setupEnvironment( builder : NodeBuilder ) : BasicEnvironmentNode.<vec3>

Source: https://threejs.org/docs/pages/MeshBasicNodeMaterial.html

Sets up the environment node for the material.

```APIDOC
## .setupEnvironment( builder : NodeBuilder ) : BasicEnvironmentNode.<vec3>

### Description
Overwritten since this type of material uses BasicEnvironmentNode to implement the default environment mapping.

### Method
`setupEnvironment( builder )`

### Parameters
- **builder** (NodeBuilder) - Required - The current node builder.

### Returns
- **BasicEnvironmentNode.<vec3>** - The environment node.
```

--------------------------------

### play() : AnimationAction

Source: https://threejs.org/docs/pages/AnimationAction.html

Starts the playback of the animation.

```APIDOC
## play() : AnimationAction

### Description
Starts the playback of the animation.

### Returns
A reference to this animation action.
```

--------------------------------

### ShapePath.moveTo

Source: https://threejs.org/docs/pages/ShapePath.html

Starts a new sub-path at the specified coordinates.

```APIDOC
## ShapePath.moveTo

### Description
Creates a new path and moves its current point to the given one.

### Method
moveTo

### Parameters
- **x** (number) - Required - The x coordinate.
- **y** (number) - Required - The y coordinate.

### Returns
A reference to this shape path.
```

--------------------------------

### ShadowNode.setup( builder )

Source: https://threejs.org/docs/pages/ShadowNode.html

Performs the setup of the output node. An output is only produced if shadow mapping is globally enabled in the renderer.

```APIDOC
## setup( builder )

### Description
The implementation performs the setup of the output node. An output is only produced if shadow mapping is globally enabled in the renderer.

### Parameters
- **builder** (NodeBuilder) - Required - A reference to the current node builder.

### Returns
- **ShaderCallNodeInternal** - The output node.
```

--------------------------------

### .delta( target )

Source: https://threejs.org/docs/pages/Line3.html

Computes the vector from start to end.

```APIDOC
## .delta( target : Vector3 ) : Vector3

### Description
Returns the delta vector of the line segment's start and end point.

### Method
`.delta( target )`

### Parameters
- **target** (Vector3) - Required - The target vector that is used to store the method's result.

### Returns
The delta vector.
```

--------------------------------

### .setupLightingModel( builder : NodeBuilder ) : LightingModel (abstract)

Source: https://threejs.org/docs/pages/NodeMaterial.html

This method should be implemented by most derived materials since it defines the material's lighting model.

```APIDOC
## .setupLightingModel( builder : NodeBuilder ) : LightingModel (abstract)

### Description
This method should be implemented by most derived materials since it defines the material's lighting model.

### Parameters
- **builder** (NodeBuilder) - Required - The current node builder.

### Returns
The lighting model.

```

--------------------------------

### .colorMode : string

Source: https://threejs.org/docs/pages/AnaglyphPassNode.html

Gets or sets the color mode.

```APIDOC
## Property

### .colorMode : string

Gets the current color mode.

### .colorMode : string

Sets the color mode.
```

--------------------------------

### .setup( builder )

Source: https://threejs.org/docs/pages/ChromaticAberrationNode.html

Sets up the effect's TSL code using the provided node builder.

```APIDOC
## Method: .setup( builder : NodeBuilder ) : ShaderCallNodeInternal

### Description
This method is used to setup the effect's TSL code.

### Parameters
- **builder** (NodeBuilder) - The current node builder.

### Returns
- **ShaderCallNodeInternal** - The internal shader call node.

### Overrides
[TempNode#setup](TempNode.html#setup)
```

--------------------------------

### .setupLightMap( builder : NodeBuilder ) : BasicLightMapNode.<vec3>

Source: https://threejs.org/docs/pages/MeshBasicNodeMaterial.html

Sets up the light map node for the material.

```APIDOC
## .setupLightMap( builder : NodeBuilder ) : BasicLightMapNode.<vec3>

### Description
This method must be overwritten since light maps are evaluated with a special scaling factor for basic materials.

### Method
`setupLightMap( builder )`

### Parameters
- **builder** (NodeBuilder) - Required - The current node builder.

### Returns
- **BasicLightMapNode.<vec3>** - The light map node.
```

--------------------------------

### .algorithm : string

Source: https://threejs.org/docs/pages/AnaglyphPassNode.html

Gets or sets the anaglyph algorithm.

```APIDOC
## Property

### .algorithm : string

Gets the current anaglyph algorithm.

### .algorithm : string

Sets the anaglyph algorithm.
```

--------------------------------

### Create LineSegments2 with geometry and material

Source: https://threejs.org/docs/pages/LineSegments2.html

Shows how to create a LineSegments2 instance using LineSegmentsGeometry and LineMaterial. The material uses linewidth 5 and vertexColors true. Note the example has a syntax error: the material object is closed with '}' instead of '}'. This snippet is from the 'Code Example' section.

```javascript
const geometry = new LineSegmentsGeometry();
geometry.setPositions( positions );
geometry.setColors( colors );
const material = new LineMaterial( { linewidth: 5, vertexColors: true } };
const lineSegments = new LineSegments2( geometry, material );
scene.add( lineSegments );
```

--------------------------------

### LightsNode.setupLights(builder, lightNodes)

Source: https://threejs.org/docs/pages/LightsNode.html

Setups the internal lights by building all respective light nodes.

```APIDOC
## Method: setupLights(builder, lightNodes)

### Description
Setups the internal lights by building all respective light nodes.

### Parameters
- **builder** (NodeBuilder) - Required - A reference to the current node builder.
- **lightNodes** (Array.<LightingNode>) - Required - An array of lighting nodes.

### Returns
None.
```

--------------------------------

### .itemStart(url)

Source: https://threejs.org/docs/pages/LoadingManager.html

Called by loaders when they start loading an item.

```APIDOC
## .itemStart(url)

### Description
This should be called by any loader using the manager when the loader starts loading an item.

### Method
`itemStart( url : string )`

### Parameters
- **url** (string) - Required - The URL to load.
```

--------------------------------

### .zeroSlopeAtStart

Source: https://threejs.org/docs/pages/AnimationAction.html

Property that enables smooth interpolation at the start of the animation.

```APIDOC
## .zeroSlopeAtStart : boolean

### Description
Enables smooth interpolation without separate clips for start, loop and end. Default is `true`.
```

--------------------------------

### .init( renderer : Renderer ) : Promise (async)

Source: https://threejs.org/docs/pages/Backend.html

Initializes the backend so it is ready for usage. Concrete backends are supposed to implement their rendering context creation and related operations in this method.

```APIDOC
## .init( renderer : Renderer ) : Promise (async)

### Description
Initializes the backend so it is ready for usage. Concrete backends are supposed to implement their rendering context creation and related operations in this method.

### Parameters
- **renderer** (Renderer) - Required - The renderer.

### Returns
- **Promise** - A Promise that resolves when the backend has been initialized.
```

--------------------------------

### Import SSAARenderPass

Source: https://threejs.org/docs/pages/SSAARenderPass.html

Imports the SSAARenderPass addon from the three.js examples.

```javascript
import { SSAARenderPass } from 'three/addons/postprocessing/SSAARenderPass.js';
```

--------------------------------

### RectAreaLightUniformsLib.init()

Source: https://threejs.org/docs/pages/RectAreaLightUniformsLib.html

Static method to initialize the uniform library for rect area lights.

```APIDOC
## RectAreaLightUniformsLib.init()

### Description
Initializes the internal uniform library required for using RectAreaLight with WebGLRenderer. This must be called before rect area lights can be used.

### Method
init()

### Parameters
None

### Return Value
None

### Example
```js
RectAreaLightUniformsLib.init();
```
```

--------------------------------

### .setupLightingModel() : ShadowMaskModel

Source: https://threejs.org/docs/pages/ShadowNodeMaterial.html

Sets up the lighting model for the shadow material and returns the lighting model.

```APIDOC
## Method: .setupLightingModel() : ShadowMaskModel

### Description
Setups the lighting model.

### Returns
- **ShadowMaskModel** - The lighting model.

### Overrides
[NodeMaterial#setupLightingModel](NodeMaterial.html#setupLightingModel)
```

--------------------------------

### getPolarAngle() : number

Source: https://threejs.org/docs/pages/OrbitControls.html

Get the current vertical rotation, in radians.

```APIDOC
## getPolarAngle() : number

### Description
Get the current vertical rotation, in radians.

### Parameters
None.

### Returns
- **number** - The current vertical rotation, in radians.
```

--------------------------------

### LightsNode.setupDirectLight(builder, lightNode, lightData)

Source: https://threejs.org/docs/pages/LightsNode.html

Sets up a direct light in the lighting model.

```APIDOC
## Method: setupDirectLight(builder, lightNode, lightData)

### Description
Sets up a direct light in the lighting model.

### Parameters
- **builder** (Object) - Required - The builder object containing the context and stack.
- **lightNode** (Object) - Required - The light node.
- **lightData** (Object) - Required - The light object containing color and direction properties.

### Returns
None.
```

--------------------------------

### getAzimuthalAngle() : number

Source: https://threejs.org/docs/pages/OrbitControls.html

Get the current horizontal rotation, in radians.

```APIDOC
## getAzimuthalAngle() : number

### Description
Get the current horizontal rotation, in radians.

### Parameters
None.

### Returns
- **number** - The current horizontal rotation, in radians.
```

--------------------------------

### .getLayers() : Layers

Source: https://threejs.org/docs/pages/PassNode.html

Gets the current layer configuration of the pass.

```APIDOC
## .getLayers() : Layers

### Description
Gets the current layer configuration of the pass.

### Returns
Layers - The current layer configuration.
```

--------------------------------

### .setupEnvironment( builder : NodeBuilder ) : EnvironmentNode.<vec3>

Source: https://threejs.org/docs/pages/MeshStandardNodeMaterial.html

Sets up the environment node for PBR environment mapping.

```APIDOC
## .setupEnvironment( builder : NodeBuilder ) : EnvironmentNode.<vec3>

### Description
Overwritten since this type of material uses [EnvironmentNode](EnvironmentNode.html) to implement the PBR (PMREM based) environment mapping. Besides, the method honors `Scene.environment`.

### Parameters
- **builder** (NodeBuilder) - Required - The current node builder.

### Returns
- **EnvironmentNode.<vec3>** - The environment node.

**Overrides:** [NodeMaterial#setupEnvironment](NodeMaterial.html#setupEnvironment)

```

--------------------------------

### getResolutionScale() : number

Source: https://threejs.org/docs/pages/BloomNode.html

Gets the current resolution scale of the pass.

```APIDOC
## Method: getResolutionScale() : number

### Description
Gets the current resolution scale of the pass.

### Parameters
None.

### Returns
- **number** - The current resolution scale. A value of `1` means full resolution.
```

--------------------------------

### .init( builder : Builder )

Source: https://threejs.org/docs/pages/TileShadowNode.html

Initializes the tiled shadow node by creating lights, cameras, and shadow maps for each tile.

```APIDOC
## Method: .init( builder : Builder )

### Description
Initializes the tiled shadow node by creating lights, cameras, and shadow maps for each tile.

### Parameters
- **builder** (Builder) - Required - The builder used to create render targets and other resources.

### Returns
No return value.
```
Tokens:
Raw