Skip to content

Commit a65b407

Browse files
authored
JSDoc: Add @tsl tag. (#30453)
1 parent 823833f commit a65b407

File tree

151 files changed

+546
-63
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

151 files changed

+546
-63
lines changed

examples/jsm/tsl/display/AfterImageNode.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -232,6 +232,7 @@ class AfterImageNode extends TempNode {
232232
/**
233233
* TSL function for creating an after image node for post processing.
234234
*
235+
* @tsl
235236
* @function
236237
* @param {Node<vec4>} node - The node that represents the input of the effect.
237238
* @param {Number} [damp=0.96] - The damping intensity. A higher value means a stronger after image effect.

examples/jsm/tsl/display/AnaglyphPassNode.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,7 @@ export default AnaglyphPassNode;
9797
/**
9898
* TSL function for creating an anaglyph pass node.
9999
*
100+
* @tsl
100101
* @function
101102
* @param {Scene} scene - The scene to render.
102103
* @param {Camera} camera - The camera to render the scene with.

examples/jsm/tsl/display/AnamorphicNode.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -244,6 +244,7 @@ class AnamorphicNode extends TempNode {
244244
/**
245245
* TSL function for creating an anamorphic flare effect.
246246
*
247+
* @tsl
247248
* @function
248249
* @param {TextureNode} node - The node that represents the input of the effect.
249250
* @param {Node<float> | Number} [threshold=0.9] - The threshold is one option to control the intensity and size of the effect.

examples/jsm/tsl/display/BleachBypass.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ import { float, Fn, vec3, vec4, min, max, mix, luminance } from 'three/tsl';
33
/**
44
* Applies a bleach bypass effect to the given color node.
55
*
6+
* @tsl
67
* @function
78
* @param {Node<vec4>} color - The color node to apply the sepia for.
89
* @param {Node<float>} [opacity=1] - Influences how strong the effect is blended with the original color.

examples/jsm/tsl/display/BloomNode.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -505,6 +505,7 @@ class BloomNode extends TempNode {
505505
/**
506506
* TSL function for creating a bloom effect.
507507
*
508+
* @tsl
508509
* @function
509510
* @param {Node<vec4>} node - The node that represents the input of the effect.
510511
* @param {Number} [strength=1] - The strength of the bloom.

examples/jsm/tsl/display/DenoiseNode.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -321,6 +321,7 @@ function generateDefaultNoise( size = 64 ) {
321321
/**
322322
* TSL function for creating a denoise effect.
323323
*
324+
* @tsl
324325
* @function
325326
* @param {Node} node - The node that represents the input of the effect (e.g. AO).
326327
* @param {Node<float>} depthNode - A node that represents the scene's depth.

examples/jsm/tsl/display/DepthOfFieldNode.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -185,6 +185,7 @@ export default DepthOfFieldNode;
185185
/**
186186
* TSL function for creating a depth-of-field effect (DOF) for post processing.
187187
*
188+
* @tsl
188189
* @function
189190
* @param {Node<vec4>} node - The node that represents the input of the effect.
190191
* @param {Node<float>} viewZNode - Represents the viewZ depth values of the scene.

examples/jsm/tsl/display/DotScreenNode.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,7 @@ export default DotScreenNode;
9393
/**
9494
* TSL function for creating a dot-screen node for post processing.
9595
*
96+
* @tsl
9697
* @function
9798
* @param {Node<vec4>} node - The node that represents the input of the effect.
9899
* @param {Number} [angle=1.57] - The rotation of the effect in radians.

examples/jsm/tsl/display/FXAANode.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -356,6 +356,7 @@ export default FXAANode;
356356
/**
357357
* TSL function for creating a FXAA node for anti-aliasing via post processing.
358358
*
359+
* @tsl
359360
* @function
360361
* @param {Node<vec4>} node - The node that represents the input of the effect.
361362
* @returns {FXAANode}

examples/jsm/tsl/display/FilmNode.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,7 @@ export default FilmNode;
8888
/**
8989
* TSL function for creating a film node for post processing.
9090
*
91+
* @tsl
9192
* @function
9293
* @param {Node<vec4>} inputNode - The node that represents the input of the effect.
9394
* @param {Node<float>?} [intensityNode=null] - A node that represents the effect's intensity.

0 commit comments

Comments
 (0)