PixiJS

Namespace: utils

PIXI.utils

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

EventEmitter

Members

staticPIXI.utils._saidHelloboolean

Deprecated
  • since 4.1.0
    See:

    static, constantPIXI.utils.premultiplyBlendModeArray.<Array.<number>>

    maps premultiply flag and blendMode to adjusted blendMode

    Methods

    staticPIXI.utils.canUseNewCanvasBlendModes()boolean

    deprecation.js:965
    Deprecated
    • Yes
    See:
    Returns:
    Type Description
    boolean Can use blend modes.

    staticPIXI.utils.clearTextureCache()

    index.js:382

    Removes all textures from cache, but does not destroy them

    staticPIXI.utils.correctBlendMode(blendMode, premultiplied)number

    index.js:410

    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

    staticPIXI.utils.decomposeDataUri(dataUri)DecomposedDataUri | undefined

    index.js:159

    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
    DecomposedDataUri | undefined The decomposed data uri or undefined

    staticPIXI.utils.destroyTextureCache()

    index.js:362

    Destroys all texture in the cache

    staticPIXI.utils.getResolutionOfUrl(url, defaultValue)number

    index.js:127

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

    Name Type Default Description
    url string

    the image path
    defaultValue number 1 optional

    the defaultValue if no filename prefix is set.
    Returns:
    Type Description
    number resolution / device pixel ratio of an asset

    staticPIXI.utils.getSvgSize(svgString)Size | undefined

    index.js:213

    Get size from an svg string using regexp.

    Name Type Description
    svgString string

    a serialized svg element
    Returns:
    Type Description
    Size | undefined image extension

    staticPIXI.utils.getUrlFileExtension(url)string | undefined

    index.js:185

    Get type of the image by regexp for extension. Returns undefined for unknown extensions.

    Name Type Description
    url string

    the image path
    Returns:
    Type Description
    string | undefined image extension

    staticPIXI.utils.hex2rgb(hex, out)Array.<number>

    index.js:78

    Converts a hex color number to an [R, G, B] array

    Name Type Default Description
    hex number

    The number to convert
    out Array.<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.

    staticPIXI.utils.hex2string(hex)string

    index.js:98

    Converts a hex color number to a string.

    Name Type Description
    hex number

    Number in hex
    Returns:
    Type Description
    string The string color.

    staticPIXI.utils.isMobile()Object

    index.js:32
    See:
    Returns:
    Type Description
    Object

    staticPIXI.utils.isWebGLSupported()boolean

    index.js:288

    Helper for checking for webgl support

    Returns:
    Type Description
    boolean is webgl supported

    staticPIXI.utils.pluginTarget()mixin

    index.js:57
    Returns:
    Type Description
    mixin

    staticPIXI.utils.removeItems()Object

    index.js:41
    See:
    Returns:
    Type Description
    Object

    staticPIXI.utils.rgb2hex(rgb)number

    index.js:114

    Converts a color as an [R, G, B] array to a hex number

    Name Type Description
    rgb Array.<number>

    rgb array
    Returns:
    Type Description
    number The color number

    staticPIXI.utils.sayHello(type)

    index.js:246

    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 makes you a jerk face.

    Name Type Description
    type string

    The string renderer type to log.

    staticPIXI.utils.sign(n)number

    index.js:331

    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

    staticPIXI.utils.skipHello()

    index.js:235

    Skips the hello message of renderers that are created after this is run.

    staticPIXI.utils.uid()number

    index.js:66

    Gets the next unique identifier

    Returns:
    Type Description
    number The next unique identifier to use.

    staticPIXI.utils.uuid()number

    deprecation.js:951
    Deprecated
    • since version 3.0.6
      See:
      Returns:
      Type Description
      number The uid