Cocos2d-x 3.0截屏功能汇总
在Cocos2d-x开发中,截屏功能是一个常见需求。Cocos2d-x 3.0的截屏原理与2.x大体相同,都是利用RenderTexture来处理。具体操作是在渲染之前调用相关函数,接着调用Cocos的场景visit函数进行渲染,渲染结束后调用end函数。不过,需要注意的是,Cocos2d-x 3.0截屏需要在截完屏的下一帧才能处理RenderTexture。
本文重点介绍如何将截图功能集成到Cocos2d-x 3.0引擎。
1. 集成到Director
将截屏功能集成到Director中是个不错的选择,这样可以让全局的导演来执行截屏功能。以下是具体的实现代码:
void Director::saveScreenshot(const std::string& fileName, const std::function<void(const std::string&)>& callback)
{
Image::Format format;
// 进行后缀判断
if (std::string::npos != fileName.find_last_of(".")) {
auto extension = fileName.substr(fileName.find_last_of("."), fileName.length());
if (!extension.compare(".png")) {
format = Image::Format::PNG;
} else if (!extension.compare(".jpg")) {
format = Image::Format::JPG;
} else {
CCLOG("cocos2d: the image can only be saved as JPG or PNG format");
return;
}
} else {
CCLOG("cocos2d: the image can only be saved as JPG or PNG format");
return;
}
// 获取屏幕尺寸,初始化一个空的渲染纹理对象
auto renderTexture = RenderTexture::create(getWinSize().width, getWinSize().height, Texture2D::PixelFormat::RGBA8888);
// 清空并开始获取
renderTexture->beginWithClear(0.0f, 0.0f, 0.0f, 0.0f);
// 遍历场景节点对象,填充纹理到RenderTexture中
getRunningScene()->visit();
// 结束获取
renderTexture->end();
// 保存文件
renderTexture->saveToFile(fileName, format);
// 使用schedule在下一帧中调用callback函数
auto fullPath = FileUtils::getInstance()->getWritablePath() + fileName;
auto scheduleCallback = [&, fullPath, callback](float dt) {
callback(fullPath);
};
auto _schedule = getRunningScene()->getScheduler();
_schedule->schedule(scheduleCallback, this, 0.0f, 0, 0.0f, false, "screenshot");
}
代码解释:
- 后缀判断:通过判断文件名的后缀来确定保存的图片格式,仅支持PNG和JPG格式。
- 创建渲染纹理:根据屏幕尺寸创建一个
RenderTexture对象。 - 渲染过程:调用
beginWithClear开始获取,调用场景的visit函数填充纹理,最后调用end结束获取。 - 保存文件:将渲染好的纹理保存为指定格式的文件。
- 回调处理:使用
schedule在下一帧中调用回调函数,确保在截屏完成后处理结果。
2. 如何使用saveScreenshot
截屏功能的使用非常简单,直接调用saveScreenshot函数即可。该函数的第一个参数为文件名(支持PNG和JPG格式,不带后缀名默认为PNG格式),第二个参数为回调函数,你可以在回调函数中处理这个文件。以下是使用示例:
void ScreenshotTest::saveImage(Ref *pSender)
{
static int counter = 0;
char png[20];
sprintf(png, "image-%d.png", counter);
char jpg[20];
sprintf(jpg, "image-%d.jpg", counter);
// 截屏后的回调函数,这里显示在左下角
auto callback = [&](const std::string& fullPath) {
auto sprite = Sprite::create(fullPath);
CCASSERT(sprite != nullptr, "Failed to create sprite.");
addChild(sprite);
sprite->setScale(0.3f);
sprite->setPosition(Point(40, 40));
sprite->setRotation(counter * 3);
CCLOG("Image saved %s", fullPath.c_str());
};
// 调用Director的截屏功能
Director::getInstance()->saveScreenshot(png, callback);
counter++;
}
代码解释:
- 文件名生成:使用
sprintf函数生成带有编号的PNG和JPG文件名。 - 回调函数:在回调函数中创建一个
Sprite对象,将截屏图片显示在左下角,并输出保存信息。 - 调用截屏函数:调用
Director的saveScreenshot函数进行截屏。
3. 源码下载
该功能已提交pull request到Cocos2d-x Github上,有需求的开发者可以自行集成。