textureCache Class

Module: cc Parent Module: cc

cc.textureCache is a singleton object, it's the global cache for cc.Texture2D

Index

Methods

• description Description
• textureForKey Returns an already created texture. Returns null if the texture doesn't exist.
• getTextureForKey Returns an already created texture. Returns null if the texture doesn't exist.
• getTextureColors
• getAllTextures get all textures
• removeAllTextures

  Purges the dictionary of loaded textures.
  Call this method if you receive the "Memory Warning"
  In the short term: it will free some resources preventing your app from being killed
  In the medium term: it will allocate more resources
  In the long term: it will be the same

• removeTexture Deletes a texture from the cache given a texture.
• removeTextureForKey Deletes a texture from the cache given a its key name.
• addImage

  Returns a Texture2D object given an file image
  If the file image was not previously loaded, it will create a new Texture2D
  object and it will return it. It will use the filename as a key.
  Otherwise it will return a reference of a previously loaded image.
  Supported image extensions: .png, .jpg, .gif

• cacheImage Cache the image data.

Details

Methods

description

Description

textureForKey

Returns an already created texture. Returns null if the texture doesn't exist.

Parameters

• textureKeyName String

Examples

------------------
var key = cc.textureCache.textureForKey("hello.png");

getTextureForKey

Returns an already created texture. Returns null if the texture doesn't exist.

Parameters

• textureKeyName String

Examples

------------------
var key = cc.textureCache.getTextureForKey("hello.png");

getTextureColors

Parameters

• texture HTMLImageElement

Examples

---------------
var cacheTextureForColor = cc.textureCache.getTextureColors(texture);

getAllTextures

get all textures

removeAllTextures

Purges the dictionary of loaded textures.
Call this method if you receive the "Memory Warning"
In the short term: it will free some resources preventing your app from being killed
In the medium term: it will allocate more resources
In the long term: it will be the same

Examples

--------
cc.textureCache.removeAllTextures();

removeTexture

Deletes a texture from the cache given a texture.

Parameters

• texture HTMLImageElement

Examples

-----
cc.textureCache.removeTexture(texture);

removeTextureForKey

Deletes a texture from the cache given a its key name.

Parameters

• textureKeyName String

Examples

------
cc.textureCache.removeTexture("hello.png");

addImage

Returns a Texture2D object given an file image
If the file image was not previously loaded, it will create a new Texture2D
object and it will return it. It will use the filename as a key.
Otherwise it will return a reference of a previously loaded image.
Supported image extensions: .png, .jpg, .gif

Parameters

• url String
• cb Function
• target Object

Examples

----
cc.textureCache.addImage("hello.png");

cacheImage

Cache the image data.

Parameters

• path String
• texture HTMLImageElement | HTMLCanvasElement