Class cc.SpriteFrameCache

Defined in: CCSpriteFrameCache.js
Extends cc.Class

Class Summary
Constructor Attributes	Constructor Name and Description
	cc.SpriteFrameCache() Singleton that handles the loading of the sprite frames.

Method Summary

Method Attributes	Method Name and Description
	addSpriteFrame(frame, frameName) Adds an sprite frame with a given name.
	addSpriteFrames(filePath, texture) Adds multiple Sprite Frames from a plist or json file.
	ctor() Constructor
<static>	cc.SpriteFrameCache.getInstance() Returns the shared instance of the Sprite Frame cache
	getSpriteFrame(name) Returns an Sprite Frame that was previously added.
<static>	cc.SpriteFrameCache.purgeSharedSpriteFrameCache() Purges the cache.
	removeSpriteFrameByName(name) Deletes an sprite frame from the sprite frame cache.
	removeSpriteFrames() Purges the dictionary of loaded sprite frames.
	removeSpriteFramesFromFile(plist) Removes multiple Sprite Frames from a plist file.
	removeSpriteFramesFromTexture(texture) Removes all Sprite Frames associated with the specified textures.

Class Detail

cc.SpriteFrameCache()

Singleton that handles the loading of the sprite frames. It saves in a cache the sprite frames.

// add SpriteFrames to SpriteFrameCache With File
cc.SpriteFrameCache.getInstance().addSpriteFrames(s_grossiniPlist);

Method Detail

addSpriteFrame(frame, frameName)

Adds an sprite frame with a given name.
If the name already exists, then the contents of the old name will be replaced with the new one.

Parameters:

{cc.SpriteFrame} frame

{String} frameName
addSpriteFrames(filePath, texture)

Adds multiple Sprite Frames from a plist or json file.
A texture will be loaded automatically. The texture name will composed by replacing the .plist or .json suffix with .png
If you want to use another texture, you should use the addSpriteFrames:texture method.
```
// add SpriteFrames to SpriteFrameCache With File
cc.SpriteFrameCache.getInstance().addSpriteFrames(s_grossiniPlist);
cc.SpriteFrameCache.getInstance().addSpriteFrames(s_grossiniJson);
```
Parameters:

{String} filePath

file path

{HTMLImageElement|cc.Texture2D|string} texture
ctor()

Constructor
<static> {cc.SpriteFrameCache} cc.SpriteFrameCache.getInstance()

Returns the shared instance of the Sprite Frame cache

Returns:

{cc.SpriteFrameCache}
{cc.SpriteFrame} getSpriteFrame(name)

Returns an Sprite Frame that was previously added.
If the name is not found it will return nil.
You should retain the returned copy if you are going to use it.
```
//get a SpriteFrame by name
var frame = cc.SpriteFrameCache.getInstance().getSpriteFrame("grossini_dance_01.png");
```
Parameters:

{String} name

name of SpriteFrame

Returns:

{cc.SpriteFrame}
<static> cc.SpriteFrameCache.purgeSharedSpriteFrameCache()

Purges the cache. It releases all the Sprite Frames and the retained instance.
removeSpriteFrameByName(name)

Deletes an sprite frame from the sprite frame cache.

Parameters:

{String} name
removeSpriteFrames()

Purges the dictionary of loaded sprite frames.
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.
removeSpriteFramesFromFile(plist)

Removes multiple Sprite Frames from a plist file.
Sprite Frames stored in this file will be removed.
It is convinient to call this method when a specific texture needs to be removed.

Parameters:

{String} plist

plist filename
removeSpriteFramesFromTexture(texture)

Removes all Sprite Frames associated with the specified textures.
It is convinient to call this method when a specific texture needs to be removed.

Parameters:

{HTMLImageElement|HTMLCanvasElement|cc.Texture2D} texture