Class cc.SpriteFrameCache
Extends
cc.Class.
Defined in: CCSpriteFrameCache.js.
Constructor Attributes | Constructor Name and Description |
---|---|
Singleton that handles the loading of the sprite frames.
|
Method Attributes | Method Name and Description |
---|---|
addSpriteFrame(frame, frameName)
Adds an sprite frame with a given name. |
|
addSpriteFrames(plist, texture)
Adds multiple Sprite Frames from a plist file. |
|
addSpriteFramesWithJson(jsonData)
Adds multiple Sprite Frames from a 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.
|
|
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. |
// add SpriteFrames to SpriteFrameCache With File cc.SpriteFrameCache.getInstance().addSpriteFrames(s_grossiniPlist);
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
Adds multiple Sprite Frames from a plist file.
A texture will be loaded automatically. The texture name will composed by replacing the .plist 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);
- Parameters:
- {String} plist
- plist filename
- {HTMLImageElement|cc.Texture2D} texture
- Parameters:
- {object} jsonData
- Returns:
- {cc.SpriteFrameCache}
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}
- Parameters:
- {String} name
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.
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
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