PIXI

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:

    Methods

    staticPIXI.utils.canUseNewCanvasBlendModes(){boolean}

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

    staticPIXI.utils.clearTextureCache()

    core/utils/index.js, line 401

    Removes all textures from cache, but does not destroy them

    staticPIXI.utils.decomposeDataUri(dataUri){DecomposedDataUri|undefined}

    core/utils/index.js, line 148

    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()

    core/utils/index.js, line 381

    Destroys all texture in the cache

    staticPIXI.utils.getResolutionOfUrl(url, defaultValue){number}

    core/utils/index.js, line 116

    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}

    core/utils/index.js, line 202

    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}

    core/utils/index.js, line 174

    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>}

    core/utils/index.js, line 67

    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}

    core/utils/index.js, line 87

    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}

    core/utils/index.js, line 30
    See:
    Returns:
    Type Description
    Object

    staticPIXI.utils.isWebGLSupported(){boolean}

    core/utils/index.js, line 277

    Helper for checking for webgl support

    Returns:
    Type Description
    boolean is webgl supported

    staticPIXI.utils.pluginTarget(){mixin}

    core/utils/index.js, line 46
    Returns:
    Type Description
    mixin

    staticPIXI.utils.removeItems(arr, startIdx, removeCount)

    core/utils/index.js, line 335

    Remove a range of items from an array

    Name Type Description
    arr Array.<*>

    The target array
    startIdx number

    The index to begin removing from (inclusive)
    removeCount number

    How many items to remove

    staticPIXI.utils.rgb2hex(rgb){number}

    core/utils/index.js, line 103

    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)

    core/utils/index.js, line 235

    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}

    core/utils/index.js, line 320

    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()

    core/utils/index.js, line 224

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

    staticPIXI.utils.uid(){number}

    core/utils/index.js, line 55

    Gets the next unique identifier

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

    staticPIXI.utils.uuid(){number}

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