SVGFile
A single SVG File suitable for loading by the Loader.
SVG files are loaded as text, optionally resized according to a width, height, or scale factor, then rasterized to a bitmap image and stored in the Texture Manager. Once loaded, the resulting texture can be used by any Game Object that accepts a texture key, just like a PNG or JPEG image.
These are created when you use the Phaser.Loader.LoaderPlugin#svg method and are not typically created directly.
For documentation about what all the arguments and configuration options mean please see Phaser.Loader.LoaderPlugin#svg.
Constructor
new SVGFile(loader, key, [url], [svgConfig], [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.SVGFileConfig | 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>.svg, i.e. if key was "alien" then the URL will be "alien.svg". |
| svgConfig | Phaser.Types.Loader.FileTypes.SVGSizeConfig | Yes | The svg size configuration object. |
| xhrSettings | Phaser.Types.Loader.XHRSettingsObject | Yes | Extra XHR Settings specifically for this file. |
Scope: static
Extends
Source: src/loader/filetypes/SVGFile.js#L14
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 its target cache upon successful loading and processing.
Overrides: Phaser.Loader.File#addToCache
Source: src/loader/filetypes/SVGFile.js#L189
Since: 3.7.0
onProcess
<instance> onProcess()
Description:
Called automatically by Loader.nextFile. This method parses the raw SVG text response, optionally resizes the SVG by modifying its width, height, or viewBox attributes according to the file's svgConfig, then serializes the result into a Blob and loads it into an HTMLImageElement. On browsers that do not support object URLs (such as older versions of Safari), it falls back to a data URI. Once the image has loaded, onProcessComplete is called to finalize the file.
Overrides: Phaser.Loader.File#onProcess
Source: src/loader/filetypes/SVGFile.js#L77
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