Class TextureSource

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.

Index

Constructors

Properties

compressionAlgorithm flipY glTexture height image isCanvas isGLTexture isPowerOf2 isRenderTexture isVideo renderer resolution scaleMode source texture width

Methods

destroy init setFilter setFlipY update updateSize

Constructors

constructor

new TextureSource(
    texture: Textures.Texture,
    source:
        | WebGLTextureWrapper
        | HTMLImageElement
        | GameObjects.RenderTexture
        | HTMLCanvasElement
        | DynamicTexture
        | HTMLVideoElement
        | CompressedTextureData,
    width?: number,
    height?: number,
    flipY?: boolean,
): TextureSource
Parameters
- texture: Textures.Texture
  The Texture this TextureSource belongs to.
- source:
      | WebGLTextureWrapper
      | HTMLImageElement
      | GameObjects.RenderTexture
      | HTMLCanvasElement
      | DynamicTexture
      | HTMLVideoElement
      | CompressedTextureData
  The source image data.
- Optionalwidth: number
  Optional width of the source image. If not given it's derived from the source itself.
- Optionalheight: number
  Optional height of the source image. If not given it's derived from the source itself.
- OptionalflipY: boolean
  Sets the UNPACK_FLIP_Y_WEBGL flag the WebGL Texture uses during upload. Default true.
Returns TextureSource
- Defined in types/phaser.d.ts:109606

Properties

compressionAlgorithm

compressionAlgorithm: number

Holds the compressed textured algorithm, or null if it's not a compressed texture.

Prior to Phaser 3.60 this value always held null.

flipY

flipY: boolean

Sets the UNPACK_FLIP_Y_WEBGL flag the WebGL Texture uses during upload.

glTexture

glTexture: WebGLTextureWrapper

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.

height

height: number

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.

image

image:
    | HTMLImageElement
    | HTMLCanvasElement
    | HTMLVideoElement
    | Uint8Array<ArrayBufferLike>

The image data.

This is either an Image element, Canvas element, Video Element, or Uint8Array.

isCanvas

isCanvas: boolean

Is the source image a Canvas Element?

isGLTexture

isGLTexture: boolean

Is the source image a WebGLTextureWrapper?

isPowerOf2

isPowerOf2: boolean

Are the source image dimensions a power of two?

isRenderTexture

isRenderTexture: boolean

Is the source image a Render Texture?

isVideo

isVideo: boolean

Is the source image a Video Element?

renderer

renderer: WebGLRenderer | CanvasRenderer

A reference to the Canvas or WebGL Renderer.

resolution

resolution: number

The resolution of the source image.

scaleMode

scaleMode: number

The Scale Mode the image will use when rendering. Either Linear or Nearest.

source

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.

texture

texture: Textures.Texture

The Texture this TextureSource instance belongs to.

width

width: number

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.

Methods

destroy

destroy(): void
Destroys this Texture Source and nulls the references.

Returns void
- Defined in types/phaser.d.ts:109741

init

init(game: Game): void
Creates a WebGL Texture, if required, and sets the Texture filter mode.
Parameters
- game: Game
  A reference to the Phaser Game instance.
Returns void
- Defined in types/phaser.d.ts:109705

setFilter

setFilter(filterMode: FilterMode): void
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
- filterMode: FilterMode
  The Filter Mode.
Returns void
- Defined in types/phaser.d.ts:109715

setFlipY

setFlipY(value?: boolean): void
Sets the UNPACK_FLIP_Y_WEBGL flag for the WebGL Texture during texture upload.
Parameters
- Optionalvalue: boolean
  Should the WebGL Texture be flipped on the Y axis on texture upload or not? Default true.
Returns void
- Defined in types/phaser.d.ts:109721

update

update(): void
If this TextureSource is backed by a Canvas and is running under WebGL, it updates the WebGLTexture using the canvas data.

Returns void
- Defined in types/phaser.d.ts:109727

updateSize

updateSize(width: number, height: number): void
Updates the dimensions of this Texture Source. This is called automatically by game systems which manage textures, such as Text, which renders to a dedicated canvas that changes size.
Parameters
- width: number
  The new width of the source image.
- height: number
  The new height of the source image.
Returns void
- Defined in types/phaser.d.ts:109736

Class TextureSource

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns TextureSource

Properties

compressionAlgorithm

flipY

glTexture

height

image

isCanvas

isGLTexture

isPowerOf2

isRenderTexture

isVideo

renderer

resolution

scaleMode

source

texture

width

Methods

destroy

Returns void

init

Parameters

Returns void

setFilter

Parameters

Returns void

setFlipY

Parameters

Returns void

update

Returns void

updateSize

Parameters

Returns void

Settings

On This Page