Skip to content

Commit 741d1f5

Browse files
photonstormphotonstorm
committed
Doc pending tags
1 parent 8bdeb69 commit 741d1f5

8 files changed

Lines changed: 274 additions & 272 deletions

File tree

‎src/renderer/webgl/Utils.js‎

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

1414
/**
15-
* [description]
15+
* [pending]
1616
*
1717
* @function Phaser.Renderer.WebGL.Utils.getTintFromFloats
1818
* @since 3.0.0
1919
*
20-
* @param {number} r - [description]
20+
* @param {number} r - [pending] - what's the range?
2121
* @param {number} g - [description]
2222
* @param {number} b - [description]
23-
* @param {number} a - [description]
23+
* @param {number} a - [pending] - what's the range?
2424
*
2525
* @return {number} [description]
2626
*/
@@ -35,15 +35,15 @@ module.exports = {
3535
},
3636

3737
/**
38-
* [description]
38+
* [pending]
3939
*
4040
* @function Phaser.Renderer.WebGL.Utils.getTintAppendFloatAlpha
4141
* @since 3.0.0
4242
*
43-
* @param {number} rgb - [description]
44-
* @param {number} a - [description]
43+
* @param {number} rgb - [pending] - what's the range?
44+
* @param {number} a - [pending] - what's the range?
4545
*
46-
* @return {number} [description]
46+
* @return {number} [pending]
4747
*/
4848
getTintAppendFloatAlpha: function (rgb, a)
4949
{
@@ -52,15 +52,15 @@ module.exports = {
5252
},
5353

5454
/**
55-
* [description]
55+
* [pending]
5656
*
5757
* @function Phaser.Renderer.WebGL.Utils.getTintAppendFloatAlphaAndSwap
5858
* @since 3.0.0
5959
*
60-
* @param {number} rgb - [description]
61-
* @param {number} a - [description]
60+
* @param {number} rgb - [pending] - what's the range?
61+
* @param {number} a - [pending] - what's the range?
6262
*
63-
* @return {number} [description]
63+
* @return {number} [pending]
6464
*/
6565
getTintAppendFloatAlphaAndSwap: function (rgb, a)
6666
{
@@ -73,14 +73,14 @@ module.exports = {
7373
},
7474

7575
/**
76-
* [description]
76+
* [pending]
7777
*
7878
* @function Phaser.Renderer.WebGL.Utils.getFloatsFromUintRGB
7979
* @since 3.0.0
8080
*
81-
* @param {number} rgb - [description]
81+
* @param {number} rgb - [pending]
8282
*
83-
* @return {number} [description]
83+
* @return {number} [pending]
8484
*/
8585
getFloatsFromUintRGB: function (rgb)
8686
{
@@ -92,15 +92,15 @@ module.exports = {
9292
},
9393

9494
/**
95-
* [description]
95+
* [pending]
9696
*
9797
* @function Phaser.Renderer.WebGL.Utils.getComponentCount
9898
* @since 3.0.0
9999
*
100-
* @param {number} attributes - [description]
101-
* @param {WebGLRenderingContext} glContext - [description]
100+
* @param {number} attributes - [pending]
101+
* @param {WebGLRenderingContext} glContext - [pending]
102102
*
103-
* @return {number} [description]
103+
* @return {number} [pending]
104104
*/
105105
getComponentCount: function (attributes, glContext)
106106
{

‎src/renderer/webgl/WebGLPipeline.js‎

Lines changed: 39 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ var Utils = require('./Utils');
1010

1111
/**
1212
* @classdesc
13-
* [description]
13+
* [pending] explain the concept behind the pipelines, what they are and how they work.
1414
*
1515
* @class WebGLPipeline
1616
* @memberOf Phaser.Renderer.WebGL
@@ -26,7 +26,7 @@ var WebGLPipeline = new Class({
2626
function WebGLPipeline (config)
2727
{
2828
/**
29-
* [description]
29+
* [pending]
3030
*
3131
* @name Phaser.Renderer.WebGL.WebGLPipeline#name
3232
* @type {string}
@@ -53,7 +53,7 @@ var WebGLPipeline = new Class({
5353
this.view = config.game.canvas;
5454

5555
/**
56-
* [description]
56+
* [pending]
5757
*
5858
* @name Phaser.Renderer.WebGL.WebGLPipeline#resolution
5959
* @type {number}
@@ -62,7 +62,7 @@ var WebGLPipeline = new Class({
6262
this.resolution = config.game.config.resolution;
6363

6464
/**
65-
* [description]
65+
* [pending]
6666
*
6767
* @name Phaser.Renderer.WebGL.WebGLPipeline#width
6868
* @type {number}
@@ -71,7 +71,7 @@ var WebGLPipeline = new Class({
7171
this.width = config.game.config.width * this.resolution;
7272

7373
/**
74-
* [description]
74+
* [pending]
7575
*
7676
* @name Phaser.Renderer.WebGL.WebGLPipeline#height
7777
* @type {number}
@@ -89,7 +89,7 @@ var WebGLPipeline = new Class({
8989
this.gl = config.gl;
9090

9191
/**
92-
* [description]
92+
* [pending]
9393
*
9494
* @name Phaser.Renderer.WebGL.WebGLPipeline#vertexCount
9595
* @type {number}
@@ -99,7 +99,7 @@ var WebGLPipeline = new Class({
9999
this.vertexCount = 0;
100100

101101
/**
102-
* [description]
102+
* [pending]
103103
*
104104
* @name Phaser.Renderer.WebGL.WebGLPipeline#vertexCapacity
105105
* @type {integer}
@@ -117,7 +117,7 @@ var WebGLPipeline = new Class({
117117
this.renderer = config.renderer;
118118

119119
/**
120-
* [description]
120+
* [pending]
121121
*
122122
* @name Phaser.Renderer.WebGL.WebGLPipeline#vertexData
123123
* @type {ArrayBuffer}
@@ -126,7 +126,7 @@ var WebGLPipeline = new Class({
126126
this.vertexData = (config.vertices ? config.vertices : new ArrayBuffer(config.vertexCapacity * config.vertexSize));
127127

128128
/**
129-
* [description]
129+
* [pending]
130130
*
131131
* @name Phaser.Renderer.WebGL.WebGLPipeline#vertexBuffer
132132
* @type {WebGLBuffer}
@@ -135,7 +135,7 @@ var WebGLPipeline = new Class({
135135
this.vertexBuffer = this.renderer.createVertexBuffer((config.vertices ? config.vertices : this.vertexData.byteLength), this.gl.STREAM_DRAW);
136136

137137
/**
138-
* [description]
138+
* [pending]
139139
*
140140
* @name Phaser.Renderer.WebGL.WebGLPipeline#program
141141
* @type {WebGLProgram}
@@ -144,7 +144,7 @@ var WebGLPipeline = new Class({
144144
this.program = this.renderer.createProgram(config.vertShader, config.fragShader);
145145

146146
/**
147-
* [description]
147+
* [pending]
148148
*
149149
* @name Phaser.Renderer.WebGL.WebGLPipeline#attributes
150150
* @type {object}
@@ -153,7 +153,7 @@ var WebGLPipeline = new Class({
153153
this.attributes = config.attributes;
154154

155155
/**
156-
* [description]
156+
* [pending]
157157
*
158158
* @name Phaser.Renderer.WebGL.WebGLPipeline#vertexSize
159159
* @type {integer}
@@ -162,7 +162,7 @@ var WebGLPipeline = new Class({
162162
this.vertexSize = config.vertexSize;
163163

164164
/**
165-
* [description]
165+
* [pending]
166166
*
167167
* @name Phaser.Renderer.WebGL.WebGLPipeline#topology
168168
* @type {integer}
@@ -171,7 +171,7 @@ var WebGLPipeline = new Class({
171171
this.topology = config.topology;
172172

173173
/**
174-
* [description]
174+
* [pending]
175175
*
176176
* @name Phaser.Renderer.WebGL.WebGLPipeline#bytes
177177
* @type {Uint8Array}
@@ -200,16 +200,16 @@ var WebGLPipeline = new Class({
200200
},
201201

202202
/**
203-
* [description]
203+
* [pending]
204204
*
205205
* @method Phaser.Renderer.WebGL.WebGLPipeline#addAttribute
206206
* @since 3.2.0
207207
*
208-
* @param {string} name - [description]
209-
* @param {integer} size - [description]
210-
* @param {integer} type - [description]
211-
* @param {boolean} normalized - [description]
212-
* @param {integer} offset - [description]
208+
* @param {string} name - [pending]
209+
* @param {integer} size - [pending]
210+
* @param {integer} type - [pending]
211+
* @param {boolean} normalized - [pending]
212+
* @param {integer} offset - [pending]
213213
*
214214
* @return {Phaser.Renderer.WebGL.WebGLPipeline} [description]
215215
*/
@@ -227,7 +227,7 @@ var WebGLPipeline = new Class({
227227
},
228228

229229
/**
230-
* [description]
230+
* [pending]
231231
*
232232
* @method Phaser.Renderer.WebGL.WebGLPipeline#shouldFlush
233233
* @since 3.0.0
@@ -240,7 +240,7 @@ var WebGLPipeline = new Class({
240240
},
241241

242242
/**
243-
* [description]
243+
* [pending]
244244
*
245245
* @method Phaser.Renderer.WebGL.WebGLPipeline#resize
246246
* @since 3.0.0
@@ -259,7 +259,7 @@ var WebGLPipeline = new Class({
259259
},
260260

261261
/**
262-
* [description]
262+
* [pending]
263263
*
264264
* @method Phaser.Renderer.WebGL.WebGLPipeline#bind
265265
* @since 3.0.0
@@ -357,7 +357,7 @@ var WebGLPipeline = new Class({
357357
},
358358

359359
/**
360-
* [description]
360+
* [pending]
361361
*
362362
* @method Phaser.Renderer.WebGL.WebGLPipeline#flush
363363
* @since 3.0.0
@@ -469,16 +469,16 @@ var WebGLPipeline = new Class({
469469
},
470470

471471
/**
472-
* [description]
472+
* [pending]
473473
*
474474
* @method Phaser.Renderer.WebGL.WebGLPipeline#setFloat4
475475
* @since 3.2.0
476476
*
477-
* @param {string} name - [description]
478-
* @param {float} x - [description]
479-
* @param {float} y - [description]
480-
* @param {float} z - [description]
481-
* @param {float} w - [description]
477+
* @param {string} name - [pending]
478+
* @param {float} x - [pending]
479+
* @param {float} y - [pending]
480+
* @param {float} z - [pending]
481+
* @param {float} w - [pending]
482482
*
483483
* @return {Phaser.Renderer.WebGL.WebGLPipeline} [description]
484484
*/
@@ -544,16 +544,16 @@ var WebGLPipeline = new Class({
544544
},
545545

546546
/**
547-
* [description]
547+
* [pending]
548548
*
549549
* @method Phaser.Renderer.WebGL.WebGLPipeline#setInt4
550550
* @since 3.2.0
551551
*
552-
* @param {string} name - [description]
553-
* @param {integer} x - [description]
554-
* @param {integer} y - [description]
555-
* @param {integer} z - [description]
556-
* @param {integer} w - [description]
552+
* @param {string} name - [pending]
553+
* @param {integer} x - [pending]
554+
* @param {integer} y - [pending]
555+
* @param {integer} z - [pending]
556+
* @param {integer} w - [pending]
557557
*
558558
* @return {Phaser.Renderer.WebGL.WebGLPipeline} [description]
559559
*/
@@ -605,9 +605,9 @@ var WebGLPipeline = new Class({
605605
* @method Phaser.Renderer.WebGL.WebGLPipeline#setMatrix4
606606
* @since 3.2.0
607607
*
608-
* @param {string} name - [description]
609-
* @param {boolean} transpose - [description]
610-
* @param {Float32Array} matrix - [description]
608+
* @param {string} name - [pending]
609+
* @param {boolean} transpose - [pending]
610+
* @param {Float32Array} matrix - [pending]
611611
*
612612
* @return {Phaser.Renderer.WebGL.WebGLPipeline} [description]
613613
*/

0 commit comments

Comments
 (0)