Namespace: PIXI

PIXI

Classes

AbstractBatchRenderer
AbstractRenderer
AnimatedSprite
Application
AppLoaderPlugin
Attribute
BasePrepare
BaseRenderTexture
BaseTexture
BatchDrawCall
BatchGeometry
BatchPluginFactory
BatchShaderGenerator
BatchTextureArray
BitmapFontLoader
BitmapText
Bounds
Buffer
CanvasExtract
CanvasGraphicsRenderer
CanvasMaskManager
CanvasMeshRenderer
CanvasPrepare
CanvasRenderer
CanvasRenderTarget
CanvasSpriteRenderer
Circle
Container
CountLimiter
CubeTexture
DisplayObject
Ellipse
Extract
FillStyle
Filter
FilterManager
Framebuffer
Geometry
GLProgram
GLTexture
Graphics
GraphicsData
GraphicsGeometry
LineStyle
Loader
LoaderResource
MaskData
Matrix
Mesh
MeshBatchUvs
MeshGeometry
MeshMaterial
NineSlicePlane
ObjectRenderer
ObservablePoint
ParticleContainer
ParticleRenderer
Point
Polygon
Prepare
Program
Quad
QuadUv
Rectangle
Renderer
RenderTexture
RenderTexturePool
RopeGeometry
RoundedRectangle
Runner
Shader
SimpleMesh
SimplePlane
SimpleRope
Sprite
SpriteMaskFilter
Spritesheet
SpritesheetLoader
Star
State
System
Text
TextMetrics
TextStyle
Texture
TextureLoader
TextureMatrix
TextureUvs
Ticker
TickerPlugin
TilingSprite
TilingSpriteRenderer
TimeLimiter
Transform
TransformBase
TransformStatic
UniformGroup
ViewableBuffer
WebGLRenderer

Namespaces

accessibility
CanvasTinter
canvasUtils
extract
extras
filters
graphicsUtils
groupD8
GroupD8
interaction
loaders
mesh
particles
prepare
resources
settings
systems
ticker
utils

Members

PIXI.ALPHA_MODES number static

如何使用预乘透明度处理纹理

Properties:
Name Type Description
NO_PREMULTIPLIED_ALPHA number

来源未预乘。 从类型化数组创建的压缩和数据纹理的选项。

PREMULTIPLY_ON_UPLOAD number

来源未预乘,上传时未预乘。 默认选项,用于所有加载的图像。

PREMULTIPLIED_ALPHA number

来源已被预乘示例:带有_pma后缀的骨骼图集。

NPM number

NO_PREMULTIPLIED_ALPHA的别名

UNPACK number

默认选项,PREMULTIPLY_ON_UPLOAD的别名。

PMA number

PREMULTIPLIED_ALPHA的别名。

PIXI.BLEND_MODES number static

PIXI支持各种混合模式

IMPORTANT - WebGL渲染器仅支持NORMAL,ADD,MULTIPLY和SCREEN混合模式。 其他都会像NORMAL一样默默地进行。

Properties:
Name Type Description
NORMAL number

正常

ADD number

线性减淡,添加

MULTIPLY number

正片叠底

SCREEN number

滤色

OVERLAY number

叠加

DARKEN number

变暗

LIGHTEN number

变亮

COLOR_DODGE number

颜色减淡

COLOR_BURN number

颜色加深

HARD_LIGHT number

强光

SOFT_LIGHT number

柔光

DIFFERENCE number

差值

EXCLUSION number

排除

HUE number

色相

SATURATION number

饱和度

COLOR number

颜色

LUMINOSITY number

明度

NORMAL_NPM number
ADD_NPM number
SCREEN_NPM number
NONE number
SRC_IN number
SRC_OUT number
SRC_ATOP number
DST_OVER number
DST_IN number
DST_OUT number
DST_ATOP number
SUBTRACT number
SRC_OVER number
ERASE number
XOR number

PIXI.CLEAR_MODES number static

如何清除滤镜中的renderTextures

Properties:
Name Type Description
BLEND number

保留纹理中的信息,在上面混合

CLEAR number

必须使用gl.clear操作

BLIT number

清除或变白,取决于设备和程度

NO number

BLEND的别名,与早期版本中的false相同

YES number

CLEAR的别名,与早期版本中的true相同

AUTO number

BLIT的别名

PIXI.DATA_URI RegExp | string staticconstant

Regexp for data URI. Based on: https://github.com/ragingwind/data-uri-regex

Example
data:image/png;base64

PIXI.defaultFilterVertex string static

Default filter vertex shader

PIXI.defaultVertex string static

Default vertex shader

PIXI.DEG_TO_RAD number staticconstant

Conversion factor for converting degrees to radians.

PIXI.DRAW_MODES number static

各种webgl绘制模式。这些可用于指定在某些情况和渲染器下使用的GL drawMode。

Properties:
Name Type Description
POINTS number
LINES number
LINE_LOOP number
LINE_STRIP number
TRIANGLES number
TRIANGLE_STRIP number
TRIANGLE_FAN number

PIXI.ENV number static

WebGL的不同类型的环境。

Properties:
Name Type Description
WEBGL_LEGACY number

用于较旧的v1 WebGL设备。 PixiJS将致力于确保与较旧/较不先进的设备兼容。如果您遇到无法解释的闪烁,请选择此环境。

WEBGL number

WebGL版本1

WEBGL2 number

WebGL版本2

PIXI.FORMATS number static

各种GL纹理/资源格式。

Properties:
Name Type Default Description
RGBA number 6408
RGB number 6407
ALPHA number 6406
LUMINANCE number 6409
LUMINANCE_ALPHA number 6410
DEPTH_COMPONENT number 6402
DEPTH_STENCIL number 34041

PIXI.GC_MODES number static

pixi支持的gc模式。

PixiJS纹理的 PIXI.settings.GC_MODE 垃圾回收模式为 AUTO 如果设置 GC_MODE, 渲染器会定时检查纹理使用情况。 如果在指定的时间段内没有使用它们,它们将从GPU中删除。 他们会在需要时再次上传。这是一个静默的幕后过程,应该确保GPU不会被填满。

方便移动设备使用! 此属性仅影响WebGL。

Properties:
Name Type Description
AUTO number

垃圾收集将自动定期进行

MANUAL number

垃圾收集将需要手动调用

PIXI.GRAPHICS_CURVES object staticconstant

Graphics curves resolution settings. If adaptive flag is set to true, the resolution is calculated based on the curve's length to ensure better visual quality. Adaptive draw works with bezierCurveTo and quadraticCurveTo.

Properties:
Name Type Default Description
adaptive boolean false

flag indicating if the resolution should be adaptive

maxLength number 10

maximal length of a single segment of the curve (if adaptive = false, ignored)

minSegments number 8

minimal number of segments in the curve (if adaptive = false, ignored)

maxSegments number 2048

maximal number of segments in the curve (if adaptive = false, ignored)

PIXI.loader PIXI.Loader Deprecated : since 5.0.0 static

See:

PIXI.MASK_TYPES number static

遮罩的实现常量。 我们使用type后缀,因为它导致非常不同的行为

Properties:
Name Type Description
NONE number

忽略遮罩

SCISSOR number

剪裁遮罩, 屏幕矩形, cheap

STENCIL number

模板遮罩, 1-bit, 中等, 仅在渲染器支持模板时有效

SPRITE number

使用SpriteMaskFilter的蒙版使用临时的RenderTexture

PIXI.MIPMAP_MODES number static

pixi支持的Mipmap过滤模式。

PIXI.settings.MIPMAP_TEXTURES 影响默认的纹理过滤。 如果baseTexture的mipmap字段为'ON',则会生成Mipmap。 否则,为POW2和纹理尺寸为2的n次幂。 由于平台限制,ON选项将像webgl-1的POW2`一样工作。

此属性仅影响WebGL。

Properties:
Name Type Description
OFF number

没有mipmaps

POW2 number

如果纹理维度为pow2,则生成mipmaps

ON number

始终生成mipmaps

PIXI.PI_2 number staticconstant

Two Pi.

PIXI.PRECISION string staticconstant

在着色器中指定浮点精度的常量。

Properties:
Name Type Default Description
LOW string 'lowp'
MEDIUM string 'mediump'
HIGH string 'highp'

PIXI.RAD_TO_DEG number staticconstant

Conversion factor for converting radians to degrees.

PIXI.RENDERER_TYPE number static

标识渲染器类型的常量

Properties:
Name Type Description
UNKNOWN number

未知渲染器类型

WEBGL number

WebGL渲染器类型

CANVAS number

Canvas渲染器类型

PIXI.SCALE_MODES number static

pixi支持的缩放模式。

PIXI.settings.SCALE_MODE 缩放模式会影响以后操作的默认缩放模式。 可以根据适用性将其重新分配为LINEAR或NEAREST。

Properties:
Name Type Description
LINEAR number

平滑缩放

NEAREST number

像素缩放

PIXI.SHAPES enum staticconstant

Constants that identify shapes, mainly to prevent instanceof calls.

Properties:
Name Type Description
POLY number

Polygon

RECT number

Rectangle

CIRC number

Circle

ELIP number

Ellipse

RREC number

Rounded Rectangle

PIXI.SVG_SIZE RegExp | string Deprecated : since 5.0.0 staticconstant

See:

PIXI.TARGETS number static

各种GL目标类型

Properties:
Name Type Default Description
TEXTURE_2D number 3553
TEXTURE_CUBE_MAP number 34067
TEXTURE_2D_ARRAY number 35866
TEXTURE_CUBE_MAP_POSITIVE_X number 34069
TEXTURE_CUBE_MAP_NEGATIVE_X number 34070
TEXTURE_CUBE_MAP_POSITIVE_Y number 34071
TEXTURE_CUBE_MAP_NEGATIVE_Y number 34072
TEXTURE_CUBE_MAP_POSITIVE_Z number 34073
TEXTURE_CUBE_MAP_NEGATIVE_Z number 34074

PIXI.TEXT_GRADIENT object staticconstant

定义文本上渐变类型的常数。

Properties:
Name Type Description
LINEAR_VERTICAL number

垂直渐变

LINEAR_HORIZONTAL number

线性渐变

PIXI.TRANSFORM_MODE number Deprecated : since 5.0.0 staticconstant

Constants that specify the transform type.

Properties:
Name Type Description
STATIC number
DYNAMIC number

PIXI.TYPES number static

各种GL数据格式类型

Properties:
Name Type Default Description
UNSIGNED_BYTE number 5121
UNSIGNED_SHORT number 5123
UNSIGNED_SHORT_5_6_5 number 33635
UNSIGNED_SHORT_4_4_4_4 number 32819
UNSIGNED_SHORT_5_5_5_1 number 32820
FLOAT number 5126
HALF_FLOAT number 36193

PIXI.UPDATE_PRIORITY number staticconstant

Represents the update priorities used by internal PIXI classes when registered with the PIXI.Ticker object. Higher priority items are updated first and lower priority items, such as render, should go later.

Properties:
Name Type Default Description
INTERACTION number 50

Highest priority, used for PIXI.interaction.InteractionManager

HIGH number 25

High priority updating, PIXI.VideoBaseTexture and PIXI.AnimatedSprite

NORMAL number 0

Default priority for ticker events, see PIXI.Ticker#add.

LOW number -25

Low priority used for PIXI.Application rendering.

UTILITY number -50

Lowest priority used for PIXI.prepare.BasePrepare utility.

PIXI.VERSION string staticconstant

String of the current PIXI version.

PIXI.WRAP_MODES number static

pixi支持的循环模式。

PIXI.settings.WRAP_MODE 循环模式会影响以后操作的默认循环模式。 可以根据适用性将其重新分配给CLAMP或REPEAT。 如果纹理不是2的幂,则不管WebGL是否只能在纹理为po2时使用REPEAT,都将使用clamp。

此属性仅影响WebGL。

Properties:
Name Type Description
CLAMP number

强制贴图边界拉伸

REPEAT number

贴图重复平铺

MIRRORED_REPEAT number

平铺并重复镜像

Methods

PIXI.autoDetectRenderer (options)PIXI.Renderer | PIXI.CanvasRenderer static

此辅助函数将自动检测您应该使用哪个渲染器。 WebGL是首选的渲染器,因为它速度更快。 如果浏览器不支持WebGL,则此函数将返回画布渲染器。

Name Type Description
options object optional

可选的渲染器参数

Name Type Default Description
width number 800 optional

渲染器视图的宽度

height number 600 optional

渲染器视图的高度

view HTMLCanvasElement optional

用作视图的canvas元素

transparent boolean false optional

true的时候,渲染视图是透明的,默认为false

autoDensity boolean false optional

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

antialias boolean false optional

设置抗锯齿

preserveDrawingBuffer boolean false optional

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

backgroundColor number 0x000000 optional

渲染区域的背景色 (不为透明时显示).

clearBeforeRender boolean true optional

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

resolution number 1 optional

渲染器的分辨率/设备像素比,retina为2

forceCanvas boolean false optional

阻止选择WebGL渲染器,即使存在,也仅当使用 pixi.js-legacy@pixi/canvas-renderer 模块时, 此选项才可用,否则将被忽略。

forceFXAA boolean false optional

强制在本机上使用FXAA抗锯齿。 FXAA更快,但可能并不总是看起来比 webgl出色

powerPreference string optional

传递给webgl上下文的参数,对于具有双显卡的设备,可以设置为"high-performance" 仅适用于webgl

Returns:
Type Description
PIXI.Renderer | PIXI.CanvasRenderer 返回WebGL渲染器(如果可用),否则返回CanvasRenderer

PIXI.useDeprecated () static

Deprecations (backward compatibilities) are automatically applied for browser bundles in the UMD module format. If using Webpack or Rollup, you'll need to apply these deprecations manually by doing something like this:

Example
import * as PIXI from 'pixi.js';
PIXI.useDeprecated(); // MUST be bound to namespace

Type Definitions

PIXI.GD8Symmetry number

See:

PIXI.ICanvasImageSource HTMLImageElement | HTMLCanvasElement | HTMLVideoElement | ImageBitmap

可传递给drawImage的类型

PIXI.IFontMetrics

A number, or a string containing a number.

Properties:
Name Type Description
ascent number

Font ascent

descent number

Font descent

fontSize number

Font size

PIXI.ILoaderPlugin

要安装用于处理特定加载器资源的插件。

Properties:
Name Type Argument Description
add function <optional>

注册插件后立即调用的函数。

pre PIXI.Loader.loaderMiddleware <optional>

要在加载前运行的中间件函数,其参数为 (resource, next)

use PIXI.Loader.loaderMiddleware <optional>

加载后要运行的中间件函数,其参数为 (resource, next)

PIXI.ISize object

Size object, contains width and height

Properties:
Name Type Description
width number

Width component

height number

Height component

Interface Definitions

PIXI.IHitArea

碰撞区域类的接口。

它由以下类实现:

PIXI.IPoint

Common interface for points. Both Point and ObservablePoint implement it