HTMLTextureFile
An HTML Texture File suitable for loading by the Loader. This file type loads an HTML file from the server, wraps its contents inside an SVG foreignObject element sized to the specified width and height, converts the SVG to a Blob URL, and then renders it as an Image element. The resulting image is stored in the Texture Manager and can be used as a texture by any Game Object that accepts a texture key.
These are created when you use the Phaser.Loader.LoaderPlugin#htmlTexture method and are not typically created directly.
For documentation about what all the arguments and configuration options mean please see Phaser.Loader.LoaderPlugin#htmlTexture.
Constructor
new HTMLTextureFile(loader, key, [url], [width], [height], [xhrSettings])
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.HTMLTextureFileConfig | No | The key to use for this file, or a file configuration object. |
| url | string | Yes | The absolute or relative URL to load this file from. If undefined or null it will be set to <key>.html, i.e. if key was "alien" then the URL will be "alien.html". |
| width | number | Yes | The width of the texture the HTML will be rendered to. |
| height | number | Yes | The height of the texture the HTML will be rendered to. |
| xhrSettings | Phaser.Types.Loader.XHRSettingsObject | Yes | Extra XHR Settings specifically for this file. |
Scope: static
Extends
Source: src/loader/filetypes/HTMLTextureFile.js#L14
Since: 3.12.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 its target cache upon successful loading and processing.
Overrides: Phaser.Loader.File#addToCache
Source: src/loader/filetypes/HTMLTextureFile.js#L145
Since: 3.7.0
onProcess
<instance> onProcess()
Description:
Called automatically by Loader.nextFile. Processes the loaded HTML content by wrapping it inside an SVG foreignObject element sized to the configured width and height. The SVG markup is then converted to a window.Blob, which is assigned as an object URL to a new Image element. Once the Image loads successfully, the file transitions to the completed state and is ready to be added to the Texture Manager. If Blob creation or Image loading fails, the file is marked as errored.
Overrides: Phaser.Loader.File#onProcess
Source: src/loader/filetypes/HTMLTextureFile.js#L80
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