Skip to content

Commit 9661cea

Browse files
authored
Docs: More JSDoc. (#30733)
1 parent 44b01db commit 9661cea

Some content is hidden

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

54 files changed

+462
-211
lines changed

examples/jsm/shaders/ACESFilmicToneMappingShader.js

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,15 @@
1+
/** @module ACESFilmicToneMappingShader */
2+
13
/**
2-
* ACES Filmic Tone Mapping Shader by Stephen Hill
3-
* source: https://github.com/selfshadow/ltc_code/blob/master/webgl/shaders/ltc/ltc_blit.fs
4+
* ACES Filmic Tone Mapping Shader by Stephen Hill.
5+
* Reference: [ltc_blit.fs]{@link https://github.com/selfshadow/ltc_code/blob/master/webgl/shaders/ltc/ltc_blit.fs}
6+
*
7+
* This implementation of ACES is modified to accommodate a brighter viewing environment.
8+
* The scale factor of 1/0.6 is subjective. See discussion in #19621.
49
*
5-
* this implementation of ACES is modified to accommodate a brighter viewing environment.
6-
* the scale factor of 1/0.6 is subjective. see discussion in #19621.
10+
* @constant
11+
* @type {Object}
712
*/
8-
913
const ACESFilmicToneMappingShader = {
1014

1115
name: 'ACESFilmicToneMappingShader',

examples/jsm/shaders/AfterimageShader.js

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
1+
/** @module AfterimageShader */
2+
13
/**
2-
* Afterimage shader
3-
* I created this effect inspired by a demo on codepen:
4-
* https://codepen.io/brunoimbrizi/pen/MoRJaN?page=1&
4+
* Inspired by [Three.js FBO motion trails]{@link https://codepen.io/brunoimbrizi/pen/MoRJaN?page=1&}.
5+
*
6+
* @constant
7+
* @type {Object}
58
*/
6-
79
const AfterimageShader = {
810

911
name: 'AfterimageShader',

examples/jsm/shaders/BasicShader.js

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,11 @@
1+
/** @module BasicShader */
2+
13
/**
2-
* Simple test shader
4+
* Simple shader for testing.
5+
*
6+
* @constant
7+
* @type {Object}
38
*/
4-
59
const BasicShader = {
610

711
name: 'BasicShader',

examples/jsm/shaders/BleachBypassShader.js

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,13 @@
1+
2+
/** @module BleachBypassShader */
3+
14
/**
2-
* Bleach bypass shader [http://en.wikipedia.org/wiki/Bleach_bypass]
3-
* - based on Nvidia example
4-
* http://developer.download.nvidia.com/shaderlibrary/webpages/shader_library.html#post_bleach_bypass
5+
* Bleach bypass shader [http://en.wikipedia.org/wiki/Bleach_bypass] based on
6+
* [Nvidia Shader library]{@link http://developer.download.nvidia.com/shaderlibrary/webpages/shader_library.html#post_bleach_bypass}.
7+
*
8+
* @constant
9+
* @type {Object}
510
*/
6-
711
const BleachBypassShader = {
812

913
name: 'BleachBypassShader',

examples/jsm/shaders/BlendShader.js

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,11 @@
1+
/** @module BlendShader */
2+
13
/**
2-
* Blend two textures
4+
* Blends two textures.
5+
*
6+
* @constant
7+
* @type {Object}
38
*/
4-
59
const BlendShader = {
610

711
name: 'BlendShader',

examples/jsm/shaders/BokehShader.js

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,12 @@
1+
/** @module BokehShader */
2+
13
/**
2-
* Depth-of-field shader with bokeh
3-
* ported from GLSL shader by Martins Upitis
4-
* http://artmartinsh.blogspot.com/2010/02/glsl-lens-blur-filter-with-bokeh.html
4+
* Depth-of-field shader with bokeh ported from
5+
* [GLSL shader by Martins Upitis]{@link http://artmartinsh.blogspot.com/2010/02/glsl-lens-blur-filter-with-bokeh.html}.
6+
*
7+
* @constant
8+
* @type {Object}
59
*/
6-
710
const BokehShader = {
811

912
name: 'BokehShader',

examples/jsm/shaders/BokehShader2.js

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,16 @@ import {
22
Vector2
33
} from 'three';
44

5+
/** @module BokehShader2 */
6+
57
/**
6-
* Depth-of-field shader with bokeh
7-
* ported from GLSL shader by Martins Upitis
8-
* http://blenderartists.org/forum/showthread.php?237488-GLSL-depth-of-field-with-bokeh-v2-4-(update)
8+
* Depth-of-field shader with bokeh ported from
9+
* [GLSL shader by Martins Upitis]{@link http://blenderartists.org/forum/showthread.php?237488-GLSL-depth-of-field-with-bokeh-v2-4-(update)}.
910
*
1011
* Requires #define RINGS and SAMPLES integers
12+
*
13+
* @constant
14+
* @type {Object}
1115
*/
1216
const BokehShader = {
1317

examples/jsm/shaders/BrightnessContrastShader.js

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,13 @@
1+
/** @module BrightnessContrastShader */
2+
13
/**
2-
* Brightness and contrast adjustment
3-
* https://github.com/evanw/glfx.js
4-
* brightness: -1 to 1 (-1 is solid black, 0 is no change, and 1 is solid white)
5-
* contrast: -1 to 1 (-1 is solid gray, 0 is no change, and 1 is maximum contrast)
4+
* Brightness and contrast adjustment {@link https://github.com/evanw/glfx.js}.
5+
* Brightness: -1 to 1 (-1 is solid black, 0 is no change, and 1 is solid white)
6+
* Contrast: -1 to 1 (-1 is solid gray, 0 is no change, and 1 is maximum contrast)
7+
*
8+
* @constant
9+
* @type {Object}
610
*/
7-
811
const BrightnessContrastShader = {
912

1013
name: 'BrightnessContrastShader',

examples/jsm/shaders/ColorCorrectionShader.js

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,14 @@ import {
22
Vector3
33
} from 'three';
44

5+
/** @module ColorCorrectionShader */
6+
57
/**
6-
* Color correction
8+
* Color correction shader.
9+
*
10+
* @constant
11+
* @type {Object}
712
*/
8-
913
const ColorCorrectionShader = {
1014

1115
name: 'ColorCorrectionShader',

examples/jsm/shaders/ColorifyShader.js

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,14 @@ import {
22
Color
33
} from 'three';
44

5+
/** @module ColorifyShader */
6+
57
/**
6-
* Colorify shader
8+
* Colorify shader.
9+
*
10+
* @constant
11+
* @type {Object}
712
*/
8-
913
const ColorifyShader = {
1014

1115
name: 'ColorifyShader',

0 commit comments

Comments
 (0)