Phaser.Renderer.Canvas

Scope: static

Source: src/renderer/canvas/index.js#L7

Classs:

Public Members

Private Members

Methods:

Public Members

GetBlendModes

<static> GetBlendModes()

Description:

Returns an array which maps the default blend modes to supported Canvas blend modes.

If the browser doesn't support a blend mode, it will default to the normal source-over blend mode.

Returns: array - Which Canvas blend mode corresponds to which default Phaser blend mode.

Source: src/renderer/canvas/utils/GetBlendModes.js#L10
Since: 3.0.0


SetTransform

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

Description:

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 the Game Object has a texture frame, imageSmoothingEnabled is set based on frame.source.scaleMode.
  8. If the Game Object does not have a texture frame, imageSmoothingEnabled is set based on Renderer.antialias.

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

Parameters:

nametypeoptionaldescription
rendererPhaser.Renderer.Canvas.CanvasRendererNoA reference to the current active Canvas renderer.
ctxCanvasRenderingContext2DNoThe canvas context to set the transform on.
srcPhaser.GameObjects.GameObjectNoThe Game Object being rendered. Can be any type that extends the base class.
cameraPhaser.Cameras.Scene2D.CameraNoThe Camera that is rendering the Game Object.
parentMatrixPhaser.GameObjects.Components.TransformMatrixYesA parent transform matrix to apply to the Game Object before rendering.

Returns: boolean - true if the Game Object context was set, otherwise false.

Source: src/renderer/canvas/utils/SetTransform.js#L9
Since: 3.12.0


Private Members

Updated on