Filter
A Texture Source is the encapsulation of the actual source data for a Texture.
This is typically an Image Element, loaded from the file system or network, a Canvas Element or a Video Element.
A Texture can contain multiple Texture Sources, which only happens when a multi-atlas is loaded.
Constructor:
new TextureSource(texture, source, [width], [height], [flipY])
Parameters:
| name | type | arguments | Default | description |
|---|---|---|---|---|
| texture | Phaser.Textures.Texture |
The Texture this TextureSource belongs to. |
||
| source | HTMLImageElement | HTMLCanvasElement | HTMLVideoElement | Phaser.GameObjects.RenderTexture | Phaser.Renderer.WebGL.Wrappers.WebGLTextureWrapper | Phaser.Textures.DynamicTexture | Phaser.Types.Textures.CompressedTextureData |
The source image data. |
||
| width | number | <optional> |
Optional width of the source image. If not given it's derived from the source itself. |
|
| height | number | <optional> |
Optional height of the source image. If not given it's derived from the source itself. |
|
| flipY | boolean | <optional> | false |
Sets the |
Members
Description:
Holds the compressed textured algorithm, or null if it's not a compressed texture.
Prior to Phaser 3.60 this value always held null.
Type:
Description:
Sets the UNPACK_FLIP_Y_WEBGL flag the WebGL Texture uses during upload.
Type:
Description:
The wrapped WebGL Texture of the source image. If this TextureSource is driven from a WebGLTexture already, then this wrapper contains a reference to that WebGLTexture.
Description:
The height of the source image. If not specified in the constructor it will check
the naturalHeight and then height properties of the source image.
Type:
Description:
The image data.
This is either an Image element, Canvas element, Video Element, or Uint8Array.
Type:
Description:
Is the source image a Canvas Element?
Type:
Description:
Is the source image a WebGLTextureWrapper?
Type:
Description:
Are the source image dimensions a power of two?
Type:
Description:
Is the source image a Render Texture?
Type:
Description:
Is the source image a Video Element?
Type:
Description:
A reference to the Canvas or WebGL Renderer.
Description:
The resolution of the source image.
Type:
Description:
The Scale Mode the image will use when rendering. Either Linear or Nearest.
Type:
Description:
The source of the image data.
This is either an Image Element, a Canvas Element, a Video Element, a RenderTexture or a WebGLTextureWrapper.
In Phaser 3.60 and above it can also be a Compressed Texture data object.
Type:
Description:
The Texture this TextureSource instance belongs to.
Type:
Description:
The width of the source image. If not specified in the constructor it will check
the naturalWidth and then width properties of the source image.
Type:
Methods
Description:
Destroys this Texture Source and nulls the references.
Description:
Creates a WebGL Texture, if required, and sets the Texture filter mode.
Parameters:
| name | type | description |
|---|---|---|
| game | Phaser.Game |
A reference to the Phaser Game instance. |
Description:
Sets the Filter Mode for this Texture.
The mode can be either Linear, the default, or Nearest.
For pixel-art you should use Nearest.
Parameters:
| name | type | description |
|---|---|---|
| filterMode | Phaser.Textures.FilterMode |
The Filter Mode. |
Description:
Sets the UNPACK_FLIP_Y_WEBGL flag for the WebGL Texture during texture upload.
Parameters:
| name | type | arguments | Default | description |
|---|---|---|---|---|
| value | boolean | <optional> | true |
Should the WebGL Texture be flipped on the Y axis on texture upload or not? |
Description:
If this TextureSource is backed by a Canvas and is running under WebGL, it updates the WebGLTexture using the canvas data.