axmol/core/renderer/backend/ProgramState.cpp

556 lines
16 KiB
C++
Raw Normal View History

2019-11-23 20:27:39 +08:00
/****************************************************************************
Copyright (c) 2018-2019 Xiamen Yaji Software Co., Ltd.
2021-09-30 08:16:33 +08:00
Copyright (c) 2021 Bytedance Inc.
2019-11-23 20:27:39 +08:00
https://axis-project.github.io/
2019-11-23 20:27:39 +08:00
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.
****************************************************************************/
2021-12-25 10:04:45 +08:00
2019-11-23 20:27:39 +08:00
#include "renderer/backend/ProgramState.h"
#include "renderer/backend/ProgramCache.h"
#include "renderer/backend/Program.h"
#include "renderer/backend/Texture.h"
#include "renderer/backend/Types.h"
#include "base/CCEventDispatcher.h"
#include "base/CCEventType.h"
#include "base/CCDirector.h"
#include <algorithm>
2020-11-14 12:22:51 +08:00
#include "xxhash.h"
2020-10-23 16:40:51 +08:00
#ifdef CC_USE_METAL
2021-12-25 10:04:45 +08:00
# include "glsl_optimizer.h"
2019-11-23 20:27:39 +08:00
#endif
NS_AX_BACKEND_BEGIN
2019-11-23 20:27:39 +08:00
2021-12-25 10:04:45 +08:00
namespace
{
2019-11-23 20:27:39 +08:00
#define MAT3_SIZE 36
#define MAT4X3_SIZE 48
#define VEC3_SIZE 12
#define VEC4_SIZE 16
#define BVEC3_SIZE 3
#define BVEC4_SIZE 4
#define IVEC3_SIZE 12
#define IVEC4_SIZE 16
2021-12-25 10:04:45 +08:00
void convertbVec3TobVec4(const bool* src, bool* dst)
{
dst[0] = src[0];
dst[1] = src[1];
dst[2] = src[2];
dst[3] = false;
}
void convertiVec3ToiVec4(const int* src, int* dst)
{
dst[0] = src[0];
dst[1] = src[1];
dst[2] = src[2];
dst[3] = 0;
}
void convertVec3ToVec4(const float* src, float* dst)
{
dst[0] = src[0];
dst[1] = src[1];
dst[2] = src[2];
dst[3] = 0.0f;
2019-11-23 20:27:39 +08:00
}
2021-12-25 10:04:45 +08:00
void convertMat3ToMat4x3(const float* src, float* dst)
{
dst[3] = dst[7] = dst[11] = 0.0f;
dst[0] = src[0];
dst[1] = src[1];
dst[2] = src[2];
dst[4] = src[3];
dst[5] = src[4];
dst[6] = src[5];
dst[8] = src[6];
dst[9] = src[7];
dst[10] = src[8];
}
} // namespace
// static field
2019-11-23 20:27:39 +08:00
std::vector<ProgramState::AutoBindingResolver*> ProgramState::_customAutoBindingResolvers;
2021-09-30 08:16:33 +08:00
TextureInfo::TextureInfo(std::vector<int>&& _slots, std::vector<backend::TextureBackend*>&& _textures)
: TextureInfo(std::move(_slots), std::vector<int>(_slots.size(), 0), std::move(_textures))
2021-12-25 10:04:45 +08:00
{}
2020-08-29 16:56:48 +08:00
2021-09-30 08:16:33 +08:00
TextureInfo::TextureInfo(std::vector<int>&& _slots,
std::vector<int>&& _indexs,
std::vector<backend::TextureBackend*>&& _textures)
2021-12-25 10:04:45 +08:00
: slots(std::move(_slots)), indexs(std::move(_indexs)), textures(std::move(_textures))
2019-11-23 20:27:39 +08:00
{
retainTextures();
}
2020-08-29 16:56:48 +08:00
/* CLASS TextureInfo */
2021-12-25 10:04:45 +08:00
TextureInfo::TextureInfo(const TextureInfo& other)
2019-11-23 20:27:39 +08:00
{
2020-08-29 16:56:48 +08:00
this->assign(other);
}
TextureInfo::TextureInfo(TextureInfo&& other)
{
this->assign(std::move(other));
2019-11-23 20:27:39 +08:00
}
TextureInfo::~TextureInfo()
{
releaseTextures();
}
void TextureInfo::retainTextures()
{
for (auto& texture : textures)
CC_SAFE_RETAIN(texture);
2019-11-23 20:27:39 +08:00
}
void TextureInfo::releaseTextures()
{
for (auto& texture : textures)
CC_SAFE_RELEASE(texture);
2020-08-29 22:00:58 +08:00
textures.clear();
2019-11-23 20:27:39 +08:00
}
2020-08-29 16:56:48 +08:00
TextureInfo& TextureInfo::operator=(const TextureInfo& other) noexcept
{
this->assign(other);
return *this;
}
TextureInfo& TextureInfo::operator=(TextureInfo&& other) noexcept
2019-11-23 20:27:39 +08:00
{
2020-08-29 16:56:48 +08:00
this->assign(std::move(other));
return *this;
}
void TextureInfo::assign(const TextureInfo& other)
{
if (this != &other)
2019-11-23 20:27:39 +08:00
{
2020-08-29 20:07:13 +08:00
releaseTextures();
2021-12-25 10:04:45 +08:00
indexs = other.indexs;
slots = other.slots;
2020-08-29 16:56:48 +08:00
textures = other.textures;
retainTextures();
2019-11-23 20:27:39 +08:00
#if CC_ENABLE_CACHE_TEXTURE_DATA
2020-08-29 16:56:48 +08:00
location = other.location;
2019-11-23 20:27:39 +08:00
#endif
}
}
2020-08-29 16:56:48 +08:00
void TextureInfo::assign(TextureInfo&& other)
2019-11-23 20:27:39 +08:00
{
2020-08-29 16:56:48 +08:00
if (this != &other)
2019-11-23 20:27:39 +08:00
{
2020-08-29 16:56:48 +08:00
releaseTextures();
2021-12-25 10:04:45 +08:00
indexs = std::move(other.indexs);
slots = std::move(other.slots);
2020-08-29 16:56:48 +08:00
textures = std::move(other.textures);
2019-11-23 20:27:39 +08:00
#if CC_ENABLE_CACHE_TEXTURE_DATA
2021-12-25 10:04:45 +08:00
location = other.location;
2020-08-29 16:56:48 +08:00
other.location = -1;
2019-11-23 20:27:39 +08:00
#endif
}
}
2020-08-29 16:56:48 +08:00
/* CLASS ProgramState */
2019-11-23 20:27:39 +08:00
ProgramState::ProgramState(Program* program)
{
init(program);
}
bool ProgramState::init(Program* program)
{
CC_SAFE_RETAIN(program);
2021-12-25 10:04:45 +08:00
_program = program;
2019-11-23 20:27:39 +08:00
_vertexUniformBufferSize = _program->getUniformBufferSize(ShaderStage::VERTEX);
2021-12-25 10:04:45 +08:00
_vertexUniformBuffer = (char*)calloc(1, _vertexUniformBufferSize);
#ifdef CC_USE_METAL
2019-11-23 20:27:39 +08:00
_fragmentUniformBufferSize = _program->getUniformBufferSize(ShaderStage::FRAGMENT);
2021-12-25 10:04:45 +08:00
_fragmentUniformBuffer = (char*)calloc(1, _fragmentUniformBufferSize);
2020-10-23 11:37:52 +08:00
#endif
#ifdef CC_USE_METAL
2020-10-23 11:37:52 +08:00
_uniformHashState = XXH32_createState();
2019-11-23 20:27:39 +08:00
#endif
#if CC_ENABLE_CACHE_TEXTURE_DATA
2021-12-25 10:04:45 +08:00
_backToForegroundListener =
EventListenerCustom::create(EVENT_RENDERER_RECREATED, [this](EventCustom*) { this->resetUniforms(); });
2019-11-23 20:27:39 +08:00
Director::getInstance()->getEventDispatcher()->addEventListenerWithFixedPriority(_backToForegroundListener, -1);
#endif
return true;
}
void ProgramState::resetUniforms()
{
#if CC_ENABLE_CACHE_TEXTURE_DATA
2021-12-25 10:04:45 +08:00
if (_program == nullptr)
2019-11-23 20:27:39 +08:00
return;
const auto& uniformLocation = _program->getAllUniformsLocation();
2021-12-25 10:04:45 +08:00
for (const auto& uniform : uniformLocation)
2019-11-23 20:27:39 +08:00
{
2021-12-25 10:04:45 +08:00
auto location = uniform.second;
2019-11-23 20:27:39 +08:00
auto mappedLocation = _program->getMappedLocation(location);
2021-12-25 10:04:45 +08:00
// check if current location had been set before
if (_vertexTextureInfos.find(location) != _vertexTextureInfos.end())
2019-11-23 20:27:39 +08:00
{
_vertexTextureInfos[location].location = mappedLocation;
}
}
#endif
}
ProgramState::~ProgramState()
{
#ifdef CC_USE_METAL
2020-10-23 11:37:52 +08:00
XXH32_freeState(_uniformHashState);
#endif
CC_SAFE_RELEASE(_program);
CC_SAFE_FREE(_vertexUniformBuffer);
CC_SAFE_FREE(_fragmentUniformBuffer);
2021-12-25 10:04:45 +08:00
#if CC_ENABLE_CACHE_TEXTURE_DATA
2019-11-23 20:27:39 +08:00
Director::getInstance()->getEventDispatcher()->removeEventListener(_backToForegroundListener);
#endif
}
2021-12-25 10:04:45 +08:00
ProgramState* ProgramState::clone() const
2019-11-23 20:27:39 +08:00
{
2021-12-25 10:04:45 +08:00
ProgramState* cp = new ProgramState(_program);
cp->_vertexTextureInfos = _vertexTextureInfos;
2019-11-23 20:27:39 +08:00
cp->_fragmentTextureInfos = _fragmentTextureInfos;
memcpy(cp->_vertexUniformBuffer, _vertexUniformBuffer, _vertexUniformBufferSize);
cp->_vertexLayout = _vertexLayout;
#ifdef CC_USE_METAL
2019-11-23 20:27:39 +08:00
memcpy(cp->_fragmentUniformBuffer, _fragmentUniformBuffer, _fragmentUniformBufferSize);
#endif
2020-10-23 11:37:52 +08:00
cp->_uniformID = _uniformID;
2019-11-23 20:27:39 +08:00
return cp;
}
backend::UniformLocation ProgramState::getUniformLocation(backend::Uniform name) const
{
return _program->getUniformLocation(name);
}
backend::UniformLocation ProgramState::getUniformLocation(std::string_view uniform) const
2019-11-23 20:27:39 +08:00
{
return _program->getUniformLocation(uniform);
}
2021-12-25 10:04:45 +08:00
void ProgramState::setCallbackUniform(const backend::UniformLocation& uniformLocation, const UniformCallback& callback)
2019-11-23 20:27:39 +08:00
{
_callbackUniforms[uniformLocation] = callback;
2019-11-23 20:27:39 +08:00
}
void ProgramState::setUniform(const backend::UniformLocation& uniformLocation, const void* data, std::size_t size)
{
switch (uniformLocation.shaderStage)
{
2021-12-25 10:04:45 +08:00
case backend::ShaderStage::VERTEX:
setVertexUniform(uniformLocation.location[0], data, size, uniformLocation.location[1]);
break;
case backend::ShaderStage::FRAGMENT:
setFragmentUniform(uniformLocation.location[1], data, size);
break;
case backend::ShaderStage::VERTEX_AND_FRAGMENT:
setVertexUniform(uniformLocation.location[0], data, size, uniformLocation.location[1]);
setFragmentUniform(uniformLocation.location[1], data, size);
break;
default:
break;
2019-11-23 20:27:39 +08:00
}
}
#ifdef CC_USE_METAL
2021-12-25 10:04:45 +08:00
void ProgramState::convertAndCopyUniformData(const backend::UniformInfo& uniformInfo,
const void* srcData,
std::size_t srcSize,
void* buffer)
2019-11-23 20:27:39 +08:00
{
2021-12-25 10:04:45 +08:00
auto basicType = static_cast<glslopt_basic_type>(uniformInfo.type);
2019-11-23 20:27:39 +08:00
char* convertedData = new char[uniformInfo.size];
memset(convertedData, 0, uniformInfo.size);
int offset = 0;
switch (basicType)
{
2021-12-25 10:04:45 +08:00
case kGlslTypeFloat:
{
if (uniformInfo.isMatrix)
2019-11-23 20:27:39 +08:00
{
2021-12-25 10:04:45 +08:00
for (int i = 0; i < uniformInfo.count; i++)
2019-11-23 20:27:39 +08:00
{
2021-12-25 10:04:45 +08:00
if (offset >= srcSize)
break;
convertMat3ToMat4x3((float*)srcData + offset, (float*)convertedData + i * MAT4X3_SIZE);
offset += MAT3_SIZE;
2019-11-23 20:27:39 +08:00
}
}
2021-12-25 10:04:45 +08:00
else
2019-11-23 20:27:39 +08:00
{
2021-12-25 10:04:45 +08:00
for (int i = 0; i < uniformInfo.count; i++)
2019-11-23 20:27:39 +08:00
{
2021-12-25 10:04:45 +08:00
if (offset >= srcSize)
2019-11-23 20:27:39 +08:00
break;
2021-12-25 10:04:45 +08:00
convertVec3ToVec4((float*)srcData + offset, (float*)convertedData + i * VEC4_SIZE);
offset += VEC3_SIZE;
2019-11-23 20:27:39 +08:00
}
}
2021-12-25 10:04:45 +08:00
break;
}
case kGlslTypeBool:
{
for (int i = 0; i < uniformInfo.count; i++)
2019-11-23 20:27:39 +08:00
{
2021-12-25 10:04:45 +08:00
if (offset >= srcSize)
break;
convertbVec3TobVec4((bool*)srcData + offset, (bool*)convertedData + i * BVEC4_SIZE);
offset += BVEC3_SIZE;
2019-11-23 20:27:39 +08:00
}
2021-12-25 10:04:45 +08:00
break;
}
case kGlslTypeInt:
{
for (int i = 0; i < uniformInfo.count; i++)
{
if (offset >= srcSize)
break;
convertiVec3ToiVec4((int*)srcData + offset, (int*)convertedData + i * IVEC4_SIZE);
offset += IVEC3_SIZE;
}
break;
2019-11-23 20:27:39 +08:00
}
2021-12-25 10:04:45 +08:00
default:
CC_ASSERT(false);
2021-12-25 10:04:45 +08:00
break;
}
2019-11-23 20:27:39 +08:00
memcpy((char*)buffer + uniformInfo.location, convertedData, uniformInfo.size);
CC_SAFE_DELETE_ARRAY(convertedData);
2019-11-23 20:27:39 +08:00
}
#endif
void ProgramState::setVertexUniform(int location, const void* data, std::size_t size, std::size_t offset)
{
2021-12-25 10:04:45 +08:00
if (location < 0)
2019-11-23 20:27:39 +08:00
return;
2021-12-25 10:04:45 +08:00
// float3 etc in Metal has both sizeof and alignment same as float4, need convert to correct laytout
#ifdef CC_USE_METAL
2019-11-23 20:27:39 +08:00
const auto& uniformInfo = _program->getActiveUniformInfo(ShaderStage::VERTEX, location);
2021-12-25 10:04:45 +08:00
if (uniformInfo.needConvert)
2019-11-23 20:27:39 +08:00
{
convertAndCopyUniformData(uniformInfo, data, size, _vertexUniformBuffer);
}
else
{
memcpy(_vertexUniformBuffer + location, data, size);
}
#else
memcpy(_vertexUniformBuffer + offset, data, size);
#endif
}
void ProgramState::setFragmentUniform(int location, const void* data, std::size_t size)
{
2021-12-25 10:04:45 +08:00
if (location < 0)
2019-11-23 20:27:39 +08:00
return;
2021-12-25 10:04:45 +08:00
// float3 etc in Metal has both sizeof and alignment same as float4, need convert to correct laytout
#ifdef CC_USE_METAL
2019-11-23 20:27:39 +08:00
const auto& uniformInfo = _program->getActiveUniformInfo(ShaderStage::FRAGMENT, location);
2021-12-25 10:04:45 +08:00
if (uniformInfo.needConvert)
2019-11-23 20:27:39 +08:00
{
convertAndCopyUniformData(uniformInfo, data, size, _fragmentUniformBuffer);
}
else
{
memcpy(_fragmentUniformBuffer + location, data, size);
}
2020-10-23 11:37:52 +08:00
#endif
}
void ProgramState::updateUniformID(int uniformID)
2020-10-23 11:37:52 +08:00
{
2021-12-25 10:04:45 +08:00
if (uniformID == -1)
{
#ifdef CC_USE_METAL
XXH32_reset(_uniformHashState, 0);
XXH32_update(_uniformHashState, _vertexUniformBuffer, _vertexUniformBufferSize);
XXH32_update(_uniformHashState, _fragmentUniformBuffer, _fragmentUniformBufferSize);
_uniformID = XXH32_digest(_uniformHashState);
2020-10-23 11:37:52 +08:00
#else
_uniformID = XXH32(_vertexUniformBuffer, _vertexUniformBufferSize, 0);
2019-11-23 20:27:39 +08:00
#endif
}
2021-12-25 10:04:45 +08:00
else
{
_uniformID = uniformID;
}
2019-11-23 20:27:39 +08:00
}
void ProgramState::setTexture(backend::TextureBackend* texture)
{
for (int slot = 0; slot < texture->getCount() && slot < CC_META_TEXTURES; ++slot)
2021-12-25 10:04:45 +08:00
{
2020-08-29 16:56:48 +08:00
auto location = getUniformLocation((backend::Uniform)(backend::Uniform::TEXTURE + slot));
setTexture(location, slot, slot, texture);
2019-11-23 20:27:39 +08:00
}
}
2021-09-30 08:16:33 +08:00
void ProgramState::setTexture(const backend::UniformLocation& uniformLocation,
int slot,
backend::TextureBackend* texture)
2020-08-29 16:56:48 +08:00
{
setTexture(uniformLocation, slot, 0, texture);
}
2021-09-30 08:16:33 +08:00
void ProgramState::setTexture(const backend::UniformLocation& uniformLocation,
int slot,
int index,
backend::TextureBackend* texture)
2019-11-23 20:27:39 +08:00
{
switch (uniformLocation.shaderStage)
{
2021-12-25 10:04:45 +08:00
case backend::ShaderStage::VERTEX:
setTexture(uniformLocation.location[0], slot, index, texture, _vertexTextureInfos);
break;
case backend::ShaderStage::FRAGMENT:
setTexture(uniformLocation.location[1], slot, index, texture, _fragmentTextureInfos);
break;
case backend::ShaderStage::VERTEX_AND_FRAGMENT:
setTexture(uniformLocation.location[0], slot, index, texture, _vertexTextureInfos);
setTexture(uniformLocation.location[1], slot, index, texture, _fragmentTextureInfos);
break;
default:
break;
2019-11-23 20:27:39 +08:00
}
}
2021-09-30 08:16:33 +08:00
void ProgramState::setTextureArray(const backend::UniformLocation& uniformLocation,
std::vector<int> slots,
std::vector<backend::TextureBackend*> textures)
2019-11-23 20:27:39 +08:00
{
switch (uniformLocation.shaderStage)
{
2021-12-25 10:04:45 +08:00
case backend::ShaderStage::VERTEX:
setTextureArray(uniformLocation.location[0], std::move(slots), std::move(textures), _vertexTextureInfos);
break;
case backend::ShaderStage::FRAGMENT:
setTextureArray(uniformLocation.location[1], std::move(slots), std::move(textures), _fragmentTextureInfos);
break;
case backend::ShaderStage::VERTEX_AND_FRAGMENT:
setTextureArray(uniformLocation.location[0], std::move(slots), std::move(textures), _vertexTextureInfos);
setTextureArray(uniformLocation.location[1], std::move(slots), std::move(textures), _fragmentTextureInfos);
break;
default:
break;
2019-11-23 20:27:39 +08:00
}
}
2021-09-30 08:16:33 +08:00
void ProgramState::setTexture(int location,
int slot,
int index,
backend::TextureBackend* texture,
std::unordered_map<int, TextureInfo>& textureInfo)
2019-11-23 20:27:39 +08:00
{
2021-12-25 10:04:45 +08:00
if (location < 0)
2019-11-23 20:27:39 +08:00
return;
2020-08-29 16:56:48 +08:00
auto& info = textureInfo[location];
2021-12-25 10:04:45 +08:00
info = {{slot}, {index}, {texture}};
2020-08-29 16:56:48 +08:00
#if CC_ENABLE_CACHE_TEXTURE_DATA
2019-11-23 20:27:39 +08:00
info.location = location;
#endif
}
2021-09-30 08:16:33 +08:00
void ProgramState::setTextureArray(int location,
std::vector<int> slots,
std::vector<backend::TextureBackend*> textures,
std::unordered_map<int, TextureInfo>& textureInfo)
2019-11-23 20:27:39 +08:00
{
assert(slots.size() == textures.size());
2020-08-29 16:56:48 +08:00
auto& info = textureInfo[location];
2021-12-25 10:04:45 +08:00
info = {std::move(slots), std::move(textures)};
2020-08-29 16:56:48 +08:00
#if CC_ENABLE_CACHE_TEXTURE_DATA
2019-11-23 20:27:39 +08:00
info.location = location;
#endif
}
void ProgramState::setParameterAutoBinding(std::string_view uniform, std::string_view autoBinding)
2019-11-23 20:27:39 +08:00
{
_autoBindings.emplace(uniform, autoBinding);
applyAutoBinding(uniform, autoBinding);
}
void ProgramState::applyAutoBinding(std::string_view uniformName, std::string_view autoBinding)
2019-11-23 20:27:39 +08:00
{
for (const auto resolver : _customAutoBindingResolvers)
{
2021-10-11 12:15:41 +08:00
if (resolver->resolveAutoBinding(this, uniformName, autoBinding))
break;
2019-11-23 20:27:39 +08:00
}
}
ProgramState::AutoBindingResolver::AutoBindingResolver()
{
_customAutoBindingResolvers.emplace_back(this);
}
ProgramState::AutoBindingResolver::~AutoBindingResolver()
{
2021-12-25 10:04:45 +08:00
auto& list = _customAutoBindingResolvers;
2019-11-23 20:27:39 +08:00
list.erase(std::remove(list.begin(), list.end(), this), list.end());
}
void ProgramState::getVertexUniformBuffer(char** buffer, std::size_t& size) const
{
*buffer = _vertexUniformBuffer;
2021-12-25 10:04:45 +08:00
size = _vertexUniformBufferSize;
2019-11-23 20:27:39 +08:00
}
void ProgramState::getFragmentUniformBuffer(char** buffer, std::size_t& size) const
{
*buffer = _fragmentUniformBuffer;
2021-12-25 10:04:45 +08:00
size = _fragmentUniformBufferSize;
2019-11-23 20:27:39 +08:00
}
NS_AX_BACKEND_END