The new loader, extends Resource Loader by Chad Engler: https://github.com/englercj/resource-loader
const loader = PIXI.Loader.shared; // PixiJS exposes a premade instance for you to use.
//or
const loader = new PIXI.Loader(); // you can also create your own if you want
const sprites = {};
// Chainable `add` to enqueue a resource
loader.add('bunny', 'data/bunny.png')
.add('spaceship', 'assets/spritesheet.json');
loader.add('scoreFont', 'assets/score.fnt');
// Chainable `pre` to add a middleware that runs for each resource, *before* loading that resource.
// This is useful to implement custom caching modules (using filesystem, indexeddb, memory, etc).
loader.pre(cachingMiddleware);
// Chainable `use` to add a middleware that runs for each resource, *after* loading that resource.
// This is useful to implement custom parsing modules (like spritesheet parsers, spine parser, etc).
loader.use(parsingMiddleware);
// The `load` method loads the queue of resources, and calls the passed in callback called once all
// resources have loaded.
loader.load((loader, resources) => {
// resources is an object where the key is the name of the resource loaded and the value is the resource object.
// They have a couple default properties:
// - `url`: The URL that the resource was loaded from
// - `error`: The error that happened when trying to load (if any)
// - `data`: The raw data that was loaded
// also may contain other properties based on the middleware that runs.
sprites.bunny = new PIXI.TilingSprite(resources.bunny.texture);
sprites.spaceship = new PIXI.TilingSprite(resources.spaceship.texture);
sprites.scoreFont = new PIXI.TilingSprite(resources.scoreFont.texture);
});
// throughout the process multiple signals can be dispatched.
loader.onProgress.add(() => {}); // called once per loaded/errored file
loader.onError.add(() => {}); // called once per errored file
loader.onLoad.add(() => {}); // called once per loaded file
loader.onComplete.add(() => {}); // called once when the queued resources all load.
Name | Type | Default | Description |
---|---|---|---|
baseUrl |
string | '' |
optional
The base url for all resources loaded by this loader. |
concurrency |
number | 10 |
optional
The number of resources to load concurrently. |
Extends
- module:resource-loader.ResourceLoader
Members
-
PIXI.Loader.shared PIXI.Loader static
-
A premade instance of the loader that can be used to load resources.
Methods
-
PIXI.Loader.registerPlugin (plugin)PIXI.Loader static
-
Adds a Loader plugin for the global shared loader and all new Loader instances created.
Name Type Description plugin
PIXI.Loader~LoaderPlugin The plugin to add
Returns:
Type Description PIXI.Loader Reference to PIXI.Loader for chaining
Type Definitions
-
Name Type Description resource
PIXI.LoaderResource next
function -
Plugin to be installed for handling specific Loader resources.
Properties:
Name Type Argument Description plugin.add
function <optional>
Function to call immediate after registering plugin.
plugin.pre
PIXI.Loader~loaderMiddleware <optional>
Middleware function to run before load, the arguments for this are
(resource, next)
plugin.use
PIXI.Loader~loaderMiddleware <optional>
Middleware function to run after load, the arguments for this are
(resource, next)