Generalized convenience utilities for PIXI.
Example
// Extend PIXI's internal Event Emitter.
class MyEmitter extends PIXI.utils.EventEmitter {
constructor() {
super();
console.log("Emitter created!");
}
}
// Get info on current device
console.log(PIXI.utils.isMobile);
// Convert hex color to string
console.log(PIXI.utils.hex2string(0xff00ff)); // returns: "#ff00ff"Classes
Namespaces
Members
-
- TODO
-
- Describe property usage
-
A simple JS library that detects mobile devices.
- See:
Properties:
Name Type Description anyboolean trueif current platform is tablet or phone devicetabletboolean trueif current platform large-screen tablet devicephoneboolean trueif current platform small-screen phone deviceappleobject Properties
Name Type Description deviceboolean trueif any Apple devicetabletboolean trueif any Apple iPadphoneboolean trueif any Apple iPhoneipodboolean trueif any iPodandroidobject Properties
Name Type Description deviceboolean trueif any Android devicetabletboolean trueif any Android tabletphoneboolean trueif any Android phoneamazonobject Properties
Name Type Description deviceboolean trueif any Silk devicetabletboolean trueif any Silk tabletphoneboolean trueif any Silk phonewindowsobject Properties
Name Type Description deviceboolean trueif any Windows devicetabletboolean trueif any Windows tabletphoneboolean trueif any Windows phone -
maps premultiply flag and blendMode to adjusted blendMode
-
- TODO
-
- Describe property usage
-
- TODO
-
- Describe property usage
-
Node.js compatible URL utilities.
Methods
-
Removes all textures from cache, but does not destroy them
-
changes blendMode according to texture format
Name Type Description blendModenumber supposed blend mode
premultipliedboolean whether source is premultiplied
Returns:
Type Description number true blend mode for this texture -
Generic Mask Stack data structure
Name Type Description sizenumber Number of quads
outBufferUint16Array | Uint32Array optional Buffer for output, length has to be
6 * sizeReturns:
Type Description Uint16Array | Uint32Array - Resulting index buffer
-
PIXI.utils.decomposeDataUri (dataUri)PIXI.utils.DecomposedDataUri | undefined static
-
Split a data URI into components. Returns undefined if parameter
dataUriis not a valid data URI.Name Type Description dataUristring the data URI to check
Returns:
Type Description PIXI.utils.DecomposedDataUri | undefined The decomposed data uri or undefined -
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 Default Description versionstring The version where the feature became deprecated
messagestring Message should include what is deprecated, where, and the new solution
ignoreDepthnumber 3 optional The number of steps to ignore at the top of the error stack this is mostly to ignore internal deprecation calls.
-
Destroys all texture in the cache
-
A polygon triangulation library
Name Type Default Description verticesArray.<number> A flat array of vertex coordinates
holesArray.<number> optional An array of hole indices
dimensionsnumber 2 optional The number of coordinates per vertex in the input array
Returns:
Type Description Array.<number> Triangulated polygon -
get the resolution / device pixel ratio of an asset by looking for the prefix used by spritesheets and image urls
Name Type Default Description urlstring the image path
defaultValuenumber 1 optional the defaultValue if no filename prefix is set.
Returns:
Type Description number resolution / device pixel ratio of an asset -
Converts a hexadecimal color number to an [R, G, B] array of normalized floats (numbers from 0.0 to 1.0).
Name Type Default Description hexnumber The hexadecimal number to convert
outArray.<number> [] optional If supplied, this array will be used rather than returning a new one
Returns:
Type Description Array.<number> An array representing the [R, G, B] of the color where all values are floats. Example
PIXI.utils.hex2rgb(0xffffff); // returns [1, 1, 1] -
Converts a hexadecimal color number to a string.
Name Type Description hexnumber Number in hex (e.g.,
0xffffff)Returns:
Type Description string The string color (e.g., "#ffffff").Example
PIXI.utils.hex2string(0xffffff); // returns "#ffffff" -
Checks if a number is a power of two.
Name Type Description vnumber input value
Returns:
Type Description boolean trueif value is power of two -
Helper for checking for WebGL support.
Returns:
Type Description boolean Is WebGL supported. -
Computes ceil of log base 2
Name Type Description vnumber input value
Returns:
Type Description number logarithm base 2 -
Rounds to next power of two.
Name Type Description vnumber input value
Returns:
Type Description number -
combines rgb and alpha to out array
Name Type Default Description rgbFloat32Array | Array.<number> input rgb
alphanumber alpha param
outFloat32Array optional output
premultiplyboolean true optional do premultiply it
Returns:
Type Description Float32Array vec4 rgba -
premultiplies tint
Name Type Description tintnumber integer RGB
alphanumber floating point alpha (0.0-1.0)
Returns:
Type Description number tint multiplied by alpha -
converts integer tint and float alpha to vec4 form, premultiplies by default
Name Type Default Description tintnumber input tint
alphanumber alpha param
outFloat32Array optional output
premultiplyboolean true optional do premultiply it
Returns:
Type Description Float32Array vec4 rgba -
Remove items from a javascript array without generating garbage
Name Type Description arrArray.<any> Array to remove elements from
startIdxnumber starting index
removeCountnumber how many to remove
-
Converts a color as an [R, G, B] array of normalized floats to a hexadecimal number.
Name Type Description rgbArray.<number> Array of numbers where all values are normalized floats from 0.0 to 1.0.
Returns:
Type Description number Number in hexadecimal. Example
PIXI.utils.rgb2hex([1, 1, 1]); // returns 0xffffff -
Logs out the version and renderer information for this running instance of PIXI. If you don't want to see this message you can run
PIXI.utils.skipHello()before creating your renderer. Keep in mind that doing that will forever make you a jerk face.Name Type Description typestring The string renderer type to log.
-
Returns sign of number
Name Type Description nnumber the number to check the sign of
Returns:
Type Description number 0 if nis 0, -1 ifnis negative, 1 ifnis positive -
Skips the hello message of renderers that are created after this is run.
-
Converts a hexadecimal string to a hexadecimal color number.
Name Type Description stringstring The string color (e.g.,
"#ffffff")Returns:
Type Description number Number in hexadecimal. Example
PIXI.utils.string2hex("#ffffff"); // returns 0xffffff -
Trim transparent borders from a canvas
Name Type Description canvasHTMLCanvasElement the canvas to trim
Returns:
Type Description object Trim data -
Gets the next unique identifier
Returns:
Type Description number The next unique identifier to use.