Phaser 3 API Documentation - Class: TextureManager

new TextureManager(game)

Parameters:

Name	Type	Description
`game`	Phaser.Game	The Phaser.Game instance this Texture Manager belongs to.

Since: 3.0.0
Source: src/textures/TextureManager.js (Line 27)

Extends

Phaser.Events.EventEmitter

Members

game :Phaser.Game

The Game that this TextureManager belongs to.

Type:

Phaser.Game

Since: 3.0.0
Source: src/textures/TextureManager.js (Line 54)

list :object

An object that has all of textures that Texture Manager creates. Textures are assigned to keys so we can access to any texture that this object has directly by key value without iteration.

Type:

object

Since: 3.0.0

Default Value:

{}

Source: src/textures/TextureManager.js (Line 72)

name :string

The name of this manager.

Type:

string

Since: 3.0.0
Source: src/textures/TextureManager.js (Line 63)

Methods

addAtlas(key, source, data [, dataSource])

Adds a new Texture Atlas to this Texture Manager. It can accept either JSON Array or JSON Hash formats, as exported by Texture Packer and similar software.

Parameters:

Name	Type	Argument	Description
`key`	string		The unique string-based key of the Texture.
`source`	HTMLImageElement		The source Image element.
`data`	object		The Texture Atlas data.
`dataSource`	HTMLImageElement \| HTMLCanvasElement \| Array.<HTMLImageElement> \| Array.<HTMLCanvasElement>	<optional>	An optional data Image element.

Since: 3.0.0
Source: src/textures/TextureManager.js (Line 584)

Returns:

The Texture that was created, or null if the key is already in use.

Type: Phaser.Textures.Texture

addAtlasJSONArray(key, source, data [, dataSource])

Adds a Texture Atlas to this Texture Manager. The frame data of the atlas must be stored in an Array within the JSON. This is known as a JSON Array in software such as Texture Packer.

Parameters:

Name	Type	Argument	Description
`key`	string		The unique string-based key of the Texture.
`source`	HTMLImageElement \| Array.<HTMLImageElement>		The source Image element/s.
`data`	object \| Array.<object>		The Texture Atlas data/s.
`dataSource`	HTMLImageElement \| HTMLCanvasElement \| Array.<HTMLImageElement> \| Array.<HTMLCanvasElement>	<optional>	An optional data Image element.

Since: 3.0.0
Source: src/textures/TextureManager.js (Line 611)

Fires:

Phaser.Textures.Events#event:ADD

Returns:

The Texture that was created, or null if the key is already in use.

Type: Phaser.Textures.Texture

addAtlasJSONHash(key, source, data [, dataSource])

Adds a Texture Atlas to this Texture Manager. The frame data of the atlas must be stored in an Object within the JSON. This is known as a JSON Hash in software such as Texture Packer.

Parameters:

Name	Type	Argument	Description
`key`	string		The unique string-based key of the Texture.
`source`	HTMLImageElement		The source Image element.
`data`	object		The Texture Atlas data.
`dataSource`	HTMLImageElement \| HTMLCanvasElement \| Array.<HTMLImageElement> \| Array.<HTMLCanvasElement>	<optional>	An optional data Image element.

Since: 3.0.0
Source: src/textures/TextureManager.js (Line 664)

Fires:

Phaser.Textures.Events#event:ADD

Returns:

The Texture that was created, or null if the key is already in use.

Type: Phaser.Textures.Texture

addAtlasXML(key, source, data [, dataSource])

Adds a Texture Atlas to this Texture Manager, where the atlas data is given in the XML format.

Parameters:

Name	Type	Argument	Description
`key`	string		The unique string-based key of the Texture.
`source`	HTMLImageElement		The source Image element.
`data`	object		The Texture Atlas XML data.
`dataSource`	HTMLImageElement \| HTMLCanvasElement \| Array.<HTMLImageElement> \| Array.<HTMLCanvasElement>	<optional>	An optional data Image element.

Since: 3.7.0
Source: src/textures/TextureManager.js (Line 711)

Fires:

Phaser.Textures.Events#event:ADD

Returns:

The Texture that was created, or null if the key is already in use.

Type: Phaser.Textures.Texture

addBase64(key, data)

Adds a new Texture to the Texture Manager created from the given Base64 encoded data.

It works by creating an Image DOM object, then setting the src attribute to the given base64 encoded data. As a result, the process is asynchronous by its nature, so be sure to listen for the events this method dispatches before using the texture.

Parameters:

Name	Type	Description
`key`	string	The unique string-based key of the Texture.
`data`	*	The Base64 encoded data.

Since: 3.0.0
Source: src/textures/TextureManager.js (Line 247)

Fires:

Returns:

This Texture Manager instance.

Type: Phaser.Textures.TextureManager

addCanvas(key, source [, skipCache])

Creates a new Canvas Texture object from an existing Canvas element and adds it to this Texture Manager, unless skipCache is true.

Parameters:

Name	Type	Argument	Default	Description
`key`	string			The unique string-based key of the Texture.
`source`	HTMLCanvasElement			The Canvas element to form the base of the new Texture.
`skipCache`	boolean	<optional>	false	Skip adding this Texture into the Cache?

Since: 3.0.0
Source: src/textures/TextureManager.js (Line 548)

Fires:

Phaser.Textures.Events#event:ADD

Returns:

The Canvas Texture that was created, or null if the key is already in use.

Type: Phaser.Textures.CanvasTexture

addGLTexture(key, glTexture [, width] [, height])

Takes a WebGL Texture and creates a Phaser Texture from it, which is added to the Texture Manager using the given key.

This allows you to then use the Texture as a normal texture for texture based Game Objects like Sprites.

If the width and height arguments are omitted, but the WebGL Texture was created by Phaser's WebGL Renderer and has glTexture.width and glTexture.height properties, these values will be used instead.

This is a WebGL only feature.

Parameters:

Name	Type	Argument	Description
`key`	string		The unique string-based key of the Texture.
`glTexture`	WebGLTexture		The source Render Texture.
`width`	number	<optional>	The new width of the Texture. Read from `glTexture.width` if omitted.
`height`	number	<optional>	The new height of the Texture. Read from `glTexture.height` if omitted.

Since: 3.19.0
Source: src/textures/TextureManager.js (Line 388)

Fires:

Phaser.Textures.Events#event:ADD

Returns:

The Texture that was created, or null if the key is already in use.

Type: Phaser.Textures.Texture

addImage(key, source [, dataSource])

Adds a new Texture to the Texture Manager created from the given Image element.

Parameters:

Name	Type	Argument	Description
`key`	string		The unique string-based key of the Texture.
`source`	HTMLImageElement		The source Image element.
`dataSource`	HTMLImageElement \| HTMLCanvasElement	<optional>	An optional data Image element.

Since: 3.0.0
Source: src/textures/TextureManager.js (Line 354)

Fires:

Phaser.Textures.Events#event:ADD

Returns:

The Texture that was created, or null if the key is already in use.

Type: Phaser.Textures.Texture

addListener(event, fn [, context])

Add a listener for a given event.

Parameters:

Name	Type	Argument	Default	Description
`event`	string \| symbol			The event name.
`fn`	function			The listener function.
`context`	*	<optional>	this	The context to invoke the listener with.

Since: 3.0.0

Inherited From:

Phaser.Events.EventEmitter#addListener

Source: src/events/EventEmitter.js (Line 111)

Returns:

this.

Type: Phaser.Textures.TextureManager

addRenderTexture(key, renderTexture)

Adds a Render Texture to the Texture Manager using the given key. This allows you to then use the Render Texture as a normal texture for texture based Game Objects like Sprites.

Parameters:

Name	Type	Description
`key`	string	The unique string-based key of the Texture.
`renderTexture`	Phaser.GameObjects.RenderTexture	The source Render Texture.

Since: 3.12.0
Source: src/textures/TextureManager.js (Line 428)

Fires:

Phaser.Textures.Events#event:ADD

Returns:

The Texture that was created, or null if the key is already in use.

Type: Phaser.Textures.Texture

addSpriteSheet(key, source, config)

Adds a Sprite Sheet to this Texture Manager.

In Phaser terminology a Sprite Sheet is a texture containing different frames, but each frame is the exact same size and cannot be trimmed or rotated.

Parameters:

Name	Type	Description
`key`	string	The unique string-based key of the Texture.
`source`	HTMLImageElement	The source Image element.
`config`	Phaser.Types.Textures.SpriteSheetConfig	The configuration object for this Sprite Sheet.

Since: 3.0.0
Source: src/textures/TextureManager.js (Line 783)

Fires:

Phaser.Textures.Events#event:ADD

Returns:

The Texture that was created, or null if the key is already in use.

Type: Phaser.Textures.Texture

addSpriteSheetFromAtlas(key, config)

Adds a Sprite Sheet to this Texture Manager, where the Sprite Sheet exists as a Frame within a Texture Atlas.

In Phaser terminology a Sprite Sheet is a texture containing different frames, but each frame is the exact same size and cannot be trimmed or rotated.

Parameters:

Name	Type	Description
`key`	string	The unique string-based key of the Texture.
`config`	Phaser.Types.Textures.SpriteSheetFromAtlasConfig	The configuration object for this Sprite Sheet.

Since: 3.0.0
Source: src/textures/TextureManager.js (Line 818)

Fires:

Phaser.Textures.Events#event:ADD

Returns:

The Texture that was created, or null if the key is already in use.

Type: Phaser.Textures.Texture

addUnityAtlas(key, source, data [, dataSource])

Adds a Unity Texture Atlas to this Texture Manager. The data must be in the form of a Unity YAML file.

Parameters:

Name	Type	Argument	Description
`key`	string		The unique string-based key of the Texture.
`source`	HTMLImageElement		The source Image element.
`data`	object		The Texture Atlas data.
`dataSource`	HTMLImageElement \| HTMLCanvasElement \| Array.<HTMLImageElement> \| Array.<HTMLCanvasElement>	<optional>	An optional data Image element.

Since: 3.0.0
Source: src/textures/TextureManager.js (Line 747)

Fires:

Phaser.Textures.Events#event:ADD

Returns:

The Texture that was created, or null if the key is already in use.

Type: Phaser.Textures.Texture

checkKey(key)

Checks the given texture key and throws a console.warn if the key is already in use, then returns false. If you wish to avoid the console.warn then use TextureManager.exists instead.

Parameters:

Name	Type	Description
`key`	string	The texture key to check.

Since: 3.7.0
Source: src/textures/TextureManager.js (Line 160)

Returns:

true if it's safe to use the texture key, otherwise false.

Type: boolean

cloneFrame(key, frame)

Takes a Texture key and Frame name and returns a clone of that Frame if found.

Parameters:

Name	Type	Description
`key`	string	The unique string-based key of the Texture.
`frame`	string \| number	The string or index of the Frame to be cloned.

Since: 3.0.0
Source: src/textures/TextureManager.js (Line 947)

Returns:

A Clone of the given Frame.

Type: Phaser.Textures.Frame

create(key, source, width, height)

Creates a new Texture using the given source and dimensions.

Parameters:

Name	Type	Description
`key`	string	The unique string-based key of the Texture.
`source`	HTMLImageElement	The source Image element.
`width`	number	The width of the Texture.
`height`	number	The height of the Texture.

Since: 3.0.0
Source: src/textures/TextureManager.js (Line 871)

Returns:

The Texture that was created, or null if the key is already in use.

Type: Phaser.Textures.Texture

createCanvas(key [, width] [, height])

Creates a new Texture using a blank Canvas element of the size given.

Canvas elements are automatically pooled and calling this method will extract a free canvas from the CanvasPool, or create one if none are available.

Parameters:

Name	Type	Argument	Default	Description
`key`	string			The unique string-based key of the Texture.
`width`	number	<optional>	256	The width of the Canvas element.
`height`	number	<optional>	256	The height of the Canvas element.

Since: 3.0.0
Source: src/textures/TextureManager.js (Line 518)

Returns:

The Canvas Texture that was created, or null if the key is already in use.

Type: Phaser.Textures.CanvasTexture

destroy()

Destroys the Texture Manager and all Textures stored within it.

Since: 3.0.0

Overrides:

Phaser.Events.EventEmitter#destroy

Source: src/textures/TextureManager.js (Line 1187)

each(callback, scope [, args])

Passes all Textures to the given callback.

Parameters:

Name	Type	Argument	Description
`callback`	EachTextureCallback		The callback function to be sent the Textures.
`scope`	object		The value to use as `this` when executing the callback.
`args`	*	<optional> <repeatable>	Additional arguments that will be passed to the callback, after the child.

Since: 3.0.0
Source: src/textures/TextureManager.js (Line 1160)

emit(event [, args])

Calls each of the listeners registered for a given event.

Parameters:

Name	Type	Argument	Description
`event`	string \| symbol		The event name.
`args`	*	<optional> <repeatable>	Additional arguments that will be passed to the event handler.

Since: 3.0.0

Inherited From:

Phaser.Events.EventEmitter#emit

Source: src/events/EventEmitter.js (Line 86)

Returns:

true if the event had listeners, else false.

Type: boolean

eventNames()

Return an array listing the events for which the emitter has registered listeners.

Since: 3.0.0

Inherited From:

Phaser.Events.EventEmitter#eventNames

Source: src/events/EventEmitter.js (Line 55)

Returns:

Type: Array.<(string|symbol)>

exists(key)

Checks the given key to see if a Texture using it exists within this Texture Manager.

Parameters:

Name	Type	Description
`key`	string	The unique string-based key of the Texture.

Since: 3.0.0
Source: src/textures/TextureManager.js (Line 898)

Returns:

Returns true if a Texture matching the given key exists in this Texture Manager.

Type: boolean

generate(key, config)

Creates a new Texture using the given config values.

Generated textures consist of a Canvas element to which the texture data is drawn.

Generates a texture based on the given Create configuration object.

The texture is drawn using a fixed-size indexed palette of 16 colors, where the hex value in the data cells map to a single color. For example, if the texture config looked like this:

var star = [
  '.....828.....',
  '....72227....',
  '....82228....',
  '...7222227...',
  '2222222222222',
  '8222222222228',
  '.72222222227.',
  '..787777787..',
  '..877777778..',
  '.78778887787.',
  '.27887.78872.',
  '.787.....787.'
];

this.textures.generate('star', { data: star, pixelWidth: 4 });

Then it would generate a texture that is 52 x 48 pixels in size, because each cell of the data array represents 1 pixel multiplied by the pixelWidth value. The cell values, such as 8, maps to color number 8 in the palette. If a cell contains a period character . then it is transparent.

The default palette is Arne16, but you can specify your own using the palette property.

Parameters:

Name	Type	Description
`key`	string	The unique string-based key of the Texture.
`config`	Phaser.Types.Create.GenerateTextureConfig	The configuration object needed to generate the texture.

Since: 3.0.0
Source: src/textures/TextureManager.js (Line 457)

Returns:

The Texture that was created, or null if the key is already in use.

Type: Phaser.Textures.Texture

get(key)

Returns a Texture from the Texture Manager that matches the given key.

If the key is undefined it will return the __DEFAULT Texture.

If the key is an instance of a Texture, it will return the key directly.

Finally. if the key is given, but not found and not a Texture instance, it will return the __MISSING Texture.

Parameters:

Name	Type	Description
`key`	string \| Phaser.Textures.Texture	The unique string-based key of the Texture, or a Texture instance.

Since: 3.0.0
Source: src/textures/TextureManager.js (Line 913)

Returns:

The Texture that was created.

Type: Phaser.Textures.Texture

getBase64(key [, frame] [, type] [, encoderOptions])

Gets an existing texture frame and converts it into a base64 encoded image and returns the base64 data.

You can also provide the image type and encoder options.

This will only work with bitmap based texture frames, such as those created from Texture Atlases. It will not work with GL Texture objects, such as Shaders, or Render Textures. For those please see the WebGL Snapshot function instead.

Parameters:

Name	Type	Argument	Default	Description
`key`	string			The unique string-based key of the Texture.
`frame`	string \| number	<optional>		The string-based name, or integer based index, of the Frame to get from the Texture.
`type`	string	<optional>	'image/png'	A DOMString indicating the image format. The default format type is image/png.
`encoderOptions`	number	<optional>	0.92	A Number between 0 and 1 indicating the image quality to use for image formats that use lossy compression such as image/jpeg and image/webp. If this argument is anything else, the default value for image quality is used. The default value is 0.92. Other arguments are ignored.

Since: 3.12.0
Source: src/textures/TextureManager.js (Line 295)

Returns:

The base64 encoded data, or an empty string if the texture frame could not be found.

Type: string

getFrame(key [, frame])

Takes a Texture key and Frame name and returns a reference to that Frame, if found.

Parameters:

Name	Type	Argument	Description
`key`	string		The unique string-based key of the Texture.
`frame`	string \| number	<optional>	The string-based name, or integer based index, of the Frame to get from the Texture.

Since: 3.0.0
Source: src/textures/TextureManager.js (Line 966)

Returns:

A Texture Frame object.

Type: Phaser.Textures.Frame

getPixel(x, y, key [, frame])

Given a Texture and an x and y coordinate this method will return a new Color object that has been populated with the color and alpha values of the pixel at that location in the Texture.

Parameters:

Name	Type	Argument	Description
`x`	number		The x coordinate of the pixel within the Texture.
`y`	number		The y coordinate of the pixel within the Texture.
`key`	string		The unique string-based key of the Texture.
`frame`	string \| number	<optional>	The string or index of the Frame.

Since: 3.0.0
Source: src/textures/TextureManager.js (Line 1009)

Returns:

A Color object populated with the color values of the requested pixel, or null if the coordinates were out of bounds.

Type: Phaser.Display.Color

getPixelAlpha(x, y, key [, frame])

Given a Texture and an x and y coordinate this method will return a value between 0 and 255 corresponding to the alpha value of the pixel at that location in the Texture. If the coordinate is out of bounds it will return null.

Parameters:

Name	Type	Argument	Description
`x`	number		The x coordinate of the pixel within the Texture.
`y`	number		The y coordinate of the pixel within the Texture.
`key`	string		The unique string-based key of the Texture.
`frame`	string \| number	<optional>	The string or index of the Frame.

Since: 3.10.0
Source: src/textures/TextureManager.js (Line 1056)

Returns:

A value between 0 and 255, or null if the coordinates were out of bounds.

Type: number

getTextureKeys()

Returns an array with all of the keys of all Textures in this Texture Manager. The output array will exclude the __DEFAULT and __MISSING keys.

Since: 3.0.0
Source: src/textures/TextureManager.js (Line 985)

Returns:

An array containing all of the Texture keys stored in this Texture Manager.

Type: Array.<string>

listenerCount(event)

Return the number of listeners listening to a given event.

Parameters:

Name	Type	Description
`event`	string \| symbol	The event name.

Since: 3.0.0

Inherited From:

Phaser.Events.EventEmitter#listenerCount

Source: src/events/EventEmitter.js (Line 75)

Returns:

The number of listeners.

Type: number

listeners(event)

Return the listeners registered for a given event.

Parameters:

Name	Type	Description
`event`	string \| symbol	The event name.

Since: 3.0.0

Inherited From:

Phaser.Events.EventEmitter#listeners

Source: src/events/EventEmitter.js (Line 64)

Returns:

The registered listeners.

Type: Array.<function()>

off(event [, fn] [, context] [, once])

Remove the listeners of a given event.

Parameters:

Name	Type	Argument	Description
`event`	string \| symbol		The event name.
`fn`	function	<optional>	Only remove the listeners that match this function.
`context`	*	<optional>	Only remove the listeners that have this context.
`once`	boolean	<optional>	Only remove one-time listeners.

Since: 3.0.0

Inherited From:

Phaser.Events.EventEmitter#off

Source: src/events/EventEmitter.js (Line 151)

Returns:

this.

Type: Phaser.Textures.TextureManager

on(event, fn [, context])

Add a listener for a given event.

Parameters:

Name	Type	Argument	Default	Description
`event`	string \| symbol			The event name.
`fn`	function			The listener function.
`context`	*	<optional>	this	The context to invoke the listener with.

Since: 3.0.0

Inherited From:

Phaser.Events.EventEmitter#on

Source: src/events/EventEmitter.js (Line 98)

Returns:

this.

Type: Phaser.Textures.TextureManager

once(event, fn [, context])

Add a one-time listener for a given event.

Parameters:

Name	Type	Argument	Default	Description
`event`	string \| symbol			The event name.
`fn`	function			The listener function.
`context`	*	<optional>	this	The context to invoke the listener with.

Since: 3.0.0

Inherited From:

Phaser.Events.EventEmitter#once

Source: src/events/EventEmitter.js (Line 124)

Returns:

this.

Type: Phaser.Textures.TextureManager

remove(key)

Removes a Texture from the Texture Manager and destroys it. This will immediately clear all references to it from the Texture Manager, and if it has one, destroy its WebGLTexture. This will emit a removetexture event.

Note: If you have any Game Objects still using this texture they will start throwing errors the next time they try to render. Make sure that removing the texture is the final step when clearing down to avoid this.

Parameters:

Name	Type	Description
`key`	string \| Phaser.Textures.Texture	The key of the Texture to remove, or a reference to it.

Since: 3.7.0
Source: src/textures/TextureManager.js (Line 184)

Fires:

Phaser.Textures.Events#event:REMOVE

Returns:

The Texture Manager.

Type: Phaser.Textures.TextureManager

removeAllListeners( [event])

Remove all listeners, or those of the specified event.

Parameters:

Name	Type	Argument	Description
`event`	string \| symbol	<optional>	The event name.

Since: 3.0.0

Inherited From:

Phaser.Events.EventEmitter#removeAllListeners

Source: src/events/EventEmitter.js (Line 165)

Returns:

this.

Type: Phaser.Textures.TextureManager

removeKey(key)

Removes a key from the Texture Manager but does not destroy the Texture that was using the key.

Parameters:

Name	Type	Description
`key`	string	The key to remove from the texture list.

Since: 3.17.0
Source: src/textures/TextureManager.js (Line 227)

Returns:

The Texture Manager.

Type: Phaser.Textures.TextureManager

removeListener(event [, fn] [, context] [, once])

Remove the listeners of a given event.

Parameters:

Name	Type	Argument	Description
`event`	string \| symbol		The event name.
`fn`	function	<optional>	Only remove the listeners that match this function.
`context`	*	<optional>	Only remove the listeners that have this context.
`once`	boolean	<optional>	Only remove one-time listeners.

Since: 3.0.0

Inherited From:

Phaser.Events.EventEmitter#removeListener

Source: src/events/EventEmitter.js (Line 137)

Returns:

this.

Type: Phaser.Textures.TextureManager

renameTexture(currentKey, newKey)

Changes the key being used by a Texture to the new key provided.

The old key is removed, allowing it to be re-used.

Game Objects are linked to Textures by a reference to the Texture object, so all existing references will be retained.

Parameters:

Name	Type	Description
`currentKey`	string	The current string-based key of the Texture you wish to rename.
`newKey`	string	The new unique string-based key to use for the Texture.

Since: 3.12.0
Source: src/textures/TextureManager.js (Line 1126)

Returns:

true if the Texture key was successfully renamed, otherwise false.

Type: boolean

setTexture(gameObject, key [, frame])

Sets the given Game Objects texture and frame properties so that it uses the Texture and Frame specified in the key and frame arguments to this method.

Parameters:

Name	Type	Argument	Description
`gameObject`	Phaser.GameObjects.GameObject		The Game Object the texture would be set on.
`key`	string		The unique string-based key of the Texture.
`frame`	string \| number	<optional>	The string or index of the Frame.

Since: 3.0.0
Source: src/textures/TextureManager.js (Line 1102)

Returns:

The Game Object the texture was set on.

Type: Phaser.GameObjects.GameObject

shutdown()

Removes all listeners.

Since: 3.0.0

Inherited From:

Phaser.Events.EventEmitter#shutdown

Source: src/events/EventEmitter.js (Line 31)