Class: Renderer

PIXI~Renderer

渲染器将场景及其所有内容绘制到启用WebGL的画布上。

此渲染器应用于支持WebGL的浏览器。

该渲染器通过自动管理WebGLBatchesm来工作,因此不需要Sprite Batchs或Sprite Cloud。 不要忘记将视图添加到DOM中,否则您将看不到任何内容!

new Renderer (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

true时,设置渲染视图为透明

autoDensity boolean false optional

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

antialias boolean false optional

设置抗锯齿。 如果本机不可用,则使用FXAA抗锯齿。

forceFXAA boolean false optional

强制在本机上使用FXAA抗锯齿。 FXAA更快,但可能并不总是那么好。

resolution number 1 optional

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

clearBeforeRender boolean true optional

这将设置渲染器是否在新的渲染过程之前清除画布。 如果您希望将其设置为false,则 必须 将prepareDrawingBuffer设置为 true

preserveDrawingBuffer boolean false optional

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

backgroundColor number 0x000000 optional

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

powerPreference string optional

传递给WebGL上下文的参数,对于具有双显卡的设备,设置为"high-performance"。

context object optional

如果WebGL上下文已经存在,则必须从中获取所有参数。

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

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

batch PIXI.systems.BatchSystem readonly

批处理系统实例

clearBeforeRender boolean inherited overrides

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

context PIXI.systems.ContextSystem readonly

上下文系统实例

extract PIXI.Extract

Collection of methods for extracting data (image, pixels, etc.) from a display object or render texture

See:

filter PIXI.systems.FilterSystem readonly

滤镜系统实例

framebuffer PIXI.systems.FramebufferSystem readonly

帧缓冲系统实例

geometry PIXI.systems.GeometrySystem readonly

几何系统实例

gl WebGLRenderingContext readonly

WebGL上下文,由contextSystem(this.context)设置

globalUniforms PIXI.UniformGroup

全局 uniforms

height number readonly inherited overrides

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

Default Value:
  • 600

mask PIXI.systems.MaskSystem readonly

遮罩系统实例

options Object readonly inherited overrides

构造函数选项

plugins object readonly overrides

已安装插件的集合。 这些默认包含在PIXI中,但可以通过创建自定义版本来排除。 有关创建自定义版本和排除插件的更多信息,请查阅README。

Properties:
Name Type Description
accessibility PIXI.accessibility.AccessibilityManager

支持制表互动元素。

extract PIXI.Extract

从渲染器提取图像数据。.

interaction PIXI.interaction.InteractionManager

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

prepare PIXI.Prepare

预渲染显示对象。

preserveDrawingBuffer boolean inherited overrides

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

projection PIXI.systems.ProjectionSystem readonly

投影系统实例

renderingToScreen boolean readonly

Flag if we are rendering to the screen vs renderTexture

Default Value:
  • true

renderTexture PIXI.systems.RenderTextureSystem readonly

RenderTexture系统实例

resolution number inherited overrides

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

Default Value:
  • 1

scissor PIXI.systems.ScissorSystem readonly

剪式系统实例

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

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

shader PIXI.systems.ShaderSystem readonly

着色器系统实例

state PIXI.systems.StateSystem readonly

状态系统实例

stencil PIXI.systems.StencilSystem readonly

模具系统实例

texture PIXI.systems.TextureSystem readonly

纹理系统实例

textureGC PIXI.systems.TextureGCSystem readonly

纹理垃圾收集器系统实例

textureManager PIXI.systems.TextureSystem Deprecated : since 5.0.0

See:

transparent boolean inherited overrides

渲染视图是否透明。

type number overrides

此渲染器的类型为标准化const

See:

view HTMLCanvasElement inherited overrides

绘制所有内容的canvas元素。

width number readonly inherited overrides

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

Default Value:
  • 800

Methods

PIXI.Renderer.registerPlugin (pluginName, ctor) static

将插件添加到渲染器。

Name Type Description
pluginName string

插件的名称。

ctor function

插件的构造函数或类。

addSystem (ClassRef, name)PIXI.Renderer

将新系统添加到渲染器。

Name Type Description
ClassRef function

类引用

name string optional

系统的属性名称(如果未指定)将在类本身上使用静态的 name 属性。 此名称将在Renderer上分配为s属性,因此请确保它不会与Renderer上的属性冲突。

Returns:
Type Description
PIXI.Renderer 返回渲染器实例

clear ()

清除帧缓冲区

destroy (removeView) overrides

从渲染器中删除所有内容(事件监听器,spritebatch等)

Name Type Default Description
removeView boolean false optional

从DOM中删除Canvas元素。 See: https://github.com/pixijs/pixi.js/issues/2233

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

静态保存的插件字典。

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

将对象渲染到其WebGL视图

Name Type Default Description
displayObject PIXI.DisplayObject

要渲染的对象。

renderTexture PIXI.RenderTexture optional

要渲染到的渲染纹理。

clear boolean true optional

在新渲染之前清除画布。

transform PIXI.Matrix optional

在渲染之前应用于渲染纹理的变换。

skipUpdateTransform boolean false optional

我们应该跳过更新转换吗?

重置WebGL状态,以便您可以根据自己的喜好渲染事物!

Returns:
Type Description
PIXI.Renderer Returns itself.

resize (screenWidth, screenHeight) overrides

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

Name Type Description
screenWidth number

屏幕的新宽度。

screenHeight number

屏幕的新高度。

Events

context

设置WebGL上下文时触发。

Name Type Description
gl WebGLRenderingContext

WebGL context.

postrender

渲染完成后触发。

prerender

在渲染开始之前触发。