Namespace: PIXI

Classes

AbstractMaskSystem

AbstractMultiResource

AccessibilityManager

AlphaFilter

AnimatedSprite

Application

ArrayResource

AssetLoader

Attribute

BackgroundLoader

BackgroundSystem

BaseImageResource

BasePrepare

BaseRenderTexture

BaseTexture

BasisParser

BatchDrawCall

BatchGeometry

BatchRenderer

BatchShaderGenerator

BatchSystem

BatchTextureArray

BitmapFont

BitmapFontData

BitmapText

BlobResource

BlurFilter

BlurFilterPass

Bounds

Buffer

BufferResource

BufferSystem

Cache

CanvasContextSystem

CanvasExtract

CanvasMaskSystem

CanvasObjectRendererSystem

CanvasPrepare

CanvasRenderer

CanvasResource

Circle

Color

ColorMatrixFilter

CompressedTextureResource

Container

ContextSystem

CountLimiter

CubeResource

DisplacementFilter

DisplayObject

Ellipse

EventBoundary

EventsTickerClass

EventSystem

Extract

FederatedEvent

FederatedMouseEvent

FederatedPointerEvent

FederatedWheelEvent

FillStyle

Filter

FilterSystem

Framebuffer

FramebufferSystem

FXAAFilter

GenerateTextureSystem

Geometry

GeometrySystem

GLFramebuffer

GLProgram

GLTexture

Graphics

GraphicsData

GraphicsGeometry

HTMLText

HTMLTextStyle

ImageBitmapResource

ImageResource

LineStyle

MaskData

MaskSystem

Matrix

Mesh

MeshBatchUvs

MeshGeometry

MeshMaterial

MultisampleSystem

NineSlicePlane

NoiseFilter

ObjectRenderer

ObjectRendererSystem

ObservablePoint

ParticleContainer

ParticleRenderer

PlaneGeometry

PluginSystem

Point

Polygon

Prepare

Program

ProjectionSystem

Quad

QuadUv

Rectangle

Renderer

RenderTexture

RenderTexturePool

RenderTextureSystem

Resolver

Resource

RopeGeometry

RoundedRectangle

Runner

ScissorSystem

Shader

ShaderSystem

SimpleMesh

SimplePlane

SimpleRope

Sprite

SpriteMaskFilter

Spritesheet

StartupSystem

State

StateSystem

StencilSystem

SVGResource

SystemManager

Text

TextMetrics

TextStyle

Texture

TextureGCSystem

TextureMatrix

TextureSystem

Ticker

TickerPlugin

TilingSprite

TilingSpriteRenderer

TimeLimiter

Transform

TransformFeedback

TransformFeedbackSystem

UniformGroup

VideoFrameResource

VideoResource

ViewableBuffer

ViewSystem

CanvasGraphicsRenderer

CanvasMeshRenderer

CanvasSpriteRenderer

TextureUvs

Interface Definitions

AssetExtension

This developer convenience object allows developers to group together the various asset parsers into a single object.

AssetInitOptions

Initialization options object for Asset Class.

Properties:

Name	Type	Description
basePath	string	a base path for any assets loaded
bundleIdentifier	BundleIdentifierOptions	advanced - override how bundlesIds are generated
defaultSearchParams	string | Record<string, any>	a default URL parameter string to append to all assets loaded
manifest	string | PIXI.AssetsManifest	a manifest to tell the asset loader upfront what all your assets are this can be the manifest object itself, or a URL to the manifest.
preferences	Partial<PIXI.AssetsPreferences>	Optional loader preferences
skipDetections	boolean	If true, don't attempt to detect whether browser has preferred formats available. May result in increased performance as it skips detection step.
texturePreference	{ resolution? : number | number[], format? : ArrayOr<string> }	optional preferences for which textures preferences you have when resolving assets for example you might set the resolution to 0.5 if the user is on a rubbish old phone or you might set the resolution to 2 if the user is on a retina display

AssetsBundle

Structure of a bundle found in a manifest file

AssetsManifest

The expected format of a manifest. This would normally be auto generated or made by the developer

AssetsPreferences

Extensible preferences that can be used, for instance, when configuring loaders.

Since:

• 7.2.0

BackgroundSystemOptions

Options for the background system.

CacheParser

For every asset that is cached, it will call the parsers test function the flow is as follows:

1. cacheParser.test(): Test the asset.
2. cacheParser.getCacheableAssets(): If the test passes call the getCacheableAssets function with the asset

Useful if you want to add more than just a raw asset to the cache (for example a spritesheet will want to make all its sub textures easily accessible in the cache)

Properties:

Name	Type	Description
config	Record<string, any>	A config to adjust the parser
getCacheableAssets	(keys: string[], asset: T) => Record<string, any>	If the test passes, this function is called to get the cacheable assets an example may be that a spritesheet object will return all the sub textures it has so they can be cached.
test	(asset: T) => boolean	Gets called by the cache when a dev caches an asset

ContextSystemOptions

Options for the context system.

EventSystemFeatures

The event features that are enabled by the EventSystem This option only is available when using @pixi/events package (included in the pixi.js and pixi.js-legacy bundle), otherwise it will be ignored.

Properties:

Name	Type	Description
click	boolean	Enables pointer events associated with clicking: pointerup / mouseup / touchend / 'rightup' pointerupoutside / mouseupoutside / touchendoutside / 'rightupoutside' pointerdown / 'mousedown' / touchstart / 'rightdown' click / tap
globalMove	boolean	Enables global pointer move events: globalpointermove globalmousemove globaltouchemove
move	boolean	Enables pointer events associated with pointer movement: pointermove / mousemove / touchmove pointerout / mouseout pointerover / mouseover
wheel	boolean	Enables wheel events.

Since:

• 7.2.0

ExtensionFormat

Strict extension format that is used internally for registrations.

Properties:

Name	Type	Description
type	PIXI.ExtensionType[]	The extension type, always expressed as multiple, even if a single

ExtensionFormatLoose

Format when registering an extension. Generally, the extension should have these values as extension static property, but you can override name or type by providing an object.

Properties:

Name	Type	Description
name	string	Optional. Some plugins provide an API name/property, such as Renderer plugins
priority	number	Optional, used for sorting the plugins in a particular order
ref	any	Reference to the plugin object/class
type	PIXI.ExtensionType | PIXI.ExtensionType[]	The extension type, can be multiple types

FederatedEventTarget

Describes the shape for a PIXI.FederatedEvent's' eventTarget.

Properties:

Name	Type	Description
children	ReadonlyArray<PIXI.FederatedEventTarget>	The children of this event target.
cursor	Cursor | string	The cursor preferred when the mouse pointer is hovering over.
eventMode	PIXI.EventMode	The mode of interaction for this object
hitArea	IHitArea | null	The hit-area specifies the area for which pointer events should be captured by this event target.
interactive	boolean	Whether this event target should fire UI events.
interactiveChildren	boolean	Whether this event target has any children that need UI events. This can be used optimize event propagation.
isInteractive	() => boolean	Returns true if the DisplayObject has interactive 'static' or 'dynamic'
onclick	PIXI.FederatedEventHandler | null	Handler for 'click' event
onglobalmousemove	PIXI.FederatedEventHandler | null	Handler for 'globalmousemove' event
onglobalpointermove	PIXI.FederatedEventHandler | null	Handler for 'globalpointermove' event
onglobaltouchmove	PIXI.FederatedEventHandler | null	Handler for 'globaltouchmove' event
onmousedown	PIXI.FederatedEventHandler | null	Handler for 'mousedown' event
onmouseenter	PIXI.FederatedEventHandler | null	Handler for 'mouseenter' event
onmouseleave	PIXI.FederatedEventHandler | null	Handler for 'mouseleave' event
onmousemove	PIXI.FederatedEventHandler | null	Handler for 'mousemove' event
onmouseout	PIXI.FederatedEventHandler | null	Handler for 'mouseout' event
onmouseover	PIXI.FederatedEventHandler | null	Handler for 'mouseover' event
onmouseup	PIXI.FederatedEventHandler | null	Handler for 'mouseup' event
onmouseupoutside	PIXI.FederatedEventHandler | null	Handler for 'mouseupoutside' event
onpointercancel	PIXI.FederatedEventHandler | null	Handler for 'pointercancel' event
onpointerdown	PIXI.FederatedEventHandler | null	Handler for 'pointerdown' event
onpointerenter	PIXI.FederatedEventHandler | null	Handler for 'pointerenter' event
onpointerleave	PIXI.FederatedEventHandler | null	Handler for 'pointerleave' event
onpointermove	PIXI.FederatedEventHandler | null	Handler for 'pointermove' event
onpointerout	PIXI.FederatedEventHandler | null	Handler for 'pointerout' event
onpointerover	PIXI.FederatedEventHandler | null	Handler for 'pointerover' event
onpointertap	PIXI.FederatedEventHandler | null	Handler for 'pointertap' event
onpointerup	PIXI.FederatedEventHandler | null	Handler for 'pointerup' event
onpointerupoutside	PIXI.FederatedEventHandler | null	Handler for 'pointerupoutside' event
onrightclick	PIXI.FederatedEventHandler | null	Handler for 'rightclick' event
onrightdown	PIXI.FederatedEventHandler | null	Handler for 'rightdown' event
onrightup	PIXI.FederatedEventHandler | null	Handler for 'rightup' event
onrightupoutside	PIXI.FederatedEventHandler | null	Handler for 'rightupoutside' event
ontap	PIXI.FederatedEventHandler | null	Handler for 'tap' event
ontouchcancel	PIXI.FederatedEventHandler | null	Handler for 'touchcancel' event
ontouchend	PIXI.FederatedEventHandler | null	Handler for 'touchend' event
ontouchendoutside	PIXI.FederatedEventHandler | null	Handler for 'touchendoutside' event
ontouchmove	PIXI.FederatedEventHandler | null	Handler for 'touchmove' event
ontouchstart	PIXI.FederatedEventHandler | null	Handler for 'touchstart' event
onwheel	PIXI.FederatedEventHandler<PIXI.FederatedWheelEvent> | null	Handler for 'wheel' event
parent	PIXI.FederatedEventTarget	The parent of this event target.

FormatDetectionParser

Format detection is useful for detecting feature support on the current platform.

Properties:

Name	Type	Description
add	(formats: string[]) => Promise<string[]>	Add formats (file extensions) to the existing list of formats. Return an new array with added formats, do not mutate the formats argument.
extension	ExtensionMetadata	Should be ExtensionType.DetectionParser
remove	(formats: string[]) => Promise<string[]>	Remove formats (file extensions) from the list of supported formats. This is used when uninstalling this DetectionParser. Return an new array with filtered formats, do not mutate the formats argument.
test	() => Promise<boolean>	Browser/platform feature detection supported if return true

IAdapter

This interface describes all the DOM dependent calls that Pixi makes throughout its codebase. Implementations of this interface can be used to make sure Pixi will work in any environment, such as browser, Web Workers, and Node.js.

Properties:

Name	Type	Description
createCanvas	(width: number, height: number) => ICanvas	Returns a canvas object that can be used to create a webgl context.
getBaseUrl	() => string	Returns the current base URL For browser environments this is either the document.baseURI or window.location.href
getCanvasRenderingContext2D	() => { prototype : ICanvasRenderingContext2D }	Returns a 2D rendering context.
getNavigator	() => { userAgent : string }	Returns a partial implementation of the browsers window.navigator
getWebGLRenderingContext	() => typeof WebGLRenderingContext	Returns a WebGL rendering context.

IApplicationOptions

Application options supplied to constructor.

Properties:

Name	Type	Default	Description
autoStart	boolean	true	Automatically starts the rendering after the construction. Note: Setting this parameter to false does NOT stop the shared ticker even if you set options.sharedTicker to true in case that it is already started. Stop it by your own.
resizeTo	Window | HTMLElement		Element to automatically resize stage to.
sharedTicker	boolean	false	Settrue to use Ticker.shared, false to create new ticker. If set to false, you cannot register a handler to occur before anything that runs on the shared ticker. The system ticker will always run before both the shared ticker and the app ticker.

IApplicationPlugin

Any plugin that's usable for Application should contain these methods.

IArrayBuffer

Marks places in PixiJS where you can pass Float32Array, UInt32Array, any typed arrays, and ArrayBuffer.

Same as ArrayBuffer in typescript lib, defined here just for documentation.

IBatchableElement

Interface for elements like Sprite, Mesh etc. for batching.

IBitmapFontDataChar

Properties:

Name	Type	Description
height	number	Height of character in page.
id	number	Unique id of character
page	number	PIXI.IBitmapFontDataPage id
width	number	Width of character in page.
x	number	x-position of character in page.
xadvance	number	Advancement to apply to next character.
xoffset	number	x-offset to apply when rendering character
y	number	y-position of character in page.
yoffset	number	y-offset to apply when rendering character.

IBitmapFontDataCommon

Properties:

Name	Type	Description
lineHeight	number	Line height, in pixels.

IBitmapFontDataDistanceField

Properties:

Name	Type	Description
distanceRange	number	Range of distance
fieldType	string	Type of distance field

IBitmapFontDataInfo

Properties:

Name	Type	Description
face	string	Font face
size	number	Font size

IBitmapFontDataKerning

Properties:

Name	Type	Description
amount	number	x-offset to apply between first & second characters when they are next to each other.
first	number	First character of pair
second	number	Second character of pair

IBitmapFontDataPage

Properties:

Name	Type	Description
file	string	File name
id	number	Unique id for bitmap texture

IBitmapFontOptions

Properties:

Name	Type	Default	Description
alphaMode	PIXI.ALPHA_MODES	PIXI.BaseTexture.defaultOptions.alphaMode	Pre multiply the image alpha. Note: for MSDF/SDF fonts, alphaMode is not supported.
anisotropicLevel	number	PIXI.BaseTexture.defaultOptions.anisotropicLevel	Anisotropic filtering level of texture.
chars	string | (string | string[])[]	PIXI.BitmapFont.ALPHANUMERIC	Characters included in the font set. You can also use ranges. For example, [['a', 'z'], ['A', 'Z'], "!@#$%^&*()~{}[] "]. Don't forget to include spaces ' ' in your character set!
mipmap	PIXI.MIPMAP_MODES	PIXI.BaseTexture.defaultOptions.mipmap	If mipmapping is enabled for texture. For instance, by default PixiJS only enables mipmapping on Power-of-Two textures. If your textureWidth or textureHeight are not power-of-two, you may consider enabling mipmapping to get better quality with lower font sizes. Note: for MSDF/SDF fonts, mipmapping is not supported.
padding	number	4	Padding between glyphs on texture atlas. Lower values could mean more visual artifacts and bleeding from other glyphs, larger values increase the space required on the texture.
resolution	number	1	Render resolution for glyphs.
scaleMode	PIXI.SCALE_MODES	PIXI.BaseTexture.defaultOptions.scaleMode	Default scale mode, linear, nearest. Nearest can be helpful for bitmap-style fonts.
skipKerning	boolean	false	Skip generation of kerning information for the BitmapFont. If true, this could potentially increase the performance, but may impact the rendered text appearance.
textureHeight	number	512	Optional height of atlas, smaller values to reduce memory.
textureWidth	number	512	Optional width of atlas, smaller values to reduce memory.

IBlobResourceOptions

Constructor options for BlobResource.

IBufferResourceOptions

Constructor options for BufferResource.

ICanvas

Common interface for HTMLCanvasElement, OffscreenCanvas, and other custom canvas classes.

Properties:

Name	Type	Description
height	number	Height of the canvas.
parentNode	ICanvasParentNode | null	Parent node of the canvas.
style	ICanvasStyle	Style of the canvas.
width	number	Width of the canvas.

ICanvasRenderingContext2D

Common interface for CanvasRenderingContext2D, OffscreenCanvasRenderingContext2D, and other custom canvas 2D context.

ICubeResourceOptions

Constructor options for CubeResource.

Properties:

Name	Type	Description
autoLoad	boolean	Whether to auto-load resources
linkBaseTexture	boolean	In case BaseTextures are supplied, whether to copy them or use.

IGraphicsBatchElement

Batch element computed from Graphics geometry.

IGraphicsCurvesSettings Deprecated

IHTMLFont

Font information for HTMLText

Properties:

Name	Type	Description
dataSrc	string	Base64 string for font
display	PIXI.FontDisplay	Display property of the font
family	string	Family name of font
fontFace	FontFace | null	FontFace installed in the document
originalUrl	string	User-supplied URL request
refs	number	Reference counter
src	string	Blob-based URL for font
style	TextStyleFontStyle	Style of the font
weight	TextStyleFontWeight	Weight of the font

Since:

• 7.2.0

IHTMLTextStyle

Modifed versions from ITextStyle.

Properties:

Name	Type	Description
whiteSpace	PIXI.HTMLTextStyleWhiteSpace	White-space with expanded options.

Since:

• 7.2.0

IImageBitmapResourceOptions

Options for ImageBitmapResource.

Properties:

Name	Type	Description
alphaMode	PIXI.ALPHA_MODES	Alpha mode used when creating the ImageBitmap.
autoLoad	boolean	Start loading process automatically when constructed.
crossOrigin	boolean	Load image using cross origin.
ownsImageBitmap	boolean	Whether the underlying ImageBitmap is owned by the PIXI.ImageBitmapResource. When set to true, the underlying ImageBitmap will be disposed automatically when disposing PIXI.ImageBitmapResource. If this option is not set, whether it owns the underlying ImageBitmap is determained by the type of source used when constructing PIXI.ImageBitmapResource: When source is ImageBitmap, the underlying ImageBitmap is not owned by default. When source is string (a URL), the underlying ImageBitmap is owned by default.

IPoint

Common interface for points. Both Point and ObservablePoint implement it

Properties:

Name	Type	Description
x	number	X coord
y	number	Y coord

IPointData

Common interface for points. Both Point and ObservablePoint implement it

Properties:

Name	Type	Description
x	number	X coord
y	number	Y coord

IRenderableContainer

Interface for Container to interface with Renderer.

IRenderableObject

Interface for DisplayObject to interface with Renderer. The minimum APIs needed to implement a renderable object.

Properties:

Name	Type	Description
parent	PIXI.IRenderableContainer	Object must have a parent container
transform	PIXI.Transform	Object must have a transform

IRenderer

Standard Interface for a Pixi renderer.

Properties:

Name	Type	Description
runners	{ [key: string]: PIXI.Runner }	a collection of runners defined by the user
autoDensity	boolean	Whether CSS dimensions of canvas view should be resized to screen dimensions automatically.
background	PIXI.BackgroundSystem	Background color, alpha and clear behavior
height	number	the height of the screen
lastObjectRendered	PIXI.IRenderableObject	the last object rendered by the renderer. Useful for other plugins like interaction managers
multisample	PIXI.MSAA_QUALITY	The number of MSAA samples of the renderer.
options	PIXI.IRendererOptions	The options passed in to create a new instance of the renderer.
plugins	IRendererPlugins	Collection of plugins
rendererLogId	string	When logging Pixi to the console, this is the name we will show
renderingToScreen	boolean	Flag if we are rendering to the screen vs renderTexture
resolution	number	The resolution / device pixel ratio of the renderer.
screen	PIXI.Rectangle	Measurements of the screen. (0, 0, screenWidth, screenHeight). Its safe to use as filterArea or hitArea for the whole stage.
type	PIXI.RENDERER_TYPE	The type of the renderer.
view	VIEW	The canvas element that everything is drawn to.
width	number	the width of the screen

IRendererOptions

Renderer options supplied to constructor.

Properties:

Name	Type	Description
antialias	boolean	WebGL Only. Whether to enable anti-aliasing. This may affect performance.
autoDensity	boolean	Whether the CSS dimensions of the renderer's view should be resized automatically.
background	PIXI.ColorSource	Alias for PIXI.IRendererOptions.backgroundColor
backgroundAlpha	number	Transparency of the background color, value from 0 (fully transparent) to 1 (fully opaque).
backgroundColor	PIXI.ColorSource	The background color used to clear the canvas. See PIXI.ColorSource for accepted color values.
clearBeforeRender	boolean	Whether to clear the canvas before new render passes.
context	PIXI.IRenderingContext | null	WebGL Only. User-provided WebGL rendering context object.
eventFeatures	Partial<PIXI.EventSystemFeatures>	The event features that are enabled by the EventSystem This option only is available when using @pixi/events package (included in the pixi.js and pixi.js-legacy bundle), otherwise it will be ignored.
eventMode	PIXI.EventMode	The default event mode mode for all display objects. This option only is available when using @pixi/events package (included in the pixi.js and pixi.js-legacy bundle), otherwise it will be ignored.
height	number	The height of the renderer's view.
hello	boolean	Whether to log the version and type information of renderer to console.
powerPreference	WebGLPowerPreference	WebGL Only. A hint indicating what configuration of GPU is suitable for the WebGL context, can be 'default', 'high-performance' or 'low-power'. Setting to 'high-performance' will prioritize rendering performance over power consumption, while setting to 'low-power' will prioritize power saving over rendering performance.
premultipliedAlpha	boolean	WebGL Only. Whether the compositor will assume the drawing buffer contains colors with premultiplied alpha.
preserveDrawingBuffer	boolean	WebGL Only. Whether to enable drawing buffer preservation. If enabled, the drawing buffer will preserve its value until cleared or overwritten. Enable this if you need to call toDataUrl on the WebGL context.
resolution	number	The resolution / device pixel ratio of the renderer.
useContextAlpha	boolean | "notMultiplied"	Deprecated since 7.0.0, use premultipliedAlpha and backgroundAlpha instead. Pass-through value for canvas' context attribute alpha. This option is for cases where the canvas needs to be opaque, possibly for performance reasons on some older devices. If you want to set transparency, please use backgroundAlpha. WebGL Only: When set to 'notMultiplied', the canvas' context attribute alpha will be set to true and premultipliedAlpha will be to false.
view	PIXI.ICanvas	The canvas to use as the view. If omitted, a new canvas will be created.
width	number	The width of the renderer's view.

See:

• PIXI.settings.RENDER_OPTIONS

IRendererOptionsAuto

Renderer options supplied to autoDetectRenderer.

Properties:

Name	Type	Default	Description
forceCanvas	boolean	false	Force CanvasRenderer even if WebGL is supported. Only available with pixi.js-legacy.

IRenderingContext

Mixed WebGL1 / WebGL2 rendering context. Either it's WebGL2, either it's WebGL1 with PixiJS polyfills on it.

IResourcePlugin

Shape of supported resource plugins

ISize

ISpritesheetData

Atlas format.

ISpritesheetFrameData

Represents the JSON data for a spritesheet atlas.

ISystem

Interface for systems used by the PIXI.Renderer.

ITextStyle

Generic interface for TextStyle options.

Properties:

Name	Type	Description
align	'left' | 'center' | 'right' | 'justify'	Alignment for multiline text, does not affect single line text
breakWords	boolean	Indicates if lines can be wrapped within words, it needs wordWrap to be set to true
dropShadow	boolean	Set a drop shadow for the text
dropShadowAlpha	number	Set alpha for the drop shadow
dropShadowAngle	number	Set a angle of the drop shadow
dropShadowBlur	number	Set a shadow blur radius
dropShadowColor	string | number	A fill style to be used on the dropshadow e.g., 'red', '#00FF00'
dropShadowDistance	number	Set a distance of the drop shadow
fill	string | Array<string> | number | Array<number> | CanvasGradient | CanvasPattern	A canvas fillstyle that will be used on the text e.g., 'red', '#00FF00'. Can be an array to create a gradient, e.g., ['#000000','#FFFFFF'] MDN
fillGradientStops	number[]	If fill is an array of colours to create a gradient, this array can set the stop points (numbers between 0 and 1) for the color, overriding the default behaviour of evenly spacing them.
fillGradientType	PIXI.TEXT_GRADIENT	If fill is an array of colours to create a gradient, this can change the type/direction of the gradient. See PIXI.TEXT_GRADIENT
fontFamily	string | string[]	The font family, can be a single font name, or a list of names where the first is the preferred font.
fontSize	number | string	The font size (as a number it converts to px, but as a string, equivalents are '26px','20pt','160%' or '1.6em')
fontStyle	'normal' | 'italic' | 'oblique'	The font style.
fontVariant	'normal' | 'small-caps'	The font variant.
fontWeight	'normal' | 'bold' | 'bolder' | 'lighter' | '100' | '200' | '300' | '400' | '500' | '600' | '700' | '800' | '900'	The font weight.
leading	number	The height of the line, a number that represents the vertical space that a letter uses.
letterSpacing	number	The amount of spacing between letters, default is 0
lineHeight	number	The line height, a number that represents the vertical space that a letter uses
lineJoin	'miter' | 'round' | 'bevel'	The lineJoin property sets the type of corner created, it can resolve spiked text issues. Possible values "miter" (creates a sharp corner), "round" (creates a round corner) or "bevel" (creates a squared corner).
miterLimit	number	The miter limit to use when using the 'miter' lineJoin mode. This can reduce or increase the spikiness of rendered text.
padding	number	Occasionally some fonts are cropped. Adding some padding will prevent this from happening by adding padding to all sides of the text.
stroke	string | number	A canvas fillstyle that will be used on the text stroke, e.g., 'blue', '#FCFF00'
strokeThickness	number	A number that represents the thickness of the stroke. A value of 0 will disable stroke.
textBaseline	'alphabetic' | 'top' | 'hanging' | 'middle' | 'ideographic' | 'bottom'	The baseline of the text that is rendered.
trim	boolean	Trim transparent borders
whiteSpace	'normal' | 'pre' | 'pre-line'	Determines whether newlines & spaces are collapsed or preserved "normal" (collapse, collapse), "pre" (preserve, preserve) | "pre-line" (preserve, collapse). It needs wordWrap to be set to true.
wordWrap	boolean	Indicates if word wrap should be used
wordWrapWidth	number	The width at which text will wrap, it needs wordWrap to be set to true

ITextureBorders

Stores the width of the non-scalable borders, for example when used with PIXI.NineSlicePlane texture.

Properties:

Name	Type	Description
bottom	number	bottom border in pixels
left	number	left border in pixels
right	number	right border in pixels
top	number	top border in pixels

Since:

• 7.2.0

ITypedArray

PixiJS classes use this type instead of ArrayBuffer and typed arrays to support expressions like geometry.buffers[0].data[0] = position.x.

Gives access to indexing and length field.

• @popelyshev: If data is actually ArrayBuffer and throws Exception on indexing - its user problem :)

LoaderParser

All functions are optional here. The flow:

for every asset,

1. parser.test(): Test the asset url.
2. parser.load(): If test passes call the load function with the url
3. parser.testParse(): Test to see if the asset should be parsed by the plugin
4. parse.parse(): If test is parsed, then run the parse function on the asset.

some plugins may only be used for parsing, some only for loading and some for both!

Properties:

Name	Type	Description
config	CONFIG	A config to adjust the parser
load	(url: string, resolvedAsset: PIXI.ResolvedAsset<META_DATA>, loader: PIXI.AssetLoader) => Promise<T>	This is the promise that loads the URL provided resolves with a loaded asset if returned by the parser.
name	string	The name of the parser (this can be used when specifying loadParser in a ResolvedAsset)
parse	(asset: ASSET, resolvedAsset: META_DATA<PIXI.ResolvedAsset>, loader: PIXI.AssetLoader) => Promise<T>	Gets called on the asset it testParse passes. Useful to convert a raw asset into something more useful than
test	(url: string, resolvedAsset: PIXI.ResolvedAsset<META_DATA>, loader: PIXI.AssetLoader) => boolean	each URL to load will be tested here, if the test is passed the assets are loaded using the load function below. Good place to test for things like file extensions!
testParse	(asset: ASSET, resolvedAsset: META_DATA<PIXI.ResolvedAsset>, loader: PIXI.AssetLoader) => Promise<boolean>	This function is used to test if the parse function should be run on the asset If this returns true then parse is called with the asset
unload	(asset: ASSET, resolvedAsset: META_DATA<PIXI.ResolvedAsset>, loader: PIXI.AssetLoader) => void	If an asset is parsed using this parser, the unload function will be called when the user requests an asset to be unloaded. This is useful for things like sounds or textures that can be unloaded from memory

LoadTextureConfig

Configuration for the loadTextures loader plugin.

Properties:

Name	Type	Default	Description
crossOrigin	HTMLImageElement["crossOrigin"]	'anonymous'	The crossOrigin value to use for images when preferCreateImageBitmap is false.
preferCreateImageBitmap	boolean	true	When set to true, loading and decoding images will happen with createImageBitmap, otherwise it will use new Image().
preferWorkers	boolean	true	When set to true, loading and decoding images will happen with Worker thread, if available on the browser. This is much more performant as network requests and decoding can be expensive on the CPU. However, not all environments support Workers, in some cases it can be helpful to disable by setting to false.

See:

• PIXI.loadTextures

LoadVideoConfig

Configuration for the loadVideo loader parser.

Properties:

Name	Type	Default	Description
defaultAutoPlay	boolean	true	When set to true, the video will start playing automatically after being loaded, otherwise it will not start playing automatically.
defaultLoop	boolean	false	When set to true, the loaded video will loop by default.
defaultMuted	boolean	false	When set to true, the loaded video will be muted.
defaultPlaysinline	boolean	true	When set to true, opening the video on mobile devices is prevented.
defaultUpdateFPS	number	0	How many times a second to update the texture of the loaded video by default. If 0, requestVideoFrameCallback is used to update the texture. If requestVideoFrameCallback is not available, the texture is updated every render.

See:

• PIXI.loadVideo

PreferOrder

A prefer order lets the resolver know which assets to prefer depending on the various parameters passed to it.

Properties:

Name	Type	Description
priority	string[]	the importance order of the params

ResolvedAsset

A fully resolved asset, with all the information needed to load it.

Properties:

Name	Type	Description
alias	string[]	Aliases associated with asset
data	T	Optional data
format	string	Format, usually the file extension
loadParser	PIXI.LoadParserName	An override that will ensure that the asset is loaded with a specific parser
name	string[]	Please use alias instead.
src	string	The URL or relative path to the asset
srcs	string	Please use src instead.

ResolveURLParser

Format for url parser, will test a string and if it pass will then parse it, turning it into an ResolvedAsset

Properties:

Name	Type	Description
config	Record<string, any>	A config to adjust the parser
parse	(value: string) => ResolvedAsset	the function that will convert the url into an object
test	(url: string) => boolean	the test to perform on the url to determine if it should be parsed

SpritesheetOptions

Options for loading a spritesheet from an atlas.

Properties:

Name	Type	Description
cachePrefix	string	Prefix to add to texture names when adding to global TextureCache, using this option can be helpful if you have multiple texture atlases that share texture names and you need to disambiguate them.
data	S	JSON data for the atlas.
resolutionFilename	string	The filename to consider when determining the resolution of the spritesheet.
texture	PIXI.BaseTexture | PIXI.Texture	Reference to Texture

StartupSystemOptions

Options for the startup system.

UnresolvedAsset

An asset that has not been resolved yet.

Properties:

Name	Type	Description
alias	ArrayOr<string>	Aliases associated with asset
name	ArrayOr<string>	Please use alias instead.
src	AssetSrc	The URL or relative path to the asset
srcs	AssetSrc	Please use src instead.

ViewSystemOptions

Options for the view system.

Namespaces

canvasUtils

filters

groupD8

settings

utils

Assets

extensions

graphicsUtils

Members

 import { DATA_URI } from 'pixi.js';

 DATA_URI.test('data:image/png;base64,foobar'); // => true

class CustomResource extends PIXI.Resource {
    // MUST have source, options constructor signature
    // for auto-detected resources to be created.
    constructor(source, options) {
        super();
    }
    upload(renderer, baseTexture, glTexture) {
        // Upload with GL
        return true;
    }
    // Used to auto-detect resource
    static test(source, extension) {
        return extension === 'xyz' || source instanceof SomeClass;
    }
}
// Install the new resource type
PIXI.INSTALLED.push(CustomResource);

// Set the config
import { loadTextures } from '@pixi/assets';
loadTextures.config = {
   // If true we will use a worker to load the ImageBitmap
   preferWorkers: true,
   // If false we will use new Image() instead of createImageBitmap
   // If false then this will also disable the use of workers as it requires createImageBitmap
   preferCreateImageBitmap: true,
   crossOrigin: 'anonymous',
};

Enums

Properties:

Name	Default	Description
NO_PREMULTIPLIED_ALPHA	0	Source is not premultiplied, leave it like that. Option for compressed and data textures that are created from typed arrays.
NPM	0	Alias for NO_PREMULTIPLIED_ALPHA.
PMA	2	Alias for PREMULTIPLIED_ALPHA.
PREMULTIPLIED_ALPHA	2	Source is already premultiplied. Example: spine atlases with _pma suffix.
PREMULTIPLY_ON_UPLOAD	1	Source is not premultiplied, premultiply on upload. Default option, used for all loaded images.
UNPACK	1	Default option, alias for PREMULTIPLY_ON_UPLOAD.

Properties:

Name	Default	Description
COLOR	0x00004000	Indicates the buffers currently enabled for color writing.
DEPTH	0x00000100	Indicates the depth buffer.
STENCIL	0x00000400	Indicates the stencil buffer.

Properties:

Name	Default	Description
ARRAY_BUFFER	34962	buffer type for using attribute data
ELEMENT_ARRAY_BUFFER	34963	buffer type for using as an index buffer
UNIFORM_BUFFER	35345	the buffer type is for uniform buffer objects

See:

• PIXI.BUFFER_TYPE

Configure whether filter textures are cleared after binding.

Properties:

Name	Default	Description
AUTO	2	Alias for BLIT
BLEND	0	Do not clear the filter texture. The filter's output will blend on top of the output texture.
BLIT	2	Clear only if PIXI.FilterSystem.forceClear is set or if the filter uses pixel blending.
CLEAR	1	Always clear the filter texture.
NO	0	Alias for BLEND, same as false in earlier versions
YES	1	Alias for CLEAR, same as true in earlier versions

Properties:

Name	Default	Description
ALPHA	0x	Alpha channel.
BLUE	0x4	Blue channel.
GREEN	0x2	Green channel
RED	0x1	Red channel.

Properties:

Name	Default	Description
LINE_LOOP	2	To draw a series of connected line segments. It also joins the first and last vertices to form a loop.
LINE_STRIP	3	To draw a series of connected line segments.
LINES	1	To draw a series of unconnected line segments (individual lines).
POINTS	0	To draw a series of points.
TRIANGLE_FAN	6	To draw a series of connected triangles sharing the first vertex in a fan-like fashion.
TRIANGLE_STRIP	5	To draw a series of connected triangles in strip fashion.
TRIANGLES	4	To draw a series of separate triangles.

Properties:

Name	Default	Description
WEBGL	1	Version 1 of WebGL
WEBGL_LEGACY	0	Used for older v1 WebGL devices. PixiJS will aim to ensure compatibility with older / less advanced devices. If you experience unexplained flickering prefer this environment.
WEBGL2	2	Version 2 of WebGL

Properties:

Name	Default	Description
ALPHA	6406
DEPTH_COMPONENT	6402
DEPTH_STENCIL	34041
LUMINANCE	6409
LUMINANCE_ALPHA	6410
RED	6403
RED_INTEGER	36244
RG	33319
RG_INTEGER	33320
RGB	6407
RGB_INTEGER	36248
RGBA	6408
RGBA_INTEGER	36249

The gc modes that are supported by pixi.

Properties:

Name	Default	Description
AUTO	0	Garbage collection will happen periodically automatically
MANUAL	1	Garbage collection will need to be called manually

Properties:

Name	Default	Description
COMPRESSED_R11_EAC	0x9270
COMPRESSED_RG11_EAC	0x9272
COMPRESSED_RGB_ATC_WEBGL	0x8C92
COMPRESSED_RGB_BPTC_SIGNED_FLOAT_EXT	0x8E8E
COMPRESSED_RGB_BPTC_UNSIGNED_FLOAT_EXT	0x8E8F
COMPRESSED_RGB_ETC1_WEBGL	0x8D64
COMPRESSED_RGB_PVRTC_2BPPV1_IMG	0x8C01
COMPRESSED_RGB_PVRTC_4BPPV1_IMG	0x8C00
COMPRESSED_RGB_S3TC_DXT1_EXT	0x83F0
COMPRESSED_RGB8_ETC2	0x9274
COMPRESSED_RGB8_PUNCHTHROUGH_ALPHA1_ETC2	0x9276
COMPRESSED_RGBA_ASTC_4x4_KHR	0x93B0
COMPRESSED_RGBA_ATC_EXPLICIT_ALPHA_WEBGL	0x8C93
COMPRESSED_RGBA_ATC_INTERPOLATED_ALPHA_WEBGL	0x87EE
COMPRESSED_RGBA_BPTC_UNORM_EXT	0x8E8C
COMPRESSED_RGBA_PVRTC_2BPPV1_IMG	0x8C03
COMPRESSED_RGBA_PVRTC_4BPPV1_IMG	0x8C02
COMPRESSED_RGBA_S3TC_DXT1_EXT	0x83F1
COMPRESSED_RGBA_S3TC_DXT3_EXT	0x83F2
COMPRESSED_RGBA_S3TC_DXT5_EXT	0x83F3
COMPRESSED_RGBA8_ETC2_EAC	0x9278
COMPRESSED_SIGNED_R11_EAC	0x9271
COMPRESSED_SIGNED_RG11_EAC	0x9273
COMPRESSED_SRGB_ALPHA_BPTC_UNORM_EXT	0x8E8D
COMPRESSED_SRGB_ALPHA_S3TC_DXT1_EXT	35917
COMPRESSED_SRGB_ALPHA_S3TC_DXT3_EXT	35918
COMPRESSED_SRGB_ALPHA_S3TC_DXT5_EXT	35919
COMPRESSED_SRGB_S3TC_DXT1_EXT	35916
COMPRESSED_SRGB8_ALPHA8_ETC2_EAC	0x9279
COMPRESSED_SRGB8_ETC2	0x9275
COMPRESSED_SRGB8_PUNCHTHROUGH_ALPHA1_ETC2	0x9277

Properties:

Name	Default	Description
BUTT	butt	'butt': don't add any cap at line ends (leaves orthogonal edges)
ROUND	round	'round': add semicircle at ends
SQUARE	square	'square': add square at end (like BUTT except more length at end)

See:

• PIXI.Graphics#lineStyle

Properties:

Name	Default	Description
BEVEL	bevel	'bevel': add a square butt at each end of line segment and fill the triangle at turn
MITER	miter	'miter': make a sharp corner where outer part of lines meet
ROUND	round	'round': add an arc at the joint

See:

• PIXI.Graphics#lineStyle
• https://graphicdesign.stackexchange.com/questions/59018/what-is-a-bevel-join-of-two-lines-exactly-illustrator

Properties:

Name	Default	Description
COLOR	4	Color mask (RGBA)
NONE	0	Mask is ignored
SCISSOR	1	Scissor mask, rectangle on screen, cheap
SPRITE	3	Mask that uses SpriteMaskFilter, uses temporary RenderTexture
STENCIL	2	Stencil mask, 1-bit, medium, works only if renderer supports stencil

Mipmap filtering modes that are supported by pixi.

Properties:

Name	Default	Description
OFF	0	No mipmaps.
ON	2	Always generate mipmaps.
ON_MANUAL	3	Use mipmaps, but do not auto-generate them. this is used with a resource that supports buffering each level-of-detail.
POW2	1	Generate mipmaps if texture dimensions are powers of 2.

Properties:

Name	Default	Description
HIGH	8	Try 8 samples
LOW	2	Try 2 samples
MEDIUM	4	Try 4 samples
NONE	0	No multisampling for this renderTexture

See:

• PIXI.Framebuffer#multisample

Properties:

Name	Default	Description
HIGH	highp	highp is at least a 32 bit value. For floating point values they can range from: -2^62 to +2^62, for integer values they are similar to Uint32Array or Int32Array
LOW	lowp	lowp is at least an 9 bit value. For floating point values they can range from: -2 to +2, for integer values they are similar to Uint8Array or Int8Array
MEDIUM	mediump	mediump is at least a 16 bit value. For floating point values they can range from: -2^14 to +2^14, for integer values they are similar to Uint16Array or Int16Array

Properties:

Name	Default	Description
CANVAS	2	Canvas render type.
UNKNOWN	0	Unknown render type.
WEBGL	1	WebGL render type.

Properties:

Name	Default	Description
FLOAT	0
INT	1
UINT	2

The scale modes that are supported by pixi.

Properties:

Name	Default	Description
LINEAR	1	Smooth scaling
NEAREST	0	Pixelating scaling

Properties:

Name	Default	Description
CIRC	2	Properties Name Type Description CIRC number Circle
ELIP	3	Properties Name Type Description ELIP number Ellipse
POLY	0	Properties Name Type Description RECT number Rectangle
RECT	1	Properties Name Type Description POLY number Polygon
RREC	4	Properties Name Type Description RREC number Rounded Rectangle

Properties:

Name	Default	Description
TEXTURE_2D	3553	A two-dimensional texture
TEXTURE_2D_ARRAY	35866	A two-dimensional array texture.
TEXTURE_CUBE_MAP	34067	A cube-mapped texture. When using a WebGL 2 context, the following values are available additionally: gl.TEXTURE_3D: A three-dimensional texture. gl.TEXTURE_2D_ARRAY: A two-dimensional array texture.
TEXTURE_CUBE_MAP_NEGATIVE_X	34070	Negative X face for a cube-mapped texture.
TEXTURE_CUBE_MAP_NEGATIVE_Y	34072	Negative Y face for a cube-mapped texture.
TEXTURE_CUBE_MAP_NEGATIVE_Z	34074	Negative Z face for a cube-mapped texture.
TEXTURE_CUBE_MAP_POSITIVE_X	34069	Positive X face for a cube-mapped texture.
TEXTURE_CUBE_MAP_POSITIVE_Y	34071	Positive Y face for a cube-mapped texture.
TEXTURE_CUBE_MAP_POSITIVE_Z	34073	Positive Z face for a cube-mapped texture.

Properties:

Name	Default	Description
LINEAR_HORIZONTAL	1	Linear gradient
LINEAR_VERTICAL	0	Vertical gradient

Properties:

Name	Default	Description
BYTE	5120
FLOAT	5126
FLOAT_32_UNSIGNED_INT_24_8_REV	36269
HALF_FLOAT	36193
INT	5124
SHORT	5122
UNSIGNED_BYTE	5121	8 bits per channel for gl.RGBA
UNSIGNED_INT	5125
UNSIGNED_INT_10F_11F_11F_REV	35899
UNSIGNED_INT_2_10_10_10_REV	33640
UNSIGNED_INT_24_8	34042
UNSIGNED_INT_5_9_9_9_REV	35902
UNSIGNED_SHORT	5123
UNSIGNED_SHORT_4_4_4_4	32819	4 red bits, 4 green bits, 4 blue bits, 4 alpha bits.
UNSIGNED_SHORT_5_5_5_1	32820	5 red bits, 5 green bits, 5 blue bits, 1 alpha bit.
UNSIGNED_SHORT_5_6_5	33635	5 red bits, 6 green bits, 5 blue bits.

Properties:

Name	Default	Description
HIGH	25	High priority updating, used by PIXI.AnimatedSprite
INTERACTION	50	Highest priority used for interaction events in PIXI.EventSystem
LOW	-25	Low priority used for PIXI.Application rendering.
NORMAL	0	Default priority for ticker events, see PIXI.Ticker#add.
UTILITY	-50	Lowest priority used for PIXI.BasePrepare utility.

The wrap modes that are supported by pixi.

Properties:

Name	Default	Description
CLAMP	33071	The textures uvs are clamped
MIRRORED_REPEAT	33648	The texture uvs tile and repeat with mirroring
REPEAT	10497	The texture uvs tile and repeat

Various blend modes supported by PIXI.

Properties:

Name	Default	Description
ADD	1
ADD_NPM	18
COLOR	15	Preserves the luma of the bottom layer, while adopting the hue and chroma of the top layer. Canvas Renderer only.
COLOR_BURN	8	Divides the inverted bottom layer by the top layer, and then inverts the result. Canvas Renderer only.
COLOR_DODGE	7	Divides the bottom layer by the inverted top layer. Canvas Renderer only.
DARKEN	5	Retains the darkest pixels of both layers. Canvas Renderer only.
DIFFERENCE	11	Subtracts the bottom layer from the top layer or the other way round to always get a positive value. Canvas Renderer only.
DST_ATOP	27	The existing canvas is only kept where it overlaps the new shape. The new shape is drawn behind the canvas content.
DST_IN	25	The existing canvas content is kept where both the new shape and existing canvas content overlap. Everything else is made transparent.
DST_OUT	26	The existing content is kept where it doesn't overlap the new shape.
DST_OVER	24	New shapes are drawn behind the existing canvas content.
ERASE	26
EXCLUSION	12	Like difference, but with lower contrast. Canvas Renderer only.
HARD_LIGHT	9	A combination of multiply and screen like overlay, but with top and bottom layer swapped. Canvas Renderer only.
HUE	13	Preserves the luma and chroma of the bottom layer, while adopting the hue of the top layer. Canvas Renderer only.
LIGHTEN	6	Retains the lightest pixels of both layers. Canvas Renderer only.
LUMINOSITY	16	Preserves the hue and chroma of the bottom layer, while adopting the luma of the top layer. Canvas Renderer only.
MULTIPLY	2	The pixels of the top layer are multiplied with the corresponding pixel of the bottom layer. A darker picture is the result.
NONE	20
NORMAL	0
NORMAL_NPM	17
OVERLAY	4	A combination of multiply and screen. Dark parts on the base layer become darker, and light parts become lighter. Canvas Renderer only.
SATURATION	14	Preserves the luma and hue of the bottom layer, while adopting the chroma of the top layer. Canvas Renderer only.
SCREEN	3	The pixels are inverted, multiplied, and inverted again. A lighter picture is the result (opposite of multiply)
SCREEN_NPM	19
SOFT_LIGHT	10	A softer version of hard-light. Pure black or white does not result in pure black or white. Canvas Renderer only.
SRC_ATOP	23	The new shape is only drawn where it overlaps the existing canvas content.
SRC_IN	21	The new shape is drawn only where both the new shape and the destination canvas overlap. Everything else is made transparent.
SRC_OUT	22	The new shape is drawn where it doesn't overlap the existing canvas content.
SRC_OVER	0	Draws new shapes on top of the existing canvas content.
SUBTRACT	28
XOR	29	Shapes are made transparent where both overlap and drawn normal everywhere else.

Properties:

Name	Description
Application	Application plugins
CacheParser	Parsers for Assets cache.
CanvasRendererPlugin	Plugins for CanvasRenderer
Loader	Plugins to use with Loader
LoadParser	Parsers for Assets loader.
RendererPlugin	Plugins for Renderer
ResolveParser	Parsers for Assets resolvers.

Properties:

Name	Description
High	Specific texture types: svg, png, ktx, dds, basis
Low	Generic parsers: txt, json, webfonts
Normal	PixiJS assets with generic extensions: spritesheets, bitmapfonts

Type Definitions

pressTargetsByButton: {
    [id: number]: FederatedEventTarget[];
};
clicksByButton: {
    [id: number]: {
        clickCount: number;
        target: FederatedEventTarget;
        timeStamp: number;
    };
};
overTargets: FederatedEventTarget[];

Methods