CanvasRenderer

.Renderer.Canvas. CanvasRenderer

画布渲染器负责管理2D画布渲染上下文, 包括游戏画布使用的那个.它跟踪的内部状态 给定上下文,可以渲染纹理游戏对象,考虑 帐户阿尔法,混合和缩放.

Constructor

new CanvasRenderer(game)

Since:
  • 3.0.0
Parameters:
Name Type Description
game Phaser.Game 拥有此渲染器的相位器游戏实例.

Extends

Members

antialias :boolean

Since:
  • 3.20.0
绘制精灵时,画布是否应该使用图像平滑?
Type:
  • boolean

blendModes :array

Since:
  • 3.0.0
画布渲染器支持的混合模式. 此对象映射Phaser.BlendModes到画布合成操作.
Type:
  • array

config :object

Since:
  • 3.0.0
CanvasRenderer的本地配置设置.
Type:
  • object

currentContext :CanvasRenderingContext2D

Since:
  • 3.0.0
CanvasRenderer当前用于所有渲染操作的画布上下文.
Type:
  • CanvasRenderingContext2D

drawCount :number

Since:
  • 3.0.0
Default Value:
  • 0
一帧中渲染的游戏对象总数.
Type:
  • number

game :Phaser.Game

Since:
  • 3.0.0
拥有此渲染器的相位器游戏实例.
Type:

gameCanvas :HTMLCanvasElement

Since:
  • 3.0.0
游戏使用的画布元素.
Type:
  • HTMLCanvasElement

gameContext :CanvasRenderingContext2D

Since:
  • 3.0.0
用于在游戏循环期间渲染所有场景中所有摄像机的画布上下文.
Type:
  • CanvasRenderingContext2D

height :number

Since:
  • 3.0.0
要渲染到的画布的高度.
Type:
  • number

isBooted :boolean

Since:
  • 3.50.0
这个渲染器已经完全启动了吗?
Type:
  • boolean

snapshotState :Phaser.Types.Renderer.Snapshot.SnapshotState

Since:
  • 3.16.0
当前计划快照的详细信息. 如果在此对象中设置了非空的 `callback` ,将在当前帧完全渲染后拍摄画布的快照.
Type:

type :number

Since:
  • 3.0.0
一个常量,它允许渲染器被容易地识别为画布渲染器.
Type:
  • number

width :number

Since:
  • 3.0.0
要渲染到的画布的宽度.
Type:
  • number

Methods

addListener(event, fn, contextopt) → {this}

Since:
  • 3.0.0
Inherited From:
为给定事件添加侦听器.
Parameters:
Name Type Attributes Default Description
event string | symbol 事件名称.
fn function 侦听器函数.
context * <optional>
this 用来调用侦听器的上下文.
Returns:
`this`.
Type
this

batchSprite(sprite, frame, camera, parentTransformMatrixopt)

Since:
  • 3.12.0
获取一个精灵游戏对象,或任何扩展它的对象,并将其绘制到当前上下文.
Parameters:
Name Type Attributes Description
sprite Phaser.GameObjects.GameObject 要绘制的基于纹理的游戏对象.
frame Phaser.Textures.Frame 要绘制的框架不必是游戏对象所拥有的.
camera Phaser.Cameras.Scene2D.Camera 用于渲染转换的摄像机.
parentTransformMatrix Phaser.GameObjects.Components.TransformMatrix <optional>
父容器的转换矩阵(如果已设置).

destroy()

Since:
  • 3.0.0
Overrides:
销毁画布渲染器中的所有对象引用.

emit(event, …argsopt) → {boolean}

Since:
  • 3.0.0
Inherited From:
调用为给定事件注册的每个侦听器.
Parameters:
Name Type Attributes Description
event string | symbol 事件名称.
args * <optional>
<repeatable>
将传递给事件处理程序的附加参数.
Returns:
`true` 如果事件有侦听器,则为 `false` .
Type
boolean

eventNames() → {Array.<(string|symbol)>}

Since:
  • 3.0.0
Inherited From:
返回一个数组,列出发射器已注册侦听器的事件.
Returns:
Type
Array.<(string|symbol)>

init()

Since:
  • 3.0.0
准备游戏画布进行渲染.

listenerCount(event) → {number}

Since:
  • 3.0.0
Inherited From:
返回监听给定事件的侦听器数量.
Parameters:
Name Type Description
event string | symbol 事件名称.
Returns:
侦听器的数量.
Type
number

listeners(event) → {Array.<function()>}

Since:
  • 3.0.0
Inherited From:
返回为给定事件注册的侦听器.
Parameters:
Name Type Description
event string | symbol 事件名称.
Returns:
注册的听众.
Type
Array.<function()>

off(event, fnopt, contextopt, onceopt) → {this}

Since:
  • 3.0.0
Inherited From:
移除给定事件的侦听器.
Parameters:
Name Type Attributes Description
event string | symbol 事件名称.
fn function <optional>
仅移除与此函数匹配的侦听器.
context * <optional>
仅移除具有此上下文的侦听器.
once boolean <optional>
仅删除一次性侦听器.
Returns:
`this`.
Type
this

on(event, fn, contextopt) → {this}

Since:
  • 3.0.0
Inherited From:
为给定事件添加侦听器.
Parameters:
Name Type Attributes Default Description
event string | symbol 事件名称.
fn function 侦听器函数.
context * <optional>
this 用来调用侦听器的上下文.
Returns:
`this`.
Type
this

once(event, fn, contextopt) → {this}

Since:
  • 3.0.0
Inherited From:
为给定事件添加一次性侦听器.
Parameters:
Name Type Attributes Default Description
event string | symbol 事件名称.
fn function 侦听器函数.
context * <optional>
this 用来调用侦听器的上下文.
Returns:
`this`.
Type
this

onResize(gameSize, baseSize)

Since:
  • 3.16.0
管理缩放管理器调度的`调整大小`事件的事件处理程序.
Parameters:
Name Type Description
gameSize Phaser.Structs.Size 默认的游戏大小对象.这是未修改的游戏尺寸.
baseSize Phaser.Structs.Size 基本大小对象.游戏尺寸乘以分辨率.画布宽度/高度值与此匹配.

postRender()

Since:
  • 3.0.0
恢复游戏上下文的全局设置,并拍摄快照(如果已计划). 渲染后步骤发生在渲染所有场景中的所有摄像机之后.
Fires:

preRender()

Since:
  • 3.0.0
在渲染循环开始时调用.
Fires:

removeAllListeners(eventopt) → {this}

Since:
  • 3.0.0
Inherited From:
移除所有侦听器或指定事件的侦听器.
Parameters:
Name Type Attributes Description
event string | symbol <optional>
事件名称.
Returns:
`this`.
Type
this

removeListener(event, fnopt, contextopt, onceopt) → {this}

Since:
  • 3.0.0
Inherited From:
移除给定事件的侦听器.
Parameters:
Name Type Attributes Description
event string | symbol 事件名称.
fn function <optional>
仅移除与此函数匹配的侦听器.
context * <optional>
仅移除具有此上下文的侦听器.
once boolean <optional>
仅删除一次性侦听器.
Returns:
`this`.
Type
this

render(scene, children, camera)

Since:
  • 3.0.0
场景摄像机的核心渲染步骤. 遍历给定的游戏对象数组,并用给定的摄像机渲染它们. 这是由 `CameraManager.render` 方法调用的.摄影机管理器实例属于场景,并被调用 通过场景系统渲染方法. 如果 `Camera.visible` 是 `false` ,或者 `Camera.alpha` 为零,则不调用此方法.
Parameters:
Name Type Description
scene Phaser.Scene 要渲染的场景.
children Array.<Phaser.GameObjects.GameObject> 可以由给定摄像机渲染的过滤游戏对象的数组.
camera Phaser.Cameras.Scene2D.Camera 要渲染的场景摄影机.
Fires:

resetTransform()

Since:
  • 3.0.0
将当前上下文的转换矩阵重置为单位矩阵,从而重置任何转换.

resize(widthopt, heightopt)