RHIDevice.hpp

Go to the documentation of this file.

/**********************************************************************************/
/* This file is part of Berserk Engine project                                    */
/* https://github.com/EgorOrachyov/Berserk                                        */
/**********************************************************************************/
/* MIT License                                                                    */
/*                                                                                */
/* Copyright (c) 2018 - 2021 Egor Orachyov                                        */
/*                                                                                */
/* 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.                                                                      */
/**********************************************************************************/
 
#ifndef BERSERK_RHIDEVICE_HPP
#define BERSERK_RHIDEVICE_HPP
 
#include <core/math/TMatMxN.hpp>
 
#include <rhi/RHIBuffer.hpp>
#include <rhi/RHICommandList.hpp>
#include <rhi/RHIDefs.hpp>
#include <rhi/RHIFramebuffer.hpp>
#include <rhi/RHIGraphicsPipeline.hpp>
#include <rhi/RHIRenderPass.hpp>
#include <rhi/RHIResource.hpp>
#include <rhi/RHIResourceSet.hpp>
#include <rhi/RHISampler.hpp>
#include <rhi/RHIShader.hpp>
#include <rhi/RHITexture.hpp>
#include <rhi/RHIVertexDeclaration.hpp>
 
BRK_NS_BEGIN
 
class RHIDevice {
public:
    BRK_API virtual ~RHIDevice() = default;
 
    BRK_API virtual Ref<RHIVertexDeclaration> CreateVertexDeclaration(const RHIVertexDeclarationDesc &desc) = 0;
 
    BRK_API virtual Ref<RHIVertexBuffer> CreateVertexBuffer(const RHIBufferDesc &desc) = 0;
 
    BRK_API virtual Ref<RHIIndexBuffer> CreateIndexBuffer(const RHIBufferDesc &desc) = 0;
 
    BRK_API virtual Ref<RHIUniformBuffer> CreateUniformBuffer(const RHIBufferDesc &desc) = 0;
 
    BRK_API virtual Ref<RHISampler> CreateSampler(const RHISamplerDesc &desc) = 0;
 
    BRK_API virtual Ref<RHITexture> CreateTexture(const RHITextureDesc &desc) = 0;
 
    BRK_API virtual Ref<RHIResourceSet> CreateResourceSet(const RHIResourceSetDesc &desc) = 0;
 
    BRK_API virtual Ref<RHIFramebuffer> CreateFramebuffer(const RHIFramebufferDesc &desc) = 0;
 
    BRK_API virtual Ref<RHIShader> CreateShader(const RHIShaderDesc &desc) = 0;
 
    BRK_API virtual Ref<RHIRenderPass> CreateRenderPass(const RHIRenderPassDesc &desc) = 0;
 
    BRK_API virtual Ref<RHIGraphicsPipeline> CreateGraphicsPipeline(const RHIGraphicsPipelineDesc &desc) = 0;
 
    BRK_API virtual void UpdateVertexBuffer(const Ref<RHIVertexBuffer> &buffer, uint32 byteOffset, uint32 byteSize, const Ref<Data> &data);
 
    BRK_API virtual void UpdateIndexBuffer(const Ref<RHIIndexBuffer> &buffer, uint32 byteOffset, uint32 byteSize, const Ref<Data> &data);
 
    BRK_API virtual void UpdateUniformBuffer(const Ref<RHIUniformBuffer> &buffer, uint32 byteOffset, uint32 byteSize, const Ref<Data> &data);
 
    BRK_API virtual void UpdateTexture2D(const Ref<RHITexture> &texture, uint32 mipLevel, const Rect2u &region, const Ref<Data> &data);
 
    BRK_API virtual void UpdateTexture2DArray(const Ref<RHITexture> &texture, uint32 arrayIndex, uint32 mipLevel, const Rect2u &region, const Ref<Data> &data);
 
    BRK_API virtual void UpdateTextureCube(const Ref<RHITexture> &texture, RHITextureCubemapFace face, uint32 mipLevel, const Rect2u &region, const Ref<Data> &data);
 
    BRK_API virtual void UpdateResourceSet(const Ref<RHIResourceSet> &set, const RHIResourceSetDesc &desc);
 
    BRK_API virtual void UpdateResourceSet_RT(const Ref<RHIResourceSet> &set, const RHIResourceSetDesc &desc) = 0;
 
    BRK_API virtual void GenerateMipMaps(const Ref<RHITexture> &texture);
 
    BRK_API virtual Ref<RHICommandList> GetCoreCommandList() = 0;
 
    BRK_API virtual const std::vector<RHITextureFormat> &GetSupportedFormats() const;
 
    BRK_API virtual const std::vector<RHIShaderLanguage> &GetSupportedShaderLanguages() const;
 
    BRK_API virtual RHIType GetDriverType() const;
 
    BRK_API virtual const RHIDeviceCaps &GetCaps() const;
 
    BRK_API virtual const Mat4x4f &GetClipMatrix() const;
 
    BRK_API bool IsSupported(RHIShaderLanguage language) const;
 
protected:
    std::vector<RHITextureFormat> mSupportedTextureFormats;
    std::vector<RHIShaderLanguage> mSupportedShaderLanguages;
    RHIDeviceCaps mCaps;
    Mat4x4f mClipMatrix;
    RHIType mType;
};
 
BRK_NS_END
 
#endif//BERSERK_RHIDEVICE_HPP