Skip to content

Commit 00b7530

Browse files
committed
Explain render modes better.
1 parent cb3a649 commit 00b7530

1 file changed

Lines changed: 10 additions & 4 deletions

File tree

src/const.js

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,8 @@ var CONST = {
2727
ScaleModes: require('./renderer/ScaleModes'),
2828

2929
/**
30-
* AUTO Detect Renderer.
30+
* This setting will auto-detect if the browser is capable of suppporting WebGL.
31+
* If it is, it will use the WebGL Renderer. If not, it will fall back to the Canvas Renderer.
3132
*
3233
* @name Phaser.AUTO
3334
* @const
@@ -37,7 +38,8 @@ var CONST = {
3738
AUTO: 0,
3839

3940
/**
40-
* Canvas Renderer.
41+
* Forces Phaser to only use the Canvas Renderer, regardless if the browser supports
42+
* WebGL or not.
4143
*
4244
* @name Phaser.CANVAS
4345
* @const
@@ -47,7 +49,9 @@ var CONST = {
4749
CANVAS: 1,
4850

4951
/**
50-
* WebGL Renderer.
52+
* Forces Phaser to use the WebGL Renderer. If the browser does not support it, there is
53+
* no fallback to Canvas with this setting, so you should trap it and display a suitable
54+
* message to the user.
5155
*
5256
* @name Phaser.WEBGL
5357
* @const
@@ -57,7 +61,9 @@ var CONST = {
5761
WEBGL: 2,
5862

5963
/**
60-
* Headless Renderer.
64+
* A Headless Renderer doesn't create either a Canvas or WebGL Renderer. However, it still
65+
* absolutely relies on the DOM being present and available. This mode is meant for unit testing,
66+
* not for running Phaser on the server, which is something you really shouldn't do.
6167
*
6268
* @name Phaser.HEADLESS
6369
* @const

0 commit comments

Comments
 (0)