Phaser API Documentation

The width of the game, in game pixels.

The height of the game, in game pixels.

Simple scale applied to the game canvas. 2 is double size, 0.5 is half size, etc.

Which renderer to use. Phaser.AUTO, Phaser.CANVAS, Phaser.HEADLESS, or Phaser.WEBGL. AUTO picks WEBGL if available, otherwise CANVAS.

true or 1 = Use the built-in StableSort (needed for older browsers), false or 0 = Rely on ES2019 Array.sort being stable (modern browsers only), or -1 = Try and determine this automatically based on browser inspection (not guaranteed to work, errs on side of caution).

The DOM element that will contain the game canvas, or its id. If undefined, or if the named element doesn't exist, the game canvas is appended to the document body. If null no parent will be used and you are responsible for adding the canvas to the dom.

Provide your own Canvas element for Phaser to use instead of creating one.

CSS styles to apply to the game canvas instead of Phasers default styles.

Is Phaser running under a custom (non-native web) environment? If so, set this to true to skip internal Feature detection. If true the renderType cannot be left as AUTO.

Provide your own Canvas Context for Phaser to use, instead of creating one.

A scene or scenes to add to the game. If several are given, the first is started; the remainder are started only if they have { active: true }. See the sceneConfig argument in Phaser.Scenes.SceneManager#add.

Seed for the random number generator.

The title of the game. Shown in the browser console.

The URL of the game. Shown in the browser console.

The version of the game. Shown in the browser console.

Automatically call window.focus() when the game boots. Usually necessary to capture input events if the game is in a separate frame.

Input configuration, or false to disable all game input.

Disable the browser's default 'contextmenu' event (usually triggered by a right-button mouse click).

Configuration for the banner printed in the browser console when the game starts.

The DOM Container configuration object.

Game loop configuration.

Game renderer configuration.

Optional callbacks to run before or after game boot.

Loader configuration.

Images configuration.

Physics configuration.

Plugins to install.

The Scale Manager configuration.

The Audio Configuration object.

A WebGL Pipeline configuration object. Can also be part of the RenderConfig.

The background color of the game canvas. The default is black.

When set to true, WebGL uses linear interpolation to draw scaled or rotated textures, giving a smooth appearance. When set to false, WebGL uses nearest-neighbor interpolation, giving a crisper appearance. false also disables antialiasing of the game canvas itself, if the browser supports it, when the game canvas is scaled.

Sets the antialias property when the WebGL context is created. Setting this value does not impact any subsequent textures that are created, or the canvas style attributes.

When set to true it will create a desynchronized context for both 2D and WebGL. See https://developers.google.com/web/updates/2019/05/desynchronized for details.

Sets antialias to false and roundPixels to true. This is the best setting for pixel-art games.

Draw texture-based Game Objects at only whole-integer positions. Game Objects without textures, like Graphics, ignore this property.

Whether the game canvas will be transparent. Boolean that indicates if the canvas contains an alpha channel. If set to false, the browser now knows that the backdrop is always opaque, which can speed up drawing of transparent content and images.

Whether the game canvas will be cleared between each rendering frame.

If the value is true the WebGL buffers will not be cleared and will preserve their values until cleared or overwritten by the author.

In WebGL mode, the drawing buffer contains colors with pre-multiplied alpha.

Let the browser abort creating a WebGL context if it judges performance would be unacceptable.

"high-performance", "low-power" or "default". A hint to the browser on how much device power the game might use.

The default WebGL batch size. Represents the number of quads that can be added to a single batch.

The maximum number of lights allowed to be visible within range of a single Camera in the LightManager.

When in WebGL mode, this sets the maximum number of GPU Textures to use. The default, -1, will use all available units. The WebGL1 spec says all browsers should provide a minimum of 8.

The mipmap magFilter to be used when creating WebGL textures.

Automatically enable the Mobile Pipeline if iOS or Android detected?

The WebGL Pipeline that Game Objects will use by default. Set to 'MultiPipeline' as standard.

Is the Scale Manager allowed to adjust the CSS height property of the parent and/or document body to be 100%?

The scale mode.

The minimum width and height the canvas can be scaled down to.

The maximum width the canvas can be scaled up to.

Automatically round the display and style sizes of the canvas. This can help with performance in lower-powered devices.

Automatically center the canvas within the parent?

How many ms should elapse before checking if the browser size has changed?

The DOM element that will be sent into full screen mode, or its id. If undefined Phaser will create its own div and insert the canvas into it when entering fullscreen mode.