Class: CanvasRenderer

PIXI~CanvasRenderer

CanvasRenderer 将场景及其所有内容绘制到二维画布上。

此渲染器应用于不支持WebGL的浏览器。 不要忘记将CanvasRenderer.view添加到您的DOM中,否则您将看不到任何东西!

new CanvasRenderer (options)

Name Type Description
options object optional

可选的渲染器参数

Name Type Default Description
width number 800 optional

屏幕的宽度

height number 600 optional

屏幕的高度

view HTMLCanvasElement optional

用作视图的画布,可选

transparent boolean false optional

渲染视图是f\否透明的,则默认为false

autoDensity boolean false optional

调整CSS像素中渲染器视图的大小,以允许使用非1的分辨率

antialias boolean false optional

设置抗锯齿

resolution number 1 optional

渲染器的分辨率/设备像素比率。 渲染器视网膜的分辨率为2。

preserveDrawingBuffer boolean false optional

启用绘图缓冲区保留,如果需要在webgl上下文上调用toDataUrl,请启用此功能。

clearBeforeRender boolean true optional

这将设置渲染器是否在新的渲染过程之前清除画布。

backgroundColor number 0x000000 optional

渲染区域的背景色(如果不透明则显示)。

Extends

Members

_backgroundColor number protected inherited overrides

背景颜色数值

_backgroundColorRgba Array.<number> protected inherited overrides

背景颜色[R, G, B]数组

_backgroundColorString string protected inherited overrides

背景颜色字符串

_lastObjectRendered PIXI.DisplayObject protected inherited overrides

渲染器尝试渲染的最后一个根对象。

_tempDisplayObjectParent PIXI.DisplayObject protected inherited overrides

此临时显示对象用于当前呈现项的父对象。

autoDensity boolean inherited overrides

canvas视图的CSS尺寸是否应自动调整为屏幕尺寸。

autoResize boolean Deprecated : since 5.0.0 inherited overrides

See:

backgroundColor number inherited overrides

如果不透明则填充的背景色

blendModes object.<number, string>

跟踪对该渲染器的混合模式。

clearBeforeRender boolean inherited overrides

设置CanvasRenderer是否在新的渲染过程之前清除canvas。 如果场景不是透明的,PixiJS将在每一帧使用画布大小的fillRect操作来设置画布背景颜色。 如果场景是透明的,PixiJS将使用clearRect在每一帧清除画布。 将此设置为false可禁用此功能。 例如,如果您的游戏具有画布填充背景图像,则通常不需要此设置。

context CanvasRenderingContext2D

当前活动的canvas 2d上下文(可以通过renderTextures更改)

从显示对象或渲染纹理中提取数据(图像,像素等)的方法集合

See:

height number readonly inherited overrides

与view.height,垂直方向上canvas的实际像素数。

Default Value:
  • 600

CanvasMaskManager的实例,在使用画布渲染器时处理遮罩。

options Object readonly inherited overrides

构造函数选项

plugins object readonly overrides

已安装插件的集合。默认情况下,它们包含在PIXI中,但可以通过创建自定义生成来排除。 有关创建自定义生成和排除插件的详细信息,请参阅自述文件。

Properties:
Name Type Description
accessibility PIXI.accessibility.AccessibilityManager

支持切换交互元素。

extract PIXI.CanvasExtract

从渲染器提取图像数据。

interaction PIXI.interaction.InteractionManager

处理鼠标、触摸和指针事件。

prepare PIXI.CanvasPrepare

预渲染显示对象。

preserveDrawingBuffer boolean inherited overrides

reserveDrawingBuffer标志的值影响渲染后是否保留模板缓冲区的内容。

refresh boolean

布尔值标志,用于控制画布刷新。

resolution number inherited overrides

渲染器的分辨率/设备像素比率。

Default Value:
  • 1

rootContext CanvasRenderingContext2D

绘制所有内容的根画布2d上下文。

屏幕尺寸 (0, 0, screenWidth, screenHeight).

Its safe to use as filterArea or hitArea for the whole stage.

smoothProperty string

canvas属性用于设置画布平滑属性。

transparent boolean inherited overrides

渲染视图是否透明。

type number inherited overrides

渲染器类型

Default Value:
  • PIXI.RENDERER_TYPE.UNKNOWN
See:

view HTMLCanvasElement inherited overrides

绘制所有内容的canvas元素。

width number readonly inherited overrides

与view.width相同,水平方向上canvas的实际像素数。

Default Value:
  • 800

Methods

PIXI.CanvasRenderer.registerPlugin (pluginName, ctor) static

将插件添加到渲染器。

Name Type Description
pluginName string

插件的名称。

ctor function

插件的构造函数或类。

clear (clearColor)

清除渲染器的画布。

Name Type Description
clearColor string optional

使用此颜色清除画布,除非画布已为透明。

destroy (removeView) overrides

从渲染器中移除所有内容,并可选地移除Canvas DOM元素。

Name Type Default Description
removeView boolean false optional

从DOM中移除Canvas元素。

generateTexture (displayObject, scaleMode, resolution, region)PIXI.RenderTexture inherited overrides

返回可用于创建精灵的显示对象纹理的有用函数 如果您的displayObject很复杂,需要多次重用,那么这非常实用。

Name Type Description
displayObject PIXI.DisplayObject

将从中生成对象的displayObject。

scaleMode number

应该是scaleMode常量之一。

resolution number

生成的纹理的分辨率/设备像素比率。

region PIXI.Rectangle optional

displayObject的应该呈现的区域, 如果未指定区域,则默认为displayObject的本身范围。

Returns:
Type Description
PIXI.RenderTexture 图形对象的纹理。

initPlugins (staticMap) protected inherited overrides

初始化插件

Name Type Description
staticMap object

静态保存的插件字典。

invalidateBlendMode ()

检查混合模式是否已更改。

render (displayObject, renderTexture, clear, transform, skipUpdateTransform)

将对象渲染到此画布视图

Name Type Default Description
displayObject PIXI.DisplayObject

要渲染的对象

renderTexture PIXI.RenderTexture optional

要渲染到的渲染纹理。 如果未设置,它将渲染到root context.。

clear boolean false optional

绘制前是否清除画布

transform PIXI.Matrix optional

要应用的转换

skipUpdateTransform boolean false optional

是否跳过更新转换

resize (screenWidth, screenHeight) overrides

将画布视图调整为指定的宽度和高度。

Name Type Description
screenWidth number

屏幕的新宽度

screenHeight number

屏幕的新高度

setBlendMode (blendMode, readyForOuterBlend)

设置渲染器的混合模式。

Name Type Default Description
blendMode number

参考 PIXI.BLEND_MODES 的有效值。

readyForOuterBlend boolean false optional

一些混合模式是危险的,它们影响精灵的外层空间。 只有当你准备好使用它们的时候,才能通过true

Events

渲染完成后触发。

在开始渲染之前触发。