PixiJS API Documentation

Namespace: utils

PIXI.utils

Generalized convenience utilities for PIXI.

Example

 import { utils } from 'pixi.js';
 // Extend PIXI's internal Event Emitter.
 class MyEmitter extends utils.EventEmitter {
     constructor() {
         super();
         console.log('Emitter created!');
     }
 }

 // Get info on current device
 console.log(utils.isMobile);

Classes

BoundingBox
CanvasRenderTarget
EventEmitter

Interface Definitions

DecomposedDataUri

Properties:

Name	Type	Description
`charset`	string
`data`	string	The actual data
`encoding`	string	Data encoding, eg. `base64`
`mediaType`	string	type, eg. `image`
`subType`	string	Sub type, eg. `png`

Members

PIXI.utils.BaseTextureCache Record<string, BaseTexture> staticreadonly

TODO

Describe property usage

PIXI.utils.ProgramCache Record<string, Program> staticreadonly

TODO

Describe property usage

PIXI.utils.TextureCache Record<string, Texture> staticreadonly

TODO

Describe property usage

isMobile object

A simple JS library that detects mobile devices.

Properties:

Name	Type	Description
`amazon`	object
`amazon`	boolean	.device - `true` if any Silk device
`amazon`	boolean	.tablet - `true` if any Silk tablet
`amazon`	boolean	.phone - `true` if any Silk phone
`android`	object
`android`	boolean	.device - `true` if any Android device
`android`	boolean	.tablet - `true` if any Android tablet
`android`	boolean	.phone - `true` if any Android phone
`any`	boolean	`true` if current platform is tablet or phone device
`apple`	object
`apple`	boolean	.device - `true` if any Apple device
`apple`	boolean	.tablet - `true` if any Apple iPad
`apple`	boolean	.phone - `true` if any Apple iPhone
`apple`	boolean	.ipod - `true` if any iPod
`phone`	boolean	`true` if current platform small-screen phone device
`tablet`	boolean	`true` if current platform large-screen tablet device
`windows`	object
`windows`	boolean	.device - `true` if any Windows device
`windows`	boolean	.tablet - `true` if any Windows tablet
`windows`	boolean	.phone - `true` if any Windows phone

See:

https://github.com/kaimallea/isMobile

path object

Browser and Node.js compatible path utilities. All paths that are passed in will become normalized to have posix separators.

premultiplyBlendMode Array<number<Array>> readonly

maps premultiply flag and blendMode to adjusted blendMode

url object Deprecated : since 7.3.0

Node.js compatible URL utilities.

See:

https://www.npmjs.com/package/url

Methods

earcut (vertices, holes, dimensions) Array<number>

index.ts:59

A polygon triangulation library

Name	Type	Attributes	Default	Description
`vertices`	Array<number>			A flat array of vertex coordinates
`holes`	Array<number>	<optional>		An array of hole indices
`dimensions`	number	<optional>	2	The number of coordinates per vertex in the input array

See:

https://github.com/mapbox/earcut

Returns:

Type	Description
Array<number>	Triangulated polygon

sayHello () void Deprecated`` : since 7.0.0

hello.ts:16

clearTextureCache () void

caches.ts:49

Removes all textures from cache, but does not destroy them

correctBlendMode (blendMode, premultiplied) number

premultiply.ts:46

changes blendMode according to texture format

Name	Type	Description
`blendMode`	number	supposed blend mode
`premultiplied`	boolean	whether source is premultiplied

Returns:

Type	Description
number	true blend mode for this texture

createIndicesForQuads (size, outBuffer) Uint16Array | Uint32Array

createIndicesForQuads.ts:1

Generic Mask Stack data structure

Name	Type	Attributes	Default	Description
`size`	number			Number of quads
`outBuffer`	Uint16Array \| Uint32Array	<optional>	undefined	Buffer for output, length has to be `6 * size`

Returns:

Type	Description
Uint16Array \| Uint32Array	Resulting index buffer

decomposeDataUri (dataUri) PIXI.utils.DecomposedDataUri | unknown

decomposeDataUri.ts:46

Split a data URI into components. Returns undefined if parameter dataUri is not a valid data URI.

Name	Type	Description
`dataUri`	string	the data URI to check

Returns:

Type	Description
PIXI.utils.DecomposedDataUri \| unknown	The decomposed data uri or undefined

deprecation (version, message, ignoreDepth) void

deprecation.ts:6

Helper for warning developers about deprecated features & settings. A stack track for warnings is given; useful for tracking-down where deprecated methods/properties/classes are being used within the code.

Name	Type	Attributes	Default	Description
`version`	string			The version where the feature became deprecated
`message`	string			Message should include what is deprecated, where, and the new solution
`ignoreDepth`	number	<optional>	3	The number of steps to ignore at the top of the error stack this is mostly to ignore internal deprecation calls.

destroyTextureCache () void

caches.ts:30

Destroys all texture in the cache

detectVideoAlphaMode () Promise<PIXI.ALPHA_MODES>

detectVideoAlphaMode.ts:5

Helper for detecting the correct alpha mode for video textures. For some reason, some browsers/devices/WebGL implementations premultiply the alpha of a video before and then a second time if UNPACK_PREMULTIPLY_ALPHA_WEBGL is true. So the video is premultiplied twice if the alpha mode is UNPACK. In this case we need the alpha mode to be PMA. This function detects the upload behavior by uploading a white 2x2 webm with 50% alpha without UNPACK_PREMULTIPLY_ALPHA_WEBGL and then checking whether the uploaded pixels are premultiplied.

Returns:

Type	Description
Promise<PIXI.ALPHA_MODES>	The correct alpha mode for video textures.

getCanvasBoundingBox (canvas) PIXI.utils.BoundingBox

getCanvasBoundingBox.ts:27

Measuring the bounds of a canvas' visible (non-transparent) pixels.

Name	Type	Description
`canvas`	PIXI.ICanvas	The canvas to measure.

Since:

7.1.0

Returns:

Type	Description
PIXI.utils.BoundingBox	The bounding box of the canvas' visible pixels.

getResolutionOfUrl (url, defaultValue) number

getResolutionOfUrl.ts:3

get the resolution / device pixel ratio of an asset by looking for the prefix used by spritesheets and image urls

Name	Type	Attributes	Default	Description
`url`	string			the image path
`defaultValue`	number	<optional>	1	the defaultValue if no filename prefix is set.

Returns:

Type	Description
number	resolution / device pixel ratio of an asset

hex2rgb (hex, out) Array<number> Deprecated`` : since 7.2.0

hex.ts:4

Converts a hexadecimal color number to an [R, G, B] array of normalized floats (numbers from 0.0 to 1.0).

Name	Type	Attributes	Default	Description
`hex`	number			The hexadecimal number to convert
`out`	Array<number>	<optional>	[]	If supplied, this array will be used rather than returning a new one

See:

PIXI.Color.toRgbArray

Returns:

Type	Description
Array<number>	An array representing the [R, G, B] of the color where all values are floats.

hex2string (hex) string Deprecated`` : since 7.2.0

hex.ts:24

Converts a hexadecimal color number to a string.

Name	Type	Description
`hex`	number	Number in hex (e.g., `0xffffff`)

See:

PIXI.Color.toHex

Returns:

Type	Description
string	The string color (e.g., `"#ffffff"`).

isPow2 (v) boolean

pow2.ts:23

Checks if a number is a power of two.

Name	Type	Description
`v`	number	input value

Returns:

Type	Description
boolean	`true` if value is power of two

isWebGLSupported () boolean

isWebGLSupported.ts:5

Helper for checking for WebGL support.

Returns:

Type	Description
boolean	Is WebGL supported.

log2 (v) number

pow2.ts:35

Computes ceil of log base 2

Name	Type	Description
`v`	number	input value

Returns:

Type	Description
number	logarithm base 2

nextPow2 (v) number

pow2.ts:3

Rounds to next power of two.

Name	Type	Description
`v`	number	input value

Returns:

Type	Description
number	next rounded power of two

premultiplyRgba (rgb, alpha, out, premultiply) Float32Array Deprecated`` : since 7.2.0

premultiply.ts:59

Name	Type	Attributes	Default
`rgb`	Float32Array \| number<Array>
`alpha`	number
`out`	Float32Array	<optional>
`premultiply`	boolean	<optional>	true

See:

PIXI.Color.premultiply

Returns:

Type	Description
Float32Array

premultiplyTint (tint, alpha) number Deprecated`` : since 7.2.0

premultiply.ts:87

Name	Type	Description
`tint`	number
`alpha`	number

See:

PIXI.Color.toPremultiplied

Returns:

Type	Description
number

premultiplyTintToRgba (tint, alpha, out, premultiply) Float32Array Deprecated`` : since 7.2.0

premultiply.ts:107

Name	Type	Attributes	Default
`tint`	number
`alpha`	number
`out`	Float32Array	<optional>
`premultiply`	boolean	<optional>	true

See:

PIXI.Color.premultiply

Returns:

Type	Description
Float32Array

removeItems (arr, startIdx, removeCount) void

removeItems.ts:1

Remove items from a javascript array without generating garbage

Name	Type	Description
`arr`	Array<any>	Array to remove elements from
`startIdx`	number	starting index
`removeCount`	number	how many to remove

rgb2hex (rgb) number Deprecated`` : since 7.2.0

hex.ts:62

Converts a color as an [R, G, B] array of normalized floats to a hexadecimal number.

Name	Type	Description
`rgb`	Array<number>	Array of numbers where all values are normalized floats from 0.0 to 1.0.

See:

PIXI.Color.toNumber

Returns:

Type	Description
number	Number in hexadecimal.

sign (n) number

sign.ts:1

Returns sign of number

Name	Type	Description
`n`	number	the number to check the sign of

Returns:

Type	Description
number	0 if `n` is 0, -1 if `n` is negative, 1 if `n` is positive

skipHello () void Deprecated`` : since 7.0.0

hello.ts:3

string2hex (string) number Deprecated`` : since 7.2.0

hex.ts:43

Converts a string to a hexadecimal color number.

Name	Type	Description
`string`	string	The string color (e.g., `"#ffffff"`)

See:

PIXI.Color.toNumber

Returns:

Type	Description
number	Number in hexadecimal.

trimCanvas (canvas) { width : number, height : number, data : ImageData | null }

trimCanvas.ts:5

Trim transparent borders from a canvas.

Name	Type	Description
`canvas`	PIXI.ICanvas	The canvas to trim.

Returns:

Type	Description
{ width : number, height : number, data : ImageData \| null }	The trimmed canvas data.

uid () number

uid.ts:3

Gets the next unique identifier

Returns:

Type	Description
number	The next unique identifier to use.