Mirrors/phaser
2
0
Fork 0
mirror of https://github.com/photonstorm/phaser synced 2024-11-24 05:33:35 +00:00
Code Issues Projects Releases Packages Wiki Activity

Doc pending tags

Browse source
This commit is contained in:
Richard Davey 2018-04-24 15:32:08 +01:00
parent 8bdeb69716
commit 741d1f5793
8 changed files with 273 additions and 271 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

36
src/renderer/webgl/Utils.js
View file

@ -12,15 +12,15 @@
module.exports = {
/**
* [description]
* [pending]
*
* @function Phaser.Renderer.WebGL.Utils.getTintFromFloats
* @since 3.0.0
*
* @param {number} r - [description]
* @param {number} r - [pending] - what's the range?
* @param {number} g - [description]
* @param {number} b - [description]
* @param {number} a - [description]
* @param {number} a - [pending] - what's the range?
*
* @return {number} [description]
*/
@ -35,15 +35,15 @@ module.exports = {
},
/**
* [description]
* [pending]
*
* @function Phaser.Renderer.WebGL.Utils.getTintAppendFloatAlpha
* @since 3.0.0
*
* @param {number} rgb - [description]
* @param {number} a - [description]
* @param {number} rgb - [pending] - what's the range?
* @param {number} a - [pending] - what's the range?
*
* @return {number} [description]
* @return {number} [pending]
*/
getTintAppendFloatAlpha: function (rgb, a)
{
@ -52,15 +52,15 @@ module.exports = {
},
/**
* [description]
* [pending]
*
* @function Phaser.Renderer.WebGL.Utils.getTintAppendFloatAlphaAndSwap
* @since 3.0.0
*
* @param {number} rgb - [description]
* @param {number} a - [description]
* @param {number} rgb - [pending] - what's the range?
* @param {number} a - [pending] - what's the range?
*
* @return {number} [description]
* @return {number} [pending]
*/
getTintAppendFloatAlphaAndSwap: function (rgb, a)
{
@ -73,14 +73,14 @@ module.exports = {
},
/**
* [description]
* [pending]
*
* @function Phaser.Renderer.WebGL.Utils.getFloatsFromUintRGB
* @since 3.0.0
*
* @param {number} rgb - [description]
* @param {number} rgb - [pending]
*
* @return {number} [description]
* @return {number} [pending]
*/
getFloatsFromUintRGB: function (rgb)
{
@ -92,15 +92,15 @@ module.exports = {
},
/**
* [description]
* [pending]
*
* @function Phaser.Renderer.WebGL.Utils.getComponentCount
* @since 3.0.0
*
* @param {number} attributes - [description]
* @param {WebGLRenderingContext} glContext - [description]
* @param {number} attributes - [pending]
* @param {WebGLRenderingContext} glContext - [pending]
*
* @return {number} [description]
* @return {number} [pending]
*/
getComponentCount: function (attributes, glContext)
{

78
src/renderer/webgl/WebGLPipeline.js
View file

@ -10,7 +10,7 @@ var Utils = require('./Utils');
/**
* @classdesc
* [description]
* [pending] explain the concept behind the pipelines, what they are and how they work.
*
* @class WebGLPipeline
* @memberOf Phaser.Renderer.WebGL
@ -26,7 +26,7 @@ var WebGLPipeline = new Class({
function WebGLPipeline (config)
{
/**
* [description]
* [pending]
*
* @name Phaser.Renderer.WebGL.WebGLPipeline#name
* @type {string}
@ -53,7 +53,7 @@ var WebGLPipeline = new Class({
this.view = config.game.canvas;
/**
* [description]
* [pending]
*
* @name Phaser.Renderer.WebGL.WebGLPipeline#resolution
* @type {number}
@ -62,7 +62,7 @@ var WebGLPipeline = new Class({
this.resolution = config.game.config.resolution;
/**
* [description]
* [pending]
*
* @name Phaser.Renderer.WebGL.WebGLPipeline#width
* @type {number}
@ -71,7 +71,7 @@ var WebGLPipeline = new Class({
this.width = config.game.config.width * this.resolution;
/**
* [description]
* [pending]
*
* @name Phaser.Renderer.WebGL.WebGLPipeline#height
* @type {number}
@ -89,7 +89,7 @@ var WebGLPipeline = new Class({
this.gl = config.gl;
/**
* [description]
* [pending]
*
* @name Phaser.Renderer.WebGL.WebGLPipeline#vertexCount
* @type {number}
@ -99,7 +99,7 @@ var WebGLPipeline = new Class({
this.vertexCount = 0;
/**
* [description]
* [pending]
*
* @name Phaser.Renderer.WebGL.WebGLPipeline#vertexCapacity
* @type {integer}
@ -117,7 +117,7 @@ var WebGLPipeline = new Class({
this.renderer = config.renderer;
/**
* [description]
* [pending]
*
* @name Phaser.Renderer.WebGL.WebGLPipeline#vertexData
* @type {ArrayBuffer}
@ -126,7 +126,7 @@ var WebGLPipeline = new Class({
this.vertexData = (config.vertices ? config.vertices : new ArrayBuffer(config.vertexCapacity * config.vertexSize));
/**
* [description]
* [pending]
*
* @name Phaser.Renderer.WebGL.WebGLPipeline#vertexBuffer
* @type {WebGLBuffer}
@ -135,7 +135,7 @@ var WebGLPipeline = new Class({
this.vertexBuffer = this.renderer.createVertexBuffer((config.vertices ? config.vertices : this.vertexData.byteLength), this.gl.STREAM_DRAW);
/**
* [description]
* [pending]
*
* @name Phaser.Renderer.WebGL.WebGLPipeline#program
* @type {WebGLProgram}
@ -144,7 +144,7 @@ var WebGLPipeline = new Class({
this.program = this.renderer.createProgram(config.vertShader, config.fragShader);
/**
* [description]
* [pending]
*
* @name Phaser.Renderer.WebGL.WebGLPipeline#attributes
* @type {object}
@ -153,7 +153,7 @@ var WebGLPipeline = new Class({
this.attributes = config.attributes;
/**
* [description]
* [pending]
*
* @name Phaser.Renderer.WebGL.WebGLPipeline#vertexSize
* @type {integer}
@ -162,7 +162,7 @@ var WebGLPipeline = new Class({
this.vertexSize = config.vertexSize;
/**
* [description]
* [pending]
*
* @name Phaser.Renderer.WebGL.WebGLPipeline#topology
* @type {integer}
@ -171,7 +171,7 @@ var WebGLPipeline = new Class({
this.topology = config.topology;
/**
* [description]
* [pending]
*
* @name Phaser.Renderer.WebGL.WebGLPipeline#bytes
* @type {Uint8Array}
@ -200,16 +200,16 @@ var WebGLPipeline = new Class({
},
/**
* [description]
* [pending]
*
* @method Phaser.Renderer.WebGL.WebGLPipeline#addAttribute
* @since 3.2.0
*
* @param {string} name - [description]
* @param {integer} size - [description]
* @param {integer} type - [description]
* @param {boolean} normalized - [description]
* @param {integer} offset - [description]
* @param {string} name - [pending]
* @param {integer} size - [pending]
* @param {integer} type - [pending]
* @param {boolean} normalized - [pending]
* @param {integer} offset - [pending]
*
* @return {Phaser.Renderer.WebGL.WebGLPipeline} [description]
*/
@ -227,7 +227,7 @@ var WebGLPipeline = new Class({
},
/**
* [description]
* [pending]
*
* @method Phaser.Renderer.WebGL.WebGLPipeline#shouldFlush
* @since 3.0.0
@ -240,7 +240,7 @@ var WebGLPipeline = new Class({
},
/**
* [description]
* [pending]
*
* @method Phaser.Renderer.WebGL.WebGLPipeline#resize
* @since 3.0.0
@ -259,7 +259,7 @@ var WebGLPipeline = new Class({
},
/**
* [description]
* [pending]
*
* @method Phaser.Renderer.WebGL.WebGLPipeline#bind
* @since 3.0.0
@ -357,7 +357,7 @@ var WebGLPipeline = new Class({
},
/**
* [description]
* [pending]
*
* @method Phaser.Renderer.WebGL.WebGLPipeline#flush
* @since 3.0.0
@ -469,16 +469,16 @@ var WebGLPipeline = new Class({
},
/**
* [description]
* [pending]
*
* @method Phaser.Renderer.WebGL.WebGLPipeline#setFloat4
* @since 3.2.0
*
* @param {string} name - [description]
* @param {float} x - [description]
* @param {float} y - [description]
* @param {float} z - [description]
* @param {float} w - [description]
* @param {string} name - [pending]
* @param {float} x - [pending]
* @param {float} y - [pending]
* @param {float} z - [pending]
* @param {float} w - [pending]
*
* @return {Phaser.Renderer.WebGL.WebGLPipeline} [description]
*/
@ -544,16 +544,16 @@ var WebGLPipeline = new Class({
},
/**
* [description]
* [pending]
*
* @method Phaser.Renderer.WebGL.WebGLPipeline#setInt4
* @since 3.2.0
*
* @param {string} name - [description]
* @param {integer} x - [description]
* @param {integer} y - [description]
* @param {integer} z - [description]
* @param {integer} w - [description]
* @param {string} name - [pending]
* @param {integer} x - [pending]
* @param {integer} y - [pending]
* @param {integer} z - [pending]
* @param {integer} w - [pending]
*
* @return {Phaser.Renderer.WebGL.WebGLPipeline} [description]
*/
@ -605,9 +605,9 @@ var WebGLPipeline = new Class({
* @method Phaser.Renderer.WebGL.WebGLPipeline#setMatrix4
* @since 3.2.0
*
* @param {string} name - [description]
* @param {boolean} transpose - [description]
* @param {Float32Array} matrix - [description]
* @param {string} name - [pending]
* @param {boolean} transpose - [pending]
* @param {Float32Array} matrix - [pending]
*
* @return {Phaser.Renderer.WebGL.WebGLPipeline} [description]
*/

202
src/renderer/webgl/WebGLRenderer.js
View file

@ -34,7 +34,7 @@ var TextureTintPipeline = require('./pipelines/TextureTintPipeline');
/**
* @classdesc
* [description]
* [pending] - explain the core concept and philosophy behind how the renderer works.
*
* @class WebGLRenderer
* @memberOf Phaser.Renderer.WebGL
@ -156,7 +156,7 @@ var WebGLRenderer = new Class({
this.blendModes = [];
/**
* [description]
* [pending]
*
* @name Phaser.Renderer.WebGL.WebGLRenderer#nativeTextures
* @type {array}
@ -176,7 +176,7 @@ var WebGLRenderer = new Class({
this.contextLost = false;
/**
* [description]
* [pending]
*
* @name Phaser.Renderer.WebGL.WebGLRenderer#pipelines
* @type {object}
@ -201,7 +201,7 @@ var WebGLRenderer = new Class({
// Internal Renderer State (Textures, Framebuffers, Pipelines, Buffers, etc)
/**
* [description]
* [pending]
*
* @name Phaser.Renderer.WebGL.WebGLRenderer#currentActiveTextureUnit
* @type {integer}
@ -210,7 +210,7 @@ var WebGLRenderer = new Class({
this.currentActiveTextureUnit = 0;
/**
* [description]
* [pending]
*
* @name Phaser.Renderer.WebGL.WebGLRenderer#currentTextures
* @type {array}
@ -219,7 +219,7 @@ var WebGLRenderer = new Class({
this.currentTextures = new Array(16);
/**
* [description]
* [pending]
*
* @name Phaser.Renderer.WebGL.WebGLRenderer#currentFramebuffer
* @type {WebGLFramebuffer}
@ -229,7 +229,7 @@ var WebGLRenderer = new Class({
this.currentFramebuffer = null;
/**
* [description]
* [pending]
*
* @name Phaser.Renderer.WebGL.WebGLRenderer#currentPipeline
* @type {Phaser.Renderer.WebGL.WebGLPipeline}
@ -239,7 +239,7 @@ var WebGLRenderer = new Class({
this.currentPipeline = null;
/**
* [description]
* [pending]
*
* @name Phaser.Renderer.WebGL.WebGLRenderer#currentProgram
* @type {WebGLProgram}
@ -249,7 +249,7 @@ var WebGLRenderer = new Class({
this.currentProgram = null;
/**
* [description]
* [pending]
*
* @name Phaser.Renderer.WebGL.WebGLRenderer#currentVertexBuffer
* @type {WebGLBuffer}
@ -259,7 +259,7 @@ var WebGLRenderer = new Class({
this.currentVertexBuffer = null;
/**
* [description]
* [pending]
*
* @name Phaser.Renderer.WebGL.WebGLRenderer#currentIndexBuffer
* @type {WebGLBuffer}
@ -269,7 +269,7 @@ var WebGLRenderer = new Class({
this.currentIndexBuffer = null;
/**
* [description]
* [pending]
*
* @name Phaser.Renderer.WebGL.WebGLRenderer#currentBlendMode
* @type {integer}
@ -278,7 +278,7 @@ var WebGLRenderer = new Class({
this.currentBlendMode = Infinity;
/**
* [description]
* [pending]
*
* @name Phaser.Renderer.WebGL.WebGLRenderer#currentScissorEnabled
* @type {boolean}
@ -288,7 +288,7 @@ var WebGLRenderer = new Class({
this.currentScissorEnabled = false;
/**
* [description]
* [pending]
*
* @name Phaser.Renderer.WebGL.WebGLRenderer#currentScissor
* @type {Uint32Array}
@ -297,7 +297,7 @@ var WebGLRenderer = new Class({
this.currentScissor = new Uint32Array([ 0, 0, this.width, this.height ]);
/**
* [description]
* [pending]
*
* @name Phaser.Renderer.WebGL.WebGLRenderer#currentScissorIdx
* @type {number}
@ -307,7 +307,7 @@ var WebGLRenderer = new Class({
this.currentScissorIdx = 0;
/**
* [description]
* [pending]
*
* @name Phaser.Renderer.WebGL.WebGLRenderer#scissorStack
* @type {Uint32Array}
@ -340,7 +340,7 @@ var WebGLRenderer = new Class({
}
}, false);
// This are initialized post context creation
// These are initialized post context creation
/**
* [description]
@ -353,7 +353,7 @@ var WebGLRenderer = new Class({
this.gl = null;
/**
* [description]
* [pending]
*
* @name Phaser.Renderer.WebGL.WebGLRenderer#supportedExtensions
* @type {object}
@ -363,7 +363,7 @@ var WebGLRenderer = new Class({
this.supportedExtensions = null;
/**
* [description]
* [pending]
*
* @name Phaser.Renderer.WebGL.WebGLRenderer#extensions
* @type {object}
@ -373,7 +373,7 @@ var WebGLRenderer = new Class({
this.extensions = {};
/**
* [description]
* [pending]
*
* @name Phaser.Renderer.WebGL.WebGLRenderer#glFormats
* @type {array}
@ -386,7 +386,7 @@ var WebGLRenderer = new Class({
},
/**
* [description]
* [pending]
*
* @method Phaser.Renderer.WebGL.WebGLRenderer#init
* @since 3.0.0
@ -533,12 +533,12 @@ var WebGLRenderer = new Class({
},
/**
* [description]
* [pending]
*
* @method Phaser.Renderer.WebGL.WebGLRenderer#hasExtension
* @since 3.0.0
*
* @param {string} extensionName - [description]
* @param {string} extensionName - [pending]
*
* @return {boolean} [description]
*/
@ -548,14 +548,14 @@ var WebGLRenderer = new Class({
},
/**
* [description]
* [pending]
*
* @method Phaser.Renderer.WebGL.WebGLRenderer#getExtension
* @since 3.0.0
*
* @param {string} extensionName - [description]
*
* @return {object} [description]
* @return {object} [pending]
*/
getExtension: function (extensionName)
{
@ -570,7 +570,7 @@ var WebGLRenderer = new Class({
},
/**
* [description]
* [pending]
*
* @method Phaser.Renderer.WebGL.WebGLRenderer#flush
* @since 3.0.0
@ -586,12 +586,12 @@ var WebGLRenderer = new Class({
/* Renderer State Manipulation Functions */
/**
* [description]
* [pending]
*
* @method Phaser.Renderer.WebGL.WebGLRenderer#hasPipeline
* @since 3.0.0
*
* @param {string} pipelineName - [description]
* @param {string} pipelineName - [pending]
*
* @return {boolean} [description]
*/
@ -601,7 +601,7 @@ var WebGLRenderer = new Class({
},
/**
* [description]
* [pending]
*
* @method Phaser.Renderer.WebGL.WebGLRenderer#getPipeline
* @since 3.0.0
@ -616,7 +616,7 @@ var WebGLRenderer = new Class({
},
/**
* [description]
* [pending]
*
* @method Phaser.Renderer.WebGL.WebGLRenderer#removePipeline
* @since 3.0.0
@ -633,15 +633,15 @@ var WebGLRenderer = new Class({
},
/**
* [description]
* [pending]
*
* @method Phaser.Renderer.WebGL.WebGLRenderer#addPipeline
* @since 3.0.0
*
* @param {string} pipelineName - [description]
* @param {Phaser.Renderer.WebGL.WebGLPipeline} pipelineInstance - [description]
* @param {Phaser.Renderer.WebGL.WebGLPipeline} pipelineInstance - [pending]
*
* @return {Phaser.Renderer.WebGL.WebGLPipeline} [description]
* @return {Phaser.Renderer.WebGL.WebGLPipeline} [pending]
*/
addPipeline: function (pipelineName, pipelineInstance)
{
@ -662,7 +662,7 @@ var WebGLRenderer = new Class({
},
/**
* [description]
* [pending]
*
* @method Phaser.Renderer.WebGL.WebGLRenderer#setScissor
* @since 3.0.0
@ -709,7 +709,7 @@ var WebGLRenderer = new Class({
},
/**
* [description]
* [pending] - what's the difference between addScissor and pushScissor?
*
* @method Phaser.Renderer.WebGL.WebGLRenderer#pushScissor
* @since 3.0.0
@ -739,7 +739,7 @@ var WebGLRenderer = new Class({
},
/**
* [description]
* [pending]
*
* @method Phaser.Renderer.WebGL.WebGLRenderer#popScissor
* @since 3.0.0
@ -763,7 +763,7 @@ var WebGLRenderer = new Class({
},
/**
* [description]
* [pending]
*
* @method Phaser.Renderer.WebGL.WebGLRenderer#setPipeline
* @since 3.0.0
@ -892,13 +892,13 @@ var WebGLRenderer = new Class({
},
/**
* [description]
* [pending]
*
* @method Phaser.Renderer.WebGL.WebGLRenderer#setTexture2D
* @since 3.0.0
*
* @param {WebGLTexture} texture - [description]
* @param {integer} textureUnit - [description]
* @param {WebGLTexture} texture - [pending]
* @param {integer} textureUnit - [pending]
*
* @return {Phaser.Renderer.WebGL.WebGLRenderer} This WebGL Renderer.
*/
@ -926,12 +926,12 @@ var WebGLRenderer = new Class({
},
/**
* [description]
* [pending]
*
* @method Phaser.Renderer.WebGL.WebGLRenderer#setFramebuffer
* @since 3.0.0
*
* @param {WebGLFramebuffer} framebuffer - [description]
* @param {WebGLFramebuffer} framebuffer - [pending]
*
* @return {Phaser.Renderer.WebGL.WebGLRenderer} This WebGL Renderer.
*/
@ -952,12 +952,12 @@ var WebGLRenderer = new Class({
},
/**
* [description]
* [pending]
*
* @method Phaser.Renderer.WebGL.WebGLRenderer#setProgram
* @since 3.0.0
*
* @param {WebGLProgram} program - [description]
* @param {WebGLProgram} program - [pending]
*
* @return {Phaser.Renderer.WebGL.WebGLRenderer} This WebGL Renderer.
*/
@ -978,12 +978,12 @@ var WebGLRenderer = new Class({
},
/**
* [description]
* [pending]
*
* @method Phaser.Renderer.WebGL.WebGLRenderer#setVertexBuffer
* @since 3.0.0
*
* @param {WebGLBuffer} vertexBuffer - [description]
* @param {WebGLBuffer} vertexBuffer - [pending]
*
* @return {Phaser.Renderer.WebGL.WebGLRenderer} This WebGL Renderer.
*/
@ -1004,12 +1004,12 @@ var WebGLRenderer = new Class({
},
/**
* [description]
* [pending]
*
* @method Phaser.Renderer.WebGL.WebGLRenderer#setIndexBuffer
* @since 3.0.0
*
* @param {WebGLBuffer} indexBuffer - [description]
* @param {WebGLBuffer} indexBuffer - [pending]
*
* @return {Phaser.Renderer.WebGL.WebGLRenderer} This WebGL Renderer.
*/
@ -1032,7 +1032,7 @@ var WebGLRenderer = new Class({
/* Renderer Resource Creation Functions */
/**
* [description]
* [pending]
*
* @method Phaser.Renderer.WebGL.WebGLRenderer#createTextureFromSource
* @since 3.0.0
@ -1081,23 +1081,23 @@ var WebGLRenderer = new Class({
},
/**
* [description]
* [pending]
*
* @method Phaser.Renderer.WebGL.WebGLRenderer#createTexture2D
* @since 3.0.0
*
* @param {integer} mipLevel - [description]
* @param {integer} minFilter - [description]
* @param {integer} magFilter - [description]
* @param {integer} wrapT - [description]
* @param {integer} wrapS - [description]
* @param {integer} format - [description]
* @param {object} pixels - [description]
* @param {integer} width - [description]
* @param {integer} height - [description]
* @param {boolean} pma - [description]
* @param {integer} mipLevel - [pending]
* @param {integer} minFilter - [pending]
* @param {integer} magFilter - [pending]
* @param {integer} wrapT - [pending]
* @param {integer} wrapS - [pending]
* @param {integer} format - [pending]
* @param {object} pixels - [pending]
* @param {integer} width - [pending]
* @param {integer} height - [pending]
* @param {boolean} pma - [pending]
*
* @return {WebGLTexture} [description]
* @return {WebGLTexture} [pending]
*/
createTexture2D: function (mipLevel, minFilter, magFilter, wrapT, wrapS, format, pixels, width, height, pma)
{
@ -1138,17 +1138,17 @@ var WebGLRenderer = new Class({
},
/**
* [description]
* [pending]
*
* @method Phaser.Renderer.WebGL.WebGLRenderer#createFramebuffer
* @since 3.0.0
*
* @param {integer} width - [description]
* @param {integer} height - [description]
* @param {WebGLFramebuffer} renderTexture - [description]
* @param {boolean} addDepthStencilBuffer - [description]
* @param {integer} width - [pending]
* @param {integer} height - [pending]
* @param {WebGLFramebuffer} renderTexture - [pending]
* @param {boolean} addDepthStencilBuffer - [pending]
*
* @return {WebGLFramebuffer} [description]
* @return {WebGLFramebuffer} [pending]
*/
createFramebuffer: function (width, height, renderTexture, addDepthStencilBuffer)
{
@ -1193,15 +1193,15 @@ var WebGLRenderer = new Class({
},
/**
* [description]
* [pending]
*
* @method Phaser.Renderer.WebGL.WebGLRenderer#createProgram
* @since 3.0.0
*
* @param {string} vertexShader - [description]
* @param {string} fragmentShader - [description]
* @param {string} vertexShader - [pending]
* @param {string} fragmentShader - [pending]
*
* @return {WebGLProgram} [description]
* @return {WebGLProgram} [pending]
*/
createProgram: function (vertexShader, fragmentShader)
{
@ -1237,15 +1237,15 @@ var WebGLRenderer = new Class({
},
/**
* [description]
* [pending]
*
* @method Phaser.Renderer.WebGL.WebGLRenderer#createVertexBuffer
* @since 3.0.0
*
* @param {ArrayBuffer} initialDataOrSize - [description]
* @param {integer} bufferUsage - [description]
* @param {ArrayBuffer} initialDataOrSize - [pending]
* @param {integer} bufferUsage - [pending]
*
* @return {WebGLBuffer} [description]
* @return {WebGLBuffer} [pending]
*/
createVertexBuffer: function (initialDataOrSize, bufferUsage)
{
@ -1262,15 +1262,15 @@ var WebGLRenderer = new Class({
},
/**
* [description]
* [pending]
*
* @method Phaser.Renderer.WebGL.WebGLRenderer#createIndexBuffer
* @since 3.0.0
*
* @param {ArrayBuffer} initialDataOrSize - [description]
* @param {integer} bufferUsage - [description]
* @param {ArrayBuffer} initialDataOrSize - [pending]
* @param {integer} bufferUsage - [pending]
*
* @return {WebGLBuffer} [description]
* @return {WebGLBuffer} [pending]
*/
createIndexBuffer: function (initialDataOrSize, bufferUsage)
{
@ -1311,7 +1311,7 @@ var WebGLRenderer = new Class({
},
/**
* [description]
* [pending]
*
* @method Phaser.Renderer.WebGL.WebGLRenderer#deleteFramebuffer
* @since 3.0.0
@ -1345,7 +1345,7 @@ var WebGLRenderer = new Class({
},
/**
* [description]
* [pending]
*
* @method Phaser.Renderer.WebGL.WebGLRenderer#deleteBuffer
* @since 3.0.0
@ -1364,7 +1364,7 @@ var WebGLRenderer = new Class({
/* Rendering Functions */
/**
* [description]
* [pending]
*
* @method Phaser.Renderer.WebGL.WebGLRenderer#preRenderCamera
* @since 3.0.0
@ -1401,7 +1401,7 @@ var WebGLRenderer = new Class({
},
/**
* [description]
* [pending]
*
* @method Phaser.Renderer.WebGL.WebGLRenderer#postRenderCamera
* @since 3.0.0
@ -1690,17 +1690,17 @@ var WebGLRenderer = new Class({
},
/**
* [description]
* [pending]
*
* @method Phaser.Renderer.WebGL.WebGLRenderer#setFloat4
* @since 3.0.0
*
* @param {WebGLProgram} program - [description]
* @param {string} name - [description]
* @param {float} x - [description]
* @param {float} y - [description]
* @param {float} z - [description]
* @param {float} w - [description]
* @param {WebGLProgram} program - [pending]
* @param {string} name - [pending]
* @param {float} x - [pending]
* @param {float} y - [pending]
* @param {float} z - [pending]
* @param {float} w - [pending]
*
* @return {Phaser.Renderer.WebGL.WebGLRenderer} [description]
*/
@ -1780,17 +1780,17 @@ var WebGLRenderer = new Class({
},
/**
* [description]
* [pending]
*
* @method Phaser.Renderer.WebGL.WebGLRenderer#setInt4
* @since 3.0.0
*
* @param {WebGLProgram} program - [description]
* @param {string} name - [description]
* @param {integer} x - [description]
* @param {integer} y - [description]
* @param {integer} z - [description]
* @param {integer} w - [description]
* @param {WebGLProgram} program - [pending]
* @param {string} name - [pending]
* @param {integer} x - [pending]
* @param {integer} y - [pending]
* @param {integer} z - [pending]
* @param {integer} w - [pending]
*
* @return {Phaser.Renderer.WebGL.WebGLRenderer} [description]
*/
@ -1848,15 +1848,15 @@ var WebGLRenderer = new Class({
},
/**
* [description]
* [pending]
*
* @method Phaser.Renderer.WebGL.WebGLRenderer#setMatrix4
* @since 3.0.0
*
* @param {WebGLProgram} program - [description]
* @param {string} name - [description]
* @param {boolean} transpose - [description]
* @param {Float32Array} matrix - [description]
* @param {WebGLProgram} program - [pending]
* @param {string} name - [pending]
* @param {boolean} transpose - [pending]
* @param {Float32Array} matrix - [pending]
*
* @return {Phaser.Renderer.WebGL.WebGLRenderer} [description]
*/

22
src/renderer/webgl/pipelines/BitmapMaskPipeline.js
View file

@ -12,7 +12,7 @@ var WebGLPipeline = require('../WebGLPipeline');
/**
* @classdesc
* [description]
* [pending] - explain the config object properties and what they control
*
* @class BitmapMaskPipeline
* @extends Phaser.Renderer.WebGL.WebGLPipeline
@ -20,7 +20,7 @@ var WebGLPipeline = require('../WebGLPipeline');
* @constructor
* @since 3.0.0
*
* @param {object} config - [description]
* @param {object} config - [pending]
*/
var BitmapMaskPipeline = new Class({
@ -58,7 +58,7 @@ var BitmapMaskPipeline = new Class({
});
/**
* [description]
* [pending]
*
* @name Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#vertexViewF32
* @type {Float32Array}
@ -67,7 +67,7 @@ var BitmapMaskPipeline = new Class({
this.vertexViewF32 = new Float32Array(this.vertexData);
/**
* [description]
* [pending]
*
* @name Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#maxQuads
* @type {number}
@ -77,7 +77,7 @@ var BitmapMaskPipeline = new Class({
this.maxQuads = 1;
/**
* [description]
* [pending]
*
* @name Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#resolutionDirty
* @type {boolean}
@ -88,7 +88,7 @@ var BitmapMaskPipeline = new Class({
},
/**
* [description]
* [pending]
*
* @method Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#onBind
* @since 3.0.0
@ -133,13 +133,13 @@ var BitmapMaskPipeline = new Class({
},
/**
* [description]
* [pending]
*
* @method Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#beginMask
* @since 3.0.0
*
* @param {Phaser.GameObjects.GameObject} mask - [description]
* @param {Phaser.GameObjects.GameObject} maskedObject - [description]
* @param {Phaser.GameObjects.GameObject} mask - [pending]
* @param {Phaser.GameObjects.GameObject} maskedObject - [pending]
* @param {Phaser.Cameras.Scene2D.Camera} camera - [description]
*/
beginMask: function (mask, maskedObject, camera)
@ -170,12 +170,12 @@ var BitmapMaskPipeline = new Class({
},
/**
* [description]
* [pending]
*
* @method Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#endMask
* @since 3.0.0
*
* @param {Phaser.GameObjects.GameObject} mask - [description]
* @param {Phaser.GameObjects.GameObject} mask - [pending]
*/
endMask: function (mask)
{

98
src/renderer/webgl/pipelines/FlatTintPipeline.js
View file

@ -37,7 +37,7 @@ var pathArray = [];
/**
* @classdesc
* [description]
* [pending] - explain what this pipeline handles and how the config object works.
*
* @class FlatTintPipeline
* @extends Phaser.Renderer.WebGL.WebGLPipeline
@ -91,7 +91,7 @@ var FlatTintPipeline = new Class({
});
/**
* [description]
* [pending]
*
* @name Phaser.Renderer.WebGL.Pipelines.FlatTintPipeline#vertexViewF32
* @type {Float32Array}
@ -100,7 +100,7 @@ var FlatTintPipeline = new Class({
this.vertexViewF32 = new Float32Array(this.vertexData);
/**
* [description]
* [pending]
*
* @name Phaser.Renderer.WebGL.Pipelines.FlatTintPipeline#vertexViewU32
* @type {Uint32Array}
@ -109,7 +109,7 @@ var FlatTintPipeline = new Class({
this.vertexViewU32 = new Uint32Array(this.vertexData);
/**
* [description]
* [pending]
*
* @name Phaser.Renderer.WebGL.Pipelines.FlatTintPipeline#tempTriangle
* @type {array}
@ -123,7 +123,7 @@ var FlatTintPipeline = new Class({
];
/**
* [description]
* [pending]
*
* @name Phaser.Renderer.WebGL.Pipelines.FlatTintPipeline#polygonCache
* @type {array}
@ -172,29 +172,29 @@ var FlatTintPipeline = new Class({
},
/**
* [description]
* [pending]
*
* @method Phaser.Renderer.WebGL.Pipelines.FlatTintPipeline#batchFillRect
* @since 3.0.0
*
* @param {float} srcX - [description]
* @param {float} srcY - [description]
* @param {float} srcScaleX - [description]
* @param {float} srcScaleY - [description]
* @param {float} srcRotation - [description]
* @param {float} x - [description]
* @param {float} y - [description]
* @param {float} width - [description]
* @param {float} height - [description]
* @param {integer} fillColor - [description]
* @param {float} fillAlpha - [description]
* @param {float} a1 - [description]
* @param {float} b1 - [description]
* @param {float} c1 - [description]
* @param {float} d1 - [description]
* @param {float} e1 - [description]
* @param {float} f1 - [description]
* @param {Float32Array} currentMatrix - [description]
* @param {float} srcX - [pending]
* @param {float} srcY - [pending]
* @param {float} srcScaleX - [pending]
* @param {float} srcScaleY - [pending]
* @param {float} srcRotation - [pending]
* @param {float} x - [pending]
* @param {float} y - [pending]
* @param {float} width - [pending]
* @param {float} height - [pending]
* @param {integer} fillColor - [pending]
* @param {float} fillAlpha - [pending]
* @param {float} a1 - [pending]
* @param {float} b1 - [pending]
* @param {float} c1 - [pending]
* @param {float} d1 - [pending]
* @param {float} e1 - [pending]
* @param {float} f1 - [pending]
* @param {Float32Array} currentMatrix - [pending]
*/
batchFillRect: function (srcX, srcY, srcScaleX, srcScaleY, srcRotation, x, y, width, height, fillColor, fillAlpha, a1, b1, c1, d1, e1, f1, currentMatrix)
{
@ -265,12 +265,12 @@ var FlatTintPipeline = new Class({
* @param {float} srcScaleX - [description]
* @param {float} srcScaleY - [description]
* @param {float} srcRotation - [description]
* @param {float} x0 - [description]
* @param {float} y0 - [description]
* @param {float} x1 - [description]
* @param {float} y1 - [description]
* @param {float} x2 - [description]
* @param {float} y2 - [description]
* @param {float} x0 - [pending]
* @param {float} y0 - [pending]
* @param {float} x1 - [pending]
* @param {float} y1 - [pending]
* @param {float} x2 - [pending]
* @param {float} y2 - [pending]
* @param {integer} fillColor - [description]
* @param {float} fillAlpha - [description]
* @param {float} a1 - [description]
@ -343,15 +343,15 @@ var FlatTintPipeline = new Class({
* @param {float} y1 - [description]
* @param {float} x2 - [description]
* @param {float} y2 - [description]
* @param {float} lineWidth - [description]
* @param {integer} lineColor - [description]
* @param {float} lineAlpha - [description]
* @param {float} a - [description]
* @param {float} b - [description]
* @param {float} c - [description]
* @param {float} d - [description]
* @param {float} e - [description]
* @param {float} f - [description]
* @param {float} lineWidth - [pending]
* @param {integer} lineColor - [pending]
* @param {float} lineAlpha - [pending]
* @param {float} a - [pending]
* @param {float} b - [pending]
* @param {float} c - [pending]
* @param {float} d - [pending]
* @param {float} e - [pending]
* @param {float} f - [pending]
* @param {Float32Array} currentMatrix - [description]
*/
batchStrokeTriangle: function (srcX, srcY, srcScaleX, srcScaleY, srcRotation, x0, y0, x1, y1, x2, y2, lineWidth, lineColor, lineAlpha, a, b, c, d, e, f, currentMatrix)
@ -399,7 +399,7 @@ var FlatTintPipeline = new Class({
* @param {float} srcScaleX - [description]
* @param {float} srcScaleY - [description]
* @param {float} srcRotation - [description]
* @param {float} path - [description]
* @param {float} path - [pending]
* @param {integer} fillColor - [description]
* @param {float} fillAlpha - [description]
* @param {float} a1 - [description]
@ -511,7 +511,7 @@ var FlatTintPipeline = new Class({
* @param {float} d - [description]
* @param {float} e - [description]
* @param {float} f - [description]
* @param {boolean} isLastPath - [description]
* @param {boolean} isLastPath - [pending]
* @param {Float32Array} currentMatrix - [description]
*/
batchStrokePath: function (srcX, srcY, srcScaleX, srcScaleY, srcRotation, path, lineWidth, lineColor, lineAlpha, a, b, c, d, e, f, isLastPath, currentMatrix)
@ -594,14 +594,14 @@ var FlatTintPipeline = new Class({
* @param {float} srcScaleX - [description]
* @param {float} srcScaleY - [description]
* @param {float} srcRotation - [description]
* @param {float} ax - [description]
* @param {float} ay - [description]
* @param {float} bx - [description]
* @param {float} by - [description]
* @param {float} aLineWidth - [description]
* @param {float} bLineWidth - [description]
* @param {integer} aLineColor - [description]
* @param {integer} bLineColor - [description]
* @param {float} ax - [pending]
* @param {float} ay - [pending]
* @param {float} bx - [pending]
* @param {float} by - [pending]
* @param {float} aLineWidth - [pending]
* @param {float} bLineWidth - [pending]
* @param {integer} aLineColor - [pending]
* @param {integer} bLineColor - [pending]
* @param {float} lineAlpha - [description]
* @param {float} a1 - [description]
* @param {float} b1 - [description]

4
src/renderer/webgl/pipelines/ForwardDiffuseLightPipeline.js
View file

@ -13,7 +13,7 @@ var LIGHT_COUNT = 10;
/**
* @classdesc
* [description]
* [pending]
*
* @class ForwardDiffuseLightPipeline
* @extends Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline
@ -37,7 +37,7 @@ var ForwardDiffuseLightPipeline = new Class({
},
/**
* [description]
* [pending]
*
* @method Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#onBind
* @override

102
src/renderer/webgl/pipelines/TextureTintPipeline.js
View file

@ -14,7 +14,7 @@ var WebGLPipeline = require('../WebGLPipeline');
/**
* @classdesc
* [description]
* [pending] - especially explain the config properties please
*
* @class TextureTintPipeline
* @extends Phaser.Renderer.WebGL.WebGLPipeline
@ -76,7 +76,7 @@ var TextureTintPipeline = new Class({
});
/**
* [description]
* [pending]
*
* @name Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#vertexViewF32
* @type {Float32Array}
@ -85,7 +85,7 @@ var TextureTintPipeline = new Class({
this.vertexViewF32 = new Float32Array(this.vertexData);
/**
* [description]
* [pending]
*
* @name Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#vertexViewU32
* @type {Uint32Array}
@ -94,7 +94,7 @@ var TextureTintPipeline = new Class({
this.vertexViewU32 = new Uint32Array(this.vertexData);
/**
* [description]
* [pending]
*
* @name Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#maxQuads
* @type {integer}
@ -104,7 +104,7 @@ var TextureTintPipeline = new Class({
this.maxQuads = 2000;
/**
* [description]
* [pending]
*
* @name Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#batches
* @type {array}
@ -116,13 +116,13 @@ var TextureTintPipeline = new Class({
},
/**
* [description]
* [pending]
*
* @method Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#setTexture2D
* @since 3.1.0
*
* @param {WebGLTexture} texture - [description]
* @param {integer} textureUnit - [description]
* @param {WebGLTexture} texture - [pending]
* @param {integer} textureUnit - [pending]
*
* @return {Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline} [description]
*/
@ -167,7 +167,7 @@ var TextureTintPipeline = new Class({
},
/**
* [description]
* [pending]
*
* @method Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#pushBatch
* @since 3.1.0
@ -184,7 +184,7 @@ var TextureTintPipeline = new Class({
},
/**
* [description]
* [pending]
*
* @method Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#flush
* @since 3.1.0
@ -284,7 +284,7 @@ var TextureTintPipeline = new Class({
},
/**
* [description]
* [pending]
*
* @method Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#onBind
* @since 3.0.0
@ -325,7 +325,7 @@ var TextureTintPipeline = new Class({
},
/**
* [description]
* [pending]
*
* @method Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#drawStaticTilemapLayer
* @since 3.0.0
@ -361,7 +361,7 @@ var TextureTintPipeline = new Class({
},
/**
* [description]
* [pending]
*
* @method Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#drawEmitterManager
* @since 3.0.0
@ -577,7 +577,7 @@ var TextureTintPipeline = new Class({
},
/**
* [description]
* [pending]
*
* @method Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#drawBlitter
* @since 3.0.0
@ -737,7 +737,7 @@ var TextureTintPipeline = new Class({
},
/**
* [description]
* [pending]
*
* @method Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#batchSprite
* @since 3.0.0
@ -910,7 +910,7 @@ var TextureTintPipeline = new Class({
},
/**
* [description]
* [pending]
*
* @method Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#batchMesh
* @since 3.0.0
@ -1041,7 +1041,7 @@ var TextureTintPipeline = new Class({
},
/**
* [description]
* [pending]
*
* @method Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#batchBitmapText
* @since 3.0.0
@ -1318,7 +1318,7 @@ var TextureTintPipeline = new Class({
},
/**
* [description]
* [pending]
*
* @method Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#batchDynamicBitmapText
* @since 3.0.0
@ -1668,7 +1668,7 @@ var TextureTintPipeline = new Class({
},
/**
* [description]
* [pending]
*
* @method Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#batchText
* @since 3.0.0
@ -1704,7 +1704,7 @@ var TextureTintPipeline = new Class({
},
/**
* [description]
* [pending]
*
* @method Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#batchDynamicTilemapLayer
* @since 3.0.0
@ -1762,7 +1762,7 @@ var TextureTintPipeline = new Class({
},
/**
* [description]
* [pending]
*
* @method Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#batchTileSprite
* @since 3.0.0
@ -1799,40 +1799,40 @@ var TextureTintPipeline = new Class({
},
/**
* [description]
* [pending]
*
* @method Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#batchTexture
* @since 3.0.0
*
* @param {Phaser.GameObjects.GameObject} gameObject - [description]
* @param {WebGLTexture} texture - [description]
* @param {integer} textureWidth - [description]
* @param {integer} textureHeight - [description]
* @param {float} srcX - [description]
* @param {float} srcY - [description]
* @param {float} srcWidth - [description]
* @param {float} srcHeight - [description]
* @param {float} scaleX - [description]
* @param {float} scaleY - [description]
* @param {float} rotation - [description]
* @param {boolean} flipX - [description]
* @param {boolean} flipY - [description]
* @param {float} scrollFactorX - [description]
* @param {float} scrollFactorY - [description]
* @param {float} displayOriginX - [description]
* @param {float} displayOriginY - [description]
* @param {float} frameX - [description]
* @param {float} frameY - [description]
* @param {float} frameWidth - [description]
* @param {float} frameHeight - [description]
* @param {integer} tintTL - [description]
* @param {integer} tintTR - [description]
* @param {integer} tintBL - [description]
* @param {integer} tintBR - [description]
* @param {float} uOffset - [description]
* @param {float} vOffset - [description]
* @param {Phaser.Cameras.Scene2D.Camera} camera - [description]
* @param {Phaser.GameObjects.Components.TransformMatrix} parentTransformMatrix - [description]
* @param {Phaser.GameObjects.GameObject} gameObject - [pending]
* @param {WebGLTexture} texture - [pending]
* @param {integer} textureWidth - [pending]
* @param {integer} textureHeight - [pending]
* @param {float} srcX - [pending]
* @param {float} srcY - [pending]
* @param {float} srcWidth - [pending]
* @param {float} srcHeight - [pending]
* @param {float} scaleX - [pending]
* @param {float} scaleY - [pending]
* @param {float} rotation - [pending]
* @param {boolean} flipX - [pending]
* @param {boolean} flipY - [pending]
* @param {float} scrollFactorX - [pending]
* @param {float} scrollFactorY - [pending]
* @param {float} displayOriginX - [pending]
* @param {float} displayOriginY - [pending]
* @param {float} frameX - [pending]
* @param {float} frameY - [pending]
* @param {float} frameWidth - [pending]
* @param {float} frameHeight - [pending]
* @param {integer} tintTL - [pending]
* @param {integer} tintTR - [pending]
* @param {integer} tintBL - [pending]
* @param {integer} tintBR - [pending]
* @param {float} uOffset - [pending]
* @param {float} vOffset - [pending]
* @param {Phaser.Cameras.Scene2D.Camera} camera - [pending]
* @param {Phaser.GameObjects.Components.TransformMatrix} parentTransformMatrix - [pending]
*/
batchTexture: function (
gameObject,

2
src/renderer/webgl/pipelines/components/ModelViewProjection.js
View file

@ -4,6 +4,8 @@
* @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
*/
// [pending] - please add comments explaining what all of these functions do
var ModelViewProjection = {
modelMatrixDirty: false,