You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
cocos_lib/cocos/renderer/gfx-gles2/GLES2GPUObjects.h

597 lines
19 KiB

/****************************************************************************
Copyright (c) 2019-2023 Xiamen Yaji Software Co., Ltd.
http://www.cocos.com
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.
****************************************************************************/
#pragma once
#include <algorithm>
#include "GLES2Std.h"
#include "GLES2Wrangler.h"
#include "base/std/container/unordered_map.h"
#include "gfx-base/GFXDef.h"
#include "gfx-gles-common/GLESCommandPool.h"
namespace cc {
namespace gfx {
struct GLES2GPUConstantRegistry {
size_t currentBoundThreadID{0U};
MSRTSupportLevel mMSRT{MSRTSupportLevel::NONE};
FBFSupportLevel mFBF{FBFSupportLevel::NONE};
bool useVAO = false;
bool useDrawInstanced = false;
bool useInstancedArrays = false;
bool useDiscardFramebuffer = false;
bool debugMarker = false;
};
class GLES2GPUStateCache;
struct GLES2GPUSwapchain;
class GLES2GPUContext final {
public:
bool initialize(GLES2GPUStateCache *stateCache, GLES2GPUConstantRegistry *constantRegistry);
void destroy();
EGLint eglMajorVersion{0};
EGLint eglMinorVersion{0};
EGLDisplay eglDisplay{EGL_NO_DISPLAY};
EGLConfig eglConfig{nullptr};
ccstd::vector<EGLint> eglAttributes;
EGLSurface eglDefaultSurface{EGL_NO_SURFACE};
EGLContext eglDefaultContext{EGL_NO_CONTEXT};
// pass nullptr to keep the current surface
void makeCurrent(const GLES2GPUSwapchain *drawSwapchain = nullptr, const GLES2GPUSwapchain *readSwapchain = nullptr);
void bindContext(bool bound); // for context switching between threads
void present(const GLES2GPUSwapchain *swapchain);
inline bool checkExtension(const ccstd::string &extension) const {
return std::find(_extensions.begin(), _extensions.end(), extension) != _extensions.end();
}
private:
bool makeCurrent(EGLSurface drawSurface, EGLSurface readSurface, EGLContext context, bool updateCache = true);
EGLContext getSharedContext();
void resetStates() const;
// state caches
EGLSurface _eglCurrentDrawSurface{EGL_NO_SURFACE};
EGLSurface _eglCurrentReadSurface{EGL_NO_SURFACE};
EGLContext _eglCurrentContext{EGL_NO_CONTEXT};
EGLint _eglCurrentInterval{0};
GLES2GPUStateCache *_stateCache{nullptr};
GLES2GPUConstantRegistry *_constantRegistry{nullptr};
ccstd::unordered_map<size_t, EGLContext> _sharedContexts;
ccstd::vector<ccstd::string> _extensions;
};
struct GLES2GPUBuffer {
BufferUsage usage = BufferUsage::NONE;
MemoryUsage memUsage = MemoryUsage::NONE;
uint32_t size = 0;
uint32_t stride = 0;
uint32_t count = 0;
GLenum glTarget = 0;
GLuint glBuffer = 0;
uint8_t *buffer = nullptr;
DrawInfoList indirects;
};
using GLES2GPUBufferList = ccstd::vector<GLES2GPUBuffer *>;
struct GLES2GPUBufferView {
GLES2GPUBuffer *gpuBuffer = nullptr;
uint32_t offset = 0U;
uint32_t range = 0U;
};
struct GLES2GPUTexture {
TextureType type{TextureType::TEX2D};
Format format{Format::UNKNOWN};
TextureUsage usage{TextureUsageBit::NONE};
uint32_t width{0};
uint32_t height{0};
uint32_t depth{1};
uint32_t size{0};
uint32_t arrayLayer{1};
uint32_t mipLevel{1};
SampleCount samples{SampleCount::X1};
TextureFlags flags{TextureFlagBit::NONE};
bool isPowerOf2{false};
bool memoryAllocated{true}; // false if swapchain image or implicit ms render buffer.
GLenum glTarget{0};
GLenum glInternalFmt{0};
GLenum glFormat{0};
GLenum glType{0};
GLenum glUsage{0};
GLint glSamples{0};
GLuint glTexture{0};
GLuint glRenderbuffer{0};
GLenum glWrapS{0};
GLenum glWrapT{0};
GLenum glMinFilter{0};
GLenum glMagFilter{0};
GLES2GPUSwapchain *swapchain{nullptr};
};
using GLES2GPUTextureList = ccstd::vector<GLES2GPUTexture *>;
struct GLES2GPUSwapchain {
#if CC_SWAPPY_ENABLED
bool swappyEnabled{false};
#endif
EGLSurface eglSurface{EGL_NO_SURFACE};
EGLint eglSwapInterval{0};
GLuint glFramebuffer{0};
GLES2GPUTexture *gpuColorTexture{nullptr};
};
struct GLES2GPUSampler {
Filter minFilter = Filter::NONE;
Filter magFilter = Filter::NONE;
Filter mipFilter = Filter::NONE;
Address addressU = Address::CLAMP;
Address addressV = Address::CLAMP;
Address addressW = Address::CLAMP;
GLenum glMinFilter = 0;
GLenum glMagFilter = 0;
GLenum glWrapS = 0;
GLenum glWrapT = 0;
GLenum glWrapR = 0;
};
struct GLES2GPUInput {
uint32_t binding = 0;
ccstd::string name;
Type type = Type::UNKNOWN;
uint32_t stride = 0;
uint32_t count = 0;
uint32_t size = 0;
GLenum glType = 0;
GLint glLoc = -1;
};
using GLES2GPUInputList = ccstd::vector<GLES2GPUInput>;
struct GLES2GPUUniform {
uint32_t binding = INVALID_BINDING;
ccstd::string name;
Type type = Type::UNKNOWN;
uint32_t stride = 0;
uint32_t count = 0;
uint32_t size = 0;
uint32_t offset = 0;
GLenum glType = 0;
GLint glLoc = -1;
ccstd::vector<uint8_t> buff;
};
using GLES2GPUUniformList = ccstd::vector<GLES2GPUUniform>;
struct GLES2GPUUniformBlock {
uint32_t set = 0;
uint32_t binding = 0;
uint32_t idx = 0;
ccstd::string name;
uint32_t size = 0;
GLES2GPUUniformList glUniforms;
GLES2GPUUniformList glActiveUniforms;
ccstd::vector<uint32_t> activeUniformIndices;
};
using GLES2GPUUniformBlockList = ccstd::vector<GLES2GPUUniformBlock>;
struct GLES2GPUUniformSamplerTexture {
uint32_t set = 0;
uint32_t binding = 0;
ccstd::string name;
Type type = Type::UNKNOWN;
uint32_t count = 0U;
ccstd::vector<GLint> units;
GLenum glType = 0;
GLint glLoc = -1;
};
using GLES2GPUUniformSamplerTextureList = ccstd::vector<GLES2GPUUniformSamplerTexture>;
struct GLES2GPUShaderStage {
ShaderStageFlagBit type = ShaderStageFlagBit::NONE;
ccstd::string source;
GLuint glShader = 0;
};
using GLES2GPUShaderStageList = ccstd::vector<GLES2GPUShaderStage>;
struct GLES2GPUShader {
ccstd::string name;
UniformBlockList blocks;
UniformSamplerTextureList samplerTextures;
UniformInputAttachmentList subpassInputs;
GLuint glProgram = 0;
GLES2GPUShaderStageList gpuStages;
GLES2GPUInputList glInputs;
GLES2GPUUniformBlockList glBlocks;
GLES2GPUUniformSamplerTextureList glSamplerTextures;
};
struct GLES2GPUAttribute {
ccstd::string name;
GLuint glBuffer = 0;
GLenum glType = 0;
uint32_t size = 0;
uint32_t count = 0;
uint32_t stride = 1;
uint32_t componentCount = 1;
bool isNormalized = false;
bool isInstanced = false;
uint32_t offset = 0;
};
using GLES2GPUAttributeList = ccstd::vector<GLES2GPUAttribute>;
struct GLES2GPUInputAssembler {
AttributeList attributes;
GLES2GPUBufferList gpuVertexBuffers;
GLES2GPUBuffer *gpuIndexBuffer = nullptr;
GLES2GPUBuffer *gpuIndirectBuffer = nullptr;
GLES2GPUAttributeList glAttribs;
GLenum glIndexType = 0;
ccstd::unordered_map<size_t, GLuint> glVAOs;
};
struct GLES2GPURenderPass {
struct AttachmentStatistics {
uint32_t loadSubpass{SUBPASS_EXTERNAL};
uint32_t storeSubpass{SUBPASS_EXTERNAL};
};
ColorAttachmentList colorAttachments;
DepthStencilAttachment depthStencilAttachment;
SubpassInfoList subpasses;
ccstd::vector<AttachmentStatistics> statistics; // per attachment
};
class GLES2GPUFramebufferCacheMap;
class GLES2GPUFramebuffer final {
public:
GLES2GPURenderPass *gpuRenderPass{nullptr};
GLES2GPUTextureList gpuColorTextures;
GLES2GPUTexture *gpuDepthStencilTexture{nullptr};
bool usesFBF{false};
uint32_t lodLevel{0};
struct GLFramebufferInfo {
GLuint glFramebuffer{0U};
uint32_t width{UINT_MAX};
uint32_t height{UINT_MAX};
};
struct GLFramebuffer {
inline void initialize(GLES2GPUSwapchain *sc) { swapchain = sc; }
inline void initialize(const GLFramebufferInfo &info) {
_glFramebuffer = info.glFramebuffer;
_width = info.width;
_height = info.height;
}
inline GLuint getFramebuffer() const { return swapchain ? swapchain->glFramebuffer : _glFramebuffer; }
inline uint32_t getWidth() const { return swapchain ? swapchain->gpuColorTexture->width : _width; }
inline uint32_t getHeight() const { return swapchain ? swapchain->gpuColorTexture->height : _height; }
void destroy(GLES2GPUStateCache *cache, GLES2GPUFramebufferCacheMap *framebufferCacheMap);
GLES2GPUSwapchain *swapchain{nullptr};
private:
GLuint _glFramebuffer{0U};
uint32_t _width{0U};
uint32_t _height{0U};
};
struct Framebuffer {
GLFramebuffer framebuffer;
// for blit-based manual resolving
GLbitfield resolveMask{0U};
GLFramebuffer resolveFramebuffer;
};
// one per subpass, if not using FBF
ccstd::vector<Framebuffer> instances;
ccstd::vector<uint32_t> uberColorAttachmentIndices;
uint32_t uberDepthStencil{INVALID_BINDING};
Framebuffer uberInstance;
// the assumed shader output, may differ from actual subpass output
// see Feature::INPUT_ATTACHMENT_BENEFIT for more
uint32_t uberOnChipOutput{INVALID_BINDING};
uint32_t uberFinalOutput{INVALID_BINDING};
};
struct GLES2GPUDescriptorSetLayout {
DescriptorSetLayoutBindingList bindings;
ccstd::vector<uint32_t> dynamicBindings;
ccstd::vector<uint32_t> bindingIndices;
ccstd::vector<uint32_t> descriptorIndices;
uint32_t descriptorCount = 0U;
};
using GLES2GPUDescriptorSetLayoutList = ccstd::vector<GLES2GPUDescriptorSetLayout *>;
struct GLES2GPUPipelineLayout {
GLES2GPUDescriptorSetLayoutList setLayouts;
// helper storages
ccstd::vector<ccstd::vector<int>> dynamicOffsetIndices;
ccstd::vector<uint32_t> dynamicOffsetOffsets;
ccstd::vector<uint32_t> dynamicOffsets;
uint32_t dynamicOffsetCount = 0U;
};
struct GLES2GPUPipelineState {
GLenum glPrimitive = GL_TRIANGLES;
GLES2GPUShader *gpuShader = nullptr;
RasterizerState rs;
DepthStencilState dss;
BlendState bs;
DynamicStateList dynamicStates;
GLES2GPUPipelineLayout *gpuLayout = nullptr;
GLES2GPURenderPass *gpuRenderPass = nullptr;
GLES2GPUPipelineLayout *gpuPipelineLayout = nullptr;
};
struct GLES2GPUDescriptor {
DescriptorType type = DescriptorType::UNKNOWN;
GLES2GPUBuffer *gpuBuffer = nullptr;
GLES2GPUBufferView *gpuBufferView = nullptr;
GLES2GPUTexture *gpuTexture = nullptr;
GLES2GPUSampler *gpuSampler = nullptr;
};
using GLES2GPUDescriptorList = ccstd::vector<GLES2GPUDescriptor>;
struct GLES2GPUDescriptorSet {
GLES2GPUDescriptorList gpuDescriptors;
const ccstd::vector<uint32_t> *descriptorIndices = nullptr;
};
class GLES2GPUFence final {
public:
};
struct GLES2ObjectCache {
uint32_t subpassIdx = 0U;
GLES2GPURenderPass *gpuRenderPass = nullptr;
GLES2GPUFramebuffer *gpuFramebuffer = nullptr;
GLES2GPUPipelineState *gpuPipelineState = nullptr;
GLES2GPUInputAssembler *gpuInputAssembler = nullptr;
GLenum glPrimitive = 0;
Rect renderArea;
ColorList clearColors;
float clearDepth = 1.F;
uint32_t clearStencil = 0U;
};
class GLES2GPUStateCache {
public:
GLuint glArrayBuffer = 0;
GLuint glElementArrayBuffer = 0;
GLuint glUniformBuffer = 0;
GLuint glVAO = 0;
uint32_t texUint = 0;
ccstd::vector<GLuint> glTextures;
GLuint glProgram = 0;
ccstd::vector<bool> glEnabledAttribLocs;
ccstd::vector<bool> glCurrentAttribLocs;
GLuint glFramebuffer = 0;
GLuint glRenderbuffer = 0;
GLuint glReadFBO = 0;
Viewport viewport;
Rect scissor;
RasterizerState rs;
DepthStencilState dss;
BlendState bs;
bool isCullFaceEnabled = true;
bool isStencilTestEnabled = false;
ccstd::unordered_map<ccstd::string, uint32_t> texUnitCacheMap;
GLES2ObjectCache gfxStateCache;
void initialize(size_t texUnits, size_t vertexAttributes) {
glTextures.resize(texUnits, 0U);
glEnabledAttribLocs.resize(vertexAttributes, false);
glCurrentAttribLocs.resize(vertexAttributes, false);
}
void reset() {
glArrayBuffer = 0;
glElementArrayBuffer = 0;
glUniformBuffer = 0;
glVAO = 0;
texUint = 0;
glTextures.assign(glTextures.size(), 0U);
glProgram = 0;
glEnabledAttribLocs.assign(glEnabledAttribLocs.size(), false);
glCurrentAttribLocs.assign(glCurrentAttribLocs.size(), false);
glFramebuffer = 0;
glReadFBO = 0;
isCullFaceEnabled = true;
isStencilTestEnabled = false;
viewport = Viewport();
scissor = Rect();
rs = RasterizerState();
dss = DepthStencilState();
bs = BlendState();
gfxStateCache.gpuRenderPass = nullptr;
gfxStateCache.gpuFramebuffer = nullptr;
gfxStateCache.gpuPipelineState = nullptr;
gfxStateCache.gpuInputAssembler = nullptr;
gfxStateCache.glPrimitive = 0U;
gfxStateCache.subpassIdx = 0U;
}
};
class GLES2GPUBlitManager final {
public:
void initialize();
void destroy();
void draw(GLES2GPUTexture *gpuTextureSrc, GLES2GPUTexture *gpuTextureDst, const TextureBlit *regions, uint32_t count, Filter filter);
private:
GLES2GPUShader _gpuShader;
GLES2GPUDescriptorSetLayout _gpuDescriptorSetLayout;
GLES2GPUPipelineLayout _gpuPipelineLayout;
GLES2GPUPipelineState _gpuPipelineState;
GLES2GPUBuffer _gpuVertexBuffer;
GLES2GPUInputAssembler _gpuInputAssembler;
GLES2GPUSampler _gpuPointSampler;
GLES2GPUSampler _gpuLinearSampler;
GLES2GPUBuffer _gpuUniformBuffer;
GLES2GPUDescriptorSet _gpuDescriptorSet;
DrawInfo _drawInfo;
float _uniformBuffer[8];
};
class GLES2GPUFramebufferCacheMap final {
public:
explicit GLES2GPUFramebufferCacheMap(GLES2GPUStateCache *cache) : _cache(cache) {}
void registerExternal(GLuint glFramebuffer, const GLES2GPUTexture *gpuTexture) {
bool isTexture = gpuTexture->glTexture;
GLuint glResource = isTexture ? gpuTexture->glTexture : gpuTexture->glRenderbuffer;
auto &cacheMap = isTexture ? _textureMap : _renderbufferMap;
if (!cacheMap[glResource].glFramebuffer) {
cacheMap[glResource] = {glFramebuffer, true};
}
}
void unregisterExternal(GLuint glFramebuffer) {
for (auto &fbos : _textureMap) {
if (fbos.second.glFramebuffer == glFramebuffer) {
fbos.second.glFramebuffer = 0;
return;
}
}
for (auto &fbos : _renderbufferMap) {
if (fbos.second.glFramebuffer == glFramebuffer) {
fbos.second.glFramebuffer = 0;
return;
}
}
}
GLuint getFramebufferFromTexture(const GLES2GPUTexture *gpuTexture) {
bool isTexture = gpuTexture->glTexture;
GLuint glResource = isTexture ? gpuTexture->glTexture : gpuTexture->glRenderbuffer;
auto &cacheMap = isTexture ? _textureMap : _renderbufferMap;
if (!cacheMap.count(glResource)) {
GLuint glFramebuffer = 0U;
GL_CHECK(glGenFramebuffers(1, &glFramebuffer));
if (_cache->glFramebuffer != glFramebuffer) {
GL_CHECK(glBindFramebuffer(GL_FRAMEBUFFER, glFramebuffer));
_cache->glFramebuffer = glFramebuffer;
}
const FormatInfo &info = GFX_FORMAT_INFOS[static_cast<uint32_t>(gpuTexture->format)];
if (isTexture) {
if (info.hasDepth) {
GL_CHECK(glFramebufferTexture2D(GL_FRAMEBUFFER, GL_DEPTH_ATTACHMENT, gpuTexture->glTarget, glResource, 0));
if (info.hasStencil) GL_CHECK(glFramebufferTexture2D(GL_FRAMEBUFFER, GL_STENCIL_ATTACHMENT, gpuTexture->glTarget, glResource, 0));
} else {
GL_CHECK(glFramebufferTexture2D(GL_FRAMEBUFFER, GL_COLOR_ATTACHMENT0, gpuTexture->glTarget, glResource, 0));
}
} else {
if (info.hasDepth) {
GL_CHECK(glFramebufferRenderbuffer(GL_FRAMEBUFFER, GL_DEPTH_ATTACHMENT, gpuTexture->glTarget, glResource));
if (info.hasStencil) GL_CHECK(glFramebufferRenderbuffer(GL_FRAMEBUFFER, GL_STENCIL_ATTACHMENT, gpuTexture->glTarget, glResource));
} else {
GL_CHECK(glFramebufferRenderbuffer(GL_FRAMEBUFFER, GL_COLOR_ATTACHMENT0, gpuTexture->glTarget, glResource));
}
}
GLenum status;
GL_CHECK(status = glCheckFramebufferStatus(GL_FRAMEBUFFER));
CC_ASSERT_EQ(status, GL_FRAMEBUFFER_COMPLETE);
cacheMap[glResource].glFramebuffer = glFramebuffer;
}
return cacheMap[glResource].glFramebuffer;
}
void onTextureDestroy(const GLES2GPUTexture *gpuTexture) {
bool isTexture = gpuTexture->glTexture;
GLuint glResource = isTexture ? gpuTexture->glTexture : gpuTexture->glRenderbuffer;
auto &cacheMap = isTexture ? _textureMap : _renderbufferMap;
if (cacheMap.count(glResource)) {
GLuint glFramebuffer = cacheMap[glResource].glFramebuffer;
if (!glFramebuffer) return;
if (_cache->glFramebuffer == glFramebuffer) {
GL_CHECK(glBindFramebuffer(GL_FRAMEBUFFER, 0));
_cache->glFramebuffer = 0;
}
GL_CHECK(glDeleteFramebuffers(1, &glFramebuffer));
cacheMap.erase(glResource);
}
}
private:
GLES2GPUStateCache *_cache = nullptr;
struct FramebufferRecord {
GLuint glFramebuffer{0};
bool isExternal{false};
};
using CacheMap = ccstd::unordered_map<GLuint, FramebufferRecord>;
CacheMap _renderbufferMap; // renderbuffer -> framebuffer
CacheMap _textureMap; // texture -> framebuffer
};
class GLES2GPUFramebufferHub final {
public:
void connect(GLES2GPUTexture *texture, GLES2GPUFramebuffer *framebuffer) {
_framebuffers[texture].push_back(framebuffer);
}
void disengage(GLES2GPUTexture *texture) {
_framebuffers.erase(texture);
}
void disengage(GLES2GPUTexture *texture, GLES2GPUFramebuffer *framebuffer) {
auto &pool = _framebuffers[texture];
pool.erase(std::remove(pool.begin(), pool.end(), framebuffer), pool.end());
}
void update(GLES2GPUTexture *texture);
private:
ccstd::unordered_map<GLES2GPUTexture *, ccstd::vector<GLES2GPUFramebuffer *>> _framebuffers;
};
} // namespace gfx
} // namespace cc