ImageLoader Class
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.fromFrame() and PIXI.Sprite.fromFrame() When loaded this class will dispatch a 'loaded' event
Constructor
ImageLoader
-
url
-
crossorigin
Parameters:
-
url
StringThe url of the image
-
crossorigin
BooleanWhether requests should be treated as crossorigin
Item Index
Methods
emit
-
eventName
Emit an event to all registered event listeners.
Parameters:
-
eventName
StringThe name of the event.
Returns:
Indication if we've emitted an event.
listeners
-
eventName
Return a list of assigned event listeners.
Parameters:
-
eventName
StringThe events that should be listed.
Returns:
An array of listener functions
load
()
Loads image or takes it from cache
loadFramedSpriteSheet
-
frameWidth
-
frameHeight
-
textureName
Loads image and split it to uniform sized frames
Parameters:
-
frameWidth
Numberwidth of each frame
-
frameHeight
Numberheight of each frame
-
textureName
Stringif given, the frames will be cached in
- format
mixin
-
object
Mixes in the properties of the EventTarget prototype onto another object
Parameters:
-
object
ObjectThe obj to mix into
off
-
eventName
-
callback
Remove event listeners.
Parameters:
-
eventName
StringThe event we want to remove.
-
callback
FunctionThe listener that we need to find.
on
-
eventName
-
callback
Register a new EventListener for the given event.
Parameters:
-
eventName
StringName of the event.
-
callback
Functonfn Callback function.
once
-
eventName
-
callback
Add an EventListener that's only called once.
Parameters:
-
eventName
StringName of the event.
-
callback
FunctionCallback function.
onLoaded
()
private
Invoked when image file is loaded or it is already cached and ready to use
removeAllListeners
-
eventName
Remove all listeners or only the listeners for the specified event.
Parameters:
-
eventName
StringThe event you want to remove all listeners for.
Properties
frames
Array
if the image is loaded with loadFramedSpriteSheet frames will contain the sprite sheet frames