API Docs for: 2.2.1
Show:

ImageLoader Class

Uses
Defined in: pixi/loaders/ImageLoader.hx:9

The image loader class is responsible for loading images file formats ('jpeg', 'jpg', 'png' and 'gif') Once the image has been loaded it is stored in the PIXI texture cache and can be accessed though PIXI.Texture.fromFrameId() and PIXI.Sprite.fromFrameId() When loaded this class will dispatch a 'loaded' event

Constructor

ImageLoader

(
  • url
  • [crossorigin]
)

Defined in pixi/loaders/ImageLoader.hx:9

Parameters:

  • url String

    The url of the image

  • [crossorigin] Bool optional

    Whether requests should be treated as crossorigin

Methods

emit

(
  • eventName
  • data
)
Bool

Inherited from EventTarget: pixi/utils/EventTarget.hx:29

Emit an event to all registered event listeners.

Parameters:

  • eventName String

    The name of the event.

  • data Dynamic

Returns:

Bool:

Indication if we've emitted an event.

listeners

(
  • eventName
)
Array

Inherited from EventTarget: pixi/utils/EventTarget.hx:20

Return a list of assigned event listeners.

Parameters:

  • eventName String

    The events that should be listed.

Returns:

Array:

An array of listener functions

load

()

Defined in pixi/loaders/ImageLoader.hx:40

Loads image or takes it from cache

loadFramedSpriteSheet

(
  • frameWidth
  • frameHeight
  • textureName
)

Defined in pixi/loaders/ImageLoader.hx:47

Loads image and split it to uniform sized frames

Parameters:

  • frameWidth Float

    width of each frame

  • frameHeight Float

    height of each frame

  • textureName String

    if given, the frames will be cached in - format

off

(
  • eventName
  • callback
)

Inherited from EventTarget: pixi/utils/EventTarget.hx:61

Remove event listeners.

Parameters:

  • eventName String

    The event we want to remove.

  • callback Function

    The listener that we need to find.

on

(
  • eventName
  • callback
)

Inherited from EventTarget: pixi/utils/EventTarget.hx:41

Register a new EventListener for the given event.

Parameters:

  • eventName String

    Name of the event.

  • callback Functon

    Callback function.

once

(
  • eventName
  • callback
)

Inherited from EventTarget: pixi/utils/EventTarget.hx:52

Add an EventListener that's only called once.

Parameters:

  • eventName String

    Name of the event.

  • callback Function

    Callback function.

removeAllListeners

(
  • eventName
)

Inherited from EventTarget: pixi/utils/EventTarget.hx:72

Remove all listeners or only the listeners for the specified event.

Parameters:

  • eventName String

    The event you want to remove all listeners for.

Properties

frames

Array

Defined in pixi/loaders/ImageLoader.hx:30

if the image is loaded with loadFramedSpriteSheet frames will contain the sprite sheet frames

texture

Texture

Defined in pixi/loaders/ImageLoader.hx:22

The texture being loaded