CCTextureCache Class Reference

#import <CCTextureCache.h>

List of all members.

Public Member Functions
(CCTexture2D *)	- addImage:
(void)	- addImageAsync:target:selector:
(void)	- addImageAsync:withBlock:
(CCTexture2D *)	- addCGImage:forKey:
(CCTexture2D *)	- textureForKey:
(void)	- removeAllTextures
(void)	- removeUnusedTextures
(void)	- removeTexture:
(void)	- removeTextureForKey:
(void)	- dumpCachedTextureInfo
(CCTexture2D *)	- addPVRImage:
Static Public Member Functions
(CCTextureCache *)	+ sharedTextureCache
(void)	+ purgeSharedTextureCache
Protected Attributes
NSMutableDictionary *	_textures
dispatch_queue_t	_loadingQueue
dispatch_queue_t	_dictQueue

---

Detailed Description

Singleton that handles the loading of textures Once the texture is loaded, the next time it will return a reference of the previously loaded texture reducing GPU & CPU memory

---

Member Function Documentation

- (CCTexture2D*) addCGImage:		(CGImageRef)	image
forKey:		(NSString *)	key

Returns a Texture2D object given an CGImageRef image If the image was not previously loaded, it will create a new CCTexture2D object and it will return it. Otherwise it will return a reference of a previously loaded image The "key" parameter will be used as the "key" for the cache. If "key" is nil, then a new texture will be created each time.

Since:

v0.8

- (CCTexture2D*) addImage:

(NSString *)

fileimage

Returns a Texture2D object given an file image If the file image was not previously loaded, it will create a new CCTexture2D 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, .bmp, .tiff, .jpeg, .pvr, .gif

- (void) addImageAsync:		(NSString *)	filename
target:		(id)	target
selector:		(SEL)	selector

Asynchronously, load a texture2d from a file. If the file image was previously loaded, it will use it. Otherwise it will load a texture in a new thread, and when the image is loaded, the callback will be called with the Texture2D as a parameter. The callback will be called in the cocos2d thread, so it is safe to create any cocos2d object from the callback. Supported image extensions: .png, .bmp, .tiff, .jpeg, .pvr, .gif

Since:

v0.8

- (void) addImageAsync:		(NSString *)	filename
withBlock:		(CCTexture2D *tex)	block

Asynchronously, load a texture2d from a file. If the file image was previously loaded, it will use it. Otherwise it will load a texture in a new thread, and when the image is loaded, the block will be called. The callback will be called in the cocos2d thread, so it is safe to create any cocos2d object from the callback. Supported image extensions: .png, .bmp, .tiff, .jpeg, .pvr, .gif

Since:

v2.0

- (CCTexture2D*) addPVRImage:

(NSString *)

filename

Returns a Texture2D object given an PVR filename. If the file image was not previously loaded, it will create a new CCTexture2D object and it will return it. Otherwise it will return a reference of a previously loaded image

- (void) dumpCachedTextureInfo

Output to CCLOG the current contents of this CCTextureCache This will attempt to calculate the size of each texture, and the total texture memory in use

Since:

v1.0

+ (void) purgeSharedTextureCache

purges the cache. It releases the retained instance.

Since:

v0.99.0

- (void) 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

- (void) removeTexture:

(CCTexture2D *)

tex

Deletes a texture from the cache given a texture

- (void) removeTextureForKey:

(NSString *)

textureKeyName

Deletes a texture from the cache given a its key name

Since:

v0.99.4

- (void) removeUnusedTextures

Removes unused textures Textures that have a retain count of 1 will be deleted It is convenient to call this method after when starting a new Scene

Since:

v0.8

+ (CCTextureCache *) sharedTextureCache

Retruns ths shared instance of the cache

- (CCTexture2D *) textureForKey:

(NSString *)

key

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

Since:

v0.99.5

---

The documentation for this class was generated from the following file:

• CCTextureCache.h