179 KiB
Version 3.54.0 - Futaro - in dev
Updates
- When the Scene-owned Input Plugin is shutdown (i.e. via a call to
Scene.stop
) it will now remove anyKey
objects that the plugin created, not just reset them. This is a quality-of-life breaking change from how it worked previously (thanks @veleek) - Thanks to a TS Parser update by @krotovic the JSDocs can now define
@this
tags. Fix #4669. - The
Scenes.Systems.install
method has been removed. It's no longer required and would throw an error if called. Fix #5580 (thanks @Trissolo) - The
WebAudioSoundManager.onFocus
method will now test to see if the state of theAudioContext
isinterrupted
, as happens on iOS when leaving the page, and then resumes the context. Fix #5390 #5156 #4790 (thanks @SBCGames @micsun-al @AdamXA)
Bug Fixes
- Adding a Game Object to a Container that already existed in another Container would leave a copy of it on the Display List. Fix #5618 (thanks Kromah @mariogarranz)
- Fixed missing
backgroundColor
property in GameConfig. Fix #5597 (thanks @eli-s-r) - BitmapText wouldn't render correctly with the Canvas Renderer when the texture came from a Texture Atlas. Fix #5545 (thanks @vforsh)
- #5504 had broken DOM Elements being able to be clicked due to an oversight of the DOM Container. DOM Elements now correctly pick-up the default pointer events handler. Fix #5594 (thanks @pizkaz)
- The
RGBToString
function will no longer return CSS strings with decimal places if the input contained them (thanks @neil-h) - Objects added to a
SpineContainer
were also added to the base Display List, causing them to appear twice. Fix #5599 (thanks @spayton)
Examples, Documentation and TypeScript
My thanks to the following for helping with the Phaser 3 Examples, Docs, and TypeScript definitions, either by reporting errors, fixing them, or helping author the docs:
@samme @masterT @krotovic @Kvisaz
Version 3.53.1 - Anastasia - 8th March 2021
- Fixed an issue where Container children were not removed from the display list properly.
Version 3.53.0 - Anastasia - 8th March 2021
New Features
- You can now run Phaser from within a Web Worker. You must use the
type: 'classic'
method and then useimportScripts('phaser.js')
within your workers, but it will no longer throw window errors and allows you access to lots of the core Phaser functions from Workers. Scenes.Events.PRE_RENDER
is a new event fired after the display list is sorted and before the Scene is rendered (thanks @samme)- You can now set the boolean
preserveDrawingBuffer
in the Game Config (either directly, or in the Render Config). This is passed to the WebGL context during creation and controls if the buffers are automatically cleared each frame or not. The default is to clear them. Set totrue
to retain them. GameObjects.Shape.setDisplaySize
is a new method that helps setting the display width and height of a Shape object in a chainable way. Fix #5526 (thanks @samme)Tilemaps.Parsers.Tiled.ParseTilesets
has been updated so it now retains thetype
field information that can be optionally specified within Tiled. This is useful when creating objects from tiles and tile variants (thanks @lackhand)Tilemaps.Parsers.Tiled.ParseWangsets
is a new function that will parse the Wangset information from Tiled map data, if present, and retain it so you can access the data (thanks @lackhand)WebGLPipeline.glReset
is a new boolean property that keeps track of when the GL Context was last reset by the Pipeline Manager. It then redirects calls tobind
torebind
instead to restore the pipeline state.
Display List Updates
GameObject.addToDisplayList
is a new method that allows you to add a Game Object to the given Display List. If no Display List is given, it will default to the Scene Display List. A Game Object can only exist on one Display List at any given time, but may move freely between them.GameObject.addToUpdateList
is a new method that adds the Game Object to the Update List belonging to the Scene. When a Game Object is added to the Update List it will have itspreUpdate
method called every game frame.GameObject.removeFromDisplayList
is a new method that removes the Game Object from the Display List it is currently on.GameObject.removeFromUpdateList
is a new method that removes the Game Object from the Scenes Update List.GameObject.destroy
will now call the newremoveFromDisplayList
andremoveFromUpdateList
methods.DisplayList.addChildCallback
will now use the newaddToDisplayList
andremoveFromDisplayList
Game Object methods.Container.addHandler
will now use the newaddToDisplayList
andremoveFromDisplayList
Game Object methods.Layer.addChildCallback
andremoveChildCallback
will now use the newaddToDisplayList
andremoveFromDisplayList
Game Object methods.Group
now listens for theADDED_TO_SCENE
andREMOVED_FROM_SCENE
methods and adds and removes itself from the Update List accordingly.Group.add
andcreate
now uses the newaddToDisplayList
andaddToUpdateList
Game Object methods.Group.remove
now uses the newremoveFromDisplayList
andremoveFromUpdateList
Game Object methods.Group.destroy
has a new optional boolean parameterremoveFromScene
, which will remove all Group children from the Scene if specified.
Updates
- Phaser no longer includes the IE9 polyfills. All polyfills have been removed from the core builds and moved to their own specific version called
phaser-ie9
, which can be found in thedist
folder. - All of the Device functions will now check to see if Phaser is running inside of a Web Worker, or not. If it is, they will return early, avoiding trying to make calls to
window
or other elements not present within Workers. - The Webpack loaders have been moved to dev dependencies to avoid peer issues during use of Phaser as a package (thanks @andrewstart)
- The
WebAudioSoundManager.createAudioContext
method is no longer private. - The
WebAudioSoundManager.context
property is no longer private. - The
WebAudioSoundManager.masterMuteNode
property is no longer private. - The
WebAudioSoundManager.masterVolumeNode
property is no longer private. - The
WebAudioSoundManager.destination
property is no longer private. - The
WebAudioSound.audioBuffer
property is no longer private. - The
WebAudioSound.source
property is no longer private. - The
WebAudioSound.loopSource
property is no longer private. - The
WebAudioSound.muteNode
property is no longer private. - The
WebAudioSound.volumeNode
property is no longer private. - The
WebAudioSound.pannerNode
property is no longer private. - The
WebAudioSound.hasEnded
property is no longer private, but is read only. - The
WebAudioSound.hasLooped
property is no longer private, but is read only. - The
WebAudioSoundManager.createAudioContext
method will now usewebkitAudioContext
if defined inwindow
(rather than using the polyfill) to handle audio on Safari. - If a loaded JSON File fails to parse it will now issue a console warning along with the file key (thanks @samme)
- The Canvas Renderer will no longer run a
fillRect
ifclearBeforeRender
isfalse
in the Game Config. - The
LightsManager.addPointlight
method now has full JSDocs and theattenuation
parameter. LightPipeline.lightsActive
is a new boolean property that keeps track if the Lights Manager in a Scene is active, or not.- The
LightPipeline
now only callsbatchSprite
,batchTexture
andbatchTextureFrame
if the Scene Lights Manager is active. Fix #5522 (thanks @inmylo) - The Tiled Parser has been updated so it now supports object properties defined in an array with name / type values (thanks @veleek)
LineCurve.getTangent
can now take an output vector to receive the tangent value (thanks @samme)DOMElementCSSRenderer
no longer sets thepointerEvents
style attribute toauto
. This is the default value anyway and it now means you can override it from your code by setting thepointer-events
attribute directly. Fix #5470 (thanks @hayatae @endel)SceneManager.loadComplete
will no longer try to unlock the Sound Manager, preventingAudioContext was not allowed to start
console warnings after each Scene finishes loading.WebGLRenderer.deleteTexture
will now runresetTextures(true)
first, incase the requested texture to be deleted is currently bound. Previously, it would delete the texture and then reset them.- If
TextureSource.destroy
has a WebGL Texture it will tell the WebGL Renderer to reset the textures first, before deleting its texture. Cameras.Controls.FixedKeyControl.minZoom
is a new configurable property that sets the minimum camera zoom. Default to 0.001 (thanks @samme)Cameras.Controls.FixedKeyControl.maxZoom
is a new configurable property that sets the maximum camera zoom. Default to 1000 (thanks @samme)Cameras.Controls.SmoothedKeyControl.minZoom
is a new configurable property that sets the minimum camera zoom. Default to 0.001 (thanks @samme)Cameras.Controls.SmoothedKeyControl.maxZoom
is a new configurable property that sets the maximum camera zoom. Default to 1000 (thanks @samme)- The
WebGLPipeline.rebind
method now accepts an optional parametercurrentShader
. If provided it will set the current shader to be this after the pipeline reset is complete. - The
PipelineManager.rebind
method will now flag all pipelines asglReset = true
, so they know to fully rebind the next time they are invoked.
Bug Fixes
BlitterWebGLRenderer
was calling an out-dated functionsetRenderDepth
instead ofaddToRenderList
(thanks Harm)- When a loaded JSON file fails to parse, it's marked
FILE_ERRORED
and the Loader continues. Before this change the Loader would stall (thanks @samme) Math.FromPercent
silently assumed themin
parameter to be 0. It can now be any value, allowing you to generate percentages betweenmin
andmax
correctly (thanks @somechris)- The Container and Zone Game Objects were not handling being added to the render list, causing them to fail input detection tests. Fix #5506 #5508 (thanks @rexrainbow @vforsh @Nightspeller)
IsometricWorldToTileXY
was returning a tile incorrectly offset from the given coordinates. It now returns from the expected location (thanks @veleek)DOMElementCSSRenderer
will now return early ifsrc.node
doesn't exist or is null, rather than trying to extract thestyle
property from it. Fix #5566 (thanks @rattias)- The BitmapMask will now check to see if
renderer
exists before trying to hook to its event emitter (thanks @mattjennings) - TileSprite will now check to see if
renderer
exists before trying to restore itself during a context loss (thanks @mattjennings) - A Texture will now check to see if
renderer
exists before resetting the WebGL textures (thanks @mattjennings) - Destroying a Text Game Object when using the HEADLESS renderer would cause an
Uncaught TypeError
. Fix #5558 (thanks @mattjennings) - The
Actions.PlayAnimation
arguments have been updated to match the new animation system introduced in Phaser 3.50. It will now take either a string-key, or a play animation configuration object, and thestartFrame
parameter has been replaced withignoreIfPlaying
. The function will also only callplay
if the Game Object has an animation component, meaning you can now supply this action with a mixed-content array without errors. Fix #5555 (thanks @xuxucode) RenderTarget.resize
will nowMath.floor
the scaled width and height as well as ensure they're not <= 0 which causesFramebuffer status: Incomplete Attachment
errors. Fix #5563 #5478 (thanks @orjandh @venarius)Matter.Components.Sleep.setToSleep
andsetAwake
were documented as returningthis
, however they didn't return anything. Both nowreturn this
correctly. Fix #5567 (thanks @micsun-al)- The Particle position would be wrong when set to follow a Sprite using the Canvas Renderer. Fix #5457 (thanks @samme)
- Fixed a conditional bug in Arcade Physics
ProcessX
when Body2 is Immovable and Body1 is not. - The Spine Plugin would throw an error while unloading and restarting the game. Fix #5477 (thanks @ayamomiji @Pong420)
- The Spine Plugin would cause all textures to render as blue if a Spine object followed any Game Object using the Graphics Pipeline on the display list, due to the gl context restoration not being properly handled. Fix #5493 #5449 (thanks @EmilSV @FloodGames)
- Spine Game Objects and Containers will now add themselves to the Camera render list, fixing issues where input didn't work if depth was used or they were overlapped with another interactive Game Object.
- Calling
Group.destroy
would cause a runtime error ifGroup.runChildUpdate
had been set. Fix #5576 (thanks @samme) - Moving a Sprite from a Container or Layer to the Scene would fail without first resetting the display list. Fix #5535 (thanks @malahaas @samme @tringcooler)
Examples, Documentation and TypeScript
My thanks to the following for helping with the Phaser 3 Examples, Docs, and TypeScript definitions, either by reporting errors, fixing them, or helping author the docs:
@edemaine @xuxucode @schontz @kaktus42 @Nero0 @samme
Version 3.52.0 - Crusch - 14th January 2021
New Features
- The
getPostPipeline
method available on most Game Objects will now return an array of piplines if an instance is given and the Game Object has more than one of those pipelines set on it. If only one pipeline is set, it will be returned directly.
Updates
BaseCamera.renderList
is a new array that is populated with all Game Objects that the camera has rendered in the current frame. It is automatically cleared duringCamera.preUpdate
and is an accurate representation of the Game Objects the Camera rendered. It's used internally by the Input Plugin, but exposed should you wish to read the contents or use it for profiling.BaseCamera.addToRenderList
is a new method that will add the given Game Object to the Cameras current render list.- The
InputPlugin.sortGameObjects
method now uses the new Camera render list to work out the display index depths. - The
InputPlugin.sortDropZones
method is a new method, based on the oldsortGameObjects
method that is used for sorting input enabled drop zones. - The background color behind the game url in the banner is now transparent, so it looks correct with dark dev tools themes (thanks @kainage)
Bug Fixes
WebAudioSound.destroy
now checks to see ifpannerNode
exists before disabling it, preventing an error in Safari (thanks @jdcook)- Fixed the cause of
Uncaught TypeError: Cannot read property 'getIndex' of null
by checking the display list property securely. Fix #5489 (thanks @actionmoon) - Fixed an issue where adding input-enabled Game Objects to a Layer would have the input system ignore their depth settings. Fix #5483 (thanks @pr4xx)
- The method
TilemapLayer.weightedRandomize
has changed so that the parameterweightedIndexes
is now first in the method and is non-optional. Previously, it was the 5th parameter and incorrectly flagged as optional. This change was made to the docs but not the parameters, but now works according to the docs (thanks Fantasix) - The Mesh
GenerateVerts
function was returning an object with the propertyverts
instead ofvertices
as expected by theMesh.addVertices
method. It now returns the correct name (thanks @lackhand) AtlasJSONFile
will now callFile.pendingDestroy
, clearing up the resources it used during load and emitting a missingFILE_COMPLETE
event. Fix #5495 (thanks @mikuso)AtlasJSONFile
,AtlasXMLFile
,BitmapFontFile
andUnityAtlasFile
will now callFile.pendingDestroy
, clearing up the resources it used during load and emiting a missingFILE_COMPLETE
event. Fix #5495 (thanks @mikuso)- Some Bitmap Text fonts were not rendering under Canvas due to the way in which the texture offset was calculated. It now uses the
__BASE
frame to get the texture offset, rather than the first frame in the set. Fix #5462 #5501 (thanks @monteiz @DPMakerQB)
Examples, Documentation and TypeScript
My thanks to the following for helping with the Phaser 3 Examples, Docs, and TypeScript definitions, either by reporting errors, fixing them, or helping author the docs:
@ygongdev Tucker @lackhand
Version 3.51.0 - Emilia - 5th January 2021
New Features
WebGLRenderer.isTextureClean
is a new boolean property that tracks of all of the multi-textures are in a clean 'default' state, to avoid lots of gl texture binds and activations during a Scene restart or destruction process.GameObject.removePostPipeline
would previously only remove a single pipeline instance. Calling the method with a class will now clear all instances of the pipeline class from the Game Object (thanks @rexrainbow)
Updates
Layer.destroy
will now calldestroy
on all of its children as well.- The
Layer
Game Object has been given all of the missing properties and methods from Game Object to make the class shapes identical. This includes the propertiesparentContainer
,tabIndex
,input
andbody
. You cannot set any of these properties, they are ignored by the Layer itself. It also includes the methods:setInteractive
,disableInteractive
andremoveInteractive
. A Layer cannot be enabled for input or have a physics body. Fix #5459 (thanks @PhaserEditor2D) Layer.getIndexList
is a new method, taken from the Game Object, that will return the index of the Layer in the display list, factoring in any parents.
Bug Fixes
- On some keyboards it was possible for the
keyup
event to not fire because it was filtered out by the Keyboard Plugin repeat key check. Fix #5472 (thanks @cjw6k) - Fixed issue causing
Cannot read property 'pipelines' of null
to be thrown if using 3.50 with the HEADLESS renderer. Fix #5468 (thanks @Grenagar) - Canvas Tilemap Rendering is now working again. Fix #5480 (thanks @marshmn)
Layer.destroy
will now emit theDESTROY
event at the start of the method. Fix #5466 (thanks @samme)- The error
RENDER WARNING: there is no texture bound to the unit ...
would be thrown when trying to restart a Scene. When a Scene is shutdown is will now reset the WebGL Texture cache. Fix #5464 (thanks @ffx0s) - The error
RENDER WARNING: there is no texture bound to the unit ...
would be thrown when destroying a Text Game Object, or any Game Object that uses its own custom texture. Destroying such an object will now reset the WebGL Texture cache. Fix #5464 (thanks @mark-rushakoff) - When using an asset pack with a prefix, and loading a Spine file, the prefix was being appended twice causing the texture to fail loading. It's now appended correctly (thanks @jdcook)
Examples, Documentation and TypeScript
My thanks to the following for helping with the Phaser 3 Examples, Docs, and TypeScript definitions, either by reporting errors, fixing them, or helping author the docs:
@pol0nium @ErinLMoore @umi-tyaahan @nk9
Version 3.50.1 - Subaru - 21st December 2020
- The new Web Audio Panning feature breaks WebAudio on Safari (OSX and iOS). The stero panner node is now only created if supported. Fix #5460 (thanks @d4rkforce)
Version 3.50.0 - Subaru - 16th December 2020
Due to the massive amount of changes in 3.50 this Change Log is, by its nature, very long. It's important to scan through it, especially if you're porting a game from an earlier version of Phaser to 3.50. However, if you're after more top-level descriptions of what's new, with example code, then please see the posts we will be making to the Phaser site and Phaser Patreon in the coming months after release. We have also updated the Phaser 3 Examples site, so that every single example up there has been rewritten for 3.50, so you don't have to struggle working through old or deprecated syntax. Virtually all new features are covered in new examples, as well.
With that said, we've tried to organize the Change Log into commonly themed sections to make it more digestible, but we appreciate there is a lot here. Please don't feel overwhelmed! If you need clarification about something, join us on the Phaser Discord and feel free to ask.
WebGL Pipelines and Post Processing
WebGL Pipelines are responsible for the rendering of all Game Objects in Phaser and they have had a complete rewrite in 3.50. This was to allow for the introduction of post processing pipelines, now readily available to be created from the new Post FX Pipeline class. The changes in this area have been extensive, so if you use custom WebGL Pipelines in your game already, you must update your code to use Phaser 3.50.
Pipeline Manager
The WebGL.PipelineManager
is a new class that is responsible for managing all of the WebGL Pipelines in Phaser. An instance of the Pipeline Manager is created by the WebGL Renderer and is available under the pipelines
property. This means that the WebGL Renderer no longer handles pipelines directly, causing the following API changes:
WebGLRenderer.pipelines
is no longer a plain object containing pipeline instances. It's now an instance of thePipelineManager
class. This instance is created during the init and boot phase of the renderer.- The
WebGLRenderer.currentPipeline
property no longer exists, instead usePipelineManager.current
. - The
WebGLRenderer.previousPipeline
property no longer exists, instead usePipelineManager.previous
. - The
WebGLRenderer.hasPipeline
method no longer exists, instead usePipelineManager.has
. - The
WebGLRenderer.getPipeline
method no longer exists, instead usePipelineManager.get
. - The
WebGLRenderer.removePipeline
method no longer exists, instead usePipelineManager.remove
. - The
WebGLRenderer.addPipeline
method no longer exists, instead usePipelineManager.add
. - The
WebGLRenderer.setPipeline
method no longer exists, instead usePipelineManager.set
. - The
WebGLRenderer.rebindPipeline
method no longer exists, instead usePipelineManager.rebind
. - The
WebGLRenderer.clearPipeline
method no longer exists, instead usePipelineManager.clear
.
The Pipeline Manager also offers the following new features:
- The
PipelineManager.resize
method automatically handles resize events across all pipelines. - The
PipelineManager.preRender
method calls the pre-render method of all pipelines. - The
PipelineManager.render
method calls the render method of all pipelines. - The
PipelineManager.postRender
method calls the post-render method of all pipelines. - The
PipelineManager.setMulti
method automatically binds the Multi Texture Pipeline, Phasers default. - The
PipelineManager.clear
method will clear the pipeline, store it inprevious
and free the renderer. - The
PipelineManager.rebind
method will reset the rendering context and restore theprevious
pipeline, if set. - The
PipelineManager.copyFrame
method will copy asource
Render Target to thetarget
Render Target, optionally setting the brightness of the copy. - The
PipelineManager.blitFrame
method will copy asource
Render Target to thetarget
Render Target. UnlikecopyFrame
no resizing takes place and you can optionally set the brightness and erase mode of the copy. - The
PipelineManager.copyFrameRect
method binds thesource
Render Target and then copies a section of it to thetarget
usinggl.copyTexSubImage2D
rather than a shader, making it much faster if you don't need blending or preserving alpha details. - The
PipelineManager.copyToGame
method pops the framebuffer from the renderers FBO stack and sets that as the active target, then draws thesource
Render Target to it. Use when you need to render the final result to the game canvas. - The
PipelineManager.drawFrame
method will copy asource
Render Target, optionally to atarget
Render Target, using the given ColorMatrix, allowing for full control over the luminance values used during the copy. - The
PipelineManager.blendFrames
method draws thesource1
andsource2
Render Targets to thetarget
Render Target using a linear blend effect, which is controlled by thestrength
parameter. - The
PipelineManager.blendFramesAdditive
method draws thesource1
andsource2
Render Targets to thetarget
Render Target using an additive blend effect, which is controlled by thestrength
parameter. - The
PipelineManager.clearFrame
method clears the given Render Target.
New constants have been created to help you reference a pipeline without needing to use strings:
Phaser.Renderer.WebGL.Pipelines.BITMAPMASK_PIPELINE
for the Bitmap Mask Pipeline.Phaser.Renderer.WebGL.Pipelines.LIGHT_PIPELINE
for the Light 2D Pipeline.Phaser.Renderer.WebGL.Pipelines.SINGLE_PIPELINE
for the Single Pipeline.Phaser.Renderer.WebGL.Pipelines.MULTI_PIPELINE
for the Multi Pipeline.Phaser.Renderer.WebGL.Pipelines.ROPE_PIPELINE
for the Rope Pipeline.Phaser.Renderer.WebGL.Pipelines.POINTLIGHT_PIPELINE
for the Point Light Pipeline.Phaser.Renderer.WebGL.Pipelines.POSTFX_PIPELINE
for the Post FX Pipeline.Phaser.Renderer.WebGL.Pipelines.UTILITY_PIPELINE
for the Utility Pipeline.
All Game Objects have been updated to use the new constants and Pipeline Manager.
Post FX Pipeline
The Post FX Pipeline is a brand new and special kind of pipeline specifically for handling post processing effects in Phaser 3.50.
Where-as a standard Pipeline allows you to control the process of rendering Game Objects by configuring the shaders and attributes used to draw them, a Post FX Pipeline is designed to allow you to apply processing after the Game Object/s have been rendered.
Typical examples of post processing effects are bloom filters, blurs, light effects and color manipulation.
The pipeline works by creating a tiny vertex buffer with just one single hard-coded quad in it. Game Objects can have a Post Pipeline set on them, which becomes their own unique pipeline instance. Those objects are then rendered using their standard pipeline, but are redirected to the Render Targets owned by the post pipeline, which can then apply their own shaders and effects, before passing them back to the main renderer.
The following properties and methods are available in the new PostFXPipeline
class:
- The
PostFXPipeline.gameObject
property is a reference to the Game Object that owns the Post Pipeline, if any. - The
PostFXPipeline.colorMatrix
property is a Color Matrix instance used by the draw shader. - The
PostFXPipeline.fullFrame1
property is a reference to thefullFrame1
Render Target that belongs to the Utility Pipeline, as it's commonly used in post processing. - The
PostFXPipeline.fullFrame2
property is a reference to thefullFrame2
Render Target that belongs to the Utility Pipeline, as it's commonly used in post processing. - The
PostFXPipeline.halfFrame1
property is a reference to thehalfFrame1
Render Target that belongs to the Utility Pipeline, as it's commonly used in post processing. - The
PostFXPipeline.halfFrame2
property is a reference to thehalfFrame2
Render Target that belongs to the Utility Pipeline, as it's commonly used in post processing. - The
PostFXPipeline.copyFrame
method will copy asource
Render Target to thetarget
Render Target, optionally setting the brightness of the copy. - The
PostFXPipeline.blitFrame
method will copy asource
Render Target to thetarget
Render Target. UnlikecopyFrame
no resizing takes place and you can optionally set the brightness and erase mode of the copy. - The
PostFXPipeline.copyFrameRect
method binds thesource
Render Target and then copies a section of it to thetarget
usinggl.copyTexSubImage2D
rather than a shader, making it much faster if you don't need blending or preserving alpha details. - The
PostFXPipeline.copyToGame
method pops the framebuffer from the renderers FBO stack and sets that as the active target, then draws thesource
Render Target to it. Use when you need to render the final result to the game canvas. - The
PostFXPipeline.drawFrame
method will copy asource
Render Target, optionally to atarget
Render Target, using the given ColorMatrix, allowing for full control over the luminance values used during the copy. - The
PostFXPipeline.blendFrames
method draws thesource1
andsource2
Render Targets to thetarget
Render Target using a linear blend effect, which is controlled by thestrength
parameter. - The
PostFXPipeline.blendFramesAdditive
method draws thesource1
andsource2
Render Targets to thetarget
Render Target using an additive blend effect, which is controlled by thestrength
parameter. - The
PostFXPipeline.clearFrame
method clears the given Render Target. - The
PostFXPipeline.bindAndDraw
method binds this pipeline and draws thesource
Render Target to thetarget
Render Target. This is typically the final step taken in when post processing.
Renamed WebGL Pipelines
Due to the huge amount of work that has taken place in this area, all of the pipelines have been renamed. If you extend any of these pipelines or use them in your game code (referenced by name), then please update accordingly. The name changes are:
TextureTintPipeline
is now called theMultiPipeline
.TextureTintStripPipeline
is now called theRopePipeline
.ForwardDiffuseLightPipeline
is now called theLightPipeline
.
There is also the new GraphicsPipeline
. Previously, the TextureTintPipeline
was responsible for rendering all Sprites, Graphics, and Shape objects. Now, it only renders Sprites. All Graphics and Shapes are handled by the new GraphicsPipeline
, which uses its own shaders. See below for details about this change.
To match the new pipeline names, the shader source code has also been renamed.
ForwardDiffuse.frag
is now calledLight.frag
.TextureTint.frag
is now calledMulti.frag
.TextureTint.vert
is now calledMulti.vert
.
WebGL Pipelines Updates
Further pipeline changes are as follows:
- None of the shaders or pipelines use the
uViewMatrix
anduModelMatrix
uniforms any longer. These were always just plain identity matrices, so there is no point spending CPU and GPU time to set them as uniforms or use them in the shaders. Should you need these uniforms, you can add them to your own custom pipelines. Types.Renderer.WebGL.WebGLPipelineConfig
is a new TypeDef that helps you easily configure your own Custom Pipeline when using TypeScript and also provides better JSDocs.Types.Renderer.WebGL.WebGLPipelineAttributesConfig
is a new TypeDef that helps you easily configure the attributes for your own Custom Pipelines when using TypeScript and also provides better JSDocs.- All pipelines will now work out the
renderer
property automatically, so it's no longer required in the config. - All pipelines will now work out the
gl
property automatically, so it's no longer required in the config. - All pipelines will now extract the
name
property from the config, allowing you to set it externally. - All pipelines will now extract the
vertexCapacity
property from the config, allowing you to set it externally. - All pipelines will now extract the
vertexSize
property from the config, allowing you to set it externally. - All pipelines will now extract the
vertexData
property from the config, allowing you to set it externally. - All pipelines will now extract the
attributes
property from the config, allowing you to set it externally. - All pipelines will now extract the
topology
property from the config, allowing you to set it externally. - The
WebGLPipeline.shouldFlush
method now accepts an optional parameteramount
. If given, it will returntrue
if the amount to be added to the vertex count exceeds the vertex capacity. The Multi Pipeline has been updated to now use this method instead of performing the comparison multiple times itself. - The
RopePipeline
now extendsMultiPipeline
and just changes the topology, vastly reducing the file size. - The
WebGLPipeline.flushLocked
property has been removed. A pipeline can never flush in the middle of a flush anyway, so it was just wasting CPU cycles being set. WebGLPipeline.manager
is a new property that is a reference to the WebGL Pipeline Manager.WebGLPipeline.currentUnit
is a new property that holds the most recently assigned texture unit. Treat as read-only.WebGLPipeline.forceZero
is a new boolean property that sets if the pipeline should force the use of texture zero.WebGLPipeline.hasBooted
is a new boolean property that is set once the pipeline has finished setting itself up and has booted.WebGLPipeline.isPostFX
is a new boolean property that is only set by Post FX Pipelines to help identify them.WebGLPipeline.renderTargets
is a new property that holds an array of WebGL Render Targets belonging to the pipeline.WebGLPipeline.currentRenderTarget
is a new property that holds a reference to the currently bound Render Target.WebGLPipeline.shaders
is a new property that holds an array of all WebGLShader instances that belong to the pipeline.WebGLPipeline.currentShader
is a new property that holds a reference to the currently active shader within the pipeline.WebGLPipeline.config
is a new property that holds the pipeline configuration object used to create it.WebGLPipeline.projectionMatrix
is a new property that holds a Matrix4 used as the projection matrix for the pipeline.WebGLPipeline.setProjectionMatrix
is a new method that allows you to set the ortho projection matrix of the pipeline.WebGLPipeline.boot
will now check all of the attributes and store the pointer location within the attribute entry.WebGLPipeline.bind
no longer looks-up and enables every attribute, every frame. Instead, it uses the cached pointer location stored in the attribute entry, cutting down on redundant WebGL operations.WebGLPipeline.setAttribPointers
is a new method that will set the vertex attribute pointers for the pipeline.WebGLPipeline.setShader
is a new method that allows you to set the currently active shader within the pipeline.WebGLPipeline.getShaderByName
is a new method that allows you to get a shader from the pipeline based on its name.WebGLPipeline.setShadersFromConfig
is a new method that destroys all current shaders and creates brand new ones parsed from the given config object. This is part of the pipeline boot process, but also exposed should you need to call it directly.WebGLPipeline.setGameObject
is a new method that custom pipelines can use in order to perform pre-batch tasks for the given Game Object.WebGLPipeline.setVertexBuffer
is a new method that checks if the pipelines vertex buffer is active, or not, and if not, binds it as the active buffer. This used to be performed by the WebGL Renderer, but pipelines now manage this directly.WebGLPipeline.preBatch
is a new method that is called when a new quad is about to be added to the batch. This is used by Post FX Pipelines to set frame buffers.WebGLPipeline.postBatch
is a new method that is called after a quad has been added to the batch. This is used by Post FX Pipelines to apply post processing.WebGLPipeline.unbind
is a new method that unbinds the current Render Target, if one is set.WebGLPipeline.batchVert
is a new method that adds a single vertex to the vertex buffer and increments the count by 1.WebGLPipeline.batchQuad
is a new method that adds a single quad (6 vertices) to the vertex buffer and increments the count, flushing first if adding the quad would exceed the batch limit.WebGLPipeline.batchTri
is a new method that adds a single tri (3 vertices) to the vertex buffer and increments the count, flushing first if adding the tri would exceed the batch limit.WebGLPipeline.drawFillRect
is a new method that pushes a filled rectangle into the vertex batch.WebGLPipeline.setTexture2D
is a new method that sets the texture to be bound to the next available texture unit.WebGLPipeline.bindTexture
is a new method that immediately activates the given WebGL Texture and binds it to the requested slot.WebGLPipeline.bindRenderTarget
is a new method that binds the given Render Target to a given texture slot.WebGLPipeline.setTime
is a new method that gets the current game loop duration to the given shader uniform.
Pipeline Hooks
The WebGLPipeline
class has lots of new hooks you can use. These are all empty by default so you can safely override them in your own classes to take advantage of them:
WebGLPipeline.onBoot
is a new hook you can override in your own pipelines that is called when the pipeline has booted.WebGLPipeline.onResize
is a new hook you can override in your own pipelines that is called when the pipeline is resized.WebGLPipeline.onDraw
is a new hook you can override in your own pipelines that is called by Post FX Pipelines every timepostBatch
is invoked.WebGLPipeline.onActive
is a new hook you can override in your own pipelines that is called every time the Pipeline Manager makes the pipeline the active pipeline.WebGLPipeline.onBind
is a new hook you can override in your own pipelines that is called every time a Game Object asks the Pipeline Manager to use this pipeline, even if it's already active.WebGLPipeline.onRebind
is a new hook you can override in your own pipelines that is called every time the Pipeline Manager needs to reset and rebind the current pipeline.WebGLPipeline.onBatch
is a new hook you can override in your own pipelines that is called after a new quad (or tri) has been added to the batch.WebGLPipeline.onPreBatch
is a new hook you can override in your own pipelines that is called before a new Game Object is about to process itself through the batch.WebGLPipeline.onPostBatch
is a new hook you can override in your own pipelines that is called after a new Game Object has added itself to the batch.WebGLPipeline.onPreRender
is a new hook you can override in your own pipelines that is called once, per frame, right before anything has been rendered.WebGLPipeline.onRender
is a new hook you can override in your own pipelines that is called once, per frame, by every Camera in the Scene that wants to render, at the start of the render process.WebGLPipeline.onPostRender
is a new hook you can override in your own pipelines that is called once, per frame, after all rendering has happened and snapshots have been taken.WebGLPipeline.onBeforeFlush
is a new hook you can override in your own pipelines that is called immediately before thegl.bufferData
andgl.drawArrays
calls are made, so you can perform any final pre-render modifications.WebGLPipeline.onAfterFlush
is a new hook you can override in your own pipelines that is called aftergl.drawArrays
, so you can perform additional post-render effects.
Pipeline Events
The WebGLPipeline
class now extends the Event Emitter and emits the following new events:
- The
WebGL.Pipelines.Events.AFTER_FLUSH
event is dispatched by a WebGL Pipeline right after it has issued adrawArrays
command. - The
WebGL.Pipelines.Events.BEFORE_FLUSH
event is dispatched by a WebGL Pipeline right before it is about to flush. - The
WebGL.Pipelines.Events.BIND
event is dispatched by a WebGL Pipeline when it is bound by the Pipeline Manager. - The
WebGL.Pipelines.Events.BOOT
event is dispatched by a WebGL Pipeline when it has finished booting. - The
WebGL.Pipelines.Events.DESTROY
event is dispatched by a WebGL Pipeline when it begins its destruction process. - The
WebGL.Pipelines.Events.REBIND
event is dispatched by a WebGL Pipeline when the Pipeline Manager resets and rebinds it. - The
WebGL.Pipelines.Events.RESIZE
event is dispatched by a WebGL Pipeline when it is resized, usually as a result of the Renderer.
Pipeline Uniform Changes
WebGLShaders have a uniforms
object that is automatically populated when the shader is created. It scans all of the active uniforms from the compiled shader and then builds an object containing their WebGLUniformLocation
and a value cache.
This saves redundant gl operations for both looking-up uniform locations and setting their values if they're already the currently set values by using the local cache instead.
The WebGLPipeline
classes offer a means to set uniform values on the shader (or shaders) belonging to the pipeline. Previously, calling a method such as setFloat3
on a pipeline would pass that call over to WebGLRenderer
. The renderer would first check to see if the pipeline program was current, and if not, make it so, before then looking up the uniform location and finally setting it. This is a lot of steps to take for pipelines that potentially need to change uniforms for every Game Object they render.
Under the new methods, and using the new pre-cached uniform locations and values, these extra steps are skipped. The uniform value is set directly, no shader binding takes place and no location look-up happens. This dramatically reduces the number of WebGL ops being issued per frame. To clearly differentiate these pipeline methods, we have renamed them. The new method names are as follows:
WebGLPipeline.set1f
will set a 1f uniform based on the given name.WebGLPipeline.set2f
will set a 2f uniform based on the given name.WebGLPipeline.set3f
will set a 3f uniform based on the given name.WebGLPipeline.set4f
will set a 4f uniform based on the given name.WebGLPipeline.set1fv
will set a 1fv uniform based on the given name.WebGLPipeline.set2fv
will set a 2fv uniform based on the given name.WebGLPipeline.set3fv
will set a 3fv uniform based on the given name.WebGLPipeline.set4fv
will set a 4fv uniform based on the given name.WebGLPipeline.set1iv
will set a 1iv uniform based on the given name.WebGLPipeline.set2iv
will set a 2iv uniform based on the given name.WebGLPipeline.set3iv
will set a 3iv uniform based on the given name.WebGLPipeline.set4iv
will set a 4iv uniform based on the given name.WebGLPipeline.set1i
will set a 1i uniform based on the given name.WebGLPipeline.set2i
will set a 2i uniform based on the given name.WebGLPipeline.set3i
will set a 3i uniform based on the given name.WebGLPipeline.set4i
will set a 4i uniform based on the given name.WebGLPipeline.setMatrix2fv
will set a matrix 2fv uniform based on the given name.WebGLPipeline.setMatrix3fv
will set a matrix 3fv uniform based on the given name.WebGLPipeline.setMatrix4fv
will set a matrix 4fv uniform based on the given name.
If your code uses any of the old method names, please update them using the list below:
WebGLPipeline.setFloat1
has been removed. Please useset1f
instead.WebGLPipeline.setFloat2
has been removed. Please useset2f
instead.WebGLPipeline.setFloat3
has been removed. Please useset3f
instead.WebGLPipeline.setFloat4
has been removed. Please useset4f
instead.WebGLPipeline.setFloat1v
has been removed. Please useset1fv
instead.WebGLPipeline.setFloat2v
has been removed. Please useset2fv
instead.WebGLPipeline.setFloat3v
has been removed. Please useset3fv
instead.WebGLPipeline.setFloat4v
has been removed. Please useset4fv
instead.WebGLPipeline.setInt1
has been removed. Please useset1i
instead.WebGLPipeline.setInt2
has been removed. Please useset2i
instead.WebGLPipeline.setInt3
has been removed. Please useset3i
instead.WebGLPipeline.setInt4
has been removed. Please useset4i
instead.WebGLPipeline.setMatrix1
has been removed. Please usesetMatrix2fv
instead.WebGLPipeline.setMatrix2
has been removed. Please usesetMatrix3fv
instead.WebGLPipeline.setMatrix3
has been removed. Please usesetMatrix4fv
instead.
Game Object Pipeline Component Updates
To support the new Post Pipelines in 3.50, the Pipeline Component which most Game Objects inherit has been updated. That means the following new properties and methods are available on all Game Objects that have this component, such as Sprite, Layer, Rope, etc.
hasPostPipeline
is a new boolean property that indicates if the Game Object has one, or more post pipelines set.postPipelines
is a new property that contains an array of Post Pipelines owned by the Game Object.pipelineData
is a new object object to store pipeline specific data in.- The
setPipeline
method has been updated with 2 new parameters:pipelineData
andcopyData
. These allow you to populate the pipeline data object during setting. - You can now pass a pipeline instance to the
setPipeline
method, as well as a string. setPostPipeline
is a new method that allows you to set one, or more, Post FX Pipelines on the Game Object. And optionally set the pipeline data with them.setPipelineData
is a new method that allows you to set a key/value pair into the pipeline data object in a chainable way.getPostPipeline
is a new method that will return a Post Pipeline instance from the Game Object based on the given string, function or instance.- The
resetPipeline
method has two new parametersresetPostPipeline
andresetData
, both false by default, that will reset the Post Pipelines and pipeline data accordingly. resetPostPipeline
is a new method that will specifically reset just the Post Pipelines, and optionally the pipeline data.removePostPipeline
is a new method that will destroy and remove the given Post Pipeline from the Game Object.
Utility Pipeline
The Utility Pipeline is a brand new default special-use WebGL Pipeline that is created by and belongs to the Pipeline Manager.
It provides 4 shaders and handy associated methods:
- Copy Shader. A fast texture to texture copy shader with optional brightness setting.
- Additive Blend Mode Shader. Blends two textures using an additive blend mode.
- Linear Blend Mode Shader. Blends two textures using a linear blend mode.
- Color Matrix Copy Shader. Draws a texture to a target using a Color Matrix.
You do not extend this pipeline, but instead get a reference to it from the Pipeline Manager via the setUtility
method. You can also access its methods, such as copyFrame
, directly from both the Pipeline Manager and from Post FX Pipelines, where its features are most useful.
This pipeline provides methods for manipulating framebuffer backed textures, such as copying or blending one texture to another, copying a portion of a texture, additively blending two textures, flipping textures and more. All essential and common operations for post processing.
The following properties and methods are available in the new UtilityPipeline
class:
- The
UtilityPipeline.colorMatrix
property is an instance of a ColorMatrix class, used by the draw shader. - The
UtilityPipeline.copyShader
property is a reference to the Copy Shader. - The
UtilityPipeline.addShader
property is a reference to the additive blend shader. - The
UtilityPipeline.linearShader
property is a reference to the linear blend shader. - The
UtilityPipeline.colorMatrixShader
property is a reference to the color matrix (draw) shader. - The
UtilityPipeline.fullFrame1
property is a full sized Render Target that can be used as a temporary buffer during post processing calls. - The
UtilityPipeline.fullFrame2
property is a full sized Render Target that can be used as a temporary buffer during post processing calls. - The
UtilityPipeline.halfFrame1
property is a half sized Render Target that can be used as a temporary buffer during post processing calls, where a small texture is required for more intensive operations. - The
UtilityPipeline.halfFrame2
property is a half sized Render Target that can be used as a temporary buffer during post processing calls, where a small texture is required for more intensive operations. - The
UtilityPipeline.copyFrame
method will copy asource
Render Target to thetarget
Render Target, optionally setting the brightness of the copy. - The
UtilityPipeline.blitFrame
method will copy asource
Render Target to thetarget
Render Target. UnlikecopyFrame
no resizing takes place and you can optionally set the brightness and erase mode of the copy. - The
UtilityPipeline.copyFrameRect
method binds thesource
Render Target and then copies a section of it to thetarget
usinggl.copyTexSubImage2D
rather than a shader, making it much faster if you don't need blending or preserving alpha details. - The
UtilityPipeline.copyToGame
method pops the framebuffer from the renderers FBO stack and sets that as the active target, then draws thesource
Render Target to it. Use when you need to render the final result to the game canvas. - The
UtilityPipeline.drawFrame
method will copy asource
Render Target, optionally to atarget
Render Target, using the given ColorMatrix, allowing for full control over the luminance values used during the copy. - The
UtilityPipeline.blendFrames
method draws thesource1
andsource2
Render Targets to thetarget
Render Target using a linear blend effect, which is controlled by thestrength
parameter. - The
UtilityPipeline.blendFramesAdditive
method draws thesource1
andsource2
Render Targets to thetarget
Render Target using an additive blend effect, which is controlled by thestrength
parameter. - The
UtilityPipeline.clearFrame
method clears the given Render Target. - The
UtilityPipeline.setUVs
method allows you to set the UV values for the 6 vertices that make-up the quad belonging to the Utility Pipeline. - The
UtilityPipeline.setTargetUVs
method sets the vertex UV coordinates of the quad used by the shaders so that they correctly adjust the texture coordinates for a blit frame effect. - The
UtilityPipeline.flipX
method horizontally flips the UV coordinates of the quad used by the shaders. - The
UtilityPipeline.flipY
method vertically flips the UV coordinates of the quad used by the shaders. - The
UtilityPipeline.resetUVs
method resets the quad vertice UV values to their default settings.
Light Pipeline Update
The Light Pipeline (previously called the Forward Diffuse Light Pipeline), which is responsible for rendering lights under WebGL, has been rewritten to work with the new Multi Pipeline features. Lots of redundant code has been removed and the following changes and improvements took place:
- The pipeline now works with Game Objects that do not have a normal map. They will be rendered using the new default normal map, which allows for a flat light effect to pass over them and merge with their diffuse map colors.
- Fixed a bug in the way lights were handled that caused Tilemaps to render one tile at a time, causing massive slow down. They're now batched properly, making a combination of lights and tilemaps possible again.
- The Bitmap Text (Static and Dynamic) Game Objects now support rendering with normal maps.
- The TileSprite Game Objects now support rendering with normal maps.
- Mesh Game Objects now support rendering with normal maps.
- Particle Emitter Game Object now supports rendering in Light2d.
- The Text Game Object now supports rendering in Light2d, no matter which font, stroke or style it is using.
- Tilemap Layer Game Objects now support the Light2d pipeline, with or without normal maps.
- The pipeline will no longer look-up and set all of the light uniforms unless the
Light
is dirty. - The pipeline will no longer reset all of the lights unless the quantity of lights has changed.
- The
ForwardDiffuseLightPipeline.defaultNormalMap
property has changed, it's now an object with aglTexture
property that maps to the pipelines default normal map. - The
ForwardDiffuseLightPipeline.boot
method has been changed to now generate a default normal map. - The
ForwardDiffuseLightPipeline.onBind
method has been removed as it's no longer required. - The
ForwardDiffuseLightPipeline.setNormalMap
method has been removed as it's no longer required. ForwardDiffuseLightPipeline.bind
is a new method that handles setting-up the shader uniforms.- The
ForwardDiffuseLightPipeline.batchTexture
method has been rewritten to use the Texture Tint Pipeline function instead. - The
ForwardDiffuseLightPipeline.batchSprite
method has been rewritten to use the Texture Tint Pipeline function instead. ForwardDiffuseLightPipeline.lightCount
is a new property that stores the previous number of lights rendered.ForwardDiffuseLightPipeline.getNormalMap
is a new method that will look-up and return a normal map for the given object.
Point Lights Pipeline
The Point Light Pipeline is a brand new pipeline in 3.50 that was creates specifically for rendering the new Point Light Game Objects in WebGL.
It extends the WebGLPipeline and sets the required shader attributes and uniforms for Point Light rendering.
You typically don't access or set the pipeline directly, but rather create instances of the Point Light Game Object instead. However, it does have the following unique methods:
- The
PointLightPipeline.batchPointLight
method is a special-case method that is called directly by the Point Light Game Object during rendering and allows it to add itself into the rendering batch. - The
PointLightPipeline.batchLightVert
method is a special internal method, used bybatchPointLight
that adds a single Point Light vert into the batch.
Graphics Pipeline and Graphics Game Object Changes
The Graphics Pipeline is a new pipeline added in 3.50 that is responsible for rendering Graphics Game Objects and all of the Shape Game Objects, such as Arc, Rectangle, Star, etc. Due to the new pipeline some changes have been made:
- The Graphics Pipeline now uses much simpler vertex and fragment shaders with just two attributes (
inPosition
andinColor
), making the vertex size and memory-use 57% smaller. - The private
_tempMatrix1
, 2, 3 and 4 properties have all been removed from the pipeline. - A new public
calcMatrix
property has been added, which Shape Game Objects use to maintain transform state during rendering. - The Graphics Pipeline no longer makes use of
tintEffect
or any textures. - Because Graphics and Shapes now render with their own pipeline, you are able to exclude the pipeline and those Game Objects entirely from custom builds, further reducing the final bundle size.
As a result of these changes the following features are no longer available:
Graphics.setTexture
has been removed. You can no longer use a texture as a 'fill' for a Graphic. It never worked with any shape other than a Rectangle, anyway, due to UV mapping issues, so is much better handled via the new Mesh Game Object.Graphics._tempMatrix1
, 2 and 3 have been removed. They're not required internally any longer.Graphics.renderWebGL
now uses the standardGetCalcMatrix
function, cutting down on duplicate code significantly.
Single Pipeline Update
There is a new pipeline called SinglePipeline
, created to emulate the old TextureTintPipeline
. This special pipeline uses just a single texture and makes things a lot easier if you wish to create a custom pipeline, but not have to recode your shaders to work with multiple textures. Instead, just extend SinglePipeline
, where-as before you extended the TextureTintPipeline
and you won't have to change any of your shader code. However, if you can, you should update it to make it perform faster, but that choice is left up to you.
WebGLShader
WebGLShader
is a new class that is created and belongs to WebGL Pipeline classes. When the pipeline is created it will create a WebGLShader
instance for each one of its shaders, as defined in the pipeline configuration.
This class encapsulates everything needed to manage a shader in a pipeline, including the shader attributes and uniforms, as well as lots of handy methods such as set2f
, for setting uniform values on this shader. Uniform values are automatically cached to avoid unnecessary gl operations.
Typically, you do not create an instance of this class directly, as it works in unison with the pipeline to which it belongs. You can gain access to this class via a pipeline's shaders
array, post-creation.
The following properties and methods are available in the new WebGLShader
class:
- The
WebGLShader.pipeline
property is a reference to the WebGL Pipeline that owns the WebGLShader instance. - The
WebGLShader.name
property is the name of the shader. - The
WebGLShader.renderer
property is a reference to the WebGL Renderer. - The
WebGLShader.gl
property is a reference to the WebGL Rendering Context. - The
WebGLShader.program
property is the WebGL Program created from the vertex and fragment shaders. - The
WebGLShader.attributes
property is an array of objects that describe the vertex attributes of the shader. - The
WebGLShader.vertexComponentCount
property is the total amount of vertex attribute components of 32-bit length. - The
WebGLShader.vertexSize
property is the size, in bytes, of a single vertex. - The
WebGLShader.uniforms
property is an object that is automatically populated with all active uniforms in the shader. - The
WebGLShader.createAttributes
method takes the vertex attributes config and parses it, creating the shader attributes. This is called automatically. - The
WebGLShader.bind
method sets the program the shader uses as being active. Called automatically when the parent pipeline needs this shader. - The
WebGLShader.rebind
method sets the program the shader uses as being active and resets all of the vertex attribute pointers. - The
WebGLShader.setAttribPointers
method sets the vertex attribute pointers. Called automatically duringbind
. - The
WebGLShader.createUniforms
method populates theuniforms
object with details about all active uniforms. - The
WebGLShader.hasUniform
method returns a boolean if the given uniform exists. - The
WebGLShader.resetUniform
method resets the cached value for the given uniform. - The
WebGLShader.setUniform1
method is an internal method used for setting a single value uniform on the shader. - The
WebGLShader.setUniform2
method is an internal method used for setting a double value uniform on the shader. - The
WebGLShader.setUniform3
method is an internal method used for setting a triple value uniform on the shader. - The
WebGLShader.setUniform4
method is an internal method used for setting a quadruple value uniform on the shader. - The
WebGLShader.set1f
method sets a 1f uniform based on the given name. - The
WebGLShader.set2f
method sets a 2f uniform based on the given name. - The
WebGLShader.set3f
method sets a 3f uniform based on the given name. - The
WebGLShader.set4f
method sets a 4f uniform based on the given name. - The
WebGLShader.set1fv
method sets a 1fv uniform based on the given name. - The
WebGLShader.set2fv
method sets a 2fv uniform based on the given name. - The
WebGLShader.set3fv
method sets a 3fv uniform based on the given name. - The
WebGLShader.set4fv
method sets a 4fv uniform based on the given name. - The
WebGLShader.set1iv
method sets a 1iv uniform based on the given name. - The
WebGLShader.set2iv
method sets a 2iv uniform based on the given name. - The
WebGLShader.set3iv
method sets a 3iv uniform based on the given name. - The
WebGLShader.set4iv
method sets a 4iv uniform based on the given name. - The
WebGLShader.set1i
method sets a 1i uniform based on the given name. - The
WebGLShader.set2i
method sets a 2i uniform based on the given name. - The
WebGLShader.set3i
method sets a 3i uniform based on the given name. - The
WebGLShader.set4i
method sets a 4i uniform based on the given name. - The
WebGLShader.setMatrix2fv
method sets a matrix 2fv uniform based on the given name. - The
WebGLShader.setMatrix3fv
method sets a matrix 3fv uniform based on the given name. - The
WebGLShader.setMatrix4fv
method sets a matrix 4fv uniform based on the given name. - The
WebGLShader.destroy
method removes all external references and deletes the program and attributes.
Render Target
RenderTarget
is a brand new class that encapsulates a WebGL framebuffer and the WebGL Texture that displays it. Instances of this class are typically created by, and belong to WebGL Pipelines, however other Game Objects and classes can take advantage of Render Targets as well.
The following properties and methods are available in the new RenderTexture
class:
- The
RenderTarget.renderer
property is a reference to the WebGL Renderer. - The
RenderTarget.framebuffer
property is the WebGLFramebuffer belonging to the Render Target. - The
RenderTarget.texture
property is a WebGLTexture belonging to the Render Target and bound to the framebuffer. - The
RenderTarget.width
property is the width of the Render Target. - The
RenderTarget.height
property is the height of the Render Target. - The
RenderTarget.scale
property is the scale of the Render Target, applied to the dimensions during resize. - The
RenderTarget.minFilter
property is the min filter of the texture. - The
RenderTarget.autoClear
property is a boolean that controls if the Render Target is automatically cleared when bound. - The
RenderTarget.autoResize
property is a boolean that controls if the Render Target is automatically resized if the WebGLRenderer resizes. - The
RenderTarget.setAutoResize
method lets you set the auto resize of the Render Target. - The
RenderTarget.resize
method lets you resize the Render Target. - The
RenderTarget.bind
method sets the Render Target as being the active fbo in the renderer and optionally clears and adjusts the viewport. - The
RenderTarget.adjustViewport
method sets the viewport to match the Render Target dimensions. - The
RenderTarget.clear
method disables the scissors, clears the Render Target and resets the scissors again. - The
RenderTarget.unbind
method flushes the renderer and pops the Render Target framebuffer from the stack. - The
RenderTarget.destroy
method removes all external references and deletes the framebuffer and texture.
WebGL Renderer
New WebGL Multi-Texture Support
The Multi Pipeline (previously called the Texture Tint Pipeline) has had its core flow rewritten to eliminate the need for constantly creating batch
objects. Instead, it now supports the new multi-texture shader, vastly increasing rendering performance, especially on draw-call bound systems.
All of the internal functions, such as batchQuad
and batchSprite
have been updated to use the new method of texture setting. The method signatures all remain the same unless indicated below.
Config.render.maxTextures
is a new game config setting that allows you to control how many texture units will be used in WebGL.WebGL.Utils.checkShaderMax
is a new function, used internally by the renderer, to determine the maximum number of texture units the GPU + browser supports.- The property
WebGLRenderer.currentActiveTextureUnit
has been renamed tocurrentActiveTexture
. WebGLRenderer.startActiveTexture
is a new read-only property contains the current starting active texture unit.WebGLRenderer.maxTextures
is a new read-only property that contains the maximum number of texture units WebGL can use.WebGLRenderer.textureIndexes
is a new read-only array that contains all of the available WebGL texture units.WebGLRenderer.tempTextures
is a new read-only array that contains temporary WebGL textures.- The
WebGLRenderer.currentTextures
property has been removed, as it's no longer used. TextureSource.glIndex
is a new property that holds the currently assigned texture unit for the Texture Source.TextureSource.glIndexCounter
is a new property that holds the time the index was assigned to the Texture Source.WebGLRenderer.currentTextures
has been removed, as it's no longer used internally.WebGLRenderer.setBlankTexture
no longer has aforce
parameter, as it's set by default.- The Mesh Game Object WebGL Renderer function has been updated to support multi-texture units.
- The Blitter Game Object WebGL Renderer function has been updated to support multi-texture units.
- The Bitmap Text Game Object WebGL Renderer function has been updated to support multi-texture units.
- The Dynamic Bitmap Text Game Object WebGL Renderer function has been updated to support multi-texture units.
- The Particle Emitter Game Object WebGL Renderer function has been updated to support multi-texture units.
- The Texture Tint vertex and fragment shaders have been updated to support the
inTexId
float attribute and dynamic generation. - The Texture Tint Pipeline has a new attribute,
inTexId
which is agl.FLOAT
. TextureTintPipeline.bind
is a new method that sets theuMainSampler
uniform.- The
TextureTintPipeline.requireTextureBatch
method has been removed, as it's no longer required. - The
TextureTintPipeline.pushBatch
method has been removed, as it's no longer required. - The
TextureTintPipeline.maxQuads
property has been removed, as it's no longer required. - The
TextureTintPipeline.batches
property has been removed, as it's no longer required. TextureTintPipeline.flush
has been rewritten to support multi-textures.TextureTintPipeline.flush
no longer creates a sub-array if the batch is full, but instead usesbufferData
for speed.WebGLRenderer.setTextureSource
is a new method, used by pipelines and Game Objects, that will assign a texture unit to the given Texture Source.- The
WebGLRenderer.setTexture2D
method has been updated to use the new texture unit assignment. It no longer takes thetextureUnit
orflush
parameters and these have been removed from its method signature. WebGLRenderer.setTextureZero
is a new method that activates texture zero and binds the given texture to it. Useful for fbo backed game objects.WebGLRenderer.clearTextureZero
is a new method that clears the texture that was bound to unit zero.WebGLRenderer.textureZero
is a new property that holds the currently bound unit zero texture.WebGLRenderer.normalTexture
is a new property that holds the currently bound normal map (texture unit one).WebGLRenderer.setNormalMap
is a new method that sets the current normal map texture.WebGLRenderer.clearNormalMap
is a new method that clears the current normal map texture.WebGLRenderer.resetTextures
is a new method that flushes the pipeline, resets all textures back to the temporary ones, and resets the active texture counter.WebGLRenderer.isNewNormalMap
is a new method that returns a boolean if the given parameters are not currently used.WebGLRenderer.unbindTextures
is a new method that will activate and then null bind all WebGL textures.Renderer.WebGL.Utils.parseFragmentShaderMaxTextures
is a new function that will take fragment shader source and search it for%count%
and%forloop%
declarations, replacing them with the required GLSL for multi-texture support, returning the modified source.- The
WebGL.Utils.getComponentCount
function has been removed as this is no longer required internally.
WebGLRenderer New Features, Updates and API Changes
WebGLRenderer.instancedArraysExtension
is a new property that holds the WebGL Extension for instanced array drawing, if supported by the browser.WebGLRenderer.vaoExtension
is a new property that holds a reference to the Vertex Array Object WebGL Extension, if supported by the browser.WebGLRenderer.resetProgram
is a new method that will rebind the current program, without flushing or changing any properties.WebGLRenderer.textureFlush
is a new property that keeps track of the total texture flushes per frame.WebGLRenderer.finalType
is a new boolean property that signifies if the current Game Object being rendered is the final one in the list.- The
WebGLRenderer.updateCanvasTexture
method will now setgl.UNPACK_PREMULTIPLY_ALPHA_WEBGL
to true, which should stop issues where you update a Text Game Object, having added a Render Texture or Spine Game Object to the Scene after it, which switches the PMA setting. Fix #5064 #5155 (thanks @hugoruscitti @immangrove-supertree) WebGLRenderer.previousPipeline
is a new property that is set during a call toclearPipeline
and used during calls torebindPipeline
, allowing the renderer to rebind any previous pipeline, not just the Multi Pipeline.- The
WebGLRenderer.rebindPipeline
method has been changed slightly. Previously, you had to specify thepipelineInstance
, but this is now optional. If you don't, it will use the newpreviousPipeline
property instead. If not set, or none given, it will now return without throwing gl errors as well. WebGLRenderer.defaultScissor
is a new property that holds the default scissor dimensions for the renderer. This is modified duringresize
and avoids continuous array generation in thepreRender
loop.- The
WebGLRenderer.nativeTextures
array has been removed and any WebGLTextures created by the renderer are no longer stored within it. All WebGLTexture instances are stored in theTextureSource
objects anyway, or by local classes such as RenderTexture, so there was no need to have another array taking up memroy. - The
WebGLRenderer.deleteTexture
method has a new optional boolean parameterreset
which allows you to control if theWebGLRenderer.resetTextures
method is called, or not, after the texture is deleted. - The
WebGLRenderer.getMaxTextures
method has been removed. This is no longer needed as you can use theWebGLRenderer.maxTextures
property instead. - The
WebGLRenderer.setProgram
method now returns a boolean.true
if the program was set, otherwisefalse
. WebGLRenderer.setFloat1
has been removed. UseWebGLPipeline.set1f
orWebGLShader.set1f
instead.WebGLRenderer.setFloat2
has been removed. UseWebGLPipeline.set2f
orWebGLShader.set2f
instead.WebGLRenderer.setFloat3
has been removed. UseWebGLPipeline.set3f
orWebGLShader.set3f
instead.WebGLRenderer.setFloat4
has been removed. UseWebGLPipeline.set4f
orWebGLShader.set4f
instead.WebGLRenderer.setFloat1v
has been removed. UseWebGLPipeline.set1fv
orWebGLShader.set1fv
instead.WebGLRenderer.setFloat2v
has been removed. UseWebGLPipeline.set1fv
orWebGLShader.set2fv
instead.WebGLRenderer.setFloat3v
has been removed. UseWebGLPipeline.set1fv
orWebGLShader.set3fv
instead.WebGLRenderer.setFloat4v
has been removed. UseWebGLPipeline.set1fv
orWebGLShader.set4fv
instead.WebGLRenderer.setInt1
has been removed. UseWebGLPipeline.set1fi
orWebGLShader.set1i
instead.WebGLRenderer.setInt2
has been removed. UseWebGLPipeline.set1fi
orWebGLShader.set2i
instead.WebGLRenderer.setInt3
has been removed. UseWebGLPipeline.set1fi
orWebGLShader.set3i
instead.WebGLRenderer.setInt4
has been removed. UseWebGLPipeline.set1fi
orWebGLShader.set4i
instead.WebGLRenderer.setMatrix2
has been removed. UseWebGLPipeline.setMatrix2fv
orWebGLShader.setMatrix2fv
instead.WebGLRenderer.setMatrix3
has been removed. UseWebGLPipeline.setMatrix3fv
orWebGLShader.setMatrix3fv
instead.WebGLRenderer.setMatrix4
has been removed. UseWebGLPipeline.setMatrix4fv
orWebGLShader.setMatrix4fv
instead.- The
WebGLRenderer._tempMatrix1
,_tempMatrtix2
,_tempMatrix3
and_tempMatrix4
properties have been removed. They were all flagged as private, yet used in lots of places. Instead, Game Objects now manager their own matrices, or use the globalGetCalcMatrix
function instead. WebGLRenderer.fboStack
is a new property that maintains a stack of framebuffer objects, used for pipelines supporting multiple render targets.WebGLRenderer.pushFramebuffer
is a new method that is used to push a framebuffer onto the fbo stack before setting it as the current framebuffer. This should now be called in place ofsetFramebuffer
. Remember to callpopFramebuffer
after using it.WebGLRenderer.popFramebuffer
is a new method that will pop the current framebuffer off the fbo stack and set the previous one as being active.WebGLRenderer.setFramebuffer
has a new optional boolean parameterresetTextures
which will reset the WebGL Textures, if set totrue
(which is the default).WebGLRenderer.isBooted
is a new boolean property that lets you know if the renderer has fully finished booting.- The
WebGLRenderer
now extends the Event Emitter, allowing you to listen to renderer specific events. WebGLRenderer.defaultCamera
has been removed as it's not used anywhere internally any longer.- The
WebGLRenderer.setVertexBuffer
method has been removed along with theWebGLRenderer.currentVertexBuffer
property. This is now set directly by the WebGL Pipeline, as needed. - The
WebGLRenderer.setIndexBuffer
method has been removed along with theWebGLRenderer.currentIndexBuffer
property. This is now set directly by the WebGL Pipeline, as needed. WebGLRenderer.resetScissor
is a new method that will reset the gl scissor state to be the current scissor, if there is one, without modifying the stack.WebGLRenderer.resetViewport
is a new method that will reset the gl viewport to the current renderer dimensions.WebGLRenderer.renderTarget
is a new property that contains a Render Target that is bound to the renderer and kept resized to match it.WebGLRenderer.beginCapture
is a new method that will bind the renderers Render Target, so everything drawn is redirected to it.WebGLRenderer.endCapture
is a new method that will unbind the renderers Render Target and return it, preventing anything else from being drawn to it.WebGLRenderer.setProjectionMatrix
is a new method that sets the global renderer projection matrix to the given dimensions.WebGLRenderer.resetProjectionMatrix
is a new method that resets the renderer projection matrix back to match the renderer size.WebGLRenderer.getAspectRatio
is a new method that returns the aspect ratio of the renderer.
WebGL ModelViewProjection Removed
The ModelViewProjection
object contained a lot of functions that Phaser never used internally. Instead, the functions available in them were already available in the Math.Matrix4
class. So the pipelines have been updated to use a Matrix4 instead and all of the MVP functions have been removed. The full list of removed functions is below:
projIdentity
has been removed.projPersp
has been removed.modelRotateX
has been removed.modelRotateY
has been removed.modelRotateZ
has been removed.viewLoad
has been removed.viewRotateX
has been removed.viewRotateY
has been removed.viewRotateZ
has been removed.viewScale
has been removed.viewTranslate
has been removed.modelIdentity
has been removed.modelScale
has been removed.modelTranslate
has been removed.viewIdentity
has been removed.viewLoad2D
has been removed.projOrtho
has been removed.
WebGL and Canvas Renderer Events
Phaser.Renderer.Events
is a new namespace for events emitted by the Canvas and WebGL Renderers.Renderer.Events.PRE_RENDER
is a new event dispatched by the Phaser Renderer. This happens right at the start of the render process.Renderer.Events.RENDER
is a new event dispatched by the Phaser Renderer. This happens once for every camera, in every Scene at the start of its render process.Renderer.Events.POST_RENDER
is a new event dispatched by the Phaser Renderer. This happens right at the end of the render process.Renderer.Events.RESIZE
is a new event dispatched by the Phaser Renderer whenever it is resized.
Canvas Renderer Updates
CanvasRenderer.isBooted
is a new boolean property that lets you know if the renderer has fully finished booting.- The
CanvasRenderer
now extends the Event Emitter, allowing you to listen to renderer specific events.
Camera - New Features, Updates and API Changes
The Camera API has changed in line with the new pipeline updates. To this end, the following changes have taken place:
The Camera class now inherits the Pipeline
Component. This gives it new features, in line with the other pipelines changes in 3.50, such as Camera.setPipeline
, Camera.setPostPipeline
, Camera.setPipelineData
and so on. This is a much more powerful and flexible way of setting camera effects, rather than it managing its own framebuffer and texture directly.
To that end, the following properties and methods have been removed to tidy things up:
- The
Camera.renderToTexture
property has been removed. Effects are now handled via pipelines. - The
Camera.renderToGame
property has been removed. Effects are now handled via pipelines. - The
Camera.canvas
property has been removed. Textures are handled by pipelines. - The
Camera.context
property has been removed. Textures are handled by pipelines. - The
Camera.glTexture
property has been removed. GL Textures are handled by pipelines. - The
Camera.framebuffer
property has been removed. GL Framebuffers are handled by pipelines. - The
Camera.setRenderToTexture
method has been removed. Effects are now handled via pipelines. - The
Camera.clearRenderToTexture
method has been removed. Effects are now handled via pipelines.
These changes mean that you can no longer render a Camera to a canvas in Canvas games.
Other changes and fixes:
Camera.zoomX
is a new property that allows you to specifically set the horizontal zoom factor of a Camera.Camera.zoomY
is a new property that allows you to specifically set the vertical zoom factor of a Camera.- The
Camera.setZoom
method now allows you to pass two parameters:x
andy
, to control thezoomX
andzoomY
values accordingly. - The
Camera.zoom
property now returns an average of thezoomX
andzoomY
properties. Cameras.Scene2D.Events.FOLLOW_UPDATE
is a new Event that is dispatched by a Camera when it is following a Game Object. It is dispatched every frame, right after the final Camera position and internal matrices have been updated. Use it if you need to react to a camera, using its most current position and the camera is following something. Fix #5253 (thanks @rexrainbow)- If the Camera has
roundPixels
set it will now round the internal scroll factors andworldView
during thepreRender
step. Fix #4464 (thanks @Antriel)
Spine Plugin - New Features, API Changes and Bug Fixes
- The Spine Runtimes have been updated to 3.8.99, which are the most recent non-beta versions. Please note, you will need to re-export your animations if you're working in a version of Spine lower than 3.8.20. We do not impose this requirement, the Spine editor does.
SpineContainer
is a new Game Object available viathis.add.spineContainer
to which you can add Spine Game Objects only. It uses a special rendering function to retain batching, even across multiple container or Spine Game Object instances, resulting in dramatically improved performance compared to using regular Containers. You can still use regular Containers if you need, but they do not benefit from the new batching.- A Spine Game Object with
setVisible(false)
will no longer still cause internal gl commands and is now properly skipped, retaining any current batch in the process. Fix #5174 (thanks @Kitsee) - The Spine Game Object WebGL Renderer will no longer clear the type if invisible and will only end the batch if the next type doesn't match.
- The Spine Game Object WebGL Renderer will no longer rebind the pipeline if it was the final object on the display list, saving lots of gl commands.
- The Webpack build scripts have all been updated for Webpack 4.44.x. Fix #5243 (thanks @RollinSafary)
- There is a new npm script
npm run plugin.spine.runtimes
which will build all of the Spine runtimes, for ingestion by the plugin. Note: You will need to check-out the Esoteric Spine Runtimes repo intoplugins/spine/
in order for this to work and then runnpm i
. - Spine Game Objects can now be rendered to Render Textures. Fix #5184 (thanks @Kitsee)
- Using > 128 Spine objects in a Container would cause a
WebGL: INVALID_OPERATION: vertexAttribPointer: no ARRAY_BUFFER is bound and offset is non-zero
error if you added any subsequent Spine objects to the Scene. There is now no limit. Fix #5246 (thanks @d7561985) - The Spine Plugin will now work in HEADLESS mode without crashing. Fix #4988 (thanks @raimon-segura)
- Spine Game Objects now use -1 as their default blend mode, which means 'skip setting it', as blend modes should be handled by the Spine skeletons directly.
- The Spine TypeScript defs have been updated for the latest version of the plugin and to add SpineContainers.
- The
SpineGameObject.setAnimation
method will now use thetrackIndex
parameter ifignoreIfPlaying
is set and run the check against this track index. Fix #4842 (thanks @vinerz) - The
SpineFile
will no longer throw a warning if adding a texture into the Texture Manager that already exists. This allows you to have multiple Spine JSON use the same texture file, however, it also means you now get no warning if you accidentally load a texture that exists, so be careful with your keys! Fix #4947 (thanks @Nomy1) - The Spine Plugin
destroy
method will now no longer remove the Game Objects from the Game Object Factory, or dispose of the Scene Renderer. This means when a Scene is destroyed, it will keep the Game Objects in the factory for other Scenes to use. Fix #5279 (thanks @Racoonacoon) SpinePlugin.gameDestroy
is a new method that is called if the Game instance emits adestroy
event. It removes the Spine Game Objects from the factory and disposes of the Spine scene renderer.SpineFile
will now check to see if another identical atlas in the load queue is already loading the texture it needs and will no longer get locked waiting for a file that will never complete. This allows multiple skeleton JSONs to use the same atlas data. Fix #5331 (thanks @Racoonacoon)SpineFile
now uses a!
character to split the keys, instead of an underscore, preventing the plugin from incorrectly working out the keys for filenames with underscores in them. Fix #5336 (thanks @Racoonacoon)SpineGameObject.willRender
is no longer hard-coded to returntrue
. It instead now takes a Camera parameter and performs all of the checks needed before returning. Previously, this happened during the render functions.- The Spine Plugin now uses a single instance of the Scene Renderer when running under WebGL. All instances of the plugin (installed per Scene) share the same base Scene Renderer, avoiding duplicate allocations and resizing events under multi-Scene games. Fix #5286 (thanks @spayton BunBunBun)
Game Objects - New Features, API Changes and Bug Fixes
Lots of the core Phaser Game Objects have been improved in 3.50 and there are several new Game Objects as well.
Render Texture Game Object
The Render Texture Game Object has been rewritten to use the new RenderTarget
class internally, rather than managing its own framebuffer and gl textures directly. The core draw methods are now a lot simpler and no longer require manipulating render pipelines.
As a result of these changes the following updates have happened:
RenderTexture.renderTarget
is a new property that contains aRenderTarget
instance, which is used for all drawing.- The
RenderTexture.framebuffer
property has been removed. You can now access this viaRenderTexture.renderTarget.framebuffer
. - The
RenderTexture.glTexture
property has been removed. You can now access this viaRenderTexture.renderTarget.texture
. - The
RenderTexture.gl
property has been removed.
Render Textures have the following new features:
RenderTexture.beginDraw
is a new method that allows you to create a batched draw to the Render Texture. Use this method to begin the batch.RenderTexture.batchDraw
is a new method that allows you to batch the drawing of an object to the Render Texture. You should never call this method unless you have previously started a batch withbeginDraw
. You can call this method as many times as you like, to draw as many objects as you like, without causing a framebuffer bind.RenderTexture.batchDrawFrame
is a new method that allows you to batch the drawing of a texture frame to the Render Texture. You should never call this method unless you have previously started a batch withbeginDraw
. You can call this method as many times as you like, to draw as many frames as you like, without causing a framebuffer bind.RenderTexture.endDraw
is a new method that ends a previously created batched draw on the Render Texture. Use it to write all of your batch changes to the Render Texture.- You can now draw a
Group
to aRenderTexture
. Previously, it failed to pass the camera across, resulting in none of the Group children being drawn. Fix #5330 (thanks @somnolik)
Render Textures have the following bug fixes:
RenderTexture.resize
(which is called fromsetSize
) wouldn't correctly set theTextureSource.glTexture
property, leading tobindTexture: attempt to use a deleted object
errors under WebGL.RenderTexture.fill
would fail to fill the correct area under WebGL if the RenderTexture wasn't the same size as the Canvas. It now fills the given region properly.RenderTexture.erase
has never worked when using the Canvas Renderer and a texture frame, only with Game Objects. It now works with both. Fix #5422 (thanks @vforsh)
Point Lights Game Object
The Point Light Game Object is brand new in 3.50 and provides a way to add a point light effect into your game, without the expensive shader processing requirements of the traditional Light Game Object.
The difference is that the Point Light renders using a custom shader, designed to give the impression of a radial light source, of variable radius, intensity and color, in your game. However, unlike the Light Game Object, it does not impact any other Game Objects, or use their normal maps for calculations. This makes them extremely fast to render compared to Lights and perfect for special effects, such as flickering torches or muzzle flashes.
For maximum performance you should batch Point Light Game Objects together. This means ensuring they follow each other consecutively on the display list. Ideally, use a Layer Game Object and then add just Point Lights to it, so that it can batch together the rendering of the lights. You don't have to do this, and if you've only a handful of Point Lights in your game then it's perfectly safe to mix them into the display list as normal. However, if you're using a large number of them, please consider how they are mixed into the display list.
The renderer will automatically cull Point Lights. Those with a radius that does not intersect with the Camera will be skipped in the rendering list. This happens automatically and the culled state is refreshed every frame, for every camera.
The PointLight
Game Object has the following unique properties and methods:
- The
PointLight.color
property is an instance of the Color object that controls the color value of the light. - The
PointLight.intensity
property sets the intensity of the light. The colors of the light are multiplied by this value during rendering. - The
PointLight.attenuation
property sets the attenuation of the light, which is the force with which the light falls off from its center. - The
PointLight.radius
property sets the radius of the light, in pixels. This value is also used for culling.
Point Lights also have corresponding Factory and Creator functions, available from within a Scene:
this.add.pointlight(x, y, color, radius, intensity, attenuation);
and
this.make.pointlight({ x, y, color, radius, intensity, attenuation });
Mesh Game Object
The Mesh Game Object has been rewritten from scratch in v3.50 with a lot of changes to make it much more useful. It is accompanied by the new Geom.Mesh
set of functions.
Geom.Mesh
is a new namespace that contains the Mesh related geometry functions. These are stand-alone functions that you may, or may not require, depending on your game.Geom.Mesh.Vertex
is a new class that encapsulates all of the data required for a single vertex, including position, uv, normals, color and alpha.Geom.Mesh.Face
is a new class that consists of references to the threeVertex
instances that construct a single Face in a Mesh and provides methods for manipulating them.Geom.Mesh.GenerateVerts
is a new function that will return an array ofVertex
andFace
objects generated from the given data. You can provide index, or non-index vertex lists, along with UV data, normals, colors and alpha which it will parse and return the results from.Geom.Mesh.GenerateGridVerts
is a new function that will generate a series ofVertex
objects in a grid format, based on the givenGenerateGridConfig
config file. You can set the size of the grid, the number of segments to split it into, translate it, color it and tile the texture across it. The resulting data can be easily used by a Mesh Game Object.Geom.Mesh.GenerateObjVerts
is a new function that will generate a series ofVertex
objects based on the given parsed Wavefront Obj Model data. You can optionally scale and translate the generated vertices and add them to a Mesh.Geom.Mesh.ParseObj
is a new function that will parse a triangulated Wavefront OBJ file into model data into a format that theGenerateObjVerts
function can consume.Geom.Mesh.ParseObjMaterial
is a new function that will parse a Wavefront material file and extract the diffuse color data from it, combining it with the parsed object data.Geom.Mesh.RotateFace
is a new function that will rotate a Face by a given amount, based on an optional center of rotation.Loader.OBJFile
is a new File Loader type that can load triangulated Wavefront OBJ files, and optionally material files, which are then parsed and stored in the OBJ Cache.- The Mesh constructor and
MeshFactory
signatures have changed toscene, x, y, texture, frame, vertices, uvs, indicies, containsZ, normals, colors, alphas
. Note the way the Texture and Frame parameters now comes first.indicies
is a new parameter that allows you to provide indexed vertex data to create the Mesh from, where theindicies
array holds the vertex index information. The final list of vertices is built from this index along with the provided vertices and uvs arrays. Theindicies
array is optional. If your data is not indexed, then simply passnull
or an empty array for this parameter. - The
Mesh
Game Object now has the Animation State Component. This allows you to create and play animations across the texture of a Mesh, something that previously wasn't possible. As a result, the Mesh now adds itself to the Update List when added to a Scene. Mesh.addVertices
is a new method that allows you to add vertices to a Mesh Game Object based on the given parameters. This allows you to modify a mesh post-creation, or populate it with data at a later stage.Mesh.addVerticesFromObj
is a new method that will add the model data from a loaded Wavefront OBJ file to a Mesh. You load it via the newOBJFile
with athis.load.obj
call, then you can use the key with this method. This method also takes an optional scale and position parameters to control placement of the created model within the Mesh.Mesh.hideCCW
is a new boolean property that, when enabled, tells a Face to not render if it isn't counter-clockwise. You can use this to hide backward facing Faces.Mesh.modelPosition
is a new Vector3 property that allows you to translate the position of all vertices in the Mesh.Mesh.modelRotation
is a new Vector3 property that allows you to rotate all vertices in the Mesh.Mesh.modelScale
is a new Vector3 property that allows you to scale all vertices in the Mesh.Mesh.panX
is a new function that will translate the view position of the Mesh on the x axis.Mesh.panY
is a new function that will translate the view position of the Mesh on the y axis.Mesh.panZ
is a new function that will translate the view position of the Mesh on the z axis.Mesh.setPerspective
is a new method that allows you to set a perspective projection matrix based on the given dimensions, fov, near and far values.Mesh.setOrtho
is a new method that allows you to set an orthographic projection matrix based on the given scale, near and far values.Mesh.clear
is a new method that will destroy all Faces and Vertices and clear the Mesh.Mesh.depthSort
is a new method that will run a depth sort across all Faces in the Mesh by sorting them based on their average depth.Mesh.addVertex
is a new method that allows you to add a new single Vertex into the Mesh.Mesh.addFace
is a new method that allows you to add a new Face into the Mesh. A Face must consist of 3 Vertex instances.Mesh.getFaceCount
new is a new method that will return the total number of Faces in the Mesh.Mesh.getVertexCount
new is a new method that will return the total number of Vertices in the Mesh.Mesh.getFace
new is a new method that will return a Face instance from the Mesh based on the given index.Mesh.getFaceAt
new is a new method that will return an array of Face instances from the Mesh based on the given position. The position is checked against each Face, translated through the optional Camera and Mesh matrix. If more than one Face intersects, they will all be returned but the array will be depth sorted first, so the first element will be that closest to the camera.Mesh.vertices
is now an array ofGameObject.Vertex
instances, not a Float32Array.Mesh.faces
is a new array ofGameObject.Face
instances, which is populated during a call to methods likeaddVertices
oraddModel
.Mesh.totalRendered
is a new property that holds the total number of Faces that were rendered in the previous frame.Mesh.setDebug
is a new method that allows you to render a debug visualization of the Mesh vertices to a Graphics Game Object. You can provide your own Graphics instance and optionally callback that is invoked during rendering. This allows you to easily visualize the vertices of your Mesh to help debug UV mapping.- The Mesh now renders by iterating through the Faces array, not the vertices. This allows you to use Array methods such as
BringToTop
to reposition a Face, thus changing the drawing order without having to repopulate all of the vertices. Or, for a 3D model, you can now depth sort the Faces. - The
Mesh
Game Object now extends theSingleAlpha
component and the alpha value is factored into the final alpha value per vertex during rendering. This means you can now set the whole alpha across the Mesh using the standardsetAlpha
methods. But, if you wish to, you can still control the alpha on a per-vertex basis as well. - The Mesh renderer will now check to see if the pipeline capacity has been exceeded for every Face added, allowing you to use Meshes with vertex counts that exceed the pipeline capacity without causing runtime errors.
- You can now supply just a single numerical value as the
colors
parameter in the constructor, factory method andaddVertices
method. If a number, instead of an array, it will be used as the color for all vertices created. - You can now supply just a single numerical value as the
alphas
parameter in the constructor, factory method andaddVertices
method. If a number, instead of an array, it will be used as the alpha for all vertices created. Mesh.debugGraphic
is a new property that holds the debug Graphics instance reference.Mesh.debugCallback
is a new property that holds the debug render callback.Mesh.renderDebugVerts
is a new method that acts as the default render callback forsetDebug
if none is provided.Mesh.preDestroy
is a new method that will clean-up the Mesh arrays and debug references on destruction.Mesh.isDirty
is a new method that will check if any of the data is dirty, requiring the vertices to be transformed. This is called automatically inpreUpdate
to avoid generating lots of math when nothing has changed.- The
Mesh.uv
array has been removed. All UV data is now bound in the Vertex instances. - The
Mesh.colors
array has been removed. All color data is now bound in the Vertex instances. - The
Mesh.alphas
array has been removed. All color data is now bound in the Vertex instances. - The
Mesh.tintFill
property is now aboolean
and defaults tofalse
.
Layer Game Object
A Layer is a special type of Game Object that acts as a Display List. You can add any type of Game Object to a Layer, just as you would to a Scene. Layers can be used to visually group together 'layers' of Game Objects:
const spaceman = this.add.sprite(150, 300, 'spaceman');
const bunny = this.add.sprite(400, 300, 'bunny');
const elephant = this.add.sprite(650, 300, 'elephant');
const layer = this.add.layer();
layer.add([ spaceman, bunny, elephant ]);
The 3 sprites in the example above will now be managed by the Layer they were added to. Therefore, if you then set layer.setVisible(false)
they would all vanish from the display.
You can also control the depth of the Game Objects within the Layer. For example, calling the setDepth
method of a child of a Layer will allow you to adjust the depth of that child within the Layer itself, rather than the whole Scene. The Layer, too, can have its depth set as well.
The Layer class also offers many different methods for manipulating the list, such as the methods moveUp
, moveDown
, sendToBack
, bringToTop
and so on. These allow you to change the display list position of the Layers children, causing it to adjust the order in which they are rendered. Using setDepth
on a child allows you to override this.
Layers can have Post FX Pipelines set, which allows you to easily enable a post pipeline across a whole range of children, which, depending on the effect, can often be far more efficient that doing so on a per-child basis.
Layers have no position or size within the Scene. This means you cannot enable a Layer for physics or input, or change the position, rotation or scale of a Layer. They also have no scroll factor, texture, tint, origin, crop or bounds.
If you need those kind of features then you should use a Container instead. Containers can be added to Layers, but Layers cannot be added to Containers.
However, you can set the Alpha, Blend Mode, Depth, Mask and Visible state of a Layer. These settings will impact all children being rendered by the Layer.
BitmapText Game Object
BitmapText.setCharacterTint
is a new method that allows you to set a tint color (either additive or fill) on a specific range of characters within a static Bitmap Text. You can specify the start and length offsets and per-corner tint colors.BitmapText.setWordTint
is a new method that allows you to set a tint color (either additive or fill) on all matching words within a static Bitmap Text. You can specify the word by string, or numeric offset, and the number of replacements to tint.BitmapText.setDropShadow
is a new method that allows you to apply a drop shadow effect to a Bitmap Text object. You can set the horizontal and vertical offset of the shadow, as well as the color and alpha levels. Call this method with no parameters to clear a shadow.BitmapTextWebGLRenderer
has been rewritten from scratch to make use of the new pre-cached WebGL uv texture and character location data generated byGetBitmapTextSize
. This has reduced the number of calculations made in the function dramatically, as it no longer has to work out glyph advancing or offsets during render, but only when the text content updates.BitmapText.getCharacterAt
is a new method that will return the character data from the BitmapText at the givenx
andy
coordinates. The character data includes the code, position, dimensions, and glyph information.- The
BitmapTextSize
object returned byBitmapText.getTextBounds
has a new property calledcharacters
which is an array that contains the scaled position coordinates of each character in the BitmapText, which you could use for tasks such as determining which character in the BitmapText was clicked. ParseXMLBitmapFont
will now calculate the WebGL uv data for the glyphs during parsing. This avoids it having to be done during rendering, saving CPU cycles on an operation that never changes.ParseXMLBitmapFont
will now create a Frame object for each glyph. This means you could, for example, create a Sprite using the BitmapText texture and the glyph as the frame key, i.e.:this.add.sprite(x, y, fontName, 'A')
.BitmapTextWord
,BitmapTextCharacter
andBitmapTextLines
are three new type defs that are now part of theBitmapTextSize
config object, as returned bygetTextBounds
. This improves the TypeScript defs and JS Docs for this object.- The signature of the
ParseXMLBitmapFont
function has changed. Theframe
parameter is no longer optional, and is now the second parameter in the list, instead of being the 4th. If you call this function directly, please update your code. - The
BitmapText.getTextBounds
method was being called every frame, even if the bounds didn't change, potentially costing a lot of CPU time depending on the text length and quantity of them. It now only updates the bounds if they change. - The
GetBitmapTextSize
function usedMath.round
on the values, if theround
parameter wastrue
, which didn't create integers. It now usesMath.ceil
instead to give integer results. - The
GetBitmapTextSize
function has a new boolean parameterupdateOrigin
, which will adjust the origin of the parent BitmapText if set, based on the new bounds calculations. BitmapText.preDestroy
is a new method that will tidy-up all of the BitmapText data during object destruction.BitmapText.dropShadowX
is a new property that controls the horizontal offset of the drop shadow on the Bitmap Text.BitmapText.dropShadowY
is a new property that controls the vertical offset of the drop shadow on the Bitmap Text.BitmapText.dropShadowColor
is a new property that sets the color of the Bitmap Text drop shadow.BitmapText.dropShadowAlpha
is a new property that sets the alpha of the Bitmap Text drop shadow.BatchChar
is a new internal private function for batching a single character of a Bitmap Text to the pipeline.- If you give an invalid Bitmap Font key, the Bitmap Text object will now issue a
console.warn
. - Setting the
color
value in theDynamicBitmapText.setDisplayCallback
would inverse the red and blue channels if the color was not properly encoded for WebGL. It is now encoded automatically, meaning you can pass normal hex values as the colors in the display callback. Fix #5225 (thanks @teebarjunk) - If you apply
setSize
to the Dynamic BitmapText the scissor is now calculated based on the parent transforms, not just the local ones, meaning you can crop Bitmap Text objects that exist within Containers. Fix #4653 (thanks @lgibson02) ParseXMLBitmapFont
has a new optional parametertexture
. If defined, this Texture is populated with Frame data, one frame per glyph. This happens automatically when loading Bitmap Text data in Phaser.- You can now use
setMaxWidth
onDynamicBitmapText
, which wasn't previously possible. Fix #4997 (thanks @AndreaBoeAbrahamsen)
Quad Game Object Removed
The Quad
Game Object has been removed from v3.50.0.
You can now create your own Quads easily using the new Geom.Mesh.GenerateGridVerts
function, which is far more flexible than the old quads were.
Animation API - New Features, API Changes and Bug Fixes
If you use Animations in your game, please read the following important API changes in 3.50:
The Animation API has had a significant overhaul to improve playback handling. Instead of just playing an animation based on its global key, you can now supply a new PlayAnimationConfig
object instead, which allows you to override any of the default animation settings, such as duration
, delay
and yoyo
(see below for the full list). This means you no longer have to create lots of duplicate animations just to change properties such as duration
, and can now set them dynamically at run-time as well.
- The
Animation
class no longer extendsEventEmitter
, as it no longer emits any events directly. This means you cannot now listen for events directly from an Animation instance. All of the events are now dispatched by the Game Objects instead. - All of the
SPRITE_ANIMATION_KEY
events have been removed. Instead, please use the new events which all carry theframeKey
parameter, which can be used to handle frame specific events. The only exception to this isANIMATION_COMPLETE_KEY
, which is a key specific version of the completion event. ANIMATION_UPDATE_EVENT
is a new event that is emitted from a Sprite when an animation updates, i.e. its frame changes.ANIMATION_STOP_EVENT
is a new event that is emitted from a Sprite when its current animation is stopped. This can happen if any of thestop
methods are called, or a new animation is played prior to this one reaching completion. Fix #4894 (thanks @scott20145)- The Game Object
Component.Animation
component has been renamed toAnimationState
and has moved namespace. It's now inPhaser.Animations
instead ofGameObjects.Components
to help differentiate it from theAnimation
class when browsing the documentation. - The
play
,playReverse
,playAfterDelay
,playAfterRepeat
andchain
Sprite and Animation Component methods can now all take aPhaser.Types.Animations.PlayAnimationConfig
configuration object, as well as a string, as thekey
parameter. This allows you to override any default animation setting with those defined in the config, giving you far greater control over animations on a Game Object level, without needing to globally duplicate them. AnimationState.create
is a new method that allows you to create animations directly on a Sprite. These are not global and never enter the Animation Manager, instead residing within the Sprite itself. This allows you to use the same keys across both local and global animations and set-up Sprite specific local animations.AnimationState.generateFrameNumbers
is a new method that is a proxy for the same method available under the Animation Manager. It's exposed in the Animation State so you're able to access it from within a Sprite (thanks @juanitogan)AnimationState.generateFrameNames
is a new method that is a proxy for the same method available under the Animation Manager. It's exposed in the Animation State so you're able to access it from within a Sprite (thanks @juanitogan)- All playback methods:
play
,playReverse
,playAfterDelay
andplayAfterRepeat
will now check to see if the given animation key exists locally on the Sprite first. If it does, it's used, otherwise it then checks the global Animation Manager for the key instead. AnimationState.skipMissedFrames
is now used when playing an animation, allowing you to create animations that run at frame rates far exceeding the refresh rate, or that will update to the correct frame should the game lag. Feature #4232 (thanks @colorcube)AnimationManager.addMix
is a new method that allows you to create mixes between two animations. Mixing allows you to specify a unique delay between a pairing of animations. When playing Animation A on a Game Object, if you then play Animation B, and a mix exists, it will wait for the specified delay to be over before playing Animation B. This allows you to customise smoothing between different types of animation, such as blending between an idle and a walk state, or a running and a firing state.AnimationManager.getMix
is a new method that will return the mix duration between the two given animations.AnimationManager.removeMix
is a new method that will remove the mixture between either two animations, or all mixtures for the given animation.AnimationState.remove
is a new method that will remove a locally stored Animation instance from a Sprite.AnimationState.get
is a new method that will return a locally stored Animation instance from the Sprite.AnimationState.exists
is a new method that will check if a locally stored Animation exists on the Sprite.- The internal
AnimationState.remove
method has been renamed toglobalRemove
. AnimationState.textureManager
is a new property that references the global Texture Manager.AnimationState.anims
is a new property that contains locally created Animations in a Custom Map.AnimationState.play
andSprite.play
no longer accept astartFrame
parameter. Please set it via thePlayAnimationConfig
instead.AnimationState.playReverse
andSprite.playReverse
no longer accept astartFrame
parameter. Please set it via thePlayAnimationConfig
instead.- The
AnimationState.delayedPlay
method has been renamed toplayAfterDelay
. The parameter order has also changed, so the key now comes first instead of the duration. - The
AnimationState.stopOnRepeat
method has been renamed tostopAfterRepeat
- The
AnimationState.getCurrentKey
method has been renamed togetName
. AnimationState.getFrameName
is a new method that will return the key of the current Animation Frame, if an animation has been loaded.AnimationState.playAfterDelay
andSprite.playAfterDelay
are new methods that will play the given animation after the delay in ms expires.AnimationState.playAfterRepeat
andSprite.playAfterRepeat
are new methods that will play the given animation after the current animation finishes repeating. You can also specify the number of repeats allowed left to run.- The
AnimationState.chain
method is now available on the Sprite class. - The
AnimationState.stopAfterDelay
method is now available on the Sprite class. - The
AnimationState.stopAfterRepeat
method is now available on the Sprite class. - The
AnimationState.stopOnFrame
method is now available on the Sprite class. AnimationManager.createFromAseprite
is a new method that allows you to use animations created in the Aseprite editor directly in Phaser. Please see the comprehensive documentation for this method for full details on how to do this.AnimationState
now handles all of the loading of the animation. It no longer has to make calls out to the Animation Manager or Animation instance itself and will load the animation data directly, replacing as required from the optionalPlayAnimationConfig
. This improves performance and massively reduces CPU calls in animation heavy games.- The
PlayAnimationConfig.frameRate
property lets you optionally override the animation frame rate. - The
PlayAnimationConfig.duration
property lets you optionally override the animation duration. - The
PlayAnimationConfig.delay
property lets you optionally override the animation delay. - The
PlayAnimationConfig.repeat
property lets you optionally override the animation repeat counter. - The
PlayAnimationConfig.repeatDelay
property lets you optionally override the animation repeat delay value. - The
PlayAnimationConfig.yoyo
property lets you optionally override the animation yoyo boolean. - The
PlayAnimationConfig.showOnStart
property lets you optionally override the animation show on start value. - The
PlayAnimationConfig.hideOnComplete
property lets you optionally override the animation hide on complete value. - The
PlayAnimationConfig.startFrame
property lets you optionally set the animation frame to start on. - The
PlayAnimationConfig.timeScale
property lets you optionally set the animation time scale factor. AnimationState.delayCounter
is a new property that allows you to control the delay before an animation will start playing. Only once this delay has expired, will the animationSTART
events fire. Fix #4426 (thanks @bdaenen)AnimationState.hasStarted
is a new boolean property that allows you to tell if the current animation has started playing, or is still waiting for a delay to expire.AnimationState.showOnStart
is a new boolean property that controls if the Game Object should havesetVisible(true)
called on it when the animation starts.AnimationState.hideOnComplete
is a new boolean property that controls if the Game Object should havesetVisible(false)
called on it when the animation completes.- The
AnimationState.chain
method docs said it would remove all pending animations if called with no parameters. However, it didn't - and now does! - The
AnimationState.setDelay
method has been removed. It never actually worked and you can now perform the same thing by calling eitherplayAfterDelay
or setting thedelay
property in the play config. - The
AnimationState.getDelay
method has been removed. You can now read thedelay
property directly. - The
AnimationState.setRepeat
method has been removed. You can achieve the same thing by setting therepeat
property in the play config, or adjusting the publicrepeatCounter
property if the animation has started. AnimationState.handleStart
is a new internal private method that handles the animation start process.AnimationState.handleRepeat
is a new internal private method that handles the animation repeat process.AnimationState.handleStop
is a new internal private method that handles the animation stop process.AnimationState.handleComplete
is a new internal private method that handles the animation complete process.AnimationState.emitEvents
is a new internal private method that emits animation events, cutting down on duplicate code.- The
AnimationState.restart
method has a new optional boolean parameterresetRepeats
which controls if you want to reset the repeat counter during the restart, or not. Animation.getTotalFrames
is a new method that will return the total number of frames in the animation. You can access it viathis.anims.currentAnim.getTotalFrames
from a Sprite.Animation.calculateDuration
is a new method that calculates the duration, frameRate and msPerFrame for a given animation target.- The
BuildGameObjectAnimation
function now uses thePlayAnimationConfig
object to set the values. Sprite.playReverse
is a new method that allows you to play the given animation in reverse on the Sprite.Sprite.playAfterDelay
is a new method that allows you to play the given animation on the Sprite after a delay.Sprite.stop
is a new method that allows you to stop the current animation on the Sprite.AnimationManager.load
has been removed as it's no longer required.AnimationManager.staggerPlay
has been fixed so you can now pass in negative stagger values.AnimationManager.staggerPlay
has a new optional boolean parameterstaggerFirst
, which allows you to either include or exclude the first child in the stagger calculations.- The
Animation.completeAnimation
method has been removed as it's no longer required. - The
Animation.load
method has been removed as it's no longer required. - The
Animation.setFrame
method has been removed as it's no longer required. - The
Animation.getFirstTick
method has no longer needs theincludeDelay
parameter, as it's handled byAnimationState
now. - The
Animation.getFrames
method has a new optional boolean parametersortFrames
which will run a numeric sort on the frame names after constructing them, if a string-based frame is given. Types.Animations.Animation
has a new boolean propertysortFrames
, which lets Phaser numerically sort the generated frames.AnimationState.timeScale
is a new public property that replaces the old private_timeScale
property.AnimationState.delay
is a new public property that replaces the old private_delay
property.AnimationState.repeat
is a new public property that replaces the old private_repeat
property.AnimationState.repeatDelay
is a new public property that replaces the old private_repeatDelay
property.AnimationState.yoyo
is a new public property that replaces the old private_yoyo
property.AnimationState.inReverse
is a new public property that replaces the old private_reverse
property.AnimationState.startAnimation
is a new public method that replaces the old private_startAnimation
method.- The
AnimationState.getProgress
method has been fixed so it will return correctly if the animation is playing in reverse. - The
AnimationState.globalRemove
method will now always be called when an animation is removed from the global Animation Manager, not just once. - The
AnimationState.getRepeat
method has now been removed. You can get the value from therepeat
property. - The
AnimationState.setRepeatDelay
method has now been removed. You can set the value using therepeatDelay
config property, or changing it at run-time. AnimationState.complete
is a new method that handles the completion in animation playback.- The
AnimationState.setTimeScale
method has now been removed. You can set the value using thetimeScale
config property, or changing it at run-time. - The
AnimationState.getTimeScale
method has now been removed. You can read the value using thetimeScale
property. - The
AnimationState.getTotalFrames
method has been fixed and won't error if called when no animation is loaded. - The
AnimationState.setYoyo
method has now been removed. You can set the value using theyoyo
config property, or changing it at run-time. - The
AnimationState.getYoyo
method has now been removed. You can read the value using theyoyo
property. - The
AnimationState.stopAfterRepeat
method now has an optional parameterrepeatCount
, so you can tell the animation to stop after a specified number of repeats, not just 1. - When playing an animation in reverse, if it reached the first frame and had to repeat, it would then jump to the frame before the final frame and carry on, skipping out the final frame.
- The
AnimationState.updateFrame
method has now been removed. Everything is handled bysetCurrentFrame
instead, which removes one extra step out of the update process. GenerateFrameNames
will nowconsole.warn
if the generated frame isn't present in the texture, which should help with debugging animation creation massively.GenerateFrameNumbers
will nowconsole.warn
if the generated frame isn't present in the texture, which should help with debugging animation creation massively.GenerateFrameNumbers
would include the__BASE
frame by mistake in its calculations. This didn't end up in the final animation, but did cause a cache miss when building the animation.GenerateFrameNumbers
can now accept thestart
andend
parameters in reverse order, meaning you can now do{ start: 10, end: 1 }
to create the animation in reverse.GenerateFrameNames
can now accept thestart
andend
parameters in reverse order, meaning you can now do{ start: 10, end: 1 }
to create the animation in reverse.
Tilemap - New Features, API Changes and Bug Fixes
There are three large changes to Tilemaps in 3.50. If you use tilemaps, you must read this section:
- The first change is that there are no longer
DynamicTilemapLayer
andStaticTilemapLayer
classes. They have both been removed and replaced with the newTilemapLayer
class. This new class consolidates features from both and provides a lot cleaner API experience, as well as speeding up internal logic.
In your game where you use map.createDynamicLayer
or map.createStaticLayer
replace it with map.createLayer
instead.
-
The second change is that the Tilemap system now supports isometric, hexagonal and staggered isometric map types, along with the previous orthogonal format, thanks to a PR from @svipal. You can now export maps using any of these orientations from the Tiled Map Editor and load them into Phaser using the existing tilemap loading API. No further changes need to take place in the way your maps are loaded.
-
The
Tilemap.createFromObjects
method has been overhauled to make it much more useful. The method signature has changed and it now takes a newCreateFromObjectLayerConfig
configuration object, or an array of them, which allows much more fine-grained control over which objects in the Tiled Object Layers are converted and what they are converted to. Previously it could only convert to Sprites, but you can now pass in a custom class, filter based on id, gid or name, even provide a Container to add the created Game Objects to. Please see the new documentation for this method and the config object for more details. Fix #3817 #4613 (thanks @georgzoeller @Secretmapper)
- The
Tilemap.createDynamicLayer
method has been renamed tocreateLayer
. - The
Tilemap.createStaticLayer
method has been removed. UsecreateLayer
instead. - The
Tilemap.createBlankDynamicLayer
method has been renamed tocreateBlankLayer
. - The
Tilemap.convertLayerToStatic
method has been removed as it is no longer required. - The
TilemapLayerWebGLRenderer
function will no longer iterate through the layer tilesets, drawing tiles from only that set. Instead all it does now is iterate directly through only the tiles. This allows it to take advantage of the new Multi Texturing pipeline and also draw multi-tileset isometric layers correctly. Phaser.Types.Tilemaps.TilemapOrientationType
is a new type def that holds the 4 types of map orientation now supported.- The
Tile.updatePixelXY
method now updates the tile XY position based on map type. ParseTilesets
will now correctly handle non-consecutive tile IDs. It also now correctly sets themaxId
property, fixing a bug where tiles wouldn't render if from IDs outside the expected range. Fix #4367 (thanks @jackfreak)Tilemap.hexSideLength
is a new property that holds the length of the hexagon sides, if using Hexagonal Tilemaps.LayerData.orientation
is a new property that holds the tilemap layers orientation constant.LayerData.hexSideLength
is a new property that holds the length of the hexagon sides, if using Hexagonal Tilemaps.MapData.orientation
is a new property that holds the tilemap layers orientation constant.MapData.hexSideLength
is a new property that holds the length of the hexagon sides, if using Hexagonal Tilemaps.Tilemaps.Components.HexagonalWorldToTileY
is a new function that converts a world Y coordinate to hexagonal tile Y coordinate.Tilemaps.Components.StaggeredWorldToTileY
is a new function that converts a world Y coordinate to staggered tile Y coordinate.Tilemaps.Components.HexagonalWorldToTileXY
is a new function that converts world coordinates to hexagonal tile coordinates.Tilemaps.Components.IsometricWorldToTileXY
is a new function that converts world coordinates to isometric tile coordinates.Tilemaps.Components.StaggeredWorldToTileXY
is a new function that converts world coordinates to staggered tile coordinates.Tilemaps.Components.HexagonalTileToWorldY
is a new function that converts a hexagonal Y coordinate to a world coordinate.Tilemaps.Components.StaggeredTileToWorldY
is a new function that converts a staggered Y coordinate to a world coordinate.Tilemaps.Components.HexagonalTileToWorldXY
is a new function that converts hexagonal tile coordinates to world coordinates.Tilemaps.Components.IsometricTileToWorldXY
is a new function that converts isometric tile coordinates to world coordinates.Tilemaps.Components.StaggeredTileToWorldXY
is a new function that converts staggered tile coordinates to world coordinates.Tilemaps.Components.GetTileToWorldXFunction
is a new function that returns the correct conversion function to use.Tilemaps.Components.GetTileToWorldYFunction
is a new function that returns the correct conversion function to use.Tilemaps.Components.GetTileToWorldXXFunction
is a new function that returns the correct conversion function to use.Tilemaps.Components.GetWorldToTileXFunction
is a new function that returns the correct conversion function to use.Tilemaps.Components.GetWorldToTileYFunction
is a new function that returns the correct conversion function to use.Tilemaps.Components.GetWorldToTileXYFunction
is a new function that returns the correct conversion function to use.Tilemaps.Components.GetCullTilesFunction
is a new function that returns the correct culling function to use.Tilemaps.Components.HexagonalCullTiles
is a new function that culls tiles in a hexagonal map.Tilemaps.Components.StaggeredCullTiles
is a new function that culls tiles in a staggered map.Tilemaps.Components.IsometricCullTiles
is a new function that culls tiles in a isometric map.Tilemaps.Components.CullBounds
is a new function that calculates the cull bounds for an orthogonal map.Tilemaps.Components.HexagonalCullBounds
is a new function that calculates the cull bounds for a hexagonal map.Tilemaps.Components.StaggeredCullBounds
is a new function that calculates the cull bounds for a staggered map.Tilemaps.Components.RunCull
is a new function that runs the culling process from the combined bounds and tilemap.Tilemap._convert
is a new internal private hash of tilemap conversion functions used by the public API.- The
Tilemap._isStaticCall
method has been removed and no Tilemap methods now check this, leading to faster execution. - The Arcade Physics Sprites vs. Tilemap Layers flow has changed. Previously, it would iterate through a whole bunch of linked functions, taking lots of jumps in the process. It now just calls the
GetTilesWithinWorldXY
component directly, saving lots of overhead. - The method
Tilemap.weightedRandomize
has changed so that the parameterweightedIndexes
is now first in the method and is non-optional. Previously, it was the 5th parameter and incorrectly flagged as optional. - The method
TilemapLayer.weightedRandomize
has changed so that the parameterweightedIndexes
is now first in the method and is non-optional. Previously, it was the 5th parameter and incorrectly flagged as optional.
Update List - New Features, API Changes and Bug Fixes
The way in which Game Objects add themselves to the Scene Update List has changed. Instead of being added by the Factory methods, they will now add and remove themselves based on the new ADDED_TO_SCENE
and REMOVED_FROM_SCENE
events. This means, you can now add Sprites directly to a Container, or Group, and they'll animate properly without first having to be part of the Update List. The full set of changes and new features relating to this follow:
GameObjects.Events.ADDED_TO_SCENE
is a new event, emitted by a Game Object, when it is added to a Scene, or a Container that is part of the Scene.GameObjects.Events.REMOVED_FROM_SCENE
is a new event, emitted by a Game Object, when it is removed from a Scene, or a Container that is part of the Scene.Scenes.Events.ADDED_TO_SCENE
is a new event, emitted by a Scene, when a new Game Object is added to the display list in the Scene, or a Container that is on the display list.Scenes.Events.REMOVED_FROM_SCENE
is a new event, emitted by a Scene, when it a Game Object is removed from the display list in the Scene, or a Container that is on the display list.GameObject.addedToScene
is a new method that custom Game Objects can use to perform additional set-up when a Game Object is added to a Scene. For example, Sprite uses this to add itself to the Update List.GameObject.removedFromScene
is a new method that custom Game Objects can use to perform additional tear-down when a Game Object is removed from a Scene. For example, Sprite uses this to remove themselves from the Update List.- Game Objects no longer automatically remove themselves from the Update List during
preDestroy
. This should be handled directly in theremovedFromScene
method now. - The
Container
will now test to see if any Game Object added to it is already on the display list, or not, and emit its ADDED and REMOVED events accordingly. Fix #5267 #3876 (thanks @halgorithm @mbpictures) DisplayList.events
is a new property that references the Scene's Event Emitter. This is now used internally.DisplayList.addChildCallback
is a new method that overrides the List callback and fires the new ADDED events.DisplayList.removeChildCallback
is a new method that overrides the List callback and fires the new REMOVED events.GameObjectCreator.events
is a new property that references the Scene's Event Emitter. This is now used internally.GameObjectFactory.events
is a new property that references the Scene's Event Emitter. This is now used internally.ProcessQueue.checkQueue
is a new boolean property that will make sure only unique objects are added to the Process Queue.- The
Update List
now uses the newcheckQueue
property to ensure no duplicate objects are on the active list. DOMElementFactory
,ExternFactory
,ParticleManagerFactor
,RopeFactory
andSpriteFactory
all no longer add the objects to the Update List, this is now handled by the ADDED events instead.Sprite
,Rope
,ParticleEmitterManager
,Extern
andDOMElement
now all override theaddedToScene
andremovedFromScene
callbacks to handle further set-up tasks.
Input Manager and Mouse Manager - New Features, API Changes and Bug Fixes
ScaleManager.refresh
is now called when theGame.READY
event fires. This fixes a bug where the Scale Manager would have the incorrect canvas bounds, because they were calculated before a previous canvas was removed from the DOM. Fix #4862 (thanks @dranitski)- The Game Config property
inputMouseCapture
has been removed, as this is now split into 3 new config options: inputMousePreventDefaultDown
is a new config option that allows you to controlpreventDefault
calls specifically on mouse down events. Set it viainput.mouse.preventDefaultDown
in the Game Config. It defaults totrue
, the same as the previouscapture
property did.inputMousePreventDefaultUp
is a new config option that allows you to controlpreventDefault
calls specifically on mouse up events. Set it viainput.mouse.preventDefaultUp
in the Game Config. It defaults totrue
, the same as the previouscapture
property did.inputMousePreventDefaultMove
is a new config option that allows you to controlpreventDefault
calls specifically on mouse move events. Set it viainput.mouse.preventDefaultMove
in the Game Config. It defaults totrue
, the same as the previouscapture
property did.inputMousePreventDefaultWheel
is a new config option that allows you to controlpreventDefault
calls specifically on mouse wheel events. Set it viainput.mouse.preventDefaultWheel
in the Game Config. It defaults totrue
, the same as the previouscapture
property did.- The
MouseManager.capture
property has been removed, as this is now split into 3 new config options (see below) MouseManager.preventDefaultDown
is a new boolean property, set via theinputMousePreventDefaultDown
config option that allows you to toggle capture of mouse down events at runtime.MouseManager.preventDefaultUp
is a new boolean property, set via theinputMousePreventDefaultUp
config option that allows you to toggle capture of mouse up events at runtime.MouseManager.preventDefaultMove
is a new boolean property, set via theinputMousePreventDefaultMove
config option that allows you to toggle capture of mouse move events at runtime.MouseManager.preventDefaultWheel
is a new boolean property, set via theinputMousePreventDefaultWheel
config option that allows you to toggle capture of mouse wheel at runtime.- In the
MouseManager
the up, down and move events are no longer set as being passive if captured. Over, Out, Wheel and the Window level Down and Up events are always flagged as being passive. Wheel events are non-passive if capturing is enabled. - The
GamepadPlugin
will now callrefreshPads
as part of its start process. This allows you to use Gamepads across multiple Scenes, without having to wait for a connected event from each one of them. If you've already had a connected event in a previous Scene, you can now just read the pads directly viathis.input.gamepad.pad1
and similar. Fix #4890 (thanks @Sytten) - Shutting down the Gamepad plugin (such as when sleeping a Scene) no longer calls
GamepadPlugin.disconnectAll
, but destroying it does. Gamepad._created
is a new private internal property that keeps track of when the instance was created. This is compared to the navigator timestamp in the update loop to avoid event spamming. Fix #4890.Pointer.down
will now check if the browser is running under macOS and if the ctrl key was also pressed, if so, it will flag the down event as being a right-click instead of a left-click, as per macOS conventions. Fix #4245 (thanks @BigZaphod)- When destroying an interactive Game Object that had
useHandCursor
enabled, it would reset the CSS cursor to default, even if the cursor wasn't over that Game Object. It will now only reset the cursor if it's over the Game Object being destroyed. Fix #5321 (thanks @JstnPwll) - The
InputPlugin.shutdown
method will now reset the CSS cursor, in case it was set by any Game Objects in the Scene that have since been destroyed. - The
InputPlugin.processOverEvents
has had a duplicate internal loop removed from it (thanks KingCosmic)
Tint Component Updates and resulting Shader Changes
Phaser has had the ability to apply an additive tint to a Game Object since the beginning, and gained 'filled tints', with and without texture alpha, in v3.11. While this was handy, it introduced a 3-way if-else condition to the shaders to handle the different modes. Plus, setting tint colors was also generating rgb order Float32 color values for each Game Object, making reading those colors back again difficult (as they'd return in BGR order).
This has all changed in 3.50, as outlined below. Tint values are now used directly in the shader and don't pass through a color conversion function first. Lots of private properties have been removed and the shaders no longer have a 3-way if-else block. All of this means improved performance and a slight reduction in memory overhead.
Tint.tintTopLeft
is now a normal property in RGB order, not a setter, and no longer passes through theGetColorFromValue
function. This directly replaces the private property_tintTL
which has now been removed.Tint.tintTopRight
is now a normal property in RGB order, not a setter, and no longer passes through theGetColorFromValue
function. This directly replaces the private property_tintTR
which has now been removed.Tint.tintBottomLeft
is now a normal property in RGB order, not a setter, and no longer passes through theGetColorFromValue
function. This directly replaces the private property_tintBL
which has now been removed.Tint.tintBottomRight
is now a normal property in RGB order, not a setter, and no longer passes through theGetColorFromValue
function. This directly replaces the private property_tintBR
which has now been removed.- The property
Tint._isTinted
has been removed as it's no longer required. - The
Single.frag
,Light.frag
andMulti.frag
shaders have all been updated so they now read the color value asoutTint.bgr
instead ofoutTint.rgb
. This allows the colors to remain in RGB order within the Tint component. - The
Single.frag
,Light.frag
andMulti.frag
shaders have all been updated so they no longer have a 3-way check on theoutTintEffect
value. - The
Multi Pipeline
,Bitmap Text
,Render Texture
,Text
,TileSprite
andCamera
now all read the tint values from the public properties instead of the private_tintTL
etc ones. They also now set thetintEffect
value directly from thetintFill
property, removing another conditional check. - The function
GetColorFromValue
has been removed as it's no longer used internally. - The
Rope.tintFill
property is now a boolean, not an integer, and can no longer take2
as a value for a complete fill. Instead, you should provide a solid color texture with no alpha. - As a result of the change to the shader, all uses of the WebGL Util function
getTintAppendFloatAlphaAndSwap
have been replaced withgetTintAppendFloatAlpha
instead. - As a result of the change to the shader, the Multi Pipeline now uses the
WebGLRenderer.whiteTexture
andtintEffect
mode of 1 by default, instead of mode 2 (which has been removed) and a transparent texture. This ensures Graphics and Shapes objects still render correctly under the new smaller shader code. WebGLRenderer.whiteTexture
is a new property that is a reference to a pure white 4x4 texture that is created during Boot by the Texture Manager. The Graphics Pipeline uses this internally for all geometry fill rendering.- The
TextureManager
now generates a new texture with the key__WHITE
during its boot process. This is a pure white 4x4 texture used by the Graphics pipelines. Config.images.white
is a new Game Config property that specifies the 4x4 white PNG texture used by Graphics rendering. You can override this via the config, but only do so if needed.
Arcade Physics - New Features, API Changes and Bug Fixes
Prior to v3.50 an Arcade Physics Body could be one of two states: immovable, or movable. An immovable body could not receive any impact from another Body. If something collided with it, it wouldn't even separate to break free from the collision (the other body had to take the full separation value). It was intended for objects such as platforms, ground or walls, there they absolutely shouldn't move under any circumstances. As a result, two immovable bodies could never be collided together. While this worked for scenery-like items, it didn't work if you required maybe 2 players who could collide with each other, but should never be able to push one another. As of 3.50 all physics bodies now have a new property pushable
that allows this. A pushable body can share separation with its collider, as well as take on mass-based velocity from the impact. A non-pushable body will behave differently depending on what it collides with. For example, a pushable body hitting a non-pushable (or immovable) body will rebound off it.
- The Arcade Physics
Body
class has a new boolean propertypushable
(true, by default). This allows you to set if a Body can be physically pushed by another Body, or not. Fix #4175 #4415 (thanks @inmylo @CipSoft-Components) Body.setPushable
is a new chainable method that allows you to set thepushable
state of a Body.Arcade.Components.Pushable
is a new component, inherited by the standard Arcade Physics Image and Sprite classes.- Bodies will now check to see if they are blocked in the direction they're being pushed, before resolving the collision. This helps stop some bodies from being pushed into other objects.
- Bodies will now check which direction they were moving and separate accordingly. This helps stop some bodies from being pushed into other objects.
ArcadePhysics.disableUpdate
is a new method that will prevent the Arcade Physics Worldupdate
method from being called when the Scene updates. By disabling it, you're free to call the update method yourself, passing in your own delta and time values.ArcadePhysics.enableUpdate
is a new method that will make the Arcade Physics World update in time with the Scene update. This is the default, so only call this if you have specifically disabled it previously.ArcadeWorldConfig.customUpdate
is a new boolean property you can set in the Arcade Physics config object, either in the Scene or in the Game Config. Iftrue
the World update will never be called, allowing you to call it yourself from your own component. Close #5190 (thanks @cfortuner)Physics.Arcade.Body.setCollideWorldBounds
now has a new optional parameteronWorldBounds
which allows you to enable the Body'sonWorldBounds
property in the same call (thanks @samme)ArcadePhysics.Body.setMaxVelocityX
is a new method that allows you to set the maximum horizontal velocity of a Body (thanks @samme)ArcadePhysics.Body.setMaxVelocityY
is a new method that allows you to set the maximum vertical velocity of a Body (thanks @samme)- The
PhysicsGroup
config now has two new optional propertiesmaxVelocityX
andmaxVelocityY
which allows you to set the maximum velocity on bodies added to the Group (thanks @samme) - The
Arcade.Body.resetFlags
method has a new optional boolean parameterclear
. If set, it clears thewasTouching
flags on the Body. This happens automatically whenBody.reset
is called. Previous to this, the flags were not reset until the next physics step (thanks @samme) Physics.Arcade.ProcessX
is a new set of functions, called by theSeparateX
function, that handles all of the different collision tests, checks and resolutions. These functions are not exposed in the public API.Physics.Arcade.ProcessY
is a new set of functions, called by theSeparateY
function, that handles all of the different collision tests, checks and resolutions. These functions are not exposed in the public API.Arcade.Body.center
values were incorrect after collisions with the world bounds or (for rectangular bodies) after collisions with another body. The body center is now updated after those separations (thanks @samme)- The Arcade Physics
WORLD_STEP
event now has a new parameter: the delta argument (thanks @samme) - The Arcade Body
drag
property has been redefined when damping is used and scales the damping multiplier by the physics step delta. Drag is now the velocity retained after 1 second instead of after 1 step, when damping is used. This makes damping consistent for different physics step rates and more accurate when fixedStep is off. If you usedrag
you will need to change any existing drag values to get the same effects as before. Convertdrag
todrag ^ 60
ordrag ^ fps
if you use a different step rate (thanks @samme)
New Features
Geom.Intersects.GetLineToLine
is a new function that will return a Vector3 containing the point of intersection between 2 line segments, with thez
property holding the distance value.Geom.Intersects.GetLineToPolygon
is a new function that checks for the closest point of intersection between a line segment and an array of polygons.Geom.Intersects.GetLineToPoints
is a new function that checks for the closest point of intersection between a line segment and an array of points, where each pair of points form a line segment.Geom.Intersects.GetRaysFromPointToPolygon
is a new function that emits rays out from the given point and detects for intersection against all given polygons, returning the points of intersection in the results array.Geom.Polygon.Translate
is a new function that allows you to translate all the points of a polygon by the given values.Geom.Polygon.Simplify
is a new function that takes a polygon and simplifies the points by running them through a combination of Douglas-Peucker and Radial Distance algorithms, potentially dramatically reducing the number of points while retaining its shape.Phaser.Types.Math.Vector3Like
is a new data type representing as Vector 3 like object.Phaser.Types.Math.Vector4Like
is a new data type representing as Vector 4 like object.Transform.getLocalPoint
is a new method, available on all Game Objects, that takes anx
/y
pair and translates them into the local space of the Game Object, factoring in parent transforms and display origins.- The
KeyboardPlugin
will now track the key code and timestamp of the previous key pressed and compare it to the current event. If they match, it will skip the event. On some systems, if you were to type quickly, you would sometimes get duplicate key events firing (the exact same event firing more than once). This is now prevented from happening. Display.Color.GetColorFromValue
is a new function that will take a hex color value and return it as an integer, for use in WebGL. This is now used internally by the Tint component and other classes.Utils.String.RemoveAt
is a new function that will remove a character from the given index in a string and return the new string.Frame.setUVs
is a new method that allows you to directly set the canvas and UV data for a frame. Use this if you need to override the values set automatically during frame creation.TweenManager.getTweensOf
has a new parameterincludePending
. If set, it will also check the pending tweens for the given targets and return those in the results as well. Fix #5260 (thanks @pcharest2000)WebGLPipeline.hasBooted
is a new boolean property that tracks if the pipeline has been booted or not, which is now far more important in 3.5 than in previous versions. This is checked in theWebGLRenderer.addPipeline
method, and if not set, the pipeline is booted. Fix #5251 #5255 (thanks @telinc1 @rexrainbow)- The WebGL Renderer will now add the pipelines during the
boot
method, instead ofinit
. - You can now use
this.renderer
from within a Scene, as it's now a Scene-level property and part of the Injection Map. Clock.addEvent
can now take an existingTimerEvent
object, as well as a config object. If aTimerEvent
is given it will be removed from the Clock, reset and then added. This allows you to pool TimerEvents rather than constantly create and delete them. Fix #4115 (thanks @jcyuan)Clock.removeEvent
is a new method that allows you to remove aTimerEvent
, or an array of them, from all internal lists of the current Clock.Group.getMatching
is a new method that will return any members of the Group that match the given criteria, such asgetMatching('visible', true)
(thanks @atursams)Utils.Array.SortByDigits
is a new function that takes the given array of strings and runs a numeric sort on it, ignoring any non-digits.GroupCreateConfig
, which is used when callingGroup.createMultiple
orGroup.createFromConfig
, can now accept the following new properties:setOrigin: { x, y, stepX, stepY }
which are applied to the items created by the Group.Transform.copyPosition
is a new method that will copy the position from the given object to the Game Object (thanks @samme)- The
Text.MeasureText
function, which is used to calculate the ascent and descent of Text Game Objects whenever the style, or font size, is changed, has been updated to use the newactualBoundingBoxAscent
functions present in modern browsers. This allows for significantly faster ascent calculations than previously. Older browsers, such as IE, will still fall back (thanks @rexrainbow) GameObjects.GetCalcMatrix
is a new function that is used to calculate the transformed Game Object matrix, based on the given Game Object, Camera and Parent. This function is now used by the following Game Objects:BitmapText
(Static and Dynamic),Graphics
,Extern
,Mesh
,Rope
,Shader
,Arc
,Curve
,Ellipse
,Grid
,IsoBox
,IsoTriangle
,Line
,Polygon
,Rectangle
,Star
andTriangle
. This dramatically reduces the amount of duplicate code across the API.Utils.Array.Matrix.Translate
is a new function that will translate an Array Matrix by horizontally and vertically by the given amounts.Vertor3.addScale
is a new method that will add the given vector and multiply it in the process.- When defining the ease used with a Particle Emitter you can now set
easeParams
in the config object, allowing you to pass custom ease parameters through to an ease function (thanks @vforsh) BitmapMask.createMask
is a new method that will internally create the WebGL textures and framebuffers required for the mask. This is now used by the constructor and if the context is lost. It now also clears any previous textures/fbos that may have been created first, helping prevent memory leaks.BitmapMask.clearMask
will delete any WebGL textures or framebuffers the mask is using. This is now called when the mask is destroyed, or a new mask is created upon it.Quaternion
now has a new propertyonChangeCallback
which, if set, will be invoked each time the quaternion is updated. This allows you to link change events to other objects.- The
Quaternion.set
method has a new optional boolean parameterupdate
(defaults totrue
), which will call theonChangeCallback
if set. Quaternion.setFromEuler
is a new method that will set the quaternion from the givenEuler
object, optionally calling theonChangeCallback
in the process.Quaternion.setFromRotationMatrix
is a new method that will set the rotation of the quaternion from the given Matrix4.Vector3.setFromMatrixPosition
is a new method that will set the components of the Vector3 based on the position of the given Matrix4.Vector3.setFromMatrixColumn
is a new method that will set the components of the Vector3 based on the specified Matrix4 column.Vector3.fromArray
is a new method that will set the components of the Vector3 based on the values in the given array, at the given offset.Vector3.min
is a new method that will set the components of the Vector3 based on theMain.min
between it and the given Vector3.Vector3.max
is a new method that will set the components of the Vector3 based on theMain.max
between it and the given Vector3.Vector3.addVectors
is a new method that will set the components of the Vector3 based on the addition of the two Vector3s given.Vector3.addScalar
is a new method that will multiply the components of the Vector3 by the scale value given.Vector3.applyMatrix3
is a new method that will take a Matrix3 and apply it to the Vector3.Vector3.applyMatrix4
is a new method that will take a Matrix4 and apply it to the Vector3.Vector3.projectViewMatrix
is a new method that multiplies the Vector3 by the given view and projection matrices.Vector3.unprojectViewMatrix
is a new method that multiplies the Vector3 by the given inversed projection matrix and world matrix.Matrix4.setValues
is a new method that allows you to set all of the matrix components individually. Most internal methods now use this.Matrix.multiplyToMat4
is a new method that multiplies a Matrix4 by the givensrc
Matrix4 and stores the results in theout
Matrix4.Matrix4.fromRotationXYTranslation
is a new method that takes the rotation and position vectors and builds this Matrix4 from them.Matrix4.getMaxScaleOnAxis
is a new method that will return the maximum axis scale from the Matrix4.Matrix4.lookAtRH
is a new method that will generate a right-handed look-at matrix from the given eye, target and up positions.Matrix4.transform
is a new method that will generate a transform matrix from the given position and scale vectors and a rotation quaternion.Matrix4.multiplyMatrices
is a new method that multiplies two given Matrix4 objects and stores the results in the Matrix4.Matrix4.premultiply
is a new method that takes a Matrix4 and multiplies it by the current Matrix4.Matrix4.getInverse
is a new method that takes a Matrix4, copies it to the current matrix, then returns the inverse of it.CameraManager.getVisibleChildren
is a new method that is called internally by theCameraManager.render
method. It filters the DisplayList, so that Game Objects that pass thewillRender
test for the given Camera are added to a sub-list, which is then passed to the renderer. This avoids the renderer having to do any checks on the children, it just renders each one in turn.Physics.Arcade.Body.setDamping
is a new method that allows you to set theuseDamping
property of a Body in a chainable way. Fix #5352 (thanks @juanitogan)- The
GameObjects.Graphics.fillGradientStyle
method can now accept a different alpha value for each of the fill colors. The default is still 1. If you only provide a single alpha, it'll be used for all colors. Fix #5044 (thanks @zhangciwu) Types.Core.PipelineConfig
is a new configuration object that you can set in the Game Config under thepipeline
property. It allows you to define custom WebGL pipelines as part of the Game Config, so they're automatically installed and ready for use by all Scenes in your game. You can either set thepipeline
object, or set it under therender
sub-config.Utils.Object.DeepCopy
is a new function that will recursively deep copy an array of object.Time.TimerEvent.getRemaining
is a new method that returns the time interval until the next iteration of the Timer Event (thanks @samme)Time.TimerEvent.getRemainingSeconds
is a new method that returns the time interval until the next iteration of the Timer Event in seconds (thanks @samme)Time.TimerEvent.getOverallRemaining
is a new method that returns the time interval until the last iteration of the Timer Event (thanks @samme)Time.TimerEvent.getOverallRemainingSeconds
is a new method that returns the time interval until the last iteration of the Timer Event in seconds (thanks @samme)GameObjects.Video.loadMediaStream
is a new method that allows you to hook a Video Game Object up to a Media Stream, rather than a URL, allowing you to stream video from a source such as a webcam (thanks @pirateksh)Display.Color.ColorSpectrum
is a new function that will return an array of 1024 Color Object elements aligned in a Color Spectrum layout, where the darkest colors have been omitted.AsepriteFile
is a new File Type for the Loader that allows you to load Aseprite images and animation data for use with the new Aseprite animation features. You can call this viathis.load.asesprite(png, json)
.GameObject.displayList
is a new property that contains a reference to the Display List to which the Game Object has been added. This will typically either by the Display List owned by a Scene, or a Layer Game Object. You should treat this property as read-only.- The
Shader
Game Object now supports being able to use a Render Texture as asampler2D
texture on the shader #5423 (thanks @ccaleb) BaseSound.pan
,HTMLAudioSound.pan
andWebAudioSound.pan
are new properties that allow you to get or set the pan value of a sound, a value between -1 (full left pan) and 1 (full right pan). Note that pan only works under Web Audio, but the property and event still exists under HTML5 Audio for compatibility (thanks @pi-kei)WebAudioSound.setPan
is a new method that allows you to set the pan of the sound. A value between -1 (full left pan) and 1 (full right pan) (thanks @pi-kei)Sound.Events.PAN
is a new event dispatched by both Web Audio and HTML5 Audio Sound objects when their pan changes (thanks @pi-kei)
ColorMatrix
Phaser.Display.ColorMatrix
is a new class that allows you to create and manipulate a 5x4 color matrix, which can be used by shaders or graphics operations.- The
ColorMatrix.set
method allows you to set the values of a ColorMatrix. - The
ColorMatrix.reset
method will reset the ColorMatrix to its default values. - The
ColorMatrix.getData
method will return the data in the ColorMatrix as a Float32Array, useful for setting in a shader uniform. - The
ColorMatrix.brightness
method lets you set the brightness of the ColorMatrix. - The
ColorMatrix.saturate
method lets you set the saturation of the ColorMatrix. - The
ColorMatrix.desaturate
method lets you desaturate the colors in the ColorMatrix. - The
ColorMatrix.hue
method lets you rotate the hues of the ColorMatrix by the given amount. - The
ColorMatrix.grayscale
method converts the ColorMatrix to grayscale. - The
ColorMatrix.blackWhite
method converts the ColorMatrix to black and whites. - The
ColorMatrix.contrast
method lets you set the contrast of the ColorMatrix. - The
ColorMatrix.negative
method converts the ColorMatrix to negative values. - The
ColorMatrix.desaturateLuminance
method applies a desaturated luminance to the ColorMatrix. - The
ColorMatrix.sepia
method applies a sepia tone to the ColorMatrix. - The
ColorMatrix.night
method applies a night time effect to the ColorMatrix. - The
ColorMatrix.lsd
method applies a trippy color effect to the ColorMatrix. - The
ColorMatrix.brown
method applies a brown tone to the ColorMatrix. - The
ColorMatrix.vintagePinhole
method applies a vintage pinhole color effect to the ColorMatrix. - The
ColorMatrix.kodachrome
method applies a kodachrome color effect to the ColorMatrix. - The
ColorMatrix.technicolor
method applies a technicolor color effect to the ColorMatrix. - The
ColorMatrix.polaroid
method applies a polaroid color effect to the ColorMatrix. - The
ColorMatrix.shiftToBGR
method shifts the values of the ColorMatrix into BGR order. - The
ColorMatrix.multiply
method multiplies two ColorMatrix data sets together.
Updates and API Changes
- Earcut, used for polygon triangulation, has been updated from 2.1.4 to 2.2.2.
- Earcut has now been exposed and is available via
Geom.Polygon.Earcut
and is fully documented. Config.batchSize
has been increased from 2000 to 4096.- Removed the Deferred Diffuse fragment and vertex shaders from the project, as they're not used.
StaticTilemapLayer.upload
will now set the vertex attributes and buffer the data, and handles internal checks more efficiently.StaticTilemapLayer
now includes theModelViewProjection
mixin, so it doesn't need to modify the pipeline during rendering.TransformMatrix.getXRound
is a new method that will return the X component, optionally passed viaMath.round
.TransformMatrix.getYRound
is a new method that will return the Y component, optionally passed viaMath.round
.- The
KeyboardPlugin
no longer emitskeydown_
events. These were replaced withkeydown-
events in v3.15. The previous event string was deprecated in v3.20. - The
KeyboardPlugin
no longer emitskeyup_
events. These were replaced withkeyup-
events in v3.15. The previous event string was deprecated in v3.20. - The
ScaleManager.updateBounds
method is now called every time the browser fires a 'resize' or 'orientationchange' event. This will update the offset of the canvas element Phaser is rendering to, which is responsible for keeping input positions correct. However, if you change the canvas position, or visibility, via any other method (i.e. via an Angular route) you should call theupdateBounds
method directly, yourself. - The constant
Phaser.Renderer.WebGL.BYTE
value has been removed as it wasn't used internally. - The constant
Phaser.Renderer.WebGL.SHORT
value has been removed as it wasn't used internally. - The constant
Phaser.Renderer.WebGL.UNSIGNED_BYTE
value has been removed as it wasn't used internally. - The constant
Phaser.Renderer.WebGL.UNSIGNED_SHORT
value has been removed as it wasn't used internally. - The constant
Phaser.Renderer.WebGL.FLOAT
value has been removed as it wasn't used internally. Pointer.downTime
now stores the event timestamp of when the first button on the input device was pressed down, not just when button 1 was pressed down.Pointer.upTime
now stores the event timestamp of when the final depressed button on the input device was released, not just when button 1 was released.- The
Pointer.getDuration
method now uses the new PointerdownTime
andupTime
values, meaning it will accurately report the duration of when any button is being held down, not just the primary one. Fix #5112 (thanks @veleek) - The
BaseShader
default vertex shader now includes theoutTexCoord
vec2 varying, mapped to be the same as that found in the pipeline shaders. Fix #5120 (@pavel-shirobok) - When using the
GameObjectCreator
forContainers
you can now specify thechildren
property in the configuration object. Textures.Parsers.JSONHash
will now perform ahasOwnProperty
check when iterating the frames, skipping anything that isn't a direct property. This should allow you to use generated atlas data that comes fromJSON.parse
. Fix #4768 (thanks @RollinSafary)- The
Camera3D
Plugin has been rebuilt for Phaser 3.50 and the webpack config updated. This plugin is now considered deprecated and will not be updated beyond this release. Tween.seek
will no longer issue a console warning for'Tween.seek duration too long'
, it's now up to you to check on the performance of tween seeking.- If
inputWindowEvents
is set in the Game Config, then theMouseManager
will now listen for the events onwindow.top
instead of justwindow
, which should help in situations where the pointer is released outside of an embedded iframe. This check is wrapped in atry/catch
block, as not all sites allow access towindow.top
(specifically in cross-origin iframe situations) Fix #4824 (thanks @rexrainbow) MouseManager.isTop
is a new boolean read-only property that flags if the mouse event listeners were attached towindow.top
(true), or justwindow
(false). By default Phaser will attemptwindow.top
, but this isn't possible in all environments, such as cross-origin iframes, so it will fall back towindow
in those cases and set this property to false (thanks BunBunBun)Types.GameObjects.Text.GetTextSizeObject
is a new type def for the GetTextSize function results.Utils.Array.StableSort
has been recoded. It's now based on Two-Screens stable sort 0.1.8 and has been updated to fit into Phaser better and no longer create any window bound objects. Theinplace
function has been removed, just callStableSort(array)
directly now. All classes that usedStableSort.inplace
have been updated to call it directly.- If a Scene is paused, or sent to sleep, it will automatically call
Keyboard.resetKeys
. This means that if you hold a key down, then sleep or pause a Scene, then release the key and resume or wake the Scene, it will no longer think it is still being held down (thanks @samme) Actions.setOrigin
will now callupdateDisplayOrigin
on the items array, otherwise the effects can't be seen when rendering.- You can now set the
ArcadeWorld.fixedStep
property via theArcadeWorldConfig
object (thanks @samme) Utils.Array.NumerArray
can now accept thestart
andend
parameters in reverse order, i.e.10, 1
will generate a number array running from 10 to 1. Internally it has also been optimized to skip string based returns.DataManager.Events.DESTROY
is a new event that the Data Manager will listen for from its parent and then call its owndestroy
method when received.- The
Quaternion
class constructor will now default the values to0,0,0,1
if they're not provided, making it an identity quaternion, rather than the0,0,0,0
it was before. - You can now set the
ParticleEmitter.reserve
value via the emitter configuration object (thanks @vforsh) - Setting the
pixelArt
config option will now setantialiasGL
tofalse
, as well asantialias
. Fix #5309 (thanks @Vegita2) - The
Shape
class now includes theComputedSize
component properties and methods directly in the class, rather than applying as a mixin.setSize
is now flagged as beingprivate
, because it shouldn't be used on Shape classes, which was leading to confusion as it appeared in the public-facing API. Fix #4811 (thanks @aolsx) - The
Loader.maxParallelDownloads
value is now set to 6 if running on Android, or 32 on any other OS. This avoidsnet::ERR_FAILED
issues specifically on Android. You can still override this in the Game Config if you wish. Fix #4957 (thanks @RollinSafary) - When running an Arcade Physics
overlap
test against aStaticBody
, it will no longer set theblocked
states of the dynamic body. If you are doing a collision test, they will still be set, but they're skipped for overlap-only tests. Fix #4435 (thanks @samme) - The
Line
Game Object will now default its width and height to 1, rather than zero. This allows you to give Line objects a physics body (although you will still need to re-adjust the center of the body manually). Fix #4596 (thanks @andrewaustin) - Internally, the
Quaternion
class now has 4 new private properties:_x
,_y
,_z
and_w
and 4 new getters and setters for the public versions. It also now passes most methods viaset
to allow for the onChange callback to be invoked. This does not change the public-facing API. Group
now extendsEventEmitter
, allowing you to emit custom events from within a Group.Device.Audio.wav
now usesaudio/wav
as thecanPlayType
check string, instead ofaudio/wav; codecs="1"
, which should allow iOS13 to play wav files again.- In the
Loader.FileTypes.TextFile
config you can now override the type and cache destination for the file. Loader.MultiFile
will now parse the given files array and only add valid entries into the file list, allowing multifiles to now have optional file entries.- The
ParticleEmitter.tint
value is now0xffffff
(previously, it was0xffffffff
) to allow particle tints to work in the correct RGB order including alpha (thanks @vforsh) SceneManager.start
will now reset theSceneSystems.sceneUpdate
reference toNOOP
. This gets set back to the Scene update method again duringbootScene
(if it has one) and stops errors with external plugins and multi-part files that may triggerupdate
beforecreate
has been called. Fix #4629 (thanks @Osmose)Phaser.Scene.renderer
is a new property available in every Phaser.Scene that gives you a reference to the renderer, either Canvas or WebGL.- The
CanvasRenderer._tempMatrix1
,_tempMatrtix2
,_tempMatrix3
and_tempMatrix4
properties have been removed. They were all flagged as private, yet used in lots of places. Instead, Game Objects now manager their own matrices, or use the globalGetCalcMatrix
function instead. - Since iOS 13, iPads now identify as MacOS devices. A new maxTouchPoint check is now part of the
Device.OS
tests, stopping iPads from being flagged as desktop devices. Fix #5389 (thanks @SBCGames) - The
BitmapMask.prevFramebuffer
property has been removed as it's no longer required, due to the fbo stack in the renderer. - The
TextureManager.addGLTexture
method has been updated so that thewidth
andheight
parameters are now optional. If not provided, and if available, they will be read from the given WebGLTexture instead (thanks @hexus) GameObjects.Components.Depth.depthList
is a new property that all Game Objects that have the Depth Component now have. It contains a reference to the List responsible for managing the depth sorting of the Game Object. This is typically the Scene Display List, but can also be a Layer. It allows the Depth component to queue a depth sort directly on the list it belongs to now, rather than just the Scene.- The
WebAudioSoundManager
will no longer try to unlock itself if the Game hasn't already booted and been added to the DOM. It will now wait for theBOOT
event and unlock based on that. Fix #5439 (thanks @samme)
Bug Fixes
- The
MatterAttractors
plugin, which enables attractors between bodies, has been fixed. The original plugin only worked if the body with the attractor was first in the world bodies list. It can now attract any body, no matter where in the world list it is. Fix #5160 (thanks @strahius) - The
KeyboardManager
andKeyboardPlugin
were both still checking for theInputManager.useQueue
property, which was removed several versions ago. - In Arcade Physics, Dynamic bodies would no longer hit walls when riding on horizontally moving platforms. The horizontal (and vertical) friction is now re-applied correctly in these edge-cases. Fix #5210 (thanks @Dercetech @samme)
- Calling
Rectangle.setSize()
wouldn't change the underlying geometry of the Shape Game Object, causing any stroke to be incorrectly rendered after a size change. - The
ProcessQueue
was emitting the wrong events internally. It now emits 'add' and 'remove' correctly (thanks @halilcakar) - The
GridAlign
action didn't work if only theheight
parameter was set. Fix #5019 (thanks @halilcakar) - The
Color.HSVToRGB
function has been rewritten to use the HSL and HSV formula from Wikipedia, giving much better results. Fix #5089 (thanks @DiamondeX) - Previously, the
easeParams
array within a Tweensprops
object, or a multi-object tween, were ignored and it was only used if set on the root Tween object. It will now work correctly set at any depth. Fix #4292 (thanks @willblackmore) - When using
Camera.setRenderToTexture
itszoom
androtation
values would be applied twice. Fix #4221 #4924 #4713 (thanks @wayfu @DanMcgraw @pavel-shirobok) GameObjects.Shape.Grid
would render a white fill even if you passedundefined
as the fill color in the constructor. It now doesn't render cells if no fill color is given.- The
onMouse
events in the Input Manager didn't reset theactivePointer
property to the mouse, meaning on dual-input systems such as Touch Screen devices, the active pointer would become locked to whichever input method was used first. Fix #4615 #5232 (thanks @mmolina01 @JstnPwll @Legomite) - The Scale Managers
GetScreenOrientation
function will now check forwindow.orientation
first, because iOS mobile browsers have an incomplete implementation of the Screen API, forcing us to use the window value as a priority. This means the Scale Manager will now emitorientationchange
events correctly on iOS. Fix #4361 #4914 (thanks @pfdtravalmatic @jackfreak @cuihu) Time.Clock.addEvent
can now take an instance of aTimerEvent
as its parameter. Fix #5294 (thanks @samme @EmilSV)GameConfig.audio
now defaults to an empty object, which simplifies access to the config in later checks (thanks @samme)- The
Loader.path
was being added to the File URL even if the URL was absolute. This is now checked for and the path is not applied unless the URL is relative (thanks @firesoft) Group.getMatching
would always return an empty array. It now returns matching children (thanks @samme)- The
ParticleManagerWebGLRenderer
now calculates its transform matrix differently, splitting out the parent matrix and factoring in follow offsets separately. This fixes numerous issues with particle emitters being incorrectly offset when added to Containers. Fix #5319 #5195 #4739 #4691 (thanks @vforsh @condeagustin @IvanDem @Formic) - The
ParticleManagerCanvasRenderer
now calculates its transform matrix differently, splitting out the parent matrix and factoring in the follow offsets separately. It also usessetToContext
internally. This fixes numerous issues with particle emitters being incorrectly offset when added to Containers, or having the Camera zoomed, running under Canvas. Fix #4908 #4531 #4131 (thanks @smjnab @SirLink @jhooper04) - The
Graphics
WebGL Renderer will now default topathOpen = true
. This fixes issues under WebGL where, for example, adding an arc and callingstrokePath
, without first callingbeginPath
will no longer cause rendering artefacts when WebGL tries to close the path with a single tri. Graphics.strokeRoundedRect
now issuesmoveTo
commands as part of the drawing sequence, preventing issues under WebGL where on older Android devices it would project additional vertices into the display. Fix #3955 (thanks @alexeymolchan)- Creating a Bitmap Mask from a texture atlas that was then used to mask another Game Object also using that same texture atlas would throw the error
GL_INVALID_OPERATION : glDrawArrays: Source and destination textures of the draw are the same.
. It now renders as expected. Fix #4675 (thanks @JacobCaron) - When using the same asset for a Game Object to be used as a mask, it would make other Game Objects using the same asset, that appeared above the mask in the display list, to not render. Fix #4767 (thanks @smjnab)
- When taking a
snapshot
in WebGL it would often have an extra line of empty pixels at the top of the resulting image, due to a rounding error in theWebGLSnapshot
function. Fix #4956 (thanks @gammafp @telinc1) Particles.EmitterOp.setMethods
will now reset bothonEmit
andonUpdate
to their default values. This allows you to reconfigure an emitter op with a new type of value and not have it stuck on the previous one. Fix #3663 (thanks @samme)Particles.EmitterOp
now cleanly separates between the different types of property configuration options.start | end
will now ease between the two values,min | max
will pick a random value between them andrandom: []
will pick a random element. They no longer get mixed together. Fix #3608 (thanks @samme)- When setting both
transparent: true
andbackgroundColor
in the Game Config, it would ignore the transparency and use the color anyway. If transparent, the game is now fully transparent. Fix #5362 (thanks @Hoshinokoe) - The
Ellipse
Game Object now will update the width, height, and geometric position in thesetSize
method (thanks @PhaserEditor2D) - When measuring the last word in a line in a
Text
Game Object, it no longer adds extra white space to the end (thanks @rexrainbow) Utils.Array.Remove
would return an incorrect array of removed elements if one of the items to be removed was skipped in the array. Fix #5398 (thanks @year221)Geom.Intersects.TriangleToLine
wouldn't returntrue
if the start or end of the Line fell inside the Triangle, only if the entire Line did. It now checks the start and end points correctly. (thanks @wiserim)- Using a Bitmap Mask and a Blend Mode in WebGL would reset the blend mode when the mask was rendered, causing the Game Object to have no blend mode. Fix #5409 (thanks @jcyuan)
BitmapMask
would become corrupted when resizing the Phaser Game, either via the Scale Manager or directly, because the framebuffer and texture it used for rendering was still at the old dimensions. The BitmapMask now listens for the Renderer RESIZE event and re-creates itself accordingly. Fix #5399 (thanks @Patapits)
Misc Changes
Loader Cache Changes
When loading any of the file types listed below it will no longer store the data file in the cache. For example, when loading a Texture Atlas using a JSON File, it used to store the parsed image data in the Texture Manager and also store the JSON in the JSON Cache under the same key. This has changed in 3.50. The data files are no longer cached, as they are not required by the textures once parsing is completed, which happens during load. This helps free-up memory. How much depends on the size of your data files. And also allows you to easily remove textures based on just their key, without also having to clear out the corresponding data cache.
AtlasJSONFile
no longer stores the JSON in the JSON Cache once the texture has been created.AtlasXMLFile
no longer stores the XML in the XML Cache once the texture has been created.UnityAtlasFile
no longer stores the Text in the Text Cache once the texture has been created.BitmapFontFile
no longer stores the XML in the XML Cache once the texture has been created.- You can now use
TextureManager.remove
to remove a texture and not have to worry about clearing the corresponding JSON or XML cache entry as well in order to reload a new texture using the same key. Fix #5323 (thanks @TedGriggs)
Lights 2D Updates
The Light Game Object has been rewritten so it now extends the Geom.Circle
object, as they shared lots of the same properties and methods anyway. This has cut down on duplicate code massively.
Light.dirty
is a new property that controls if the light is dirty, or not, and needs its uniforms updating.Light
has been recoded so that all of its properties are now setters that activate itsdirty
flag.LightsManager.destroy
will now clear thelightPool
array when destroyed, where-as previously it didn't.LightsManager.cull
now takes the viewport height from the renderer instead of the game config (thanks zenwaichi)
Removal of 'resolution' property from across the API
For legacy reasons, Phaser 3 has never properly supported HighDPI devices. It will render happily to them of course, but wouldn't let you set a 'resolution' for the Canvas beyond 1. Earlier versions of 3.x had a resolution property in the Game Config, but it was never fully implemented (for example, it would break zooming cameras). When the Scale Manager was introduced in v3.16 we forced the resolution to be 1 to avoid it breaking anything else internally.
For a long time, the 'resolution' property has been present - taunting developers and confusing new comers. In this release we have finally gone through and removed all references to it. The Game Config option is now gone, it's removed from the Scale Manager, Base Camera and everywhere else where it matters. As much as we would have liked to implement the feature, we've spent too long without it, and things have been built around the assumption it isn't present. The API just wouldn't cope with having it shoe-horned in at this stage. As frustrating as this is, it's even more annoying to just leave the property there confusing people and wasting CPU cycles. Phaser 4 has been built with HighDPI screens in mind from the very start, but it's too late for v3. The following changes are a result of this removal:
- The
Phaser.Scale.Events#RESIZE
event no longer sends theresolution
as a parameter. - The
BaseCamera.resolution
property has been removed. - The internal private
BaseCamera._cx
,_cy
,_cw
and_ch
properties has been removed, usex
,y
,width
andheight
instead. - The
BaseCamera.preRender
method no longer receives or uses theresolution
parameter. - The
Camera.preRender
method no longer receives or uses theresolution
parameter. - The
CameraManager.onResize
method no longer receives or uses theresolution
parameter. - The
Core.Config.resolution
property has been removed. - The
TextStyle.resolution
property is no longer read from the Game Config. You can still set it via the Text Style config to a value other than 1, but it will default to this now. - The
CanvasRenderer
no longer reads or uses the Game Config resolution property. - The
PipelineManager.resize
method along withWebGLPipeline.resize
and anything else that extends them no longer receives or uses theresolution
parameter. - The
WebGLRenderer.resize
andonResize
methods no longer receives or uses theresolution
parameter. - The
ScaleManager.resolution
property has been removed and all internal use of it.
Removal of 'interpolationPercentage' parameter from across the API
Since v3.0.0 the Game Object render
functions have received a parameter called interpolationPercentage
that was never used. The renderers do not calculate this value and no Game Objects apply it, so for the sake of clairty, reducing code and removing complexity from the API it has been removed from every single function that either sent or expected the parameter. This touches every single Game Object and changes the parameter order as a result, so please be aware of this if you have your own custom Game Objects, or plugins, that implement their own render
methods. In terms of surface API changes, you shouldn't notice anything at all from this removal.
Namespace Updates
- The
Phaser.Curves.MoveTo
function has now been exposed on the Phaser namespace (thanks @samme) - The
Phaser.DOM.GetInnerHeight
function has now been exposed on the Phaser namespace (thanks @samme) - The
Phaser.GameObjects.Bob
class has now been exposed on the Phaser namespace (thanks @samme) - The
Phaser.GameObjects.LightsManager
class has now been exposed on the Phaser namespace (thanks @samme) - The
Phaser.GameObjects.LightsPlugin
class has now been exposed on the Phaser namespace (thanks @samme) - The
Phaser.GameObjects.Particles.EmitterOp
class has now been exposed on the Phaser namespace (thanks @samme) - The
Phaser.GameObjects.GetTextSize
function has now been exposed on the Phaser namespace (thanks @samme) - The
Phaser.GameObjects.MeasureText
function has now been exposed on the Phaser namespace (thanks @samme) - The
Phaser.GameObjects.TextStyle
function has now been exposed on the Phaser namespace (thanks @samme) - The
Phaser.Input.CreatePixelPerfectHandler
function has now been exposed on the Phaser namespace (thanks @samme) - The
Phaser.Physics.Arcade.Components.OverlapCirc
function has now been exposed on the Phaser namespace (thanks @samme) - The
Phaser.Physics.Arcade.Components.OverlapRect
function has now been exposed on the Phaser namespace (thanks @samme) - The
Phaser.Physics.Arcade.Tilemap
namespace has now been exposed on the Phaser namespace (thanks @samme) - The
Phaser.Physics.Matter.Components
namespace has now been exposed on the Phaser namespace (thanks @samme) - The
Phaser.Physics.Matter.Events
namespace has now been exposed on the Phaser namespace (thanks @samme) - The
Phaser.Physics.Matter.MatterGameObject
class has now been exposed on the Phaser namespace (thanks @samme) - The
Phaser.Physics.Matter.PointerConstraint
class has now been exposed on the Phaser namespace (thanks @samme) - The
Phaser.Scenes.GetPhysicsPlugins
function has now been exposed on the Phaser namespace (thanks @samme) - The
Phaser.Scenes.GetScenePlugins
function has now been exposed on the Phaser namespace (thanks @samme) - The
Phaser.Structs.Events
namespace has now been exposed on the Phaser namespace (thanks @samme) - The
Phaser.Tilemaps.Parsers.Tiled
function has now been exposed on the Phaser namespace (thanks @samme) - Every single
Tilemap.Component
function has now been made public. This means you can call the Component functions directly, should you need to, outside of the Tilemap system.
Examples, Documentation and TypeScript
My thanks to the following for helping with the Phaser 3 Examples, Docs, and TypeScript definitions, either by reporting errors, fixing them, or helping author the docs:
@samme @16patsle @scott20145 @khasanovbi @mk360 @volkans80 @jaabberwocky @maikthomas @atursams @LearningCode2023 @DylanC @BenjaminDRichards @rexrainbow @Riderrr @spwilson2 @EmilSV @PhaserEditor2D @Gangryong @vinerz @trynx @usufruct99 @pirateksh @justin-calleja @monteiz
3.50 Beta Testing Help
A special mention to the following who submitted feedback on the 3.50 Beta releases:
@gammafp Acorn @BlunT76 @PhaserEditor2D @samme @rexrainbow @vforsh @kainage @ccaleb @spayton @FloodGames @buzzjeux @jcyuan @MadDogMayCry0 @Patapits @MMontalto @SBCGames @juanitogan @Racoonacoon @EmilSV @telinc1 @d7561985 @RollinSafary
Sorry if I forgot you!