Skip to content

Commit e85c66a

Browse files
committed
Added jsdocs comments to WebGL utils
1 parent d2da10c commit e85c66a

1 file changed

Lines changed: 21 additions & 18 deletions

File tree

src/renderer/webgl/Utils.js

Lines changed: 21 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -12,15 +12,15 @@
1212
module.exports = {
1313

1414
/**
15-
* [pending]
15+
* Packs four floats on a range from 0.0 to 1.0 into a single Uint32
1616
*
1717
* @function Phaser.Renderer.WebGL.Utils.getTintFromFloats
1818
* @since 3.0.0
1919
*
20-
* @param {number} r - [pending] - what's the range?
20+
* @param {number} r - Red component in a range from 0.0 to 1.0
2121
* @param {number} g - [description]
2222
* @param {number} b - [description]
23-
* @param {number} a - [pending] - what's the range?
23+
* @param {number} a - Alpha component in a range from 0.0 to 1.0
2424
*
2525
* @return {number} [description]
2626
*/
@@ -35,15 +35,16 @@ module.exports = {
3535
},
3636

3737
/**
38-
* [pending]
38+
* Packs a Uint24, representing RGB components, with a Float32, representing
39+
* the alpha component, with a range between 0.0 and 1.0 and return a Uint32
3940
*
4041
* @function Phaser.Renderer.WebGL.Utils.getTintAppendFloatAlpha
4142
* @since 3.0.0
4243
*
43-
* @param {number} rgb - [pending] - what's the range?
44-
* @param {number} a - [pending] - what's the range?
44+
* @param {number} rgb - Uint24 representing RGB components
45+
* @param {number} a - Float32 representing Alpha component
4546
*
46-
* @return {number} [pending]
47+
* @return {number} Packed RGBA as Uint32
4748
*/
4849
getTintAppendFloatAlpha: function (rgb, a)
4950
{
@@ -52,15 +53,17 @@ module.exports = {
5253
},
5354

5455
/**
55-
* [pending]
56+
* Packs a Uint24, representing RGB components, with a Float32, representing
57+
* the alpha component, with a range between 0.0 and 1.0 and return a
58+
* swizzled Uint32
5659
*
5760
* @function Phaser.Renderer.WebGL.Utils.getTintAppendFloatAlphaAndSwap
5861
* @since 3.0.0
5962
*
60-
* @param {number} rgb - [pending] - what's the range?
61-
* @param {number} a - [pending] - what's the range?
63+
* @param {number} rgb - Uint24 representing RGB components
64+
* @param {number} a - Float32 representing Alpha component
6265
*
63-
* @return {number} [pending]
66+
* @return {number} Packed RGBA as Uint32
6467
*/
6568
getTintAppendFloatAlphaAndSwap: function (rgb, a)
6669
{
@@ -73,14 +76,14 @@ module.exports = {
7376
},
7477

7578
/**
76-
* [pending]
79+
* Unpacks a Uint24 RGB into an array of floats of ranges of 0.0 and 1.0
7780
*
7881
* @function Phaser.Renderer.WebGL.Utils.getFloatsFromUintRGB
7982
* @since 3.0.0
8083
*
81-
* @param {number} rgb - [pending]
84+
* @param {number} rgb - RGB packed as a Uint24
8285
*
83-
* @return {number} [pending]
86+
* @return {array} Array of floats representing each component as a float
8487
*/
8588
getFloatsFromUintRGB: function (rgb)
8689
{
@@ -92,15 +95,15 @@ module.exports = {
9295
},
9396

9497
/**
95-
* [pending]
98+
* Counts how many attributes of 32 bits a vertex has
9699
*
97100
* @function Phaser.Renderer.WebGL.Utils.getComponentCount
98101
* @since 3.0.0
99102
*
100-
* @param {number} attributes - [pending]
101-
* @param {WebGLRenderingContext} glContext - [pending]
103+
* @param {array} attributes - Array of attributes
104+
* @param {WebGLRenderingContext} glContext - WebGLContext used for check types
102105
*
103-
* @return {number} [pending]
106+
* @return {number} Count of 32 bit attributes in vertex
104107
*/
105108
getComponentCount: function (attributes, glContext)
106109
{

0 commit comments

Comments
 (0)