Phaser API Documentation

<static> SetTransform(renderer, ctx, src, camera, [parentMatrix])


Takes a reference to the Canvas Renderer, a Canvas Rendering Context, a Game Object, a Camera and a parent matrix and then performs the following steps:

  1. Checks the alpha of the source combined with the Camera alpha. If 0 or less it aborts.
  2. Takes the Camera and Game Object matrix and multiplies them, combined with the parent matrix if given.
  3. Sets the blend mode of the context to be that used by the Game Object.
  4. Sets the alpha value of the context to be that used by the Game Object combined with the Camera.
  5. Saves the context state.
  6. Sets the final matrix values into the context via setTransform.
  7. If Renderer.antialias, or the frame.source.scaleMode is set, then imageSmoothingEnabled is set.

This function is only meant to be used internally. Most of the Canvas Renderer classes use it.


name type arguments description
renderer Phaser.Renderer.Canvas.CanvasRenderer

A reference to the current active Canvas renderer.

ctx CanvasRenderingContext2D

The canvas context to set the transform on.

src Phaser.GameObjects.GameObject

The Game Object being rendered. Can be any type that extends the base class.

camera Phaser.Cameras.Scene2D.Camera

The Camera that is rendering the Game Object.

parentMatrix Phaser.GameObjects.Components.TransformMatrix <optional>

A parent transform matrix to apply to the Game Object before rendering.


true if the Game Object context was set, otherwise false.

  • boolean
Since: 3.12.0