Skip to content

Commit 11d6f2e

Browse files
committed
Renderer Types
1 parent 15abc38 commit 11d6f2e

6 files changed

Lines changed: 10 additions & 6 deletions

File tree

src/renderer/canvas/CanvasRenderer.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -158,7 +158,7 @@ var CanvasRenderer = new Class({
158158
* If a non-null `callback` is set in this object, a snapshot of the canvas will be taken after the current frame is fully rendered.
159159
*
160160
* @name Phaser.Renderer.Canvas.CanvasRenderer#snapshotState
161-
* @type {Phaser.Renderer.Snapshot.Types.SnapshotState}
161+
* @type {Phaser.Types.Renderer.Snapshot.SnapshotState}
162162
* @since 3.16.0
163163
*/
164164
this.snapshotState = {

src/renderer/index.js

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,10 @@
88
* @namespace Phaser.Renderer
99
*/
1010

11+
/**
12+
* @namespace Phaser.Types.Renderer
13+
*/
14+
1115
module.exports = {
1216

1317
Canvas: require('./canvas'),

src/renderer/snapshot/typedefs/SnapshotCallback.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/**
2-
* @callback Phaser.Renderer.Snapshot.Types.SnapshotCallback
2+
* @callback Phaser.Types.Renderer.Snapshot.SnapshotCallback
33
* @since 3.16.1
44
*
55
* @param {(Phaser.Display.Color|HTMLImageElement)} snapshot - Either a Color object if a single pixel is being grabbed, or a new Image which contains a snapshot of the canvas contents.

src/renderer/snapshot/typedefs/SnapshotState.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
/**
2-
* @typedef {object} Phaser.Renderer.Snapshot.Types.SnapshotState
2+
* @typedef {object} Phaser.Types.Renderer.Snapshot.SnapshotState
33
* @since 3.16.1
44
*
5-
* @property {Phaser.Renderer.Snapshot.Types.SnapshotCallback} callback - The function to call after the snapshot is taken.
5+
* @property {Phaser.Types.Renderer.Snapshot.SnapshotCallback} callback - The function to call after the snapshot is taken.
66
* @property {string} [type='image/png'] - The format of the image to create, usually `image/png` or `image/jpeg`.
77
* @property {number} [encoderOptions=0.92] - The image quality, between 0 and 1. Used for image formats with lossy compression, such as `image/jpeg`.
88
* @property {integer} [x=0] - The x coordinate to start the snapshot from.

src/renderer/snapshot/typedefs/index.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,5 +5,5 @@
55
*/
66

77
/**
8-
* @namespace Phaser.Renderer.Snapshot.Types
8+
* @namespace Phaser.Types.Renderer.Snapshot
99
*/

src/renderer/webgl/WebGLRenderer.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -198,7 +198,7 @@ var WebGLRenderer = new Class({
198198
* If a non-null `callback` is set in this object, a snapshot of the canvas will be taken after the current frame is fully rendered.
199199
*
200200
* @name Phaser.Renderer.WebGL.WebGLRenderer#snapshotState
201-
* @type {Phaser.Renderer.Snapshot.Types.SnapshotState}
201+
* @type {Phaser.Types.Renderer.Snapshot.SnapshotState}
202202
* @since 3.0.0
203203
*/
204204
this.snapshotState = {

0 commit comments

Comments
 (0)