GLSLFile
A single GLSL File suitable for loading by the Loader.
GLSL (OpenGL Shading Language) files contain shader source code used by the WebGL renderer to create custom visual effects. Once loaded, the raw GLSL source is wrapped in a BaseShader instance and stored in the global Shader Cache, where it can be retrieved and applied to Game Objects that support custom shaders, such as those using the Phaser.GameObjects.Shader class.
These are created when you use the Phaser.Loader.LoaderPlugin#glsl method and are not typically created directly.
For documentation about what all the arguments and configuration options mean please see Phaser.Loader.LoaderPlugin#glsl.
Constructor
new GLSLFile(loader, key, [url], [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.GLSLFileConfig | 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>.glsl, i.e. if key was "alien" then the URL will be "alien.glsl". |
| xhrSettings | Phaser.Types.Loader.XHRSettingsObject | Yes | Extra XHR Settings specifically for this file. |
Scope: static
Extends
Source: src/loader/filetypes/GLSLFile.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 its target cache upon successful loading and processing. The raw GLSL source string is wrapped in a new BaseShader instance and stored in the global Shader Cache under this file's key, making it available for use with shader-enabled Game Objects.
Overrides: Phaser.Loader.File#addToCache
Source: src/loader/filetypes/GLSLFile.js#L90
Since: 3.17.0
onProcess
<instance> onProcess()
Description:
Called automatically by Loader.nextFile. This method reads the raw GLSL source text from the completed XHR response and stores it in this.data, then immediately signals that processing is complete. No further parsing or transformation is performed at this stage; the source is stored as-is until addToCache runs.
Overrides: Phaser.Loader.File#onProcess
Source: src/loader/filetypes/GLSLFile.js#L72
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