RHITexture.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_RHITEXTURE_HPP
#define BERSERK_RHITEXTURE_HPP
 
#include <core/Config.hpp>
#include <core/Typedefs.hpp>
#include <core/string/StringName.hpp>
#include <core/templates/Mask.hpp>
#include <rhi/RHIResource.hpp>
 
BRK_NS_BEGIN
 
struct RHITextureDesc {
    StringName name{};
    uint32 width = 0;
    uint32 height = 0;
    uint32 depth = 0;
    uint32 mipsCount = 1;
    uint32 arraySlices = 1;
    RHITextureType textureType = RHITextureType::Unknown;
    RHITextureFormat textureFormat = RHITextureFormat::Unknown;
    Mask<RHITextureUsage> textureUsage{};
};
 
class RHITexture : public RHIResource {
public:
    BRK_API ~RHITexture() override = default;
 
    const StringName &GetName() const { return mDesc.name; }
 
    uint32 GetWidth() const { return mDesc.width; }
 
    uint32 GetHeight() const { return mDesc.height; }
 
    uint32 GetDepth() const { return mDesc.depth; }
 
    uint32 GetMipsCount() const { return mDesc.mipsCount; }
 
    uint32 GetArraySlices() const { return mDesc.arraySlices; }
 
    RHITextureType GetTextureType() const { return mDesc.textureType; }
 
    RHITextureFormat GetTextureFormat() const { return mDesc.textureFormat; }
 
    Mask<RHITextureUsage> GetTextureUsage() const { return mDesc.textureUsage; }
 
    bool UsageShaderSampling() const {
        return mDesc.textureUsage.Get(RHITextureUsage::Sampling);
    }
 
    bool UsageColorAttachment() const {
        return mDesc.textureUsage.Get(RHITextureUsage::ColorAttachment);
    }
 
    bool UsageDepthStencilAttachment() const {
        return mDesc.textureUsage.Get(RHITextureUsage::DepthStencilAttachment) ||
               mDesc.textureUsage.Get(RHITextureUsage::DepthAttachment);
    }
 
    const RHITextureDesc &GetDesc() const { return mDesc; }
 
protected:
    RHITextureDesc mDesc;
};
 
BRK_NS_END
 
#endif//BERSERK_RHITEXTURE_HPP