cocos_lib/cocos/renderer/gfx-gles2/GLES2Device.h

/****************************************************************************
 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 "GLES2Std.h"
#include "gfx-base/GFXDevice.h"
#include "gfx-base/GFXSwapchain.h"
#include "gfx-gles-common/GLESCommandPool.h"

namespace cc {
namespace gfx {

class GLES2GPUContext;
struct GLES2GPUSwapchain;
class GLES2GPUStateCache;
class GLES2GPUBlitManager;
class GLES2GPUFramebufferHub;
struct GLES2GPUConstantRegistry;
class GLES2GPUFramebufferCacheMap;

class CC_GLES2_API GLES2Device final : public Device {
public:
    static GLES2Device *getInstance();

    ~GLES2Device() override;

    using Device::copyBuffersToTexture;
    using Device::createBuffer;
    using Device::createCommandBuffer;
    using Device::createDescriptorSet;
    using Device::createDescriptorSetLayout;
    using Device::createFramebuffer;
    using Device::createGeneralBarrier;
    using Device::createInputAssembler;
    using Device::createPipelineLayout;
    using Device::createPipelineState;
    using Device::createQueryPool;
    using Device::createQueue;
    using Device::createRenderPass;
    using Device::createSampler;
    using Device::createShader;
    using Device::createTexture;
    using Device::createTextureBarrier;

    void frameSync() override{};
    void acquire(Swapchain *const *swapchains, uint32_t count) override;
    void present() override;

    inline const GLESBindingMapping &bindingMappings() const { return _bindingMappings; }

    inline GLES2GPUContext *context() const { return _gpuContext; }
    inline GLES2GPUStateCache *stateCache() const { return _gpuStateCache; }
    inline GLES2GPUBlitManager *blitManager() const { return _gpuBlitManager; }
    inline GLES2GPUFramebufferHub *framebufferHub() const { return _gpuFramebufferHub; }
    inline GLES2GPUConstantRegistry *constantRegistry() const { return _gpuConstantRegistry; }
    inline GLES2GPUFramebufferCacheMap *framebufferCacheMap() const { return _gpuFramebufferCacheMap; }

    inline bool checkExtension(const ccstd::string &extension) const {
        return std::any_of(_extensions.begin(), _extensions.end(), [&extension](auto &ext) {
            return ext.find(extension) != ccstd::string::npos;
        });
    }

    inline uint8_t *getStagingBuffer(uint32_t size = 0) {
        if (size > _stagingBufferSize) {
            CC_FREE(_stagingBuffer);
            _stagingBuffer = static_cast<uint8_t *>(CC_MALLOC(size));
            _stagingBufferSize = size;
        }

        return _stagingBuffer;
    }

    // check the specified format is texture-exclusive (no renderbuffers allowed)
    inline bool isTextureExclusive(const Format &format) { return _textureExclusive[static_cast<size_t>(format)]; };
    SampleCount getMaxSampleCount(Format format, TextureUsage usage, TextureFlags flags) const override;
protected:
    static GLES2Device *instance;

    friend class DeviceManager;

    GLES2Device();

    bool doInit(const DeviceInfo &info) override;
    void doDestroy() override;
    CommandBuffer *createCommandBuffer(const CommandBufferInfo &info, bool hasAgent) override;
    Queue *createQueue() override;
    QueryPool *createQueryPool() override;
    Swapchain *createSwapchain() override;
    Buffer *createBuffer() override;
    Texture *createTexture() override;
    Shader *createShader() override;
    InputAssembler *createInputAssembler() override;
    RenderPass *createRenderPass() override;
    Framebuffer *createFramebuffer() override;
    DescriptorSet *createDescriptorSet() override;
    DescriptorSetLayout *createDescriptorSetLayout() override;
    PipelineLayout *createPipelineLayout() override;
    PipelineState *createPipelineState() override;

    Sampler *createSampler(const SamplerInfo &info) override;

    void copyBuffersToTexture(const uint8_t *const *buffers, Texture *dst, const BufferTextureCopy *regions, uint32_t count) override;
    void copyTextureToBuffers(Texture *src, uint8_t *const *buffers, const BufferTextureCopy *region, uint32_t count) override;
    void getQueryPoolResults(QueryPool *queryPool) override {}

    void bindContext(bool bound) override;

    void initFormatFeature();

    GLES2GPUContext *_gpuContext{nullptr};
    GLES2GPUStateCache *_gpuStateCache{nullptr};
    GLES2GPUBlitManager *_gpuBlitManager{nullptr};
    GLES2GPUFramebufferHub *_gpuFramebufferHub{nullptr};
    GLES2GPUConstantRegistry *_gpuConstantRegistry{nullptr};
    GLES2GPUFramebufferCacheMap *_gpuFramebufferCacheMap{nullptr};

    ccstd::vector<GLES2GPUSwapchain *> _swapchains;

    ccstd::array<bool, static_cast<size_t>(Format::COUNT)> _textureExclusive;

    GLESBindingMapping _bindingMappings;

    ccstd::vector<ccstd::string> _extensions;

    uint8_t *_stagingBuffer{nullptr};
    uint32_t _stagingBufferSize{0};
};

} // namespace gfx
} // namespace cc