Class: Camera

Phaser.Cameras.Scene2D. Camera

A Camera.

The Camera is the way in which all games are rendered in Phaser. They provide a view into your game world, and can be positioned, rotated, zoomed and scrolled accordingly.

A Camera consists of two elements: The viewport and the scroll values.

The viewport is the physical position and size of the Camera within your game. Cameras, by default, are created the same size as your game, but their position and size can be set to anything. This means if you wanted to create a camera that was 320x200 in size, positioned in the bottom-right corner of your game, you'd adjust the viewport to do that (using methods like setViewport and setSize).

If you wish to change where the Camera is looking in your game, then you scroll it. You can do this via the properties scrollX and scrollY or the method setScroll. Scrolling has no impact on the viewport, and changing the viewport has no impact on the scrolling.

By default a Camera will render all Game Objects it can see. You can change this using the ignore method, allowing you to filter Game Objects out on a per-Camera basis.

A Camera also has built-in special effects including Fade, Flash and Camera Shake.

new Camera(x, y, width, height)

Parameters:
Name Type Description
x number

The x position of the Camera, relative to the top-left of the game canvas.
y number

The y position of the Camera, relative to the top-left of the game canvas.
width number

The width of the Camera, in pixels.
height number

The height of the Camera, in pixels.
Since: 3.0.0
Source: src/cameras/2d/Camera.js (Line 18)

Extends

Members

alpha :number

The Camera alpha value. Setting this property impacts every single object that this Camera renders. You can either set the property directly, i.e. via a Tween, to fade a Camera in or out, or via the chainable setAlpha method instead.

Type:
  • number
Since: 3.11.0
Inherited From:
Default Value:
  • 1
Source: src/cameras/2d/BaseCamera.js (Line 377)

alphaBottomLeft :number

The alpha value starting from the bottom-left of the Game Object. This value is interpolated from the corner to the center of the Game Object.

Type:
  • number
Since: 3.0.0
Inherited From:
Source: src/gameobjects/components/Alpha.js (Line 227)

alphaBottomRight :number

The alpha value starting from the bottom-right of the Game Object. This value is interpolated from the corner to the center of the Game Object.

Type:
  • number
Since: 3.0.0
Inherited From:
Source: src/gameobjects/components/Alpha.js (Line 257)

alphaTopLeft :number

The alpha value starting from the top-left of the Game Object. This value is interpolated from the corner to the center of the Game Object.

Type:
  • number
Since: 3.0.0
Inherited From:
Source: src/gameobjects/components/Alpha.js (Line 167)

alphaTopRight :number

The alpha value starting from the top-right of the Game Object. This value is interpolated from the corner to the center of the Game Object.

Type:
  • number
Since: 3.0.0
Inherited From:
Source: src/gameobjects/components/Alpha.js (Line 197)

backgroundColor :Phaser.Display.Color

The background color of this Camera. Only used if transparent is false.

Type:
Since: 3.0.0
Inherited From:
Source: src/cameras/2d/BaseCamera.js (Line 368)

cameraManager :Phaser.Cameras.Scene2D.CameraManager

A reference to the Scene's Camera Manager to which this Camera belongs.

Type:
Since: 3.17.0
Inherited From:
Source: src/cameras/2d/BaseCamera.js (Line 106)

<readonly> centerX :number

The horizontal position of the center of the Camera's viewport, relative to the left of the game canvas.

Type:
  • number
Since: 3.10.0
Inherited From:
Source: src/cameras/2d/BaseCamera.js (Line 1854)

<readonly> centerY :number

The vertical position of the center of the Camera's viewport, relative to the top of the game canvas.

Type:
  • number
Since: 3.10.0
Inherited From:
Source: src/cameras/2d/BaseCamera.js (Line 1871)

<nullable> deadzone :Phaser.Geom.Rectangle

The Camera dead zone.

The deadzone is only used when the camera is following a target.

It defines a rectangular region within which if the target is present, the camera will not scroll. If the target moves outside of this area, the camera will begin scrolling in order to follow it.

The lerp values that you can set for a follower target also apply when using a deadzone.

You can directly set this property to be an instance of a Rectangle. Or, you can use the setDeadzone method for a chainable approach.

The rectangle you provide can have its dimensions adjusted dynamically, however, please note that its position is updated every frame, as it is constantly re-centered on the cameras mid point.

Calling setDeadzone with no arguments will reset an active deadzone, as will setting this property to null.

Type:
Since: 3.11.0
Source: src/cameras/2d/Camera.js (Line 174)

defaultPipeline :Phaser.Renderer.WebGL.WebGLPipeline

The initial WebGL pipeline of this Game Object.

If you call resetPipeline on this Game Object, the pipeline is reset to this default.

Type:
Since: 3.0.0
Inherited From:
Default Value:
  • null
Source: src/gameobjects/components/Pipeline.js (Line 21)

dirty :boolean

Is this Camera dirty?

A dirty Camera has had either its viewport size, bounds, scroll, rotation or zoom levels changed since the last frame.

This flag is cleared during the postRenderCamera method of the renderer.

Type:
  • boolean
Since: 3.11.0
Inherited From:
Default Value:
  • true
Source: src/cameras/2d/BaseCamera.js (Line 183)

disableCull :boolean

Should the camera cull Game Objects before checking them for input hit tests? In some special cases it may be beneficial to disable this.

Type:
  • boolean
Since: 3.0.0
Inherited From:
Default Value:
  • false
Source: src/cameras/2d/BaseCamera.js (Line 388)

<readonly> displayHeight :number

The displayed height of the camera viewport, factoring in the camera zoom level.

If a camera has a viewport height of 600 and a zoom of 0.5 then its display height would be 1200, as it's displaying twice as many pixels as zoom level 1.

Equally, a camera with a height of 600 and zoom of 2 would have a display height of 300 pixels.

Type:
  • number
Since: 3.11.0
Inherited From:
Source: src/cameras/2d/BaseCamera.js (Line 1911)

<readonly> displayWidth :number

The displayed width of the camera viewport, factoring in the camera zoom level.

If a camera has a viewport width of 800 and a zoom of 0.5 then its display width would be 1600, as it's displaying twice as many pixels as zoom level 1.

Equally, a camera with a width of 800 and zoom of 2 would have a display width of 400 pixels.

Type:
  • number
Since: 3.11.0
Inherited From:
Source: src/cameras/2d/BaseCamera.js (Line 1888)

fadeEffect :Phaser.Cameras.Scene2D.Effects.Fade

The Camera Fade effect handler. To fade this camera see the Camera.fade methods.

Type:
Since: 3.5.0
Source: src/cameras/2d/Camera.js (Line 85)

flashEffect :Phaser.Cameras.Scene2D.Effects.Flash

The Camera Flash effect handler. To flash this camera see the Camera.flash method.

Type:
Since: 3.5.0
Source: src/cameras/2d/Camera.js (Line 95)

flipX :boolean

The horizontally flipped state of the Game Object.

A Game Object that is flipped horizontally will render inversed on the horizontal axis. Flipping always takes place from the middle of the texture and does not impact the scale value. If this Game Object has a physics body, it will not change the body. This is a rendering toggle only.

Type:
  • boolean
Since: 3.0.0
Inherited From:
Default Value:
  • false
Source: src/gameobjects/components/Flip.js (Line 17)

flipY :boolean

The vertically flipped state of the Game Object.

A Game Object that is flipped vertically will render inversed on the vertical axis (i.e. upside down) Flipping always takes place from the middle of the texture and does not impact the scale value. If this Game Object has a physics body, it will not change the body. This is a rendering toggle only.

Type:
  • boolean
Since: 3.0.0
Inherited From:
Default Value:
  • false
Source: src/gameobjects/components/Flip.js (Line 31)

followOffset :Phaser.Math.Vector2

The values stored in this property are subtracted from the Camera targets position, allowing you to offset the camera from the actual target x/y coordinates by this amount. Can also be set via setFollowOffset or as part of the startFollow call.

Type:
Since: 3.9.0
Source: src/cameras/2d/Camera.js (Line 163)

hasPostPipeline :boolean

Does this Game Object have any Post Pipelines set?

Type:
  • boolean
Since: 3.50.0
Inherited From:
Source: src/gameobjects/components/Pipeline.js (Line 45)

height :number

The height of the Camera viewport, in pixels.

The viewport is the area into which the Camera renders. Setting the viewport does not restrict where the Camera can scroll to.

Type:
  • number
Since: 3.0.0
Inherited From:
Source: src/cameras/2d/BaseCamera.js (Line 1644)

<readonly> id :number

The Camera ID. Assigned by the Camera Manager and used to handle camera exclusion. This value is a bitmask.

Type:
  • number
Since: 3.11.0
Inherited From:
Source: src/cameras/2d/BaseCamera.js (Line 115)

inputEnabled :boolean

Does this Camera allow the Game Objects it renders to receive input events?

Type:
  • boolean
Since: 3.0.0
Default Value:
  • true
Source: src/cameras/2d/Camera.js (Line 75)

<readonly> isTinted :boolean

Does this Game Object have a tint applied?

It checks to see if the 4 tint properties are set to the value 0xffffff and that the tintFill property is false. This indicates that a Game Object isn't tinted.

Type:
  • boolean
Since: 3.11.0
Inherited From:
Source: src/gameobjects/components/Tint.js (Line 200)

lerp :Phaser.Math.Vector2

The linear interpolation value to use when following a target.

Can also be set via setLerp or as part of the startFollow call.

The default values of 1 means the camera will instantly snap to the target coordinates. A lower value, such as 0.1 means the camera will more slowly track the target, giving a smooth transition. You can set the horizontal and vertical values independently, and also adjust this value in real-time during your game.

Be sure to keep the value between 0 and 1. A value of zero will disable tracking on that axis.

Type:
Since: 3.9.0
Source: src/cameras/2d/Camera.js (Line 145)

<nullable> mask :Phaser.Display.Masks.BitmapMask|Phaser.Display.Masks.GeometryMask

The Mask this Camera is using during render. Set the mask using the setMask method. Remove the mask using the clearMask method.

Type:
Since: 3.17.0
Inherited From:
Source: src/cameras/2d/BaseCamera.js (Line 470)

<readonly> midPoint :Phaser.Math.Vector2

The mid-point of the Camera in 'world' coordinates.

Use it to obtain exactly where in the world the center of the camera is currently looking.

This value is updated in the preRender method, after the scroll values and follower have been processed.

Type:
Since: 3.11.0
Inherited From:
Source: src/cameras/2d/BaseCamera.js (Line 410)

name :string

The name of the Camera. This is left empty for your own use.

Type:
  • string
Since: 3.0.0
Inherited From:
Default Value:
  • ''
Source: src/cameras/2d/BaseCamera.js (Line 126)

originX :number

The horizontal origin of rotation for this Camera.

By default the camera rotates around the center of the viewport.

Changing the origin allows you to adjust the point in the viewport from which rotation happens. A value of 0 would rotate from the top-left of the viewport. A value of 1 from the bottom right.

See setOrigin to set both origins in a single, chainable call.

Type:
  • number
Since: 3.11.0
Inherited From:
Default Value:
  • 0.5
Source: src/cameras/2d/BaseCamera.js (Line 425)

originY :number

The vertical origin of rotation for this Camera.

By default the camera rotates around the center of the viewport.

Changing the origin allows you to adjust the point in the viewport from which rotation happens. A value of 0 would rotate from the top-left of the viewport. A value of 1 from the bottom right.

See setOrigin to set both origins in a single, chainable call.

Type:
  • number
Since: 3.11.0
Inherited From:
Default Value:
  • 0.5
Source: src/cameras/2d/BaseCamera.js (Line 442)

panEffect :Phaser.Cameras.Scene2D.Effects.Pan

The Camera Pan effect handler. To pan this camera see the Camera.pan method.

Type:
Since: 3.11.0
Source: src/cameras/2d/Camera.js (Line 115)

pipeline :Phaser.Renderer.WebGL.WebGLPipeline

The current WebGL pipeline of this Game Object.

Type:
Since: 3.0.0
Inherited From:
Default Value:
  • null
Source: src/gameobjects/components/Pipeline.js (Line 34)

pipelineData :object

An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.

Type:
  • object
Since: 3.50.0
Inherited From:
Source: src/gameobjects/components/Pipeline.js (Line 70)

postPipeline :Array.<Phaser.Renderer.WebGL.Pipelines.PostFXPipeline>

The WebGL Post FX Pipelines this Game Object uses for post-render effects.

The pipelines are processed in the order in which they appear in this array.

If you modify this array directly, be sure to set the hasPostPipeline property accordingly.

Type:
Since: 3.50.0
Inherited From:
Source: src/gameobjects/components/Pipeline.js (Line 55)

rotateToEffect :Phaser.Cameras.Scene2D.Effects.RotateTo

The Camera Rotate To effect handler. To rotate this camera see the Camera.rotateTo method.

Type:
Since: 3.23.0
Source: src/cameras/2d/Camera.js (Line 125)

roundPixels :boolean

Should this camera round its pixel values to integers?

Type:
  • boolean
Since: 3.0.0
Inherited From:
Default Value:
  • false
Source: src/cameras/2d/BaseCamera.js (Line 136)

scaleManager :Phaser.Scale.ScaleManager

A reference to the Game Scale Manager.

Type:
Since: 3.16.0
Inherited From:
Source: src/cameras/2d/BaseCamera.js (Line 97)

scene :Phaser.Scene

A reference to the Scene this camera belongs to.

Type:
Since: 3.0.0
Inherited From:
Source: src/cameras/2d/BaseCamera.js (Line 79)

sceneManager :Phaser.Scenes.SceneManager

A reference to the Game Scene Manager.

Type:
Since: 3.12.0
Inherited From:
Source: src/cameras/2d/BaseCamera.js (Line 88)

scrollX :number

The horizontal scroll position of this Camera.

Change this value to cause the Camera to scroll around your Scene.

Alternatively, setting the Camera to follow a Game Object, via the startFollow method, will automatically adjust the Camera scroll values accordingly.

You can set the bounds within which the Camera can scroll via the setBounds method.

Type:
  • number
Since: 3.0.0
Inherited From:
Default Value:
  • 0
Source: src/cameras/2d/BaseCamera.js (Line 1669)

scrollY :number

The vertical scroll position of this Camera.

Change this value to cause the Camera to scroll around your Scene.

Alternatively, setting the Camera to follow a Game Object, via the startFollow method, will automatically adjust the Camera scroll values accordingly.

You can set the bounds within which the Camera can scroll via the setBounds method.

Type:
  • number
Since: 3.0.0
Inherited From:
Default Value:
  • 0
Source: src/cameras/2d/BaseCamera.js (Line 1699)

shakeEffect :Phaser.Cameras.Scene2D.Effects.Shake

The Camera Shake effect handler. To shake this camera see the Camera.shake method.

Type:
Since: 3.5.0
Source: src/cameras/2d/Camera.js (Line 105)

tint :number

The tint value being applied to the whole of the Game Object. This property is a setter-only. Use the properties tintTopLeft etc to read the current tint value.

Type:
  • number
Since: 3.0.0
Inherited From:
Source: src/gameobjects/components/Tint.js (Line 183)

tintBottomLeft :number

The tint value being applied to the bottom-left vertice of the Game Object. This value is interpolated from the corner to the center of the Game Object. The value should be set as a hex number, i.e. 0xff0000 for red, or 0xff00ff for purple.

Type:
  • number
Since: 3.0.0
Inherited From:
Default Value:
  • 0xffffff
Source: src/gameobjects/components/Tint.js (Line 42)

tintBottomRight :number

The tint value being applied to the bottom-right vertice of the Game Object. This value is interpolated from the corner to the center of the Game Object. The value should be set as a hex number, i.e. 0xff0000 for red, or 0xff00ff for purple.

Type:
  • number
Since: 3.0.0
Inherited From:
Default Value:
  • 0xffffff
Source: src/gameobjects/components/Tint.js (Line 54)

tintFill :boolean

The tint fill mode.

false = An additive tint (the default), where vertices colors are blended with the texture. true = A fill tint, where the vertices colors replace the texture, but respects texture alpha.

Type:
  • boolean
Since: 3.11.0
Inherited From:
Default Value:
  • false
Source: src/gameobjects/components/Tint.js (Line 66)

tintTopLeft :number

The tint value being applied to the top-left vertice of the Game Object. This value is interpolated from the corner to the center of the Game Object. The value should be set as a hex number, i.e. 0xff0000 for red, or 0xff00ff for purple.

Type:
  • number
Since: 3.0.0
Inherited From:
Default Value:
  • 0xffffff
Source: src/gameobjects/components/Tint.js (Line 18)

tintTopRight :number

The tint value being applied to the top-right vertice of the Game Object. This value is interpolated from the corner to the center of the Game Object. The value should be set as a hex number, i.e. 0xff0000 for red, or 0xff00ff for purple.

Type:
  • number
Since: 3.0.0
Inherited From:
Default Value:
  • 0xffffff
Source: src/gameobjects/components/Tint.js (Line 30)

transparent :boolean

Does this Camera have a transparent background?

Type:
  • boolean
Since: 3.0.0
Inherited From:
Default Value:
  • true
Source: src/cameras/2d/BaseCamera.js (Line 358)

useBounds :boolean

Is this Camera using a bounds to restrict scrolling movement?

Set this property along with the bounds via Camera.setBounds.

Type:
  • boolean
Since: 3.0.0
Inherited From:
Default Value:
  • false
Source: src/cameras/2d/BaseCamera.js (Line 158)

visible :boolean

Is this Camera visible or not?

A visible camera will render and perform input tests. An invisible camera will not render anything and will skip input tests.

Type:
  • boolean
Since: 3.10.0
Inherited From:
Default Value:
  • true
Source: src/cameras/2d/BaseCamera.js (Line 146)

width :number

The width of the Camera viewport, in pixels.

The viewport is the area into which the Camera renders. Setting the viewport does not restrict where the Camera can scroll to.

Type:
  • number
Since: 3.0.0
Inherited From:
Source: src/cameras/2d/BaseCamera.js (Line 1619)

<readonly> worldView :Phaser.Geom.Rectangle

The World View is a Rectangle that defines the area of the 'world' the Camera is currently looking at. This factors in the Camera viewport size, zoom and scroll position and is updated in the Camera preRender step. If you have enabled Camera bounds the worldview will be clamped to those bounds accordingly. You can use it for culling or intersection checks.

Type:
Since: 3.11.0
Inherited From:
Source: src/cameras/2d/BaseCamera.js (Line 170)

x :number

The x position of the Camera viewport, relative to the top-left of the game canvas. The viewport is the area into which the camera renders. To adjust the position the camera is looking at in the game world, see the scrollX value.

Type:
  • number
Since: 3.0.0
Inherited From:
Source: src/cameras/2d/BaseCamera.js (Line 1571)

y :number

The y position of the Camera viewport, relative to the top-left of the game canvas. The viewport is the area into which the camera renders. To adjust the position the camera is looking at in the game world, see the scrollY value.

Type:
  • number
Since: 3.0.0
Inherited From:
Source: src/cameras/2d/BaseCamera.js (Line 1595)

zoom :number

The Camera zoom value. Change this value to zoom in, or out of, a Scene.

A value of 0.5 would zoom the Camera out, so you can now see twice as much of the Scene as before. A value of 2 would zoom the Camera in, so every pixel now takes up 2 pixels when rendered.

Set to 1 to return to the default zoom level.

Be careful to never set this value to zero.

Type:
  • number
Since: 3.0.0
Inherited From:
Default Value:
  • 1
Source: src/cameras/2d/BaseCamera.js (Line 1729)

zoomEffect :Phaser.Cameras.Scene2D.Effects.Zoom

The Camera Zoom effect handler. To zoom this camera see the Camera.zoom method.

Type:
Since: 3.11.0
Source: src/cameras/2d/Camera.js (Line 135)

zoomX :number

The Camera horizontal zoom value. Change this value to zoom in, or out of, a Scene.

A value of 0.5 would zoom the Camera out, so you can now see twice as much of the Scene as before. A value of 2 would zoom the Camera in, so every pixel now takes up 2 pixels when rendered.

Set to 1 to return to the default zoom level.

Be careful to never set this value to zero.

Type:
  • number
Since: 3.50.0
Inherited From:
Default Value:
  • 1
Source: src/cameras/2d/BaseCamera.js (Line 1762)

zoomY :number

The Camera vertical zoom value. Change this value to zoom in, or out of, a Scene.

A value of 0.5 would zoom the Camera out, so you can now see twice as much of the Scene as before. A value of 2 would zoom the Camera in, so every pixel now takes up 2 pixels when rendered.

Set to 1 to return to the default zoom level.

Be careful to never set this value to zero.

Type:
  • number
Since: 3.50.0
Inherited From:
Default Value:
  • 1
Source: src/cameras/2d/BaseCamera.js (Line 1793)

Methods

addListener(event, fn [, context])

Add a listener for a given event.

Parameters:
Name Type Argument Default Description
event string | symbol

The event name.
fn function

The listener function.
context * <optional>
 this

The context to invoke the listener with.
Since: 3.0.0
Inherited From:
Source: src/events/EventEmitter.js (Line 111)
Returns:

this.

Type
Phaser.Cameras.Scene2D.Camera

centerOn(x, y)

Moves the Camera so that it is centered on the given coordinates, bounds allowing.

Parameters:
Name Type Description
x number

The horizontal coordinate to center on.
y number

The vertical coordinate to center on.
Since: 3.11.0
Inherited From:
Source: src/cameras/2d/BaseCamera.js (Line 623)
Returns:

This Camera instance.

Type
Phaser.Cameras.Scene2D.Camera

centerOnX(x)

Moves the Camera horizontally so that it is centered on the given x coordinate, bounds allowing. Calling this does not change the scrollY value.

Parameters:
Name Type Description
x number

The horizontal coordinate to center on.
Since: 3.16.0
Inherited From:
Source: src/cameras/2d/BaseCamera.js (Line 569)
Returns:

This Camera instance.

Type
Phaser.Cameras.Scene2D.Camera

centerOnY(y)

Moves the Camera vertically so that it is centered on the given y coordinate, bounds allowing. Calling this does not change the scrollX value.

Parameters:
Name Type Description
y number

The vertical coordinate to center on.
Since: 3.16.0
Inherited From:
Source: src/cameras/2d/BaseCamera.js (Line 596)
Returns:

This Camera instance.

Type
Phaser.Cameras.Scene2D.Camera

centerToBounds()

Moves the Camera so that it is looking at the center of the Camera Bounds, if enabled.

Since: 3.0.0
Inherited From:
Source: src/cameras/2d/BaseCamera.js (Line 642)
Returns:

This Camera instance.

Type
Phaser.Cameras.Scene2D.Camera

centerToSize()

Moves the Camera so that it is re-centered based on its viewport size.

Since: 3.0.0
Inherited From:
Source: src/cameras/2d/BaseCamera.js (Line 667)
Returns:

This Camera instance.

Type
Phaser.Cameras.Scene2D.Camera

clampX(x)

Takes an x value and checks it's within the range of the Camera bounds, adjusting if required. Do not call this method if you are not using camera bounds.

Parameters:
Name Type Description
x number

The value to horizontally scroll clamp.
Since: 3.11.0
Inherited From:
Source: src/cameras/2d/BaseCamera.js (Line 934)
Returns:

The adjusted value to use as scrollX.

Type
number

clampY(y)

Takes a y value and checks it's within the range of the Camera bounds, adjusting if required. Do not call this method if you are not using camera bounds.

Parameters:
Name Type Description
y number

The value to vertically scroll clamp.
Since: 3.11.0
Inherited From:
Source: src/cameras/2d/BaseCamera.js (Line 966)
Returns:

The adjusted value to use as scrollY.

Type
number

clearAlpha()

Clears all alpha values associated with this Game Object.

Immediately sets the alpha levels back to 1 (fully opaque).

Since: 3.0.0
Inherited From:
Source: src/gameobjects/components/Alpha.js (Line 77)
Returns:

This Game Object instance.

Type
Phaser.Cameras.Scene2D.Camera

clearMask( [destroyMask])

Clears the mask that this Camera was using.

Parameters:
Name Type Argument Default Description
destroyMask boolean <optional>
 false

Destroy the mask before clearing it?
Since: 3.17.0
Inherited From:
Source: src/cameras/2d/BaseCamera.js (Line 1412)
Returns:

This Camera instance.

Type
Phaser.Cameras.Scene2D.Camera

clearTint()

Clears all tint values associated with this Game Object.

Immediately sets the color values back to 0xffffff and the tint type to 'additive', which results in no visible change to the texture.

Since: 3.0.0
Inherited From:
Source: src/gameobjects/components/Tint.js (Line 79)
Returns:

This Game Object instance.

Type
Phaser.Cameras.Scene2D.Camera

cull(renderableObjects)

Takes an array of Game Objects and returns a new array featuring only those objects visible by this camera.

Parameters:
Name Type Description
renderableObjects Array.<Phaser.GameObjects.GameObject>

An array of Game Objects to cull.
Since: 3.0.0
Inherited From:
Source: src/cameras/2d/BaseCamera.js (Line 683)
Returns:

An array of Game Objects visible to this Camera.

Type
Array.<Phaser.GameObjects.GameObject>

destroy()

Destroys this Camera instance. You rarely need to call this directly.

Called by the Camera Manager. If you wish to destroy a Camera please use CameraManager.remove as cameras are stored in a pool, ready for recycling later, and calling this directly will prevent that.

Since: 3.0.0
Overrides:
Source: src/cameras/2d/Camera.js (Line 780)
Fires:

emit(event [, args])

Calls each of the listeners registered for a given event.

Parameters:
Name Type Argument Description
event string | symbol

The event name.
args * <optional>
<repeatable>

Additional arguments that will be passed to the event handler.
Since: 3.0.0
Inherited From:
Source: src/events/EventEmitter.js (Line 86)
Returns:

true if the event had listeners, else false.

Type
boolean

eventNames()

Return an array listing the events for which the emitter has registered listeners.

Since: 3.0.0
Inherited From:
Source: src/events/EventEmitter.js (Line 55)
Returns:
Type
Array.<(string|symbol)>

fade( [duration] [, red] [, green] [, blue] [, force] [, callback] [, context])

Fades the Camera from transparent to the given color over the duration specified.

Parameters:
Name Type Argument Default Description
duration number <optional>
 1000

The duration of the effect in milliseconds.
red number <optional>
 0

The amount to fade the red channel towards. A value between 0 and 255.
green number <optional>
 0

The amount to fade the green channel towards. A value between 0 and 255.
blue number <optional>
 0

The amount to fade the blue channel towards. A value between 0 and 255.
force boolean <optional>
 false

Force the effect to start immediately, even if already running.
callback function <optional>

This callback will be invoked every frame for the duration of the effect. It is sent two arguments: A reference to the camera and a progress amount between 0 and 1 indicating how complete the effect is.
context any <optional>

The context in which the callback is invoked. Defaults to the Scene to which the Camera belongs.
Since: 3.0.0
Source: src/cameras/2d/Camera.js (Line 344)
Fires:
Returns:

This Camera instance.

Type
Phaser.Cameras.Scene2D.Camera

fadeFrom( [duration] [, red] [, green] [, blue] [, force] [, callback] [, context])

Fades the Camera from the given color to transparent over the duration specified.

Parameters:
Name Type Argument Default Description
duration number <optional>
 1000

The duration of the effect in milliseconds.
red number <optional>
 0

The amount to fade the red channel towards. A value between 0 and 255.
green number <optional>
 0

The amount to fade the green channel towards. A value between 0 and 255.
blue number <optional>
 0

The amount to fade the blue channel towards. A value between 0 and 255.
force boolean <optional>
 false

Force the effect to start immediately, even if already running.
callback function <optional>

This callback will be invoked every frame for the duration of the effect. It is sent two arguments: A reference to the camera and a progress amount between 0 and 1 indicating how complete the effect is.
context any <optional>

The context in which the callback is invoked. Defaults to the Scene to which the Camera belongs.
Since: 3.5.0
Source: src/cameras/2d/Camera.js (Line 320)
Fires:
Returns:

This Camera instance.

Type
Phaser.Cameras.Scene2D.Camera

fadeIn( [duration] [, red] [, green] [, blue] [, callback] [, context])

Fades the Camera in from the given color over the duration specified.

Parameters:
Name Type Argument Default Description
duration number <optional>
 1000

The duration of the effect in milliseconds.
red number <optional>
 0

The amount to fade the red channel towards. A value between 0 and 255.
green number <optional>
 0

The amount to fade the green channel towards. A value between 0 and 255.
blue number <optional>
 0

The amount to fade the blue channel towards. A value between 0 and 255.
callback function <optional>

This callback will be invoked every frame for the duration of the effect. It is sent two arguments: A reference to the camera and a progress amount between 0 and 1 indicating how complete the effect is.
context any <optional>

The context in which the callback is invoked. Defaults to the Scene to which the Camera belongs.
Since: 3.3.0
Source: src/cameras/2d/Camera.js (Line 273)
Fires:
Returns:

This Camera instance.

Type
Phaser.Cameras.Scene2D.Camera

fadeOut( [duration] [, red] [, green] [, blue] [, callback] [, context])

Fades the Camera out to the given color over the duration specified. This is an alias for Camera.fade that forces the fade to start, regardless of existing fades.

Parameters:
Name Type Argument Default Description
duration number <optional>
 1000

The duration of the effect in milliseconds.
red number <optional>
 0

The amount to fade the red channel towards. A value between 0 and 255.
green number <optional>
 0

The amount to fade the green channel towards. A value between 0 and 255.
blue number <optional>
 0

The amount to fade the blue channel towards. A value between 0 and 255.
callback function <optional>

This callback will be invoked every frame for the duration of the effect. It is sent two arguments: A reference to the camera and a progress amount between 0 and 1 indicating how complete the effect is.
context any <optional>

The context in which the callback is invoked. Defaults to the Scene to which the Camera belongs.
Since: 3.3.0
Source: src/cameras/2d/Camera.js (Line 296)
Fires:
Returns:

This Camera instance.

Type
Phaser.Cameras.Scene2D.Camera

flash( [duration] [, red] [, green] [, blue] [, force] [, callback] [, context])

Flashes the Camera by setting it to the given color immediately and then fading it away again quickly over the duration specified.

Parameters:
Name Type Argument Default Description
duration number <optional>
 250

The duration of the effect in milliseconds.
red number <optional>
 255

The amount to fade the red channel towards. A value between 0 and 255.
green number <optional>
 255

The amount to fade the green channel towards. A value between 0 and 255.
blue number <optional>
 255

The amount to fade the blue channel towards. A value between 0 and 255.
force boolean <optional>
 false

Force the effect to start immediately, even if already running.
callback function <optional>

This callback will be invoked every frame for the duration of the effect. It is sent two arguments: A reference to the camera and a progress amount between 0 and 1 indicating how complete the effect is.
context any <optional>

The context in which the callback is invoked. Defaults to the Scene to which the Camera belongs.
Since: 3.0.0
Source: src/cameras/2d/Camera.js (Line 368)
Fires:
Returns:

This Camera instance.

Type
Phaser.Cameras.Scene2D.Camera

getBounds( [out])

Returns a rectangle containing the bounds of the Camera.

If the Camera does not have any bounds the rectangle will be empty.

The rectangle is a copy of the bounds, so is safe to modify.

Parameters:
Name Type Argument Description
out Phaser.Geom.Rectangle <optional>

An optional Rectangle to store the bounds in. If not given, a new Rectangle will be created.
Since: 3.16.0
Inherited From:
Source: src/cameras/2d/BaseCamera.js (Line 1121)
Returns:

A rectangle containing the bounds of this Camera.

Type
Phaser.Geom.Rectangle

getPipelineName()

Gets the name of the WebGL Pipeline this Game Object is currently using.

Since: 3.0.0
Inherited From:
Source: src/gameobjects/components/Pipeline.js (Line 397)
Returns:

The string-based name of the pipeline being used by this Game Object.

Type
string

getPostPipeline(pipeline)

Gets a Post Pipeline instance from this Game Object, based on the given name, and returns it.

Parameters:
Name Type Description
pipeline string | function | Phaser.Renderer.WebGL.Pipelines.PostFXPipeline

The string-based name of the pipeline, or a pipeline class.
Since: 3.50.0
Inherited From:
Source: src/gameobjects/components/Pipeline.js (Line 272)
Returns:

The first Post Pipeline matching the name, or undefined if no match.

Type
Phaser.Renderer.WebGL.Pipelines.PostFXPipeline

getScroll(x, y [, out])

Calculates what the Camera.scrollX and scrollY values would need to be in order to move the Camera so it is centered on the given x and y coordinates, without actually moving the Camera there. The results are clamped based on the Camera bounds, if set.

Parameters:
Name Type Argument Description
x number

The horizontal coordinate to center on.
y number

The vertical coordinate to center on.
out Phaser.Math.Vector2 <optional>

A Vector2 to store the values in. If not given a new Vector2 is created.
Since: 3.11.0
Inherited From:
Source: src/cameras/2d/BaseCamera.js (Line 536)
Returns:

The scroll coordinates stored in the x and y properties.

Type
Phaser.Math.Vector2

getWorldPoint(x, y [, output])

Converts the given x and y coordinates into World space, based on this Cameras transform. You can optionally provide a Vector2, or similar object, to store the results in.

Parameters:
Name Type Argument Description
x number

The x position to convert to world space.
y number

The y position to convert to world space.
output object | Phaser.Math.Vector2 <optional>

An optional object to store the results in. If not provided a new Vector2 will be created.
Since: 3.0.0
Inherited From:
Source: src/cameras/2d/BaseCamera.js (Line 764)
Returns:

An object holding the converted values in its x and y properties.

Type
Phaser.Math.Vector2

ignore(entries)

Given a Game Object, or an array of Game Objects, it will update all of their camera filter settings so that they are ignored by this Camera. This means they will not be rendered by this Camera.

Parameters:
Name Type Description
entries Phaser.GameObjects.GameObject | Array.<Phaser.GameObjects.GameObject> | Phaser.GameObjects.Group

The Game Object, or array of Game Objects, to be ignored by this Camera.
Since: 3.0.0
Inherited From:
Source: src/cameras/2d/BaseCamera.js (Line 831)
Returns:

This Camera instance.

Type
Phaser.Cameras.Scene2D.Camera

initPipeline(pipeline)

Sets the initial WebGL Pipeline of this Game Object.

This should only be called during the instantiation of the Game Object. After that, use setPipeline.

Parameters:
Name Type Description
pipeline string | Phaser.Renderer.WebGL.WebGLPipeline

Either the string-based name of the pipeline, or a pipeline instance to set.
Since: 3.0.0
Inherited From:
Source: src/gameobjects/components/Pipeline.js (Line 80)
Returns:

true if the pipeline was set successfully, otherwise false.

Type
boolean

listenerCount(event)

Return the number of listeners listening to a given event.

Parameters:
Name Type Description
event string | symbol

The event name.
Since: 3.0.0
Inherited From:
Source: src/events/EventEmitter.js (Line 75)
Returns:

The number of listeners.

Type
number

listeners(event)

Return the listeners registered for a given event.

Parameters:
Name Type Description
event string | symbol

The event name.
Since: 3.0.0
Inherited From:
Source: src/events/EventEmitter.js (Line 64)
Returns:

The registered listeners.

Type
Array.<function()>

off(event [, fn] [, context] [, once])

Remove the listeners of a given event.

Parameters:
Name Type Argument Description
event string | symbol

The event name.
fn function <optional>

Only remove the listeners that match this function.
context * <optional>

Only remove the listeners that have this context.
once boolean <optional>

Only remove one-time listeners.
Since: 3.0.0
Inherited From:
Source: src/events/EventEmitter.js (Line 151)
Returns:

this.

Type
Phaser.Cameras.Scene2D.Camera

on(event, fn [, context])

Add a listener for a given event.

Parameters:
Name Type Argument Default Description
event string | symbol

The event name.
fn function

The listener function.
context * <optional>
 this

The context to invoke the listener with.
Since: 3.0.0
Inherited From:
Source: src/events/EventEmitter.js (Line 98)
Returns:

this.

Type
Phaser.Cameras.Scene2D.Camera

once(event, fn [, context])

Add a one-time listener for a given event.

Parameters:
Name Type Argument Default Description
event string | symbol

The event name.
fn function

The listener function.
context * <optional>
 this

The context to invoke the listener with.
Since: 3.0.0
Inherited From:
Source: src/events/EventEmitter.js (Line 124)
Returns:

this.

Type
Phaser.Cameras.Scene2D.Camera

pan(x, y [, duration] [, ease] [, force] [, callback] [, context])

This effect will scroll the Camera so that the center of its viewport finishes at the given destination, over the duration and with the ease specified.

Parameters:
Name Type Argument Default Description
x number

The destination x coordinate to scroll the center of the Camera viewport to.
y number

The destination y coordinate to scroll the center of the Camera viewport to.
duration number <optional>
 1000

The duration of the effect in milliseconds.
ease string | function <optional>
 'Linear'

The ease to use for the pan. Can be any of the Phaser Easing constants or a custom function.
force boolean <optional>
 false

Force the pan effect to start immediately, even if already running.
callback Phaser.Types.Cameras.Scene2D.CameraPanCallback <optional>

This callback will be invoked every frame for the duration of the effect. It is sent four arguments: A reference to the camera, a progress amount between 0 and 1 indicating how complete the effect is, the current camera scroll x coordinate and the current camera scroll y coordinate.
context any <optional>

The context in which the callback is invoked. Defaults to the Scene to which the Camera belongs.
Since: 3.11.0
Source: src/cameras/2d/Camera.js (Line 414)
Fires:
Returns:

This Camera instance.

Type
Phaser.Cameras.Scene2D.Camera

<protected> preRender()

Internal preRender step.

Since: 3.0.0
Overrides:
Source: src/cameras/2d/Camera.js (Line 488)

removeAllListeners( [event])

Remove all listeners, or those of the specified event.

Parameters:
Name Type Argument Description
event string | symbol <optional>

The event name.
Since: 3.0.0
Inherited From:
Source: src/events/EventEmitter.js (Line 165)
Returns:

this.

Type
Phaser.Cameras.Scene2D.Camera

removeBounds()

If this Camera has previously had movement bounds set on it, this will remove them.

Since: 3.0.0
Inherited From:
Source: src/cameras/2d/BaseCamera.js (Line 1003)
Returns:

This Camera instance.

Type
Phaser.Cameras.Scene2D.Camera

removeListener(event [, fn] [, context] [, once])

Remove the listeners of a given event.

Parameters:
Name Type Argument Description
event string | symbol

The event name.
fn function <optional>

Only remove the listeners that match this function.
context * <optional>

Only remove the listeners that have this context.
once boolean <optional>

Only remove one-time listeners.
Since: 3.0.0
Inherited From:
Source: src/events/EventEmitter.js (Line 137)
Returns:

this.

Type
Phaser.Cameras.Scene2D.Camera

removePostPipeline(pipeline)

Removes a type of Post Pipeline instances from this Game Object, based on the given name, and destroys them.

If you wish to remove all Post Pipelines use the resetPostPipeline method instead.

Parameters:
Name Type Description
pipeline string | Phaser.Renderer.WebGL.Pipelines.PostFXPipeline

The string-based name of the pipeline, or a pipeline class.
Since: 3.50.0
Inherited From:
Source: src/gameobjects/components/Pipeline.js (Line 361)
Returns:

This Game Object.

Type
Phaser.Cameras.Scene2D.Camera

resetFlip()

Resets the horizontal and vertical flipped state of this Game Object back to their default un-flipped state.

Since: 3.0.0
Inherited From:
Source: src/gameobjects/components/Flip.js (Line 140)
Returns:

This Game Object instance.

Type
Phaser.Cameras.Scene2D.Camera

resetFX()

Resets any active FX, such as a fade, flash or shake. Useful to call after a fade in order to remove the fade.

Since: 3.0.0
Source: src/cameras/2d/Camera.js (Line 737)
Returns:

This Camera instance.

Type
Phaser.Cameras.Scene2D.Camera

resetPipeline( [resetPostPipelines] [, resetData])

Resets the WebGL Pipeline of this Game Object back to the default it was created with.

Parameters:
Name Type Argument Default Description
resetPostPipelines boolean <optional>
 false

Reset all of the post pipelines?
resetData boolean <optional>
 false

Reset the pipelineData object to being an empty object?
Since: 3.0.0
Inherited From:
Source: src/gameobjects/components/Pipeline.js (Line 298)
Returns:

true if the pipeline was reset successfully, otherwise false.

Type
boolean

resetPostPipeline( [resetData])

Resets the WebGL Post Pipelines of this Game Object. It does this by calling the destroy method on each post pipeline and then clearing the local array.

Parameters:
Name Type Argument Default Description
resetData boolean <optional>
 false

Reset the pipelineData object to being an empty object?
Since: 3.50.0
Inherited From:
Source: src/gameobjects/components/Pipeline.js (Line 331)

rotateTo(radians [, shortestPath] [, duration] [, ease] [, force] [, callback] [, context])

This effect will rotate the Camera so that the viewport finishes at the given angle in radians, over the duration and with the ease specified.

Parameters:
Name Type Argument Default Description
radians number

The destination angle in radians to rotate the Camera viewport to. If the angle is positive then the rotation is clockwise else anticlockwise
shortestPath boolean <optional>
 false

If shortest path is set to true the camera will rotate in the quickest direction clockwise or anti-clockwise.
duration number <optional>
 1000

The duration of the effect in milliseconds.
ease string | function <optional>
 'Linear'

The ease to use for the rotation. Can be any of the Phaser Easing constants or a custom function.
force boolean <optional>
 false

Force the rotation effect to start immediately, even if already running.
callback CameraRotateCallback <optional>

This callback will be invoked every frame for the duration of the effect. It is sent four arguments: A reference to the camera, a progress amount between 0 and 1 indicating how complete the effect is, the current camera rotation angle in radians.
context any <optional>

The context in which the callback is invoked. Defaults to the Scene to which the Camera belongs.
Since: 3.23.0
Source: src/cameras/2d/Camera.js (Line 440)
Returns:

This Camera instance.

Type
Phaser.Cameras.Scene2D.Camera

setAlpha( [value])

Set the Alpha level of this Camera. The alpha controls the opacity of the Camera as it renders. Alpha values are provided as a float between 0, fully transparent, and 1, fully opaque.

Parameters:
Name Type Argument Default Description
value number <optional>
 1

The Camera alpha value.
Since: 3.11.0
Inherited From:
Source: src/cameras/2d/BaseCamera.js (Line 495)
Returns:

This Camera instance.

Type
Phaser.Cameras.Scene2D.Camera

setAngle( [value])

Set the rotation of this Camera. This causes everything it renders to appear rotated.

Rotating a camera does not rotate the viewport itself, it is applied during rendering.

Parameters:
Name Type Argument Default Description
value number <optional>
 0

The cameras angle of rotation, given in degrees.
Since: 3.0.0
Inherited From:
Source: src/cameras/2d/BaseCamera.js (Line 1022)
Returns:

This Camera instance.

Type
Phaser.Cameras.Scene2D.Camera

setBackgroundColor( [color])

Sets the background color for this Camera.

By default a Camera has a transparent background but it can be given a solid color, with any level of transparency, via this method.

The color value can be specified using CSS color notation, hex or numbers.

Parameters:
Name Type Argument Default Description
color string | number | Phaser.Types.Display.InputColorObject <optional>
 'rgba(0,0,0,0)'

The color value. In CSS, hex or numeric color notation.
Since: 3.0.0
Inherited From:
Source: src/cameras/2d/BaseCamera.js (Line 1043)
Returns:

This Camera instance.

Type
Phaser.Cameras.Scene2D.Camera

setBounds(x, y, width, height [, centerOn])

Set the bounds of the Camera. The bounds are an axis-aligned rectangle.

The Camera bounds controls where the Camera can scroll to, stopping it from scrolling off the edges and into blank space. It does not limit the placement of Game Objects, or where the Camera viewport can be positioned.

Temporarily disable the bounds by changing the boolean Camera.useBounds.

Clear the bounds entirely by calling Camera.removeBounds.

If you set bounds that are smaller than the viewport it will stop the Camera from being able to scroll. The bounds can be positioned where-ever you wish. By default they are from 0x0 to the canvas width x height. This means that the coordinate 0x0 is the top left of the Camera bounds. However, you can position them anywhere. So if you wanted a game world that was 2048x2048 in size, with 0x0 being the center of it, you can set the bounds x/y to be -1024, -1024, with a width and height of 2048. Depending on your game you may find it easier for 0x0 to be the top-left of the bounds, or you may wish 0x0 to be the middle.

Parameters:
Name Type Argument Default Description
x number

The top-left x coordinate of the bounds.
y number

The top-left y coordinate of the bounds.
width number

The width of the bounds, in pixels.
height number

The height of the bounds, in pixels.
centerOn boolean <optional>
 false

If true the Camera will automatically be centered on the new bounds.
Since: 3.0.0
Inherited From:
Source: src/cameras/2d/BaseCamera.js (Line 1069)
Returns:

This Camera instance.

Type
Phaser.Cameras.Scene2D.Camera

setDeadzone( [width] [, height])

Sets the Camera dead zone.

The deadzone is only used when the camera is following a target.

It defines a rectangular region within which if the target is present, the camera will not scroll. If the target moves outside of this area, the camera will begin scrolling in order to follow it.

The deadzone rectangle is re-positioned every frame so that it is centered on the mid-point of the camera. This allows you to use the object for additional game related checks, such as testing if an object is within it or not via a Rectangle.contains call.

The lerp values that you can set for a follower target also apply when using a deadzone.

Calling this method with no arguments will reset an active deadzone.

Parameters:
Name Type Argument Description
width number <optional>

The width of the deadzone rectangle in pixels. If not specified the deadzone is removed.
height number <optional>

The height of the deadzone rectangle in pixels.
Since: 3.11.0
Source: src/cameras/2d/Camera.js (Line 211)
Returns:

This Camera instance.

Type
Phaser.Cameras.Scene2D.Camera

setFlip(x, y)

Sets the horizontal and vertical flipped state of this Game Object.

A Game Object that is flipped will render inversed on the flipped axis. Flipping always takes place from the middle of the texture and does not impact the scale value. If this Game Object has a physics body, it will not change the body. This is a rendering toggle only.

Parameters:
Name Type Description
x boolean

The horizontal flipped state. false for no flip, or true to be flipped.
y boolean

The horizontal flipped state. false for no flip, or true to be flipped.
Since: 3.0.0
Inherited From:
Source: src/gameobjects/components/Flip.js (Line 117)
Returns:

This Game Object instance.

Type
Phaser.Cameras.Scene2D.Camera

setFlipX(value)

Sets the horizontal flipped state of this Game Object.

A Game Object that is flipped horizontally will render inversed on the horizontal axis. Flipping always takes place from the middle of the texture and does not impact the scale value. If this Game Object has a physics body, it will not change the body. This is a rendering toggle only.

Parameters:
Name Type Description
value boolean

The flipped state. false for no flip, or true to be flipped.
Since: 3.0.0
Inherited From:
Source: src/gameobjects/components/Flip.js (Line 79)
Returns:

This Game Object instance.

Type
Phaser.Cameras.Scene2D.Camera

setFlipY(value)

Sets the vertical flipped state of this Game Object.

Parameters:
Name Type Description
value boolean

The flipped state. false for no flip, or true to be flipped.
Since: 3.0.0
Inherited From:
Source: src/gameobjects/components/Flip.js (Line 100)
Returns:

This Game Object instance.

Type
Phaser.Cameras.Scene2D.Camera

setFollowOffset( [x] [, y])

Sets the horizontal and vertical offset of the camera from its follow target. The values are subtracted from the targets position during the Cameras update step.

Parameters:
Name Type Argument Default Description
x number <optional>
 0

The horizontal offset from the camera follow target.x position.
y number <optional>
 0

The vertical offset from the camera follow target.y position.
Since: 3.9.0
Source: src/cameras/2d/Camera.js (Line 635)
Returns:

This Camera instance.

Type
Phaser.Cameras.Scene2D.Camera

setLerp( [x] [, y])

Sets the linear interpolation value to use when following a target.

The default values of 1 means the camera will instantly snap to the target coordinates. A lower value, such as 0.1 means the camera will more slowly track the target, giving a smooth transition. You can set the horizontal and vertical values independently, and also adjust this value in real-time during your game.

Be sure to keep the value between 0 and 1. A value of zero will disable tracking on that axis.

Parameters:
Name Type Argument Default Description
x number <optional>
 1

The amount added to the horizontal linear interpolation of the follow target.
y number <optional>
 1

The amount added to the vertical linear interpolation of the follow target.
Since: 3.9.0
Source: src/cameras/2d/Camera.js (Line 607)
Returns:

This Camera instance.

Type
Phaser.Cameras.Scene2D.Camera

setMask(mask [, fixedPosition])

Sets the mask to be applied to this Camera during rendering.

The mask must have been previously created and can be either a GeometryMask or a BitmapMask.

Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.

If a mask is already set on this Camera it will be immediately replaced.

Masks have no impact on physics or input detection. They are purely a rendering component that allows you to limit what is visible during the render pass.

Parameters:
Name Type Argument Default Description
mask Phaser.Display.Masks.BitmapMask | Phaser.Display.Masks.GeometryMask

The mask this Camera will use when rendering.
fixedPosition boolean <optional>
 true

Should the mask translate along with the Camera, or be fixed in place and not impacted by the Cameras transform?
Since: 3.17.0
Inherited From:
Source: src/cameras/2d/BaseCamera.js (Line 1381)
Returns:

This Camera instance.

Type
Phaser.Cameras.Scene2D.Camera

setName( [value])

Sets the name of this Camera. This value is for your own use and isn't used internally.

Parameters:
Name Type Argument Default Description
value string <optional>
 ''

The name of the Camera.
Since: 3.0.0
Inherited From:
Source: src/cameras/2d/BaseCamera.js (Line 1146)
Returns:

This Camera instance.

Type
Phaser.Cameras.Scene2D.Camera

setOrigin( [x] [, y])

Sets the rotation origin of this Camera.

The values are given in the range 0 to 1 and are only used when calculating Camera rotation.

By default the camera rotates around the center of the viewport.

Changing the origin allows you to adjust the point in the viewport from which rotation happens. A value of 0 would rotate from the top-left of the viewport. A value of 1 from the bottom right.

Parameters:
Name Type Argument Default Description
x number <optional>
 0.5

The horizontal origin value.
y number <optional>
 x

The vertical origin value. If not defined it will be set to the value of x.
Since: 3.11.0
Inherited From:
Source: src/cameras/2d/BaseCamera.js (Line 507)
Returns:

This Camera instance.

Type
Phaser.Cameras.Scene2D.Camera

setPipeline(pipeline [, pipelineData] [, copyData])

Sets the main WebGL Pipeline of this Game Object.

Also sets the pipelineData property, if the parameter is given.

Both the pipeline and post pipelines share the same pipeline data object.

Parameters:
Name Type Argument Default Description
pipeline string | Phaser.Renderer.WebGL.WebGLPipeline

Either the string-based name of the pipeline, or a pipeline instance to set.
pipelineData object <optional>

Optional pipeline data object that is deep copied into the pipelineData property of this Game Object.
copyData boolean <optional>
 true

Should the pipeline data object be deep copied into the pipelineData property of this Game Object? If false it will be set by reference instead.
Since: 3.0.0
Inherited From:
Source: src/gameobjects/components/Pipeline.js (Line 125)
Returns:

This Game Object instance.

Type
Phaser.Cameras.Scene2D.Camera

setPipelineData(key [, value])

Adds an entry to the pipelineData object belonging to this Game Object.

If the 'key' already exists, its value is updated. If it doesn't exist, it is created.

If value is undefined, and key exists, key is removed from the data object.

Both the pipeline and post pipelines share the pipeline data object together.

Parameters:
Name Type Argument Description
key string

The key of the pipeline data to set, update, or delete.
value any <optional>

The value to be set with the key. If undefined then key will be deleted from the object.
Since: 3.50.0
Inherited From:
Source: src/gameobjects/components/Pipeline.js (Line 238)
Returns:

This Game Object instance.

Type
Phaser.Cameras.Scene2D.Camera

setPosition(x [, y])

Set the position of the Camera viewport within the game.

This does not change where the camera is 'looking'. See setScroll to control that.

Parameters:
Name Type Argument Default Description
x number

The top-left x coordinate of the Camera viewport.
y number <optional>
 x

The top-left y coordinate of the Camera viewport.
Since: 3.0.0
Inherited From:
Source: src/cameras/2d/BaseCamera.js (Line 1166)
Returns:

This Camera instance.

Type
Phaser.Cameras.Scene2D.Camera

setPostPipeline(pipelines [, pipelineData] [, copyData])

Sets one, or more, Post Pipelines on this Game Object.

Post Pipelines are invoked after this Game Object has rendered to its target and are commonly used for post-fx.

The post pipelines are appended to the postPipelines array belonging to this Game Object. When the renderer processes this Game Object, it iterates through the post pipelines in the order in which they appear in the array. If you are stacking together multiple effects, be aware that the order is important.

If you call this method multiple times, the new pipelines will be appended to any existing post pipelines already set. Use the resetPostPipeline method to clear them first, if required.

You can optionally also sets the pipelineData property, if the parameter is given.

Both the pipeline and post pipelines share the pipeline data object together.

Parameters:
Name Type Argument Default Description
pipelines string | Array.<string> | function | Array.<function()> | Phaser.Renderer.WebGL.Pipelines.PostFXPipeline | Array.<Phaser.Renderer.WebGL.Pipelines.PostFXPipeline>

Either the string-based name of the pipeline, or a pipeline instance, or class, or an array of them.
pipelineData object <optional>

Optional pipeline data object that is deep copied into the pipelineData property of this Game Object.
copyData boolean <optional>
 true

Should the pipeline data object be deep copied into the pipelineData property of this Game Object? If false it will be set by reference instead.
Since: 3.50.0
Inherited From:
Source: src/gameobjects/components/Pipeline.js (Line 171)
Returns:

This Game Object instance.

Type
Phaser.Cameras.Scene2D.Camera

setRotation( [value])

Set the rotation of this Camera. This causes everything it renders to appear rotated.

Rotating a camera does not rotate the viewport itself, it is applied during rendering.

Parameters:
Name Type Argument Default Description
value number <optional>
 0

The rotation of the Camera, in radians.
Since: 3.0.0
Inherited From:
Source: src/cameras/2d/BaseCamera.js (Line 1189)
Returns:

This Camera instance.

Type
Phaser.Cameras.Scene2D.Camera

setRoundPixels(value)

Should the Camera round pixel values to whole integers when rendering Game Objects?

In some types of game, especially with pixel art, this is required to prevent sub-pixel aliasing.

Parameters:
Name Type Description
value boolean

true to round Camera pixels, false to not.
Since: 3.0.0
Inherited From:
Source: src/cameras/2d/BaseCamera.js (Line 1210)
Returns:

This Camera instance.

Type
Phaser.Cameras.Scene2D.Camera

setScene(scene)

Sets the Scene the Camera is bound to.

Parameters:
Name Type Description
scene Phaser.Scene

The Scene the camera is bound to.
Since: 3.0.0
Inherited From:
Source: src/cameras/2d/BaseCamera.js (Line 1229)
Returns:

This Camera instance.

Type
Phaser.Cameras.Scene2D.Camera

setScroll(x [, y])

Set the position of where the Camera is looking within the game. You can also modify the properties Camera.scrollX and Camera.scrollY directly. Use this method, or the scroll properties, to move your camera around the game world.

This does not change where the camera viewport is placed. See setPosition to control that.

Parameters:
Name Type Argument Default Description
x number

The x coordinate of the Camera in the game world.
y number <optional>
 x

The y coordinate of the Camera in the game world.
Since: 3.0.0
Inherited From:
Source: src/cameras/2d/BaseCamera.js (Line 1259)
Returns:

This Camera instance.

Type
Phaser.Cameras.Scene2D.Camera

setSize(width [, height])

Set the size of the Camera viewport.

By default a Camera is the same size as the game, but can be made smaller via this method, allowing you to create mini-cam style effects by creating and positioning a smaller Camera viewport within your game.

Parameters:
Name Type Argument Default Description
width number

The width of the Camera viewport.
height number <optional>
 width

The height of the Camera viewport.
Since: 3.0.0
Inherited From:
Source: src/cameras/2d/BaseCamera.js (Line 1284)
Returns:

This Camera instance.

Type
Phaser.Cameras.Scene2D.Camera

setTint( [topLeft] [, topRight] [, bottomLeft] [, bottomRight])

Sets an additive tint on this Game Object.

The tint works by taking the pixel color values from the Game Objects texture, and then multiplying it by the color value of the tint. You can provide either one color value, in which case the whole Game Object will be tinted in that color. Or you can provide a color per corner. The colors are blended together across the extent of the Game Object.

To modify the tint color once set, either call this method again with new values or use the tint property to set all colors at once. Or, use the properties tintTopLeft, tintTopRight, tintBottomLeftandtintBottomRight` to set the corner color values independently.

To remove a tint call clearTint.

To swap this from being an additive tint to a fill based tint set the property tintFill to true.

Parameters:
Name Type Argument Default Description
topLeft number <optional>
 0xffffff

The tint being applied to the top-left of the Game Object. If no other values are given this value is applied evenly, tinting the whole Game Object.
topRight number <optional>

The tint being applied to the top-right of the Game Object.
bottomLeft number <optional>

The tint being applied to the bottom-left of the Game Object.
bottomRight number <optional>

The tint being applied to the bottom-right of the Game Object.
Since: 3.0.0
Inherited From:
Source: src/gameobjects/components/Tint.js (Line 98)
Returns:

This Game Object instance.

Type
Phaser.Cameras.Scene2D.Camera

setTintFill( [topLeft] [, topRight] [, bottomLeft] [, bottomRight])

Sets a fill-based tint on this Game Object.

Unlike an additive tint, a fill-tint literally replaces the pixel colors from the texture with those in the tint. You can use this for effects such as making a player flash 'white' if hit by something. You can provide either one color value, in which case the whole Game Object will be rendered in that color. Or you can provide a color per corner. The colors are blended together across the extent of the Game Object.

To modify the tint color once set, either call this method again with new values or use the tint property to set all colors at once. Or, use the properties tintTopLeft, tintTopRight, tintBottomLeftandtintBottomRight` to set the corner color values independently.

To remove a tint call clearTint.

To swap this from being a fill-tint to an additive tint set the property tintFill to false.

Parameters:
Name Type Argument Default Description
topLeft number <optional>
 0xffffff

The tint being applied to the top-left of the Game Object. If not other values are given this value is applied evenly, tinting the whole Game Object.
topRight number <optional>

The tint being applied to the top-right of the Game Object.
bottomLeft number <optional>

The tint being applied to the bottom-left of the Game Object.
bottomRight number <optional>

The tint being applied to the bottom-right of the Game Object.
Since: 3.11.0
Inherited From:
Source: src/gameobjects/components/Tint.js (Line 146)
Returns:

This Game Object instance.

Type
Phaser.Cameras.Scene2D.Camera

setViewport(x, y, width [, height])

This method sets the position and size of the Camera viewport in a single call.

If you're trying to change where the Camera is looking at in your game, then see the method Camera.setScroll instead. This method is for changing the viewport itself, not what the camera can see.

By default a Camera is the same size as the game, but can be made smaller via this method, allowing you to create mini-cam style effects by creating and positioning a smaller Camera viewport within your game.

Parameters:
Name Type Argument Default Description
x number

The top-left x coordinate of the Camera viewport.
y number

The top-left y coordinate of the Camera viewport.
width number

The width of the Camera viewport.
height number <optional>
 width

The height of the Camera viewport.
Since: 3.0.0
Inherited From:
Source: src/cameras/2d/BaseCamera.js (Line 1309)
Returns:

This Camera instance.

Type
Phaser.Cameras.Scene2D.Camera

setVisible(value)

Sets the visibility of this Camera.

An invisible Camera will skip rendering and input tests of everything it can see.

Parameters:
Name Type Description
value boolean

The visible state of the Camera.
Since: 3.10.0
Inherited From:
Source: src/cameras/2d/BaseCamera.js (Line 1436)
Returns:

This Camera instance.

Type
Phaser.Cameras.Scene2D.Camera

setZoom( [x] [, y])

Set the zoom value of the Camera.

Changing to a smaller value, such as 0.5, will cause the camera to 'zoom out'. Changing to a larger value, such as 2, will cause the camera to 'zoom in'.

A value of 1 means 'no zoom' and is the default.

Changing the zoom does not impact the Camera viewport in any way, it is only applied during rendering.

As of Phaser 3.50 you can now set the horizontal and vertical zoom values independently.

Parameters:
Name Type Argument Default Description
x number <optional>
 1

The horizontal zoom value of the Camera. The minimum it can be is 0.001.
y number <optional>
 x

The vertical zoom value of the Camera. The minimum it can be is 0.001.
Since: 3.0.0
Inherited From:
Source: src/cameras/2d/BaseCamera.js (Line 1340)
Returns:

This Camera instance.

Type
Phaser.Cameras.Scene2D.Camera

shake( [duration] [, intensity] [, force] [, callback] [, context])

Shakes the Camera by the given intensity over the duration specified.

Parameters:
Name Type Argument Default Description
duration number <optional>
 100

The duration of the effect in milliseconds.
intensity number | Phaser.Math.Vector2 <optional>
 0.05

The intensity of the shake.
force boolean <optional>
 false

Force the shake effect to start immediately, even if already running.
callback function <optional>

This callback will be invoked every frame for the duration of the effect. It is sent two arguments: A reference to the camera and a progress amount between 0 and 1 indicating how complete the effect is.
context any <optional>

The context in which the callback is invoked. Defaults to the Scene to which the Camera belongs.
Since: 3.0.0
Source: src/cameras/2d/Camera.js (Line 392)
Fires:
Returns:

This Camera instance.

Type
Phaser.Cameras.Scene2D.Camera

shutdown()

Removes all listeners.

Since: 3.0.0
Inherited From:
Source: src/events/EventEmitter.js (Line 31)

startFollow(target [, roundPixels] [, lerpX] [, lerpY] [, offsetX] [, offsetY])

Sets the Camera to follow a Game Object.

When enabled the Camera will automatically adjust its scroll position to keep the target Game Object in its center.

You can set the linear interpolation value used in the follow code. Use low lerp values (such as 0.1) to automatically smooth the camera motion.

If you find you're getting a slight "jitter" effect when following an object it's probably to do with sub-pixel rendering of the targets position. This can be rounded by setting the roundPixels argument to true to force full pixel rounding rendering. Note that this can still be broken if you have specified a non-integer zoom value on the camera. So be sure to keep the camera zoom to integers.

Parameters:
Name Type Argument Default Description
target Phaser.GameObjects.GameObject | object

The target for the Camera to follow.
roundPixels boolean <optional>
 false

Round the camera position to whole integers to avoid sub-pixel rendering?
lerpX number <optional>
 1

A value between 0 and 1. This value specifies the amount of linear interpolation to use when horizontally tracking the target. The closer the value to 1, the faster the camera will track.
lerpY number <optional>
 1

A value between 0 and 1. This value specifies the amount of linear interpolation to use when vertically tracking the target. The closer the value to 1, the faster the camera will track.
offsetX number <optional>
 0

The horizontal offset from the camera follow target.x position.
offsetY number <optional>
 0

The vertical offset from the camera follow target.y position.
Since: 3.0.0
Source: src/cameras/2d/Camera.js (Line 657)
Returns:

This Camera instance.

Type
Phaser.Cameras.Scene2D.Camera

stopFollow()

Stops a Camera from following a Game Object, if previously set via Camera.startFollow.

Since: 3.0.0
Source: src/cameras/2d/Camera.js (Line 722)
Returns:

This Camera instance.

Type
Phaser.Cameras.Scene2D.Camera

toggleFlipX()

Toggles the horizontal flipped state of this Game Object.

A Game Object that is flipped horizontally will render inversed on the horizontal axis. Flipping always takes place from the middle of the texture and does not impact the scale value. If this Game Object has a physics body, it will not change the body. This is a rendering toggle only.

Since: 3.0.0
Inherited From:
Source: src/gameobjects/components/Flip.js (Line 45)
Returns:

This Game Object instance.

Type
Phaser.Cameras.Scene2D.Camera

toggleFlipY()

Toggles the vertical flipped state of this Game Object.

Since: 3.0.0
Inherited From:
Source: src/gameobjects/components/Flip.js (Line 64)
Returns:

This Game Object instance.

Type
Phaser.Cameras.Scene2D.Camera

toJSON()

Returns an Object suitable for JSON storage containing all of the Camera viewport and rendering properties.

Since: 3.0.0
Inherited From:
Source: src/cameras/2d/BaseCamera.js (Line 1449)
Returns:

A well-formed object suitable for conversion to JSON.

Type
Phaser.Types.Cameras.Scene2D.JSONCamera

<protected> update(time, delta)

Internal method called automatically by the Camera Manager.

Parameters:
Name Type Description
time number

The current timestamp as generated by the Request Animation Frame or SetTimeout.
delta number

The delta time, in ms, elapsed since the last frame.
Since: 3.0.0
Overrides:
Source: src/cameras/2d/Camera.js (Line 757)

zoomTo(zoom [, duration] [, ease] [, force] [, callback] [, context])

This effect will zoom the Camera to the given scale, over the duration and with the ease specified.

Parameters:
Name Type Argument Default Description
zoom number

The target Camera zoom value.
duration number <optional>
 1000

The duration of the effect in milliseconds.
ease string | function <optional>
 'Linear'

The ease to use for the pan. Can be any of the Phaser Easing constants or a custom function.
force boolean <optional>
 false

Force the pan effect to start immediately, even if already running.
callback Phaser.Types.Cameras.Scene2D.CameraPanCallback <optional>

This callback will be invoked every frame for the duration of the effect. It is sent four arguments: A reference to the camera, a progress amount between 0 and 1 indicating how complete the effect is, the current camera scroll x coordinate and the current camera scroll y coordinate.
context any <optional>

The context in which the callback is invoked. Defaults to the Scene to which the Camera belongs.
Since: 3.11.0
Source: src/cameras/2d/Camera.js (Line 464)
Fires:
Returns:

This Camera instance.

Type
Phaser.Cameras.Scene2D.Camera