ImageFile
A single Image File suitable for loading by the Loader.
These are created when you use the Phaser.Loader.LoaderPlugin#image method and are not typically created directly.
For documentation about what all the arguments and configuration options mean please see Phaser.Loader.LoaderPlugin#image.
Constructor
new ImageFile(loader, key, [url], [xhrSettings], [frameConfig])
Parameters
| name | type | optional | description |
|---|---|---|---|
| loader | Phaser.Loader.LoaderPlugin | No | A reference to the Loader that is responsible for this file. |
| key | string | Phaser.Types.Loader.FileTypes.ImageFileConfig | No | The key to use for this file, or a file configuration object. |
| url | string | Array.<string> | Yes | The absolute or relative URL to load this file from. If undefined or null it will be set to <key>.png, i.e. if key was "alien" then the URL will be "alien.png". |
| xhrSettings | Phaser.Types.Loader.XHRSettingsObject | Yes | Extra XHR Settings specifically for this file. |
| frameConfig | Phaser.Types.Loader.FileTypes.ImageFrameConfig | Yes | The frame configuration object. Only provided for, and used by, Sprite Sheets. |
Scope: static
Extends
Source: src/loader/filetypes/ImageFile.js#L15
Since: 3.0.0
Inherited Methods
From Phaser.Loader.File:
- destroy
- hasCacheConflict
- load
- onBase64Load
- onError
- onLoad
- onProcessComplete
- onProcessError
- onProgress
- pendingDestroy
- resetXHR
- setLink
Public Methods
addToCache
<instance> addToCache()
Description:
Adds this file to the Texture Manager upon successful loading and processing.
If this image has a linked normal map file, the method waits until both files have completed loading before adding them together as a pair via cache.addImage. If no normal map is present, the image is added to the Texture Manager on its own.
Overrides: Phaser.Loader.File#addToCache
Source: src/loader/filetypes/ImageFile.js#L192
Since: 3.7.0
onProcess
<instance> onProcess()
Description:
Called automatically by Loader.nextFile as part of the XHR loading path. Creates an HTMLImageElement and assigns the XHR blob response as its source via an object URL, triggering the browser to decode the image. On success, calls onProcessComplete; on failure, calls onProcessError. This method is only used when images are loaded via XHR (the default). When loader.imageLoadType is set to "HTMLImageElement", the onProcessImage method is used instead.
Overrides: Phaser.Loader.File#onProcess
Source: src/loader/filetypes/ImageFile.js#L98
Since: 3.7.0
Inherited Members
From Phaser.Loader.File:
- base64
- bytesLoaded
- bytesTotal
- cache
- config
- crossOrigin
- data
- key
- linkFile
- loader
- multiFile
- percentComplete
- retryAttempts
- src
- state
- type
- url
- xhrLoader
- xhrSettings