Lothario
/
axmol
mirror of https://github.com/axmolengine/axmol.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
axmol/core/2d/CCRenderTexture.cpp

674 lines
23 KiB
C++
Raw Blame History

/****************************************************************************
Copyright (c) 2009 Jason Booth
Copyright (c) 2010-2012 cocos2d-x.org
Copyright (c) 2013-2016 Chukong Technologies Inc.
Copyright (c) 2017-2018 Xiamen Yaji Software Co., Ltd.
Copyright (c) 2022 Bytedance Inc.
https://axmolengine.github.io/
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
****************************************************************************/
#include "2d/CCRenderTexture.h"
#include "base/ccUtils.h"
#include "platform/CCFileUtils.h"
#include "base/CCEventType.h"
#include "base/CCConfiguration.h"
#include "base/CCDirector.h"
#include "base/CCEventListenerCustom.h"
#include "base/CCEventDispatcher.h"
#include "renderer/CCRenderer.h"
#include "2d/CCCamera.h"
#include "renderer/CCTextureCache.h"
#include "renderer/backend/Device.h"
#include "renderer/backend/Texture.h"
#include "renderer/backend/RenderTarget.h"
NS_AX_BEGIN
// implementation RenderTexture
RenderTexture::RenderTexture()
{
#if AX_ENABLE_CACHE_TEXTURE_DATA
// Listen this event to save render texture before come to background.
// Then it can be restored after coming to foreground on Android.
auto toBackgroundListener =
EventListenerCustom::create(EVENT_COME_TO_BACKGROUND, AX_CALLBACK_1(RenderTexture::listenToBackground, this));
_eventDispatcher->addEventListenerWithSceneGraphPriority(toBackgroundListener, this);
auto toForegroundListener =
EventListenerCustom::create(EVENT_COME_TO_FOREGROUND, AX_CALLBACK_1(RenderTexture::listenToForeground, this));
_eventDispatcher->addEventListenerWithSceneGraphPriority(toForegroundListener, this);
#endif
}
RenderTexture::~RenderTexture()
{
AX_SAFE_RELEASE(_renderTarget);
AX_SAFE_RELEASE(_sprite);
AX_SAFE_RELEASE(_depthStencilTexture);
AX_SAFE_RELEASE(_UITextureImage);
}
void RenderTexture::listenToBackground(EventCustom* /*event*/)
{
// We have not found a way to dispatch the enter background message before the texture data are destroyed.
// So we disable this pair of message handler at present.
#if AX_ENABLE_CACHE_TEXTURE_DATA
// to get the rendered texture data
auto func = [&](Image* uiTextureImage) {
if (uiTextureImage)
{
AX_SAFE_RELEASE(_UITextureImage);
_UITextureImage = uiTextureImage;
AX_SAFE_RETAIN(_UITextureImage);
const Vec2& s = _texture2D->getContentSizeInPixels();
VolatileTextureMgr::addDataTexture(_texture2D, uiTextureImage->getData(), s.width * s.height * 4,
backend::PixelFormat::RGBA8, s);
}
else
{
AXLOG("Cache rendertexture failed!");
}
AX_SAFE_RELEASE(uiTextureImage);
};
auto callback = std::bind(func, std::placeholders::_1);
newImage(callback, false);
#endif
}
void RenderTexture::listenToForeground(EventCustom* /*event*/)
{
#if AX_ENABLE_CACHE_TEXTURE_DATA
const Vec2& s = _texture2D->getContentSizeInPixels();
// TODO new-renderer: field _depthAndStencilFormat removal
// if (_depthAndStencilFormat != 0)
// {
// setupDepthAndStencil(s.width, s.height);
// }
_texture2D->setAntiAliasTexParameters();
#endif
}
RenderTexture* RenderTexture::create(int w, int h, backend::PixelFormat eFormat, bool sharedRenderTarget)
{
RenderTexture* ret = new RenderTexture();
if (ret->initWithWidthAndHeight(w, h, eFormat, sharedRenderTarget))
{
ret->autorelease();
return ret;
}
AX_SAFE_DELETE(ret);
return nullptr;
}
RenderTexture* RenderTexture::create(int w, int h, backend::PixelFormat eFormat, PixelFormat uDepthStencilFormat, bool sharedRenderTarget)
{
RenderTexture* ret = new RenderTexture();
if (ret->initWithWidthAndHeight(w, h, eFormat, uDepthStencilFormat, sharedRenderTarget))
{
ret->autorelease();
return ret;
}
AX_SAFE_DELETE(ret);
return nullptr;
}
RenderTexture* RenderTexture::create(int w, int h, bool sharedRenderTarget)
{
RenderTexture* ret = new RenderTexture();
if (ret->initWithWidthAndHeight(w, h, backend::PixelFormat::RGBA8, PixelFormat::NONE, sharedRenderTarget))
{
ret->autorelease();
return ret;
}
AX_SAFE_DELETE(ret);
return nullptr;
}
bool RenderTexture::initWithWidthAndHeight(int w, int h, backend::PixelFormat eFormat, bool sharedRenderTarget)
{
return initWithWidthAndHeight(w, h, eFormat, PixelFormat::NONE, sharedRenderTarget);
}
bool RenderTexture::initWithWidthAndHeight(int w,
int h,
backend::PixelFormat format,
PixelFormat depthStencilFormat,
bool sharedRenderTarget)
{
AXASSERT(format != backend::PixelFormat::A8, "only RGB and RGBA formats are valid for a render texture");
bool ret = false;
do
{
_fullRect = _rtTextureRect = Rect(0, 0, w, h);
w = (int)(w * AX_CONTENT_SCALE_FACTOR());
h = (int)(h * AX_CONTENT_SCALE_FACTOR());
_fullviewPort = Rect(0, 0, w, h);
// textures must be power of two squared
int powW = 0;
int powH = 0;
if (Configuration::getInstance()->supportsNPOT())
{
powW = w;
powH = h;
}
else
{
powW = ccNextPOT(w);
powH = ccNextPOT(h);
}
backend::TextureDescriptor descriptor;
descriptor.width = powW;
descriptor.height = powH;
descriptor.textureUsage = TextureUsage::RENDER_TARGET;
descriptor.textureFormat = PixelFormat::RGBA8;
_texture2D = new Texture2D();
_texture2D->updateTextureDescriptor(descriptor, !!AX_ENABLE_PREMULTIPLIED_ALPHA);
_renderTargetFlags = RenderTargetFlag::COLOR;
if (PixelFormat::D24S8 == depthStencilFormat || sharedRenderTarget)
{
_renderTargetFlags = RenderTargetFlag::ALL;
descriptor.textureFormat = PixelFormat::D24S8;
_depthStencilTexture = new Texture2D();
_depthStencilTexture->updateTextureDescriptor(descriptor);
}
AX_SAFE_RELEASE(_renderTarget);
if (sharedRenderTarget)
{
_renderTarget = _director->getRenderer()->getOffscreenRenderTarget();
_renderTarget->retain();
}
else
{
_renderTarget = backend::Device::getInstance()->newRenderTarget(
_renderTargetFlags, _texture2D ? _texture2D->getBackendTexture() : nullptr,
_depthStencilTexture ? _depthStencilTexture->getBackendTexture() : nullptr,
_depthStencilTexture ? _depthStencilTexture->getBackendTexture() : nullptr);
}
_renderTarget->setColorAttachment(_texture2D ? _texture2D->getBackendTexture() : nullptr);
auto depthStencilTexture = _depthStencilTexture ? _depthStencilTexture->getBackendTexture() : nullptr;
_renderTarget->setDepthAttachment(depthStencilTexture);
_renderTarget->setStencilAttachment(depthStencilTexture);
clearColorAttachment();
_texture2D->setAntiAliasTexParameters();
// retained
setSprite(Sprite::createWithTexture(_texture2D));
#if defined(AX_USE_GL)
_sprite->setFlippedY(true);
#endif
if (_texture2D->hasPremultipliedAlpha())
{
_sprite->setBlendFunc(BlendFunc::ALPHA_PREMULTIPLIED);
_sprite->setOpacityModifyRGB(true);
}
else
{
_sprite->setBlendFunc(BlendFunc::ALPHA_NON_PREMULTIPLIED);
_sprite->setOpacityModifyRGB(false);
}
_texture2D->release();
// Disabled by default.
_autoDraw = false;
// add sprite for backward compatibility
addChild(_sprite);
ret = true;
} while (0);
return ret;
}
void RenderTexture::setSprite(Sprite* sprite)
{
#if AX_ENABLE_GC_FOR_NATIVE_OBJECTS
auto sEngine = ScriptEngineManager::getInstance()->getScriptEngine();
if (sEngine)
{
if (sprite)
sEngine->retainScriptObject(this, sprite);
if (_sprite)
sEngine->releaseScriptObject(this, _sprite);
}
#endif // AX_ENABLE_GC_FOR_NATIVE_OBJECTS
AX_SAFE_RETAIN(sprite);
AX_SAFE_RELEASE(_sprite);
_sprite = sprite;
}
void RenderTexture::setVirtualViewport(const Vec2& rtBegin, const Rect& fullRect, const Rect& fullViewport)
{
_rtTextureRect.origin.x = rtBegin.x;
_rtTextureRect.origin.y = rtBegin.y;
_fullRect = fullRect;
_fullviewPort = fullViewport;
}
bool RenderTexture::isSharedRenderTarget() const
{
return _renderTarget == _director->getRenderer()->getOffscreenRenderTarget();
}
void RenderTexture::beginWithClear(float r, float g, float b, float a)
{
beginWithClear(r, g, b, a, 0, 0, ClearFlag::COLOR);
}
void RenderTexture::beginWithClear(float r, float g, float b, float a, float depthValue)
{
beginWithClear(r, g, b, a, depthValue, 0, ClearFlag::COLOR | ClearFlag::DEPTH);
}
void RenderTexture::beginWithClear(float r, float g, float b, float a, float depthValue, int stencilValue)
{
beginWithClear(r, g, b, a, depthValue, stencilValue, ClearFlag::ALL);
}
void RenderTexture::beginWithClear(float r,
float g,
float b,
float a,
float depthValue,
int stencilValue,
ClearFlag flags)
{
setClearColor(Color4F(r, g, b, a));
setClearDepth(depthValue);
setClearStencil(stencilValue);
setClearFlags(flags);
begin();
_director->getRenderer()->clear(_clearFlags, _clearColor, _clearDepth, _clearStencil, _globalZOrder);
}
void RenderTexture::clear(float r, float g, float b, float a)
{
this->beginWithClear(r, g, b, a);
this->end();
}
void RenderTexture::clearDepth(float depthValue)
{
setClearDepth(depthValue);
}
void RenderTexture::clearStencil(int stencilValue)
{
setClearStencil(stencilValue);
}
void RenderTexture::visit(Renderer* renderer, const Mat4& parentTransform, uint32_t parentFlags)
{
// override visit.
// Don't call visit on its children
if (!_visible)
{
return;
}
uint32_t flags = processParentFlags(parentTransform, parentFlags);
// IMPORTANT:
// To ease the migration to v3.0, we still support the Mat4 stack,
// but it is deprecated and your code should not rely on it
_director->pushMatrix(MATRIX_STACK_TYPE::MATRIX_STACK_MODELVIEW);
_director->loadMatrix(MATRIX_STACK_TYPE::MATRIX_STACK_MODELVIEW, _modelViewTransform);
_sprite->visit(renderer, _modelViewTransform, flags);
if (isVisitableByVisitingCamera())
{
draw(renderer, _modelViewTransform, flags);
}
_director->popMatrix(MATRIX_STACK_TYPE::MATRIX_STACK_MODELVIEW);
// FIX ME: Why need to set _orderOfArrival to 0??
// Please refer to https://github.com/cocos2d/cocos2d-x/pull/6920
// setOrderOfArrival(0);
}
bool RenderTexture::saveToFileAsNonPMA(std::string_view filename, bool isRGBA, SaveFileCallbackType callback)
{
std::string basename(filename);
std::transform(basename.begin(), basename.end(), basename.begin(), ::tolower);
if (basename.find(".png") != std::string::npos)
{
return saveToFileAsNonPMA(filename, Image::Format::PNG, isRGBA, callback);
}
else if (basename.find(".jpg") != std::string::npos)
{
if (isRGBA)
AXLOG("RGBA is not supported for JPG format.");
return saveToFileAsNonPMA(filename, Image::Format::JPG, false, callback);
}
else
{
AXLOG("Only PNG and JPG format are supported now!");
}
return saveToFileAsNonPMA(filename, Image::Format::JPG, false, callback);
}
bool RenderTexture::saveToFile(std::string_view filename, bool isRGBA, SaveFileCallbackType callback)
{
std::string basename(filename);
std::transform(basename.begin(), basename.end(), basename.begin(), ::tolower);
if (basename.find(".png") != std::string::npos)
{
return saveToFile(filename, Image::Format::PNG, isRGBA, callback);
}
else if (basename.find(".jpg") != std::string::npos)
{
if (isRGBA)
AXLOG("RGBA is not supported for JPG format.");
return saveToFile(filename, Image::Format::JPG, false, callback);
}
else
{
AXLOG("Only PNG and JPG format are supported now!");
}
return saveToFile(filename, Image::Format::JPG, false, callback);
}
bool RenderTexture::saveToFileAsNonPMA(std::string_view fileName,
Image::Format format,
bool isRGBA,
SaveFileCallbackType callback)
{
AXASSERT(format == Image::Format::JPG || format == Image::Format::PNG,
"the image can only be saved as JPG or PNG format");
if (isRGBA && format == Image::Format::JPG)
AXLOG("RGBA is not supported for JPG format");
_saveFileCallback = callback;
std::string fullpath = FileUtils::getInstance()->getWritablePath().append(fileName);
auto renderer = _director->getRenderer();
auto saveToFileCommand = renderer->nextCallbackCommand();
saveToFileCommand->init(_globalZOrder);
saveToFileCommand->func = AX_CALLBACK_0(RenderTexture::onSaveToFile, this, fullpath, isRGBA, true);
renderer->addCommand(saveToFileCommand);
return true;
}
bool RenderTexture::saveToFile(std::string_view fileName,
Image::Format format,
bool isRGBA,
SaveFileCallbackType callback)
{
AXASSERT(format == Image::Format::JPG || format == Image::Format::PNG,
"the image can only be saved as JPG or PNG format");
if (isRGBA && format == Image::Format::JPG)
AXLOG("RGBA is not supported for JPG format");
_saveFileCallback = callback;
std::string fullpath = FileUtils::getInstance()->getWritablePath().append(fileName);
auto renderer = _director->getRenderer();
auto saveToFileCommand = renderer->nextCallbackCommand();
saveToFileCommand->init(_globalZOrder);
saveToFileCommand->func = AX_CALLBACK_0(RenderTexture::onSaveToFile, this, fullpath, isRGBA, false);
_director->getRenderer()->addCommand(saveToFileCommand);
return true;
}
void RenderTexture::onSaveToFile(std::string_view filename, bool isRGBA, bool forceNonPMA)
{
auto callbackFunc = [&, filename, isRGBA, forceNonPMA](RefPtr<Image> image) {
if (image)
{
if (forceNonPMA && image->hasPremultipliedAlpha())
{
image->reversePremultipliedAlpha();
}
image->saveToFile(filename, !isRGBA);
}
if (_saveFileCallback)
{
_saveFileCallback(this, filename);
}
};
newImage(callbackFunc);
}
/* get buffer as Image */
void RenderTexture::newImage(std::function<void(RefPtr<Image>)> imageCallback, bool flipImage)
{
AXASSERT(_pixelFormat == backend::PixelFormat::RGBA8, "only RGBA8888 can be saved as image");
if ((nullptr == _texture2D))
{
return;
}
const Vec2& s = _texture2D->getContentSizeInPixels();
// to get the image size to save
// if the saving image domain exceeds the buffer texture domain,
// it should be cut
int savedBufferWidth = (int)s.width;
int savedBufferHeight = (int)s.height;
bool hasPremultipliedAlpha = _texture2D->hasPremultipliedAlpha();
_director->getRenderer()->readPixels(_renderTarget, [=](const backend::PixelBufferDescriptor& pbd) {
if (pbd)
{
auto image = utils::makeInstance<Image>(&Image::initWithRawData, pbd._data.getBytes(), pbd._data.getSize(),
pbd._width, pbd._height, 8, hasPremultipliedAlpha);
imageCallback(image);
}
else
imageCallback(nullptr);
});
}
void RenderTexture::draw(Renderer* renderer, const Mat4& transform, uint32_t flags)
{
if (_autoDraw)
{
// Begin will create a render group using new render target
begin();
// clear screen
_director->getRenderer()->clear(_clearFlags, _clearColor, _clearDepth, _clearStencil, _globalZOrder);
//! make sure all children are drawn
sortAllChildren();
for (const auto& child : _children)
{
if (child != _sprite)
child->visit(renderer, transform, flags);
}
// End will pop the current render group
end();
}
}
void RenderTexture::onBegin()
{
_oldProjMatrix = _director->getMatrix(MATRIX_STACK_TYPE::MATRIX_STACK_PROJECTION);
_director->loadMatrix(MATRIX_STACK_TYPE::MATRIX_STACK_PROJECTION, _projectionMatrix);
_oldTransMatrix = _director->getMatrix(MATRIX_STACK_TYPE::MATRIX_STACK_MODELVIEW);
_director->loadMatrix(MATRIX_STACK_TYPE::MATRIX_STACK_MODELVIEW, _transformMatrix);
if (!_keepMatrix)
{
_director->setProjection(_director->getProjection());
const Vec2& texSize = _texture2D->getContentSizeInPixels();
// Calculate the adjustment ratios based on the old and new projections
Vec2 size = _director->getWinSizeInPixels();
float widthRatio = size.width / texSize.width;
float heightRatio = size.height / texSize.height;
Mat4 orthoMatrix;
Mat4::createOrthographicOffCenter((float)-1.0 / widthRatio, (float)1.0 / widthRatio, (float)-1.0 / heightRatio,
(float)1.0 / heightRatio, -1, 1, &orthoMatrix);
_director->multiplyMatrix(MATRIX_STACK_TYPE::MATRIX_STACK_PROJECTION, orthoMatrix);
}
Rect viewport;
viewport.size.width = _fullviewPort.size.width;
viewport.size.height = _fullviewPort.size.height;
float viewPortRectWidthRatio = float(viewport.size.width) / _fullRect.size.width;
float viewPortRectHeightRatio = float(viewport.size.height) / _fullRect.size.height;
viewport.origin.x = (_fullRect.origin.x - _rtTextureRect.origin.x) * viewPortRectWidthRatio;
viewport.origin.y = (_fullRect.origin.y - _rtTextureRect.origin.y) * viewPortRectHeightRatio;
Renderer* renderer = _director->getRenderer();
_oldViewport = renderer->getViewport();
renderer->setViewPort(viewport.origin.x, viewport.origin.y, viewport.size.width, viewport.size.height);
_oldRenderTarget = renderer->getRenderTarget();
renderer->setRenderTarget(_renderTarget);
}
void RenderTexture::onEnd()
{
_director->loadMatrix(MATRIX_STACK_TYPE::MATRIX_STACK_PROJECTION, _oldProjMatrix);
_director->loadMatrix(MATRIX_STACK_TYPE::MATRIX_STACK_MODELVIEW, _oldTransMatrix);
Renderer* renderer = _director->getRenderer();
renderer->setViewPort(_oldViewport.x, _oldViewport.y, _oldViewport.w, _oldViewport.h);
renderer->setRenderTarget(_oldRenderTarget);
}
void RenderTexture::begin()
{
_director->pushMatrix(MATRIX_STACK_TYPE::MATRIX_STACK_PROJECTION);
_projectionMatrix = _director->getMatrix(MATRIX_STACK_TYPE::MATRIX_STACK_PROJECTION);
_director->pushMatrix(MATRIX_STACK_TYPE::MATRIX_STACK_MODELVIEW);
_transformMatrix = _director->getMatrix(MATRIX_STACK_TYPE::MATRIX_STACK_MODELVIEW);
if (!_keepMatrix)
{
_director->setProjection(_director->getProjection());
const Vec2& texSize = _texture2D->getContentSizeInPixels();
// Calculate the adjustment ratios based on the old and new projections
Vec2 size = _director->getWinSizeInPixels();
float widthRatio = size.width / texSize.width;
float heightRatio = size.height / texSize.height;
Mat4 orthoMatrix;
Mat4::createOrthographicOffCenter((float)-1.0 / widthRatio, (float)1.0 / widthRatio, (float)-1.0 / heightRatio,
(float)1.0 / heightRatio, -1, 1, &orthoMatrix);
_director->multiplyMatrix(MATRIX_STACK_TYPE::MATRIX_STACK_PROJECTION, orthoMatrix);
}
Renderer* renderer = _director->getRenderer();
auto* groupCommand = renderer->getNextGroupCommand();
groupCommand->init(_globalZOrder);
renderer->addCommand(groupCommand);
renderer->pushGroup(groupCommand->getRenderQueueID());
auto beginCommand = renderer->nextCallbackCommand();
beginCommand->init(_globalZOrder);
beginCommand->func = AX_CALLBACK_0(RenderTexture::onBegin, this);
renderer->addCommand(beginCommand);
}
void RenderTexture::end()
{
Renderer* renderer = _director->getRenderer();
auto endCommand = renderer->nextCallbackCommand();
endCommand->init(_globalZOrder);
endCommand->func = AX_CALLBACK_0(RenderTexture::onEnd, this);
renderer->addCommand(endCommand);
renderer->popGroup();
_director->popMatrix(MATRIX_STACK_TYPE::MATRIX_STACK_PROJECTION);
_director->popMatrix(MATRIX_STACK_TYPE::MATRIX_STACK_MODELVIEW);
}
void RenderTexture::setClearFlags(ClearFlag clearFlags)
{
_clearFlags = clearFlags;
if (_clearFlags != ClearFlag::NONE && !_depthStencilTexture)
{
_clearFlags = ClearFlag::COLOR;
}
}
void RenderTexture::clearColorAttachment()
{
auto renderer = _director->getRenderer();
auto beforeClearAttachmentCommand = renderer->nextCallbackCommand();
beforeClearAttachmentCommand->init(0);
beforeClearAttachmentCommand->func = [=, this]() -> void {
_oldRenderTarget = renderer->getRenderTarget();
renderer->setRenderTarget(_renderTarget);
};
renderer->addCommand(beforeClearAttachmentCommand);
Color4F color(0.f, 0.f, 0.f, 0.f);
renderer->clear(ClearFlag::COLOR, color, 1, 0, _globalZOrder);
// auto renderer = _director->getRenderer();
auto afterClearAttachmentCommand = renderer->nextCallbackCommand();
afterClearAttachmentCommand->init(0);
afterClearAttachmentCommand->func = [=, this]() -> void { renderer->setRenderTarget(_oldRenderTarget); };
renderer->addCommand(afterClearAttachmentCommand);
}
NS_AX_END
Reference in New Issue View Git Blame Copy Permalink