Mirrors/phaser
2
0
Fork 0
mirror of https://github.com/photonstorm/phaser synced 2024-11-27 23:20:59 +00:00
Code Issues Projects Releases Packages Wiki Activity

jsdoc fixes

Browse source
This commit is contained in:
Richard Davey 2018-04-18 12:13:49 +01:00
parent 5b4feedcaf
commit 55965c748f
13 changed files with 96 additions and 96 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
src/cameras/2d/effects/Fade.js
View file

@ -348,7 +348,7 @@ var Fade = new Class({
* @method Phaser.Cameras.Scene2D.Effects.Fade#postRenderWebGL * @method Phaser.Cameras.Scene2D.Effects.Fade#postRenderWebGL
* @since 3.5.0 * @since 3.5.0
* *
* @param {Phaser.Renderer.WebGL.WebGLPipeline.FlatTintPipeline} pipeline - The WebGL Pipeline to render to. * @param {Phaser.Renderer.WebGL.Pipelines.FlatTintPipeline} pipeline - The WebGL Pipeline to render to.
* @param {function} getTintFunction - A function that will return the gl safe tint colors. * @param {function} getTintFunction - A function that will return the gl safe tint colors.
* *
* @return {boolean} `true` if the effect drew to the renderer, otherwise `false`. * @return {boolean} `true` if the effect drew to the renderer, otherwise `false`.

2
src/cameras/2d/effects/Flash.js
View file

@ -295,7 +295,7 @@ var Flash = new Class({
* @method Phaser.Cameras.Scene2D.Effects.Flash#postRenderWebGL * @method Phaser.Cameras.Scene2D.Effects.Flash#postRenderWebGL
* @since 3.5.0 * @since 3.5.0
* *
* @param {Phaser.Renderer.WebGL.WebGLPipeline.FlatTintPipeline} pipeline - The WebGL Pipeline to render to. * @param {Phaser.Renderer.WebGL.Pipelines.FlatTintPipeline} pipeline - The WebGL Pipeline to render to.
* @param {function} getTintFunction - A function that will return the gl safe tint colors. * @param {function} getTintFunction - A function that will return the gl safe tint colors.
* *
* @return {boolean} `true` if the effect drew to the renderer, otherwise `false`. * @return {boolean} `true` if the effect drew to the renderer, otherwise `false`.

2
src/gameobjects/text/static/Text.js
View file

@ -102,7 +102,7 @@ var Text = new Class({
* [description] * [description]
* *
* @name Phaser.GameObjects.Text#style * @name Phaser.GameObjects.Text#style
* @type {Phaser.GameObjects.Components.TextStyle} * @type {Phaser.GameObjects.Text.TextStyle}
* @since 3.0.0 * @since 3.0.0
*/ */
this.style = new TextStyle(this, style); this.style = new TextStyle(this, style);

2
src/input/InputPlugin.js
View file

@ -62,7 +62,7 @@ var InputPlugin = new Class({
* [description] * [description]
* *
* @name Phaser.Input.InputPlugin#settings * @name Phaser.Input.InputPlugin#settings
* @type {SettingsObject} * @type {Phaser.Scenes.Settings.Object}
* @since 3.5.0 * @since 3.5.0
*/ */
this.settings = scene.sys.settings; this.settings = scene.sys.settings;

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

@ -16,7 +16,7 @@ var WebGLPipeline = require('../WebGLPipeline');
* *
* @class BitmapMaskPipeline * @class BitmapMaskPipeline
* @extends Phaser.Renderer.WebGL.WebGLPipeline * @extends Phaser.Renderer.WebGL.WebGLPipeline
* @memberOf Phaser.Renderer.WebGL * @memberOf Phaser.Renderer.WebGL.Pipelines
* @constructor * @constructor
* @since 3.0.0 * @since 3.0.0
* *
@ -60,7 +60,7 @@ var BitmapMaskPipeline = new Class({
/** /**
* [description] * [description]
* *
* @name Phaser.Renderer.WebGL.BitmapMaskPipeline#vertexViewF32 * @name Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#vertexViewF32
* @type {Float32Array} * @type {Float32Array}
* @since 3.0.0 * @since 3.0.0
*/ */
@ -69,7 +69,7 @@ var BitmapMaskPipeline = new Class({
/** /**
* [description] * [description]
* *
* @name Phaser.Renderer.WebGL.BitmapMaskPipeline#maxQuads * @name Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#maxQuads
* @type {number} * @type {number}
* @default 1 * @default 1
* @since 3.0.0 * @since 3.0.0
@ -79,7 +79,7 @@ var BitmapMaskPipeline = new Class({
/** /**
* [description] * [description]
* *
* @name Phaser.Renderer.WebGL.BitmapMaskPipeline#resolutionDirty * @name Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#resolutionDirty
* @type {boolean} * @type {boolean}
* @default true * @default true
* @since 3.0.0 * @since 3.0.0
@ -90,10 +90,10 @@ var BitmapMaskPipeline = new Class({
/** /**
* [description] * [description]
* *
* @method Phaser.Renderer.WebGL.BitmapMaskPipeline#onBind * @method Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#onBind
* @since 3.0.0 * @since 3.0.0
* *
* @return {Phaser.Renderer.WebGL.BitmapMaskPipeline} [description] * @return {Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline} [description]
*/ */
onBind: function () onBind: function ()
{ {
@ -116,14 +116,14 @@ var BitmapMaskPipeline = new Class({
/** /**
* [description] * [description]
* *
* @method Phaser.Renderer.WebGL.BitmapMaskPipeline#resize * @method Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#resize
* @since 3.0.0 * @since 3.0.0
* *
* @param {number} width - [description] * @param {number} width - [description]
* @param {number} height - [description] * @param {number} height - [description]
* @param {number} resolution - [description] * @param {number} resolution - [description]
* *
* @return {Phaser.Renderer.WebGL.BitmapMaskPipeline} [description] * @return {Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline} [description]
*/ */
resize: function (width, height, resolution) resize: function (width, height, resolution)
{ {
@ -135,7 +135,7 @@ var BitmapMaskPipeline = new Class({
/** /**
* [description] * [description]
* *
* @method Phaser.Renderer.WebGL.BitmapMaskPipeline#beginMask * @method Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#beginMask
* @since 3.0.0 * @since 3.0.0
* *
* @param {Phaser.GameObjects.GameObject} mask - [description] * @param {Phaser.GameObjects.GameObject} mask - [description]
@ -172,7 +172,7 @@ var BitmapMaskPipeline = new Class({
/** /**
* [description] * [description]
* *
* @method Phaser.Renderer.WebGL.BitmapMaskPipeline#endMask * @method Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#endMask
* @since 3.0.0 * @since 3.0.0
* *
* @param {Phaser.GameObjects.GameObject} mask - [description] * @param {Phaser.GameObjects.GameObject} mask - [description]

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

@ -41,7 +41,7 @@ var pathArray = [];
* *
* @class FlatTintPipeline * @class FlatTintPipeline
* @extends Phaser.Renderer.WebGL.WebGLPipeline * @extends Phaser.Renderer.WebGL.WebGLPipeline
* @memberOf Phaser.Renderer.WebGL * @memberOf Phaser.Renderer.WebGL.Pipelines
* @constructor * @constructor
* @since 3.0.0 * @since 3.0.0
* *
@ -93,7 +93,7 @@ var FlatTintPipeline = new Class({
/** /**
* [description] * [description]
* *
* @name Phaser.Renderer.WebGL.FlatTintPipeline#vertexViewF32 * @name Phaser.Renderer.WebGL.Pipelines.FlatTintPipeline#vertexViewF32
* @type {Float32Array} * @type {Float32Array}
* @since 3.0.0 * @since 3.0.0
*/ */
@ -102,7 +102,7 @@ var FlatTintPipeline = new Class({
/** /**
* [description] * [description]
* *
* @name Phaser.Renderer.WebGL.FlatTintPipeline#vertexViewU32 * @name Phaser.Renderer.WebGL.Pipelines.FlatTintPipeline#vertexViewU32
* @type {Uint32Array} * @type {Uint32Array}
* @since 3.0.0 * @since 3.0.0
*/ */
@ -111,7 +111,7 @@ var FlatTintPipeline = new Class({
/** /**
* [description] * [description]
* *
* @name Phaser.Renderer.WebGL.FlatTintPipeline#tempTriangle * @name Phaser.Renderer.WebGL.Pipelines.FlatTintPipeline#tempTriangle
* @type {array} * @type {array}
* @since 3.0.0 * @since 3.0.0
*/ */
@ -125,7 +125,7 @@ var FlatTintPipeline = new Class({
/** /**
* [description] * [description]
* *
* @name Phaser.Renderer.WebGL.FlatTintPipeline#polygonCache * @name Phaser.Renderer.WebGL.Pipelines.FlatTintPipeline#polygonCache
* @type {array} * @type {array}
* @default [] * @default []
* @since 3.0.0 * @since 3.0.0
@ -138,10 +138,10 @@ var FlatTintPipeline = new Class({
/** /**
* [description] * [description]
* *
* @method Phaser.Renderer.WebGL.FlatTintPipeline#onBind * @method Phaser.Renderer.WebGL.Pipelines.FlatTintPipeline#onBind
* @since 3.0.0 * @since 3.0.0
* *
* @return {Phaser.Renderer.WebGL.FlatTintPipeline} [description] * @return {Phaser.Renderer.WebGL.Pipelines.FlatTintPipeline} [description]
*/ */
onBind: function () onBind: function ()
{ {
@ -154,14 +154,14 @@ var FlatTintPipeline = new Class({
/** /**
* [description] * [description]
* *
* @method Phaser.Renderer.WebGL.FlatTintPipeline#resize * @method Phaser.Renderer.WebGL.Pipelines.FlatTintPipeline#resize
* @since 3.0.0 * @since 3.0.0
* *
* @param {number} width - [description] * @param {number} width - [description]
* @param {number} height - [description] * @param {number} height - [description]
* @param {number} resolution - [description] * @param {number} resolution - [description]
* *
* @return {Phaser.Renderer.WebGL.FlatTintPipeline} [description] * @return {Phaser.Renderer.WebGL.Pipelines.FlatTintPipeline} [description]
*/ */
resize: function (width, height, resolution) resize: function (width, height, resolution)
{ {
@ -174,7 +174,7 @@ var FlatTintPipeline = new Class({
/** /**
* [description] * [description]
* *
* @method Phaser.Renderer.WebGL.FlatTintPipeline#batchFillRect * @method Phaser.Renderer.WebGL.Pipelines.FlatTintPipeline#batchFillRect
* @since 3.0.0 * @since 3.0.0
* *
* @param {float} srcX - [description] * @param {float} srcX - [description]
@ -257,7 +257,7 @@ var FlatTintPipeline = new Class({
/** /**
* [description] * [description]
* *
* @method Phaser.Renderer.WebGL.FlatTintPipeline#batchFillTriangle * @method Phaser.Renderer.WebGL.Pipelines.FlatTintPipeline#batchFillTriangle
* @since 3.0.0 * @since 3.0.0
* *
* @param {float} srcX - [description] * @param {float} srcX - [description]
@ -329,7 +329,7 @@ var FlatTintPipeline = new Class({
/** /**
* [description] * [description]
* *
* @method Phaser.Renderer.WebGL.FlatTintPipeline#batchStrokeTriangle * @method Phaser.Renderer.WebGL.Pipelines.FlatTintPipeline#batchStrokeTriangle
* @since 3.0.0 * @since 3.0.0
* *
* @param {float} srcX - [description] * @param {float} srcX - [description]
@ -391,7 +391,7 @@ var FlatTintPipeline = new Class({
/** /**
* [description] * [description]
* *
* @method Phaser.Renderer.WebGL.FlatTintPipeline#batchFillPath * @method Phaser.Renderer.WebGL.Pipelines.FlatTintPipeline#batchFillPath
* @since 3.0.0 * @since 3.0.0
* *
* @param {float} srcX - [description] * @param {float} srcX - [description]
@ -493,7 +493,7 @@ var FlatTintPipeline = new Class({
/** /**
* [description] * [description]
* *
* @method Phaser.Renderer.WebGL.FlatTintPipeline#batchStrokePath * @method Phaser.Renderer.WebGL.Pipelines.FlatTintPipeline#batchStrokePath
* @since 3.0.0 * @since 3.0.0
* *
* @param {float} srcX - [description] * @param {float} srcX - [description]
@ -586,7 +586,7 @@ var FlatTintPipeline = new Class({
/** /**
* [description] * [description]
* *
* @method Phaser.Renderer.WebGL.FlatTintPipeline#batchLine * @method Phaser.Renderer.WebGL.Pipelines.FlatTintPipeline#batchLine
* @since 3.0.0 * @since 3.0.0
* *
* @param {float} srcX - [description] * @param {float} srcX - [description]
@ -694,7 +694,7 @@ var FlatTintPipeline = new Class({
/** /**
* [description] * [description]
* *
* @method Phaser.Renderer.WebGL.FlatTintPipeline#batchGraphics * @method Phaser.Renderer.WebGL.Pipelines.FlatTintPipeline#batchGraphics
* @since 3.0.0 * @since 3.0.0
* *
* @param {Phaser.GameObjects.Graphics} graphics - [description] * @param {Phaser.GameObjects.Graphics} graphics - [description]
@ -1126,7 +1126,7 @@ var FlatTintPipeline = new Class({
/** /**
* [description] * [description]
* *
* @method Phaser.Renderer.WebGL.FlatTintPipeline#drawStaticTilemapLayer * @method Phaser.Renderer.WebGL.Pipelines.FlatTintPipeline#drawStaticTilemapLayer
* @since 3.0.0 * @since 3.0.0
* *
* @param {Phaser.Tilemaps.StaticTilemapLayer} tilemap - [description] * @param {Phaser.Tilemaps.StaticTilemapLayer} tilemap - [description]
@ -1139,7 +1139,7 @@ var FlatTintPipeline = new Class({
/** /**
* [description] * [description]
* *
* @method Phaser.Renderer.WebGL.FlatTintPipeline#drawEmitterManager * @method Phaser.Renderer.WebGL.Pipelines.FlatTintPipeline#drawEmitterManager
* @since 3.0.0 * @since 3.0.0
* *
* @param {Phaser.GameObjects.Particles.ParticleEmitterManager} emitterManager - [description] * @param {Phaser.GameObjects.Particles.ParticleEmitterManager} emitterManager - [description]
@ -1152,7 +1152,7 @@ var FlatTintPipeline = new Class({
/** /**
* [description] * [description]
* *
* @method Phaser.Renderer.WebGL.FlatTintPipeline#drawBlitter * @method Phaser.Renderer.WebGL.Pipelines.FlatTintPipeline#drawBlitter
* @since 3.0.0 * @since 3.0.0
* *
* @param {Phaser.GameObjects.Blitter} blitter - [description] * @param {Phaser.GameObjects.Blitter} blitter - [description]
@ -1165,7 +1165,7 @@ var FlatTintPipeline = new Class({
/** /**
* [description] * [description]
* *
* @method Phaser.Renderer.WebGL.FlatTintPipeline#batchSprite * @method Phaser.Renderer.WebGL.Pipelines.FlatTintPipeline#batchSprite
* @since 3.0.0 * @since 3.0.0
* *
* @param {Phaser.GameObjects.Sprite} sprite - [description] * @param {Phaser.GameObjects.Sprite} sprite - [description]
@ -1178,7 +1178,7 @@ var FlatTintPipeline = new Class({
/** /**
* [description] * [description]
* *
* @method Phaser.Renderer.WebGL.FlatTintPipeline#batchMesh * @method Phaser.Renderer.WebGL.Pipelines.FlatTintPipeline#batchMesh
* @since 3.0.0 * @since 3.0.0
* *
* @param {Phaser.GameObjects.Mesh} mesh - [description] * @param {Phaser.GameObjects.Mesh} mesh - [description]
@ -1191,7 +1191,7 @@ var FlatTintPipeline = new Class({
/** /**
* [description] * [description]
* *
* @method Phaser.Renderer.WebGL.FlatTintPipeline#batchBitmapText * @method Phaser.Renderer.WebGL.Pipelines.FlatTintPipeline#batchBitmapText
* @since 3.0.0 * @since 3.0.0
* *
* @param {Phaser.GameObjects.BitmapText} bitmapText - [description] * @param {Phaser.GameObjects.BitmapText} bitmapText - [description]
@ -1204,7 +1204,7 @@ var FlatTintPipeline = new Class({
/** /**
* [description] * [description]
* *
* @method Phaser.Renderer.WebGL.FlatTintPipeline#batchDynamicBitmapText * @method Phaser.Renderer.WebGL.Pipelines.FlatTintPipeline#batchDynamicBitmapText
* @since 3.0.0 * @since 3.0.0
* *
* @param {Phaser.GameObjects.DynamicBitmapText} bitmapText - [description] * @param {Phaser.GameObjects.DynamicBitmapText} bitmapText - [description]
@ -1217,7 +1217,7 @@ var FlatTintPipeline = new Class({
/** /**
* [description] * [description]
* *
* @method Phaser.Renderer.WebGL.FlatTintPipeline#batchText * @method Phaser.Renderer.WebGL.Pipelines.FlatTintPipeline#batchText
* @since 3.0.0 * @since 3.0.0
* *
* @param {Phaser.GameObjects.Text} text - [description] * @param {Phaser.GameObjects.Text} text - [description]
@ -1230,7 +1230,7 @@ var FlatTintPipeline = new Class({
/** /**
* [description] * [description]
* *
* @method Phaser.Renderer.WebGL.FlatTintPipeline#batchDynamicTilemapLayer * @method Phaser.Renderer.WebGL.Pipelines.FlatTintPipeline#batchDynamicTilemapLayer
* @since 3.0.0 * @since 3.0.0
* *
* @param {Phaser.Tilemaps.DynamicTilemapLayer} tilemapLayer - [description] * @param {Phaser.Tilemaps.DynamicTilemapLayer} tilemapLayer - [description]
@ -1243,7 +1243,7 @@ var FlatTintPipeline = new Class({
/** /**
* [description] * [description]
* *
* @method Phaser.Renderer.WebGL.FlatTintPipeline#batchTileSprite * @method Phaser.Renderer.WebGL.Pipelines.FlatTintPipeline#batchTileSprite
* @since 3.0.0 * @since 3.0.0
* *
* @param {Phaser.GameObjects.TileSprite} tileSprite - [description] * @param {Phaser.GameObjects.TileSprite} tileSprite - [description]

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

@ -16,8 +16,8 @@ var LIGHT_COUNT = 10;
* [description] * [description]
* *
* @class ForwardDiffuseLightPipeline * @class ForwardDiffuseLightPipeline
* @extends Phaser.Renderer.WebGL.TextureTintPipeline * @extends Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline
* @memberOf Phaser.Renderer.WebGL * @memberOf Phaser.Renderer.WebGL.Pipelines
* @constructor * @constructor
* @since 3.0.0 * @since 3.0.0
* *
@ -39,10 +39,10 @@ var ForwardDiffuseLightPipeline = new Class({
/** /**
* [description] * [description]
* *
* @method Phaser.Renderer.WebGL.ForwardDiffuseLightPipeline#onBind * @method Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#onBind
* @since 3.0.0 * @since 3.0.0
* *
* @return {Phaser.Renderer.WebGL.ForwardDiffuseLightPipeline} [description] * @return {Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline} [description]
*/ */
onBind: function () onBind: function ()
{ {
@ -62,13 +62,13 @@ var ForwardDiffuseLightPipeline = new Class({
/** /**
* [description] * [description]
* *
* @method Phaser.Renderer.WebGL.ForwardDiffuseLightPipeline#onRender * @method Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#onRender
* @since 3.0.0 * @since 3.0.0
* *
* @param {Phaser.Scene} scene - [description] * @param {Phaser.Scene} scene - [description]
* @param {Phaser.Cameras.Scene2D.Camera} camera - [description] * @param {Phaser.Cameras.Scene2D.Camera} camera - [description]
* *
* @return {Phaser.Renderer.WebGL.ForwardDiffuseLightPipeline} [description] * @return {Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline} [description]
*/ */
onRender: function (scene, camera) onRender: function (scene, camera)
{ {
@ -122,7 +122,7 @@ var ForwardDiffuseLightPipeline = new Class({
/** /**
* [description] * [description]
* *
* @method Phaser.Renderer.WebGL.ForwardDiffuseLightPipeline#drawStaticTilemapLayer * @method Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#drawStaticTilemapLayer
* @since 3.0.0 * @since 3.0.0
* *
* @param {Phaser.Tilemaps.StaticTilemapLayer} tilemap - [description] * @param {Phaser.Tilemaps.StaticTilemapLayer} tilemap - [description]
@ -149,7 +149,7 @@ var ForwardDiffuseLightPipeline = new Class({
/** /**
* [description] * [description]
* *
* @method Phaser.Renderer.WebGL.ForwardDiffuseLightPipeline#drawEmitterManager * @method Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#drawEmitterManager
* @since 3.0.0 * @since 3.0.0
* *
* @param {Phaser.GameObjects.Particles.ParticleEmitterManager} emitterManager - [description] * @param {Phaser.GameObjects.Particles.ParticleEmitterManager} emitterManager - [description]
@ -176,7 +176,7 @@ var ForwardDiffuseLightPipeline = new Class({
/** /**
* [description] * [description]
* *
* @method Phaser.Renderer.WebGL.ForwardDiffuseLightPipeline#drawBlitter * @method Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#drawBlitter
* @since 3.0.0 * @since 3.0.0
* *
* @param {Phaser.GameObjects.Blitter} blitter - [description] * @param {Phaser.GameObjects.Blitter} blitter - [description]
@ -203,7 +203,7 @@ var ForwardDiffuseLightPipeline = new Class({
/** /**
* [description] * [description]
* *
* @method Phaser.Renderer.WebGL.ForwardDiffuseLightPipeline#batchSprite * @method Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#batchSprite
* @since 3.0.0 * @since 3.0.0
* *
* @param {Phaser.GameObjects.Sprite} sprite - [description] * @param {Phaser.GameObjects.Sprite} sprite - [description]
@ -230,7 +230,7 @@ var ForwardDiffuseLightPipeline = new Class({
/** /**
* [description] * [description]
* *
* @method Phaser.Renderer.WebGL.ForwardDiffuseLightPipeline#batchMesh * @method Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#batchMesh
* @since 3.0.0 * @since 3.0.0
* *
* @param {Phaser.GameObjects.Mesh} mesh - [description] * @param {Phaser.GameObjects.Mesh} mesh - [description]
@ -258,7 +258,7 @@ var ForwardDiffuseLightPipeline = new Class({
/** /**
* [description] * [description]
* *
* @method Phaser.Renderer.WebGL.ForwardDiffuseLightPipeline#batchBitmapText * @method Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#batchBitmapText
* @since 3.0.0 * @since 3.0.0
* *
* @param {Phaser.GameObjects.BitmapText} bitmapText - [description] * @param {Phaser.GameObjects.BitmapText} bitmapText - [description]
@ -285,7 +285,7 @@ var ForwardDiffuseLightPipeline = new Class({
/** /**
* [description] * [description]
* *
* @method Phaser.Renderer.WebGL.ForwardDiffuseLightPipeline#batchDynamicBitmapText * @method Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#batchDynamicBitmapText
* @since 3.0.0 * @since 3.0.0
* *
* @param {Phaser.GameObjects.DynamicBitmapText} bitmapText - [description] * @param {Phaser.GameObjects.DynamicBitmapText} bitmapText - [description]
@ -312,7 +312,7 @@ var ForwardDiffuseLightPipeline = new Class({
/** /**
* [description] * [description]
* *
* @method Phaser.Renderer.WebGL.ForwardDiffuseLightPipeline#batchText * @method Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#batchText
* @since 3.0.0 * @since 3.0.0
* *
* @param {Phaser.GameObjects.Text} text - [description] * @param {Phaser.GameObjects.Text} text - [description]
@ -339,7 +339,7 @@ var ForwardDiffuseLightPipeline = new Class({
/** /**
* [description] * [description]
* *
* @method Phaser.Renderer.WebGL.ForwardDiffuseLightPipeline#batchDynamicTilemapLayer * @method Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#batchDynamicTilemapLayer
* @since 3.0.0 * @since 3.0.0
* *
* @param {Phaser.Tilemaps.DynamicTilemapLayer} tilemapLayer - [description] * @param {Phaser.Tilemaps.DynamicTilemapLayer} tilemapLayer - [description]
@ -366,7 +366,7 @@ var ForwardDiffuseLightPipeline = new Class({
/** /**
* [description] * [description]
* *
* @method Phaser.Renderer.WebGL.ForwardDiffuseLightPipeline#batchTileSprite * @method Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline#batchTileSprite
* @since 3.0.0 * @since 3.0.0
* *
* @param {Phaser.GameObjects.TileSprite} tileSprite - [description] * @param {Phaser.GameObjects.TileSprite} tileSprite - [description]

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

@ -18,7 +18,7 @@ var WebGLPipeline = require('../WebGLPipeline');
* *
* @class TextureTintPipeline * @class TextureTintPipeline
* @extends Phaser.Renderer.WebGL.WebGLPipeline * @extends Phaser.Renderer.WebGL.WebGLPipeline
* @memberOf Phaser.Renderer.WebGL * @memberOf Phaser.Renderer.WebGL.Pipelines
* @constructor * @constructor
* @since 3.0.0 * @since 3.0.0
* *
@ -78,7 +78,7 @@ var TextureTintPipeline = new Class({
/** /**
* [description] * [description]
* *
* @name Phaser.Renderer.WebGL.TextureTintPipeline#vertexViewF32 * @name Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#vertexViewF32
* @type {Float32Array} * @type {Float32Array}
* @since 3.0.0 * @since 3.0.0
*/ */
@ -87,7 +87,7 @@ var TextureTintPipeline = new Class({
/** /**
* [description] * [description]
* *
* @name Phaser.Renderer.WebGL.TextureTintPipeline#vertexViewU32 * @name Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#vertexViewU32
* @type {Uint32Array} * @type {Uint32Array}
* @since 3.0.0 * @since 3.0.0
*/ */
@ -96,7 +96,7 @@ var TextureTintPipeline = new Class({
/** /**
* [description] * [description]
* *
* @name Phaser.Renderer.WebGL.TextureTintPipeline#maxQuads * @name Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#maxQuads
* @type {integer} * @type {integer}
* @default 2000 * @default 2000
* @since 3.0.0 * @since 3.0.0
@ -106,7 +106,7 @@ var TextureTintPipeline = new Class({
/** /**
* [description] * [description]
* *
* @name Phaser.Renderer.WebGL.TextureTintPipeline#batches * @name Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#batches
* @type {array} * @type {array}
* @since 3.1.0 * @since 3.1.0
*/ */
@ -118,13 +118,13 @@ var TextureTintPipeline = new Class({
/** /**
* [description] * [description]
* *
* @method Phaser.Renderer.WebGL.TextureTintPipeline#setTexture2D * @method Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#setTexture2D
* @since 3.1.0 * @since 3.1.0
* *
* @param {WebGLTexture} texture - [description] * @param {WebGLTexture} texture - [description]
* @param {integer} textureUnit - [description] * @param {integer} textureUnit - [description]
* *
* @return {Phaser.Renderer.WebGL.TextureTintPipeline} [description] * @return {Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline} [description]
*/ */
setTexture2D: function (texture, unit) setTexture2D: function (texture, unit)
{ {
@ -169,7 +169,7 @@ var TextureTintPipeline = new Class({
/** /**
* [description] * [description]
* *
* @method Phaser.Renderer.WebGL.TextureTintPipeline#pushBatch * @method Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#pushBatch
* @since 3.1.0 * @since 3.1.0
*/ */
pushBatch: function () pushBatch: function ()
@ -186,10 +186,10 @@ var TextureTintPipeline = new Class({
/** /**
* [description] * [description]
* *
* @method Phaser.Renderer.WebGL.TextureTintPipeline#flush * @method Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#flush
* @since 3.1.0 * @since 3.1.0
* *
* @return {Phaser.Renderer.WebGL.TextureTintPipeline} This Pipeline. * @return {Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline} This Pipeline.
*/ */
flush: function () flush: function ()
{ {
@ -286,10 +286,10 @@ var TextureTintPipeline = new Class({
/** /**
* [description] * [description]
* *
* @method Phaser.Renderer.WebGL.TextureTintPipeline#onBind * @method Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#onBind
* @since 3.0.0 * @since 3.0.0
* *
* @return {Phaser.Renderer.WebGL.TextureTintPipeline} [description] * @return {Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline} [description]
*/ */
onBind: function () onBind: function ()
{ {
@ -307,14 +307,14 @@ var TextureTintPipeline = new Class({
/** /**
* [description] * [description]
* *
* @method Phaser.Renderer.WebGL.TextureTintPipeline#resize * @method Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#resize
* @since 3.0.0 * @since 3.0.0
* *
* @param {number} width - [description] * @param {number} width - [description]
* @param {number} height - [description] * @param {number} height - [description]
* @param {number} resolution - [description] * @param {number} resolution - [description]
* *
* @return {Phaser.Renderer.WebGL.TextureTintPipeline} [description] * @return {Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline} [description]
*/ */
resize: function (width, height, resolution) resize: function (width, height, resolution)
{ {
@ -326,7 +326,7 @@ var TextureTintPipeline = new Class({
/** /**
* [description] * [description]
* *
* @method Phaser.Renderer.WebGL.TextureTintPipeline#drawStaticTilemapLayer * @method Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#drawStaticTilemapLayer
* @since 3.0.0 * @since 3.0.0
* *
* @param {Phaser.Tilemaps.StaticTilemapLayer} tilemap - [description] * @param {Phaser.Tilemaps.StaticTilemapLayer} tilemap - [description]
@ -361,7 +361,7 @@ var TextureTintPipeline = new Class({
/** /**
* [description] * [description]
* *
* @method Phaser.Renderer.WebGL.TextureTintPipeline#drawEmitterManager * @method Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#drawEmitterManager
* @since 3.0.0 * @since 3.0.0
* *
* @param {Phaser.GameObjects.Particles.ParticleEmitterManager} emitterManager - [description] * @param {Phaser.GameObjects.Particles.ParticleEmitterManager} emitterManager - [description]
@ -565,7 +565,7 @@ var TextureTintPipeline = new Class({
/** /**
* [description] * [description]
* *
* @method Phaser.Renderer.WebGL.TextureTintPipeline#drawBlitter * @method Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#drawBlitter
* @since 3.0.0 * @since 3.0.0
* *
* @param {Phaser.GameObjects.Blitter} blitter - [description] * @param {Phaser.GameObjects.Blitter} blitter - [description]
@ -717,7 +717,7 @@ var TextureTintPipeline = new Class({
/** /**
* [description] * [description]
* *
* @method Phaser.Renderer.WebGL.TextureTintPipeline#batchSprite * @method Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#batchSprite
* @since 3.0.0 * @since 3.0.0
* *
* @param {Phaser.GameObjects.Sprite} sprite - [description] * @param {Phaser.GameObjects.Sprite} sprite - [description]
@ -884,7 +884,7 @@ var TextureTintPipeline = new Class({
/** /**
* [description] * [description]
* *
* @method Phaser.Renderer.WebGL.TextureTintPipeline#batchMesh * @method Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#batchMesh
* @since 3.0.0 * @since 3.0.0
* *
* @param {Phaser.GameObjects.Mesh} mesh - [description] * @param {Phaser.GameObjects.Mesh} mesh - [description]
@ -1007,7 +1007,7 @@ var TextureTintPipeline = new Class({
/** /**
* [description] * [description]
* *
* @method Phaser.Renderer.WebGL.TextureTintPipeline#batchBitmapText * @method Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#batchBitmapText
* @since 3.0.0 * @since 3.0.0
* *
* @param {Phaser.GameObjects.BitmapText} bitmapText - [description] * @param {Phaser.GameObjects.BitmapText} bitmapText - [description]
@ -1276,7 +1276,7 @@ var TextureTintPipeline = new Class({
/** /**
* [description] * [description]
* *
* @method Phaser.Renderer.WebGL.TextureTintPipeline#batchDynamicBitmapText * @method Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#batchDynamicBitmapText
* @since 3.0.0 * @since 3.0.0
* *
* @param {Phaser.GameObjects.DynamicBitmapText} bitmapText - [description] * @param {Phaser.GameObjects.DynamicBitmapText} bitmapText - [description]
@ -1620,7 +1620,7 @@ var TextureTintPipeline = new Class({
/** /**
* [description] * [description]
* *
* @method Phaser.Renderer.WebGL.TextureTintPipeline#batchText * @method Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#batchText
* @since 3.0.0 * @since 3.0.0
* *
* @param {Phaser.GameObjects.Text} text - [description] * @param {Phaser.GameObjects.Text} text - [description]
@ -1656,7 +1656,7 @@ var TextureTintPipeline = new Class({
/** /**
* [description] * [description]
* *
* @method Phaser.Renderer.WebGL.TextureTintPipeline#batchDynamicTilemapLayer * @method Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#batchDynamicTilemapLayer
* @since 3.0.0 * @since 3.0.0
* *
* @param {Phaser.Tilemaps.DynamicTilemapLayer} tilemapLayer - [description] * @param {Phaser.Tilemaps.DynamicTilemapLayer} tilemapLayer - [description]
@ -1714,7 +1714,7 @@ var TextureTintPipeline = new Class({
/** /**
* [description] * [description]
* *
* @method Phaser.Renderer.WebGL.TextureTintPipeline#batchTileSprite * @method Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#batchTileSprite
* @since 3.0.0 * @since 3.0.0
* *
* @param {Phaser.GameObjects.TileSprite} tileSprite - [description] * @param {Phaser.GameObjects.TileSprite} tileSprite - [description]
@ -1751,7 +1751,7 @@ var TextureTintPipeline = new Class({
/** /**
* [description] * [description]
* *
* @method Phaser.Renderer.WebGL.TextureTintPipeline#batchTexture * @method Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#batchTexture
* @since 3.0.0 * @since 3.0.0
* *
* @param {Phaser.GameObjects.GameObject} gameObject - [description] * @param {Phaser.GameObjects.GameObject} gameObject - [description]
@ -1944,7 +1944,7 @@ var TextureTintPipeline = new Class({
/** /**
* Immediately draws a texture with no batching. * Immediately draws a texture with no batching.
* *
* @method Phaser.Renderer.WebGL.TextureTintPipeline#drawTexture * @method Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#drawTexture
* @since 3.2.0 * @since 3.2.0
* *
* @param {WebGLTexture} texture [description] * @param {WebGLTexture} texture [description]
@ -1959,7 +1959,7 @@ var TextureTintPipeline = new Class({
* @param {Phaser.GameObjects.Components.TransformMatrix} transformMatrix - [description] * @param {Phaser.GameObjects.Components.TransformMatrix} transformMatrix - [description]
* @param {Phaser.GameObjects.Components.TransformMatrix} parentTransformMatrix - [description] * @param {Phaser.GameObjects.Components.TransformMatrix} parentTransformMatrix - [description]
* *
* @return {Phaser.Renderer.WebGL.TextureTintPipeline} This Pipeline. * @return {Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline} This Pipeline.
*/ */
drawTexture: function ( drawTexture: function (
texture, texture,
@ -2095,7 +2095,7 @@ var TextureTintPipeline = new Class({
/** /**
* [description] * [description]
* *
* @method Phaser.Renderer.WebGL.TextureTintPipeline#batchGraphics * @method Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline#batchGraphics
* @since 3.0.0 * @since 3.0.0
* *
* @param {Phaser.GameObjects.Graphics} graphics - [description] * @param {Phaser.GameObjects.Graphics} graphics - [description]

2
src/scene/Scene.js
View file

@ -16,7 +16,7 @@ var Systems = require('./Systems');
* @constructor * @constructor
* @since 3.0.0 * @since 3.0.0
* *
* @param {(string|SettingsConfig)} config - Scene specific configuration settings. * @param {(string|Phaser.Scenes.Settings.Config)} config - Scene specific configuration settings.
*/ */
var Scene = new Class({ var Scene = new Class({

6
src/scene/SceneManager.js
View file

@ -298,7 +298,7 @@ var SceneManager = new Class({
* @since 3.0.0 * @since 3.0.0
* *
* @param {string} key - A unique key used to reference the Scene, i.e. `MainMenu` or `Level1`. * @param {string} key - A unique key used to reference the Scene, i.e. `MainMenu` or `Level1`.
* @param {(Phaser.Scene|SettingsConfig|function)} sceneConfig - The config for the Scene * @param {(Phaser.Scene|Phaser.Scenes.Settings.Config|function)} sceneConfig - The config for the Scene
* @param {boolean} [autoStart=false] - If `true` the Scene will be started immediately after being added. * @param {boolean} [autoStart=false] - If `true` the Scene will be started immediately after being added.
* @param {object} [data] - Optional data object. This will be set as Scene.settings.data and passed to `Scene.init`. * @param {object} [data] - Optional data object. This will be set as Scene.settings.data and passed to `Scene.init`.
* *
@ -702,7 +702,7 @@ var SceneManager = new Class({
* @since 3.0.0 * @since 3.0.0
* *
* @param {string} key - The key of the Scene. * @param {string} key - The key of the Scene.
* @param {(string|SettingsConfig)} sceneConfig - The Scene config. * @param {(string|Phaser.Scenes.Settings.Config)} sceneConfig - The Scene config.
* *
* @return {Phaser.Scene} The created Scene. * @return {Phaser.Scene} The created Scene.
*/ */
@ -786,7 +786,7 @@ var SceneManager = new Class({
* @since 3.0.0 * @since 3.0.0
* *
* @param {string} key - The key to check in the Scene config. * @param {string} key - The key to check in the Scene config.
* @param {(Phaser.Scene|SettingsConfig|function)} sceneConfig - The Scene config. * @param {(Phaser.Scene|Phaser.Scenes.Settings.Config|function)} sceneConfig - The Scene config.
* *
* @return {string} The Scene key. * @return {string} The Scene key.
*/ */

8
src/scene/ScenePlugin.js
View file

@ -49,7 +49,7 @@ var ScenePlugin = new Class({
* The settings of the Scene this ScenePlugin belongs to. * The settings of the Scene this ScenePlugin belongs to.
* *
* @name Phaser.Scenes.ScenePlugin#settings * @name Phaser.Scenes.ScenePlugin#settings
* @type {SettingsObject} * @type {Phaser.Scenes.Settings.Object}
* @since 3.0.0 * @since 3.0.0
*/ */
this.settings = scene.sys.settings; this.settings = scene.sys.settings;
@ -243,7 +243,7 @@ var ScenePlugin = new Class({
}, },
/** /**
* @typedef {object} Phaser.Scenes.ScenePlugin#SceneTransitionConfig * @typedef {object} Phaser.Scenes.ScenePlugin.SceneTransitionConfig
* *
* @property {string} target - The Scene key to transition to. * @property {string} target - The Scene key to transition to.
* @property {integer} [duration=1000] - The duration, in ms, for the transition to last. * @property {integer} [duration=1000] - The duration, in ms, for the transition to last.
@ -289,7 +289,7 @@ var ScenePlugin = new Class({
* @method Phaser.Scenes.ScenePlugin#transition * @method Phaser.Scenes.ScenePlugin#transition
* @since 3.5.0 * @since 3.5.0
* *
* @param {Phaser.Scenes.ScenePlugin#SceneTransitionConfig} config - The transition configuration object. * @param {Phaser.Scenes.ScenePlugin.SceneTransitionConfig} config - The transition configuration object.
* *
* @return {boolean} `true` is the transition was started, otherwise `false`. * @return {boolean} `true` is the transition was started, otherwise `false`.
*/ */
@ -458,7 +458,7 @@ var ScenePlugin = new Class({
* @since 3.0.0 * @since 3.0.0
* *
* @param {string} key - The Scene key. * @param {string} key - The Scene key.
* @param {(Phaser.Scene|SettingsConfig|function)} sceneConfig - The config for the Scene. * @param {(Phaser.Scene|Phaser.Scenes.Settings.Config|function)} sceneConfig - The config for the Scene.
* @param {boolean} autoStart - Whether to start the Scene after it's added. * @param {boolean} autoStart - Whether to start the Scene after it's added.
* *
* @return {Phaser.Scenes.ScenePlugin} This ScenePlugin object. * @return {Phaser.Scenes.ScenePlugin} This ScenePlugin object.

2
src/scene/Settings.js
View file

@ -57,7 +57,7 @@ var Settings = {
* @function Phaser.Scenes.Settings.create * @function Phaser.Scenes.Settings.create
* @since 3.0.0 * @since 3.0.0
* *
* @param {(string|Phaser.Scenes.SettingsConfig)} config - [description] * @param {(string|Phaser.Scenes.Settings.Config)} config - [description]
* *
* @return {Phaser.Scenes.Settings.Object} [description] * @return {Phaser.Scenes.Settings.Object} [description]
*/ */

6
src/scene/Systems.js
View file

@ -25,7 +25,7 @@ var Settings = require('./Settings');
* @since 3.0.0 * @since 3.0.0
* *
* @param {Phaser.Scene} scene - The Scene that owns this Systems instance. * @param {Phaser.Scene} scene - The Scene that owns this Systems instance.
* @param {(string|SettingsConfig)} config - Scene specific configuration settings. * @param {(string|Phaser.Scenes.Settings.Config)} config - Scene specific configuration settings.
*/ */
var Systems = new Class({ var Systems = new Class({
@ -55,7 +55,7 @@ var Systems = new Class({
* [description] * [description]
* *
* @name Phaser.Scenes.Systems#config * @name Phaser.Scenes.Systems#config
* @type {(string|SettingsConfig)} * @type {(string|Phaser.Scenes.Settings.Config)}
* @since 3.0.0 * @since 3.0.0
*/ */
this.config = config; this.config = config;
@ -64,7 +64,7 @@ var Systems = new Class({
* [description] * [description]
* *
* @name Phaser.Scenes.Systems#settings * @name Phaser.Scenes.Systems#settings
* @type {SettingsObject} * @type {Phaser.Scenes.Settings.Object}
* @since 3.0.0 * @since 3.0.0
*/ */
this.settings = Settings.create(config); this.settings = Settings.create(config);