VKMemoryAllocator.hpp

Go to the documentation of this file.

//
//  CeresEngine - A game development framework
//
//  Created by Rogiel Sulzbach.
//  Copyright (c) 2018-2022 Rogiel Sulzbach. All rights reserved.
//
 
#pragma once
 
#include "VKCommon.hpp"
 
#include "CeresEngine/DataTypes.hpp"
 
VK_DEFINE_HANDLE(VmaAllocation)
VK_DEFINE_HANDLE(VmaAllocator)
 
namespace CeresEngine {
 
    class VKMemoryAllocator;
 
    class VKMemoryAllocation final {
    protected:
        VKMemoryAllocator* allocator = nullptr;
 
        VmaAllocation allocation = VK_NULL_HANDLE;
 
    public:
        VKMemoryAllocation();
        explicit VKMemoryAllocation(VKMemoryAllocator& allocator, const VkMemoryRequirements& memoryRequirements, VkMemoryPropertyFlags requiredFlags,
            VkMemoryPropertyFlags preferredFlags = 0);
        ~VKMemoryAllocation();
 
        VKMemoryAllocation(const VKMemoryAllocation&) = delete;
        VKMemoryAllocation& operator=(const VKMemoryAllocation&) = delete;
 
        VKMemoryAllocation(VKMemoryAllocation&&) noexcept;
        VKMemoryAllocation& operator=(VKMemoryAllocation&&) noexcept;
 
    public:
        explicit operator bool() const { return allocation != VK_NULL_HANDLE; }
 
    public:
        void bind(VkBuffer buffer);
 
        void bind(VkImage image);
 
    public:
        [[nodiscard]] VkDeviceMemory getDeviceMemory() const;
 
        [[nodiscard]] VkDeviceSize getOffset() const;
 
        [[nodiscard]] VkDeviceSize getSize() const;
 
        [[nodiscard]] UInt32 getMemoryType() const;
 
        void* map();
 
        void unmap();
 
        void flush(VkDeviceSize offset = 0, VkDeviceSize size = VK_WHOLE_SIZE);
 
        void invalidate(VkDeviceSize offset = 0, VkDeviceSize size = VK_WHOLE_SIZE);
    };
 
    class VKMemoryAllocator final : public VKDeviceObject<VKMemoryAllocator> {
        friend class VKMemoryAllocation;
 
    private:
        VmaAllocator allocator = nullptr;
 
    public:
        explicit VKMemoryAllocator(VKDevice& device, VkDeviceSize preferredLargeHeapBlockSize);
        ~VKMemoryAllocator();
 
    public:
        VKMemoryAllocation allocate(const VkMemoryRequirements& memoryRequirements, VkMemoryPropertyFlags requiredFlags,
            VkMemoryPropertyFlags preferredFlags = 0);
 
        VKMemoryAllocation allocate(VkBuffer buffer, VkMemoryPropertyFlags requiredFlags, VkMemoryPropertyFlags preferredFlags = 0);
 
        VKMemoryAllocation allocate(VkImage image, VkMemoryPropertyFlags requiredFlags, VkMemoryPropertyFlags preferredFlags = 0);
    };
 
} // namespace CeresEngine