Cocos2d-x 3.x基础学习:三种缓存类
Cocos引擎主要有三种缓存类,分别是纹理缓存、精灵帧缓存和动画缓存,具体如下:
- 纹理缓存:TextureCache
- 精灵帧缓存:SpriteFrameCache
- 动画缓存:AnimationCache
缓存的目的是先将所需资源(如纹理图片)加载到内存中,之后再次使用该资源时,可直接从内存中取出,无需重新加载,从而减少CPU和GPU的内存占用。
本文对参考文献的内容进行了整理与整合,并加入了一些个人观点。
【TextureCache】
1. 概述
在游戏中,加载大量纹理图片的操作十分耗费内存和资源。例如,当游戏中的某个界面使用了大量图片时,首次进入该界面的速度会非常慢(因为需要加载和绘制大量图片),甚至会出现卡顿现象。此时,我们可以使用TextureCache提前异步加载纹理,待加载完成后再进入该界面使用这些图片,速度就会大幅提升。
- Texture2D(纹理):指图片加载到内存后,供CPU和GPU操作的贴图对象。
- TextureCache(纹理缓存):用于加载和管理纹理。一旦纹理加载完成,下次使用时可通过它返回之前加载的纹理,从而减少对GPU和CPU内存的占用。
当创建一个精灵Sprite时,通常会使用Sprite::create(fileName)方法。查看Sprite::create(fileName)的实现代码,会发现它将图片添加到了纹理缓存中,具体代码如下:
Sprite* Sprite::create(const std::string& filename)
{
Sprite *sprite = new Sprite();
if (sprite && sprite->initWithFile(filename))
{
sprite->autorelease();
return sprite;
}
_SAFE_DELETE(sprite);
return nullptr;
}
bool Sprite::initWithFile(const std::string& filename)
{
ASSERT(filename.size()>0, "Invalid filename for sprite");
// 加载filename的纹理图片
Texture2D *texture = Director::getInstance()->getTextureCache()->addImage(filename);
if (texture)
{
Rect rect = Rect::ZERO;
rect.size = texture->getContentSize();
return initWithTexture(texture, rect);
}
return false;
}
2. 获取TextureCache
在3.x版本中,TextureCache不再作为单例模式使用,而是作为Director的成员变量,可通过以下方式获取:
Director::getInstance()->getTextureCache();
3. 纹理的加载与获取
如果文件名之前未被加载,会创建一个新的Texture2D对象并返回;若已加载,则返回对先前加载图像的引用。
- addImage:该函数会返回一个纹理
Texture2D的引用,可能是新加载到内存的,也可能是之前已经存在的。 - getTextureForKey:获得该key所对应的纹理缓存,若该Key对应的纹理不存在,则返回
nullptr。 - 支持的图片格式:
.png、.bmp、.tiff、.jpeg、.pvr。
示例代码如下:
// addImage 加载纹理图片
// 支持图片格式: .png, .bmp, .tiff, .jpeg, .pvr
Texture2D *texture = Director::getInstance()->getTextureCache()->addImage(filename);
// getTextureForKey 获取纹理图片
Texture2D *texture = Director::getInstance()->getTextureCache()->getTextureForKey(textureKeyName);
4. 异步加载纹理
TextureCache类支持异步加载资源的功能,可使用addImageAsync方法。还可以为addImageAsync方法添加一个回调方法,以便在纹理异步加载结束时得到通知。
- 支持的图片格式:
.png、.jpg。 - 异步加载的优势:可以为loading场景增加一个进度条。
关键代码如下:
TextureCacheTest::TextureCacheTest()
: _numberOfSprites(20)
, _numberOfLoadedSprites(0)
{
auto size = Director::getInstance()->getWinSize();
_labelLoading = Label::createWithTTF("loading...", "fonts/arial.ttf", 15);
_labelPercent = Label::createWithTTF("%0", "fonts/arial.ttf", 15);
_labelLoading->setPosition(Point(size.width / 2, size.height / 2 - 20));
_labelPercent->setPosition(Point(size.width / 2, size.height / 2 + 20));
this->addChild(_labelLoading);
this->addChild(_labelPercent);
// 异步加载纹理图片 addImageAsync
// 加载完纹理后,会执行回调函数
Director::getInstance()->getTextureCache()->addImageAsync("Images/HelloWorld.png", CC_CALLBACK_1(TextureCacheTest::loadingCallBack, this));
Director::getInstance()->getTextureCache()->addImageAsync("Images/grossini.png", CC_CALLBACK_1(TextureCacheTest::loadingCallBack, this));
Director::getInstance()->getTextureCache()->addImageAsync("Images/CloseNormal.png", CC_CALLBACK_1(TextureCacheTest::loadingCallBack, this));
// ...
}
// 异步加载的回调函数
void TextureCacheTest::loadingCallBack(cocos2d::Texture2D *texture)
{
++_numberOfLoadedSprites;
char tmp[10];
sprintf(tmp,"%%%d", (int)(((float)_numberOfLoadedSprites / _numberOfSprites) * 100));
_labelPercent->setString(tmp);
if (_numberOfLoadedSprites == _numberOfSprites)
{
this->removeChild(_labelLoading, true);
this->removeChild(_labelPercent, true);
addSprite();
}
}
5. 清理缓存
// 释放当前所有引用计数为1的纹理,即目前没有被使用的纹理。
// 比如新场景创建好后,使用此方法释放没有使用的纹理非常方便。
Director::getInstance()->getTextureCache()->removeUnusedTextures();
// 通过给定的纹理贴图(texture)的关键名(key name)从缓存中删除该纹理贴图
Director::getInstance()->getTextureCache()->removeTextureForKey("Images/grossinis.png");
// 清除加载纹理贴图的记录,如果你收到“内存警告”,请调用该方法。
// 在短期内 : 会释放一些资源文件来防止你的app出现闪退现象
// 在中期内 : 会分配更多资源
// 长远来看 : 没有区别
Director::getInstance()->getTextureCache()->removeAllTextures();
【SpriteFrameCache】
1. 概述
SpriteFrameCache主要用于处理多张碎图合并而成的纹理图片。这种纹理在一张大图中包含了多张小图,若直接通过TextureCache引用会有诸多不便,因此衍生出精灵框帧的处理方式,即将截取好的纹理信息保存在一个精灵框帧内,精灵通过切换不同的框帧来显示不同的图案。
SpriteFrameCache内部封装了一个Map _spriteFrames对象(其中key为帧的名称)。它一般用于处理plist文件(该文件指定了每个独立的精灵在这张“大图”里面的位置和大小),该文件对应一张包含多个精灵的大图,plist文件可以使用TexturePacker制作。
SpriteFrameCache的常用接口和TextureCache类似,需要注意的是,添加精灵帧时需要配套一个plist文件和一张大的纹理图。
2. 获取与销毁SpriteFrameCache
SpriteFrameCache是一个单例对象,获取方法与Director类似:
// 获取单例对象
SpriteFrameCache* cache = SpriteFrameCache::getInstance();
// 销毁单例对象
SpriteFrameCache::destroyInstance();
3. 精灵帧的加载与使用
通过addSpriteFramesWithFile方法加载plist文件,将plist文件中的多张小图加载到精灵帧缓存中。
// boy.png 里集合了boy1.png,boy2.png这些小图。
// 参数2 可不写
SpriteFrameCache *frameCache = SpriteFrameCache::getInstance();
frameCache->addSpriteFramesWithFile("boy.plist", "boy.png");
//从SpriteFrameCache缓存中找到boy1.png这张图片.
auto frame_sp = Sprite::createWithSpriteFrameName("boy1.png");
this->addChild(frame_sp, 2);
4. 清理缓存
// 从精灵帧缓存中删除一个精灵帧.
SpriteFrameCache::getInstance()->removeSpriteFrameByName(const std::string &name);
// 清除载入精灵帧的字典。如果接收到“Memory Warning”, 请调用这个方法。
// 就眼前来说 : 它将释放一些资源来阻止你的应用崩溃掉。
// 中期的角度 : 它将分配更多的资源。
// 从长远来说 : 它将变成相同的。
SpriteFrameCache::getInstance()->removeSpriteFrames();
// 从一个.plist文件移除多个精灵帧。即:存储在这个文件的精灵帧将被删除。
// 当某个特定的纹理需要被删除时候调用这个方法很方便。
SpriteFrameCache::getInstance()->removeSpriteFramesFromFile(const std::string &plist);
// 移除与特定的纹理结合的所有的精灵帧。
// 当某个特定的纹理需要被删除时候调用这个方法很方便。
SpriteFrameCache::getInstance()->removeSpriteFramesFromTexture(cocos2d::Texture2D *texture);
// 移除没用的精灵帧。保留数为1的精灵帧将被删除。
// 在开始一个新的场景之后调用这个方法很方便。
SpriteFrameCache::getInstance()->removeUnusedSpriteFrames();
5. SpriteFrameCache VS. TextureCache
- SpriteFrameCache(精灵框帧缓存):缓存的是精灵帧
SpriteFrame,主要服务于多张碎图合并出来的纹理图片(plist文件)。若内存池中不存在要查找的图片,它会提示找不到,而不会去本地加载图片。 - TextureCache(纹理缓存):是最底层也是最有效的纹理缓存,缓存的是加载到内存中的纹理资源,即图片资源。
- 关系:SpriteFrameCache是基于TextureCache的封装,缓存的是精灵帧,是纹理指定区域的矩形块。各精灵帧都在同一纹理中,通过切换不同的框帧来显示不同的图案。
【AnimationCache】
1. 概述
通常情况下,创建一个精灵动画时,每次都需要加载精灵帧,然后按顺序添加到数组,再用Animation读取数组创建动画,这是一个非常繁琐的计算过程。对于使用频率高的动画,如角色的走动、跳舞等,可以将其加入到AnimationCache中,每次使用时直接从这个缓存中调用,这样可以有效降低创建动画的巨大消耗。
将创建好的动画Animation直接放在动画缓存AnimationCache中,当需要执行动画动作时,直接从动画缓存中取出创建初始化Animation会非常方便。
2. 相关函数
AnimationCache是一个单例对象,可通过AnimationCache::getInstance()获取单例对象。其相关函数如下:
// 添加一个动画到缓存,命名为name。
// name - animation : 是一组 键-值对(key-value) 的关系。
void addAnimation(Animation *animation, const std::string& name);
// 添加动画的plist文件到缓存
void addAnimationsWithFile(const std::string& plist);
// 获得指定名称为name的动画
Animation* getAnimation(const std::string& name);
// 移除一个指定的动画
void removeAnimation(const std::string& name);
3. 使用举例
// 动画命名为 Explosion,加入到动画缓存中
Animation* animation = Animation::createWithSpriteFrames(arr, 0.04);
AnimationCache::getInstance()->addAnimation(animation, "Explosion");
// 直接从动画缓存中取出 "Explosion" 动画
Animation* animation = AnimationCache::getInstance()->getAnimation("Explosion");
【清理顺序】
值得注意的是清理缓存的顺序,我们推荐的清理顺序如下:
- 首先清理动画缓存
AnimationCache。 - 然后清理精灵帧缓存
SpriteFrameCache。 - 最后清理纹理缓存
TextureCache。
按照引用层级由高到低的顺序清理,以保证释放引用有效。