Properly removing a spritesheet from BOTH TextureCache and SpriteFrameCache

cocos2d for iPhone » Programming » cocos2d internals

Properly removing a spritesheet from BOTH TextureCache and SpriteFrameCache

(7 posts) (4 voices)

Started 1 year ago by MikeSz
Latest reply from riq

Tags:

MikeSz
Member
I'm sure this must be really trivial but somehow I can't find the proper way ;)

So the situation is as follows:
1) I don't want to run into insufficient texture memory problems
2) Thus I create autoreleased scene for Tutorial
3) Tutorial should have a few full-screen images, some buttons, maybe some animations
a) Images for tutorial are completely separate from game images
4) I want to add tutorial images to a spriteframecache, so it's easier to use any animations etc
5) After checking tutorial - the scene should completely disappear from memory, including textures and spriteframes

Thus I do the following when creating a tutoial layer:
```
CCTexture2D * tex = [[CCTextureCache sharedTextureCache] addImage:@"tutorial_texture.png"];
[[CCSpriteFrameCache sharedSpriteFrameCache] addSpriteFramesWithFile:@"tutorial_texture.plist" texture:tex];
```
Pretty self explanatory - I add a texture to TextureCache and SpriteFrames to SpriteFrameCache

Now I create some sprites, animations, etc

After leaving the scene it is dealloced (autoreleased) but the texture and sprite frames stay in the caches

I hope all is clear till now ;)

Now the time to remove the textures... I tried the following methods in the onEnter scene of menuscene, after exiting the tutorial layer. This is correct place to do it, I already checked it

1) [[CCTextureCache sharedTextureCache] removeUnusedTextures]; - tutorial texture is NOT removed, because it is used in the sprite frames
2) [[CCTextureCache sharedTextureCache] removeTextureForKey:@"tutorial_texture.png"]; - again, NOT removed
3) `
[[CCSpriteFrameCache sharedSpriteFrameCache] removeUnusedSpriteFrames];
[[CCTextureCache sharedTextureCache] removeUnusedTextures];
`
sprite frames are released and so is the texture. BUT ! all the other unused sprite frames are also immediately released, obviously not something I would like...

So how should I do it really ? Note that I only want to remove one large texture and all sprite frames that refer to it, nothing more

There is a function to add spriteframes from .plist file for a specific texture -addSpriteFramesWithFile:(NSString*)plist texture:(CCTexture2D*)texture

I really think there should be additional function which would do the very reverse - removeSpriteFramesFromFile:(NSString*) plist
Posted 1 year ago #
cybergreg
Member

@MikeSz - I don't have an answer because I have wondered the exact same thing. So +1 to your question and lets hope someone can shed some light on this topic.

Cg

Posted 1 year ago #

You should first remove the spriteframes and then the texture, that should work. Also make sure that you don't retain them anywhere else in your code.

Besides the removeSpriteFramesFromFile, a removeSpriteFramesFromTexture(CCTexture2D*) texture would also be convenient.

Edit I had a few spare minutes..

- (void) removeSpriteFramesFromFile:(NSString*) plist
{
	NSString *path = [CCFileUtils fullPathFromRelativePath:plist];
	NSDictionary *dict = [NSDictionary dictionaryWithContentsOfFile:path];

	[self removeSpriteFramesFromDictionary:dict];
}

- (void) removeSpriteFramesFromDictionary:(NSDictionary*) dictionary
{
	NSDictionary *framesDict = [dictionary objectForKey:@"frames"];
	for(NSString *frameDictKey in framesDict)
	{
		@try
		{
			[spriteFrames removeObjectForKey:frameDictKey];
		}
		@catch (NSInvalidArgumentException  *exception)
		{//not found

		}
	}
}

- (void) removeSpriteFramesFromTexture:(CCTexture2D*) texture
{
	for (NSString *spriteFrameKey in spriteFrames)
	{
		if ([[spriteFrames valueForKey:sprteFrameKey] texture] == texture) [spriteFrames removeObjectForKey:spriteFrameKey];
	}
}

Code is not tested though.

Posted 1 year ago #

MikeSz
Member

I know the sprite frames need to be removed first, but there is no method in cocos2d to do it properly. You can either:

1) Remove frame by frame, but how do you know which frames are stored in the .plist file ? No access
2) Remove all unused frames, but that's absolutely not what we want to do

So I guess without methods like you posted that's not really possible to do ;)

Thanks for the code, I'll try to find the time to test it later :)

I'll write an issue about that with your code (if you agree that is) and let's hope it's gonna appear in .99.6 ;)

Posted 1 year ago #

araker
Moderator

Sure, open a issue. Something small like this could also be put in 0.99.5, but that is of course for Riq to decide.

The code doesn't work, removing in a loop is also a problem in a dictionary (I should have known). Here's the update..

- (void) removeSpriteFramesFromFile:(NSString*) plist
{
	NSString *path = [CCFileUtils fullPathFromRelativePath:plist];
	NSDictionary *dict = [NSDictionary dictionaryWithContentsOfFile:path];

	[self removeSpriteFramesFromDictionary:dict];
}

- (void) removeSpriteFramesFromDictionary:(NSDictionary*) dictionary
{
	NSDictionary *framesDict = [dictionary objectForKey:@"frames"];
        NSMutableArray *keysToRemove=[NSMutableArray array];

        for(NSString *frameDictKey in framesDict)
	{

		     if ([spriteFrames objectForKey:frameDictKey]!=nil) [keysToRemove addObject:spriteFrameKey];
	}
        [spriteFrames removeObjectsForKeys:keysToRemove];
}

- (void) removeSpriteFramesFromTexture:(CCTexture2D*) texture
{
        NSMutableArray *keysToRemove=[NSMutableArray array];
	for (NSString *spriteFrameKey in spriteFrames)
	{
		if ([[spriteFrames valueForKey:sprteFrameKey] texture] == texture) [keysToRemove addObject:spriteFrameKey];

	}
        [spriteFrames removeObjectsForKeys:keysToRemove];
}

Posted 1 year ago #

MikeSz
Member

ok, tested and it works :)

I have corrected some tiny errors (eg sprteFrameKey) that prevented the code from being compiled

Also added this for the .header file:

/** 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.
 */
- (void) removeSpriteFramesFromFile:(NSString*) plist;

/** Removes multiple Sprite Frames from NSDictionary.
 */
- (void) removeSpriteFramesFromDictionary:(NSDictionary*) dictionary;

/** Removes all Sprite Frames associated with the specified textures.
 * It is convinient to call this method when a specific texture needs to be removed.
 */
- (void) removeSpriteFramesFromTexture:(CCTexture2D*) texture;

Posting issue now:
http://code.google.com/p/cocos2d-iphone/issues/detail?id=953&colspec=ID%20Type%20Status%20Priority%20Milestone%20Component%20Owner%20Summary&start=100

Posted 1 year ago #

riq
Key Master

added to "develop" branch:
http://github.com/cocos2d/cocos2d-iphone/commit/984930a463dede7e7ee68f547fac66cb339ed0d7

Posted 1 year ago #

RSS feed for this topic

Reply

You must log in to post.