Buffer.h

Go to the documentation of this file.

#pragma once

#include "FlingVulkan.h"
#include "FlingExports.h"

namespace Fling
{
    class FLING_API Buffer
    {
    public:

        Buffer()
            : m_Size(0)
            , m_Buffer(VK_NULL_HANDLE)
            , m_BufferMemory(VK_NULL_HANDLE)
            , m_Descriptor{}
            , m_MappedMem(nullptr)
        {
        }

        Buffer(const Buffer& t_Other);

        Buffer(
            const VkDeviceSize& t_Size,
            const VkBufferUsageFlags& t_Usage,
            const VkMemoryPropertyFlags& t_Properties,
            const void* t_Data = nullptr
        );

        ~Buffer();

        bool operator==(const Buffer& other) const;
        bool operator!=(const Buffer& other) const;

        FORCEINLINE const VkBuffer& GetVkBuffer() const { return m_Buffer; }

        FORCEINLINE const VkDeviceMemory& GetVkDeviceMemory() const { return m_BufferMemory; }

        FORCEINLINE const VkDeviceSize& GetSize() const { return m_Size; }

        FORCEINLINE VkDescriptorBufferInfo& GetDescriptor() { return m_Descriptor; }

        static void CopyBuffer(Buffer* t_SrcBuffer, Buffer* t_DstBuffer, VkDeviceSize t_Size);

        void Release();
        
        bool IsUsed() const { return m_BufferMemory != VK_NULL_HANDLE && m_Buffer != VK_NULL_HANDLE && m_Size; }

        VkResult MapMemory(VkDeviceSize t_Size = VK_WHOLE_SIZE, VkDeviceSize t_Offset = 0);
        
        void UnmapMemory();
        
        void CreateBuffer(
            const VkDeviceSize& t_size,
            const VkBufferUsageFlags& t_Usage,
            const VkMemoryPropertyFlags& t_Properties,
            bool t_unmapBuffer,
            const void* t_Data = nullptr);
            
        void Flush(VkDeviceSize t_size, VkDeviceSize t_offset);
    
        void* m_MappedMem = nullptr;

    private:

        VkDeviceSize m_Size;

        VkBuffer m_Buffer;

        VkDeviceMemory m_BufferMemory;

        VkDescriptorBufferInfo m_Descriptor;

        VkDeviceSize m_Offset = 0;
    };
}   // namespace Fling