Skip to content

Commit b525ecb

Browse files
photonstormphotonstorm
committed
Added jsdocs
1 parent ff1a26c commit b525ecb

12 files changed

Lines changed: 587 additions & 40 deletions

File tree

‎src/const.js‎

Lines changed: 86 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,107 @@
1-
21
var CONST = {
32

3+
/**
4+
* Phaser Release Version
5+
*
6+
* @name Phaser.VERSION
7+
* @type {string}
8+
* @since 3.0.0
9+
*/
410
VERSION: '3.0.0',
511

612
BlendModes: require('./renderer/BlendModes'),
13+
714
ScaleModes: require('./renderer/ScaleModes'),
815

16+
/**
17+
* AUTO Detect Renderer.
18+
*
19+
* @name Phaser.AUTO
20+
* @type {integer}
21+
* @since 3.0.0
22+
*/
923
AUTO: 0,
24+
25+
/**
26+
* Canvas Renderer.
27+
*
28+
* @name Phaser.CANVAS
29+
* @type {integer}
30+
* @since 3.0.0
31+
*/
1032
CANVAS: 1,
33+
34+
/**
35+
* WebGL Renderer.
36+
*
37+
* @name Phaser.WEBGL
38+
* @type {integer}
39+
* @since 3.0.0
40+
*/
1141
WEBGL: 2,
42+
43+
/**
44+
* Headless Renderer.
45+
*
46+
* @name Phaser.HEADLESS
47+
* @type {integer}
48+
* @since 3.0.0
49+
*/
1250
HEADLESS: 3,
1351

52+
/**
53+
* In Phaser the value -1 means 'forever' in lots of cases, this const allows you to use it instead
54+
* to help you remember what the value is doing in your code.
55+
*
56+
* @name Phaser.FOREVER
57+
* @type {integer}
58+
* @since 3.0.0
59+
*/
1460
FOREVER: -1,
1561

62+
/**
63+
* Direction constant.
64+
*
65+
* @name Phaser.NONE
66+
* @type {integer}
67+
* @since 3.0.0
68+
*/
1669
NONE: 4,
70+
71+
/**
72+
* Direction constant.
73+
*
74+
* @name Phaser.UP
75+
* @type {integer}
76+
* @since 3.0.0
77+
*/
1778
UP: 5,
79+
80+
/**
81+
* Direction constant.
82+
*
83+
* @name Phaser.DOWN
84+
* @type {integer}
85+
* @since 3.0.0
86+
*/
1887
DOWN: 6,
88+
89+
/**
90+
* Direction constant.
91+
*
92+
* @name Phaser.LEFT
93+
* @type {integer}
94+
* @since 3.0.0
95+
*/
1996
LEFT: 7,
97+
98+
/**
99+
* Direction constant.
100+
*
101+
* @name Phaser.RIGHT
102+
* @type {integer}
103+
* @since 3.0.0
104+
*/
20105
RIGHT: 8
21106

22107
};

‎src/renderer/BlendModes.js‎

Lines changed: 146 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,169 @@
1-
// Phaser.BlendModes
1+
/**
2+
* @namespace Phaser.BlendModes
3+
*/
24

35
module.exports = {
46

7+
/**
8+
* Skips the Blend Mode check in the renderer.
9+
*
10+
* @name Phaser.BlendModes.SKIP_CHECK
11+
* @type {integer}
12+
* @since 3.0.0
13+
*/
514
SKIP_CHECK: -1,
15+
16+
/**
17+
* Normal blend mode.
18+
*
19+
* @name Phaser.BlendModes.NORMAL
20+
* @type {integer}
21+
* @since 3.0.0
22+
*/
623
NORMAL: 0,
24+
25+
/**
26+
* Add blend mode.
27+
*
28+
* @name Phaser.BlendModes.ADD
29+
* @type {integer}
30+
* @since 3.0.0
31+
*/
732
ADD: 1,
33+
34+
/**
35+
* Multiply blend mode.
36+
*
37+
* @name Phaser.BlendModes.MULTIPLY
38+
* @type {integer}
39+
* @since 3.0.0
40+
*/
841
MULTIPLY: 2,
42+
43+
/**
44+
* Screen blend mode.
45+
*
46+
* @name Phaser.BlendModes.SCREEN
47+
* @type {integer}
48+
* @since 3.0.0
49+
*/
950
SCREEN: 3,
51+
52+
/**
53+
* Overlay blend mode.
54+
*
55+
* @name Phaser.BlendModes.OVERLAY
56+
* @type {integer}
57+
* @since 3.0.0
58+
*/
1059
OVERLAY: 4,
60+
61+
/**
62+
* Darken blend mode.
63+
*
64+
* @name Phaser.BlendModes.DARKEN
65+
* @type {integer}
66+
* @since 3.0.0
67+
*/
1168
DARKEN: 5,
69+
70+
/**
71+
* Lighten blend mode.
72+
*
73+
* @name Phaser.BlendModes.LIGHTEN
74+
* @type {integer}
75+
* @since 3.0.0
76+
*/
1277
LIGHTEN: 6,
78+
79+
/**
80+
* Color Dodge blend mode.
81+
*
82+
* @name Phaser.BlendModes.COLOR_DODGE
83+
* @type {integer}
84+
* @since 3.0.0
85+
*/
1386
COLOR_DODGE: 7,
87+
88+
/**
89+
* Color Burn blend mode.
90+
*
91+
* @name Phaser.BlendModes.COLOR_BURN
92+
* @type {integer}
93+
* @since 3.0.0
94+
*/
1495
COLOR_BURN: 8,
96+
97+
/**
98+
* Hard Light blend mode.
99+
*
100+
* @name Phaser.BlendModes.SOFT_LIGHT
101+
* @type {integer}
102+
* @since 3.0.0
103+
*/
15104
HARD_LIGHT: 9,
105+
106+
/**
107+
* Soft Light blend mode.
108+
*
109+
* @name Phaser.BlendModes.SOFT_LIGHT
110+
* @type {integer}
111+
* @since 3.0.0
112+
*/
16113
SOFT_LIGHT: 10,
114+
115+
/**
116+
* Difference blend mode.
117+
*
118+
* @name Phaser.BlendModes.DIFFERENCE
119+
* @type {integer}
120+
* @since 3.0.0
121+
*/
17122
DIFFERENCE: 11,
123+
124+
/**
125+
* Exclusion blend mode.
126+
*
127+
* @name Phaser.BlendModes.EXCLUSION
128+
* @type {integer}
129+
* @since 3.0.0
130+
*/
18131
EXCLUSION: 12,
132+
133+
/**
134+
* Hue blend mode.
135+
*
136+
* @name Phaser.BlendModes.HUE
137+
* @type {integer}
138+
* @since 3.0.0
139+
*/
19140
HUE: 13,
141+
142+
/**
143+
* Saturation blend mode.
144+
*
145+
* @name Phaser.BlendModes.SATURATION
146+
* @type {integer}
147+
* @since 3.0.0
148+
*/
20149
SATURATION: 14,
150+
151+
/**
152+
* Color blend mode.
153+
*
154+
* @name Phaser.BlendModes.COLOR
155+
* @type {integer}
156+
* @since 3.0.0
157+
*/
21158
COLOR: 15,
159+
160+
/**
161+
* Luminosity blend mode.
162+
*
163+
* @name Phaser.BlendModes.LUMINOSITY
164+
* @type {integer}
165+
* @since 3.0.0
166+
*/
22167
LUMINOSITY: 16
23168

24169
};

‎src/renderer/ScaleModes.js‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,34 @@
1+
/**
2+
* @namespace Phaser.ScaleModes
3+
*/
4+
15
module.exports = {
26

7+
/**
8+
* Default Scale Mode (Linear).
9+
*
10+
* @name Phaser.ScaleModes.DEFAULT
11+
* @type {integer}
12+
* @since 3.0.0
13+
*/
314
DEFAULT: 0,
15+
16+
/**
17+
* Linear Scale Mode.
18+
*
19+
* @name Phaser.ScaleModes.LINEAR
20+
* @type {integer}
21+
* @since 3.0.0
22+
*/
423
LINEAR: 0,
24+
25+
/**
26+
* Nearest Scale Mode.
27+
*
28+
* @name Phaser.ScaleModes.NEAREST
29+
* @type {integer}
30+
* @since 3.0.0
31+
*/
532
NEAREST: 1
633

734
};

0 commit comments

Comments
 (0)