Allocation.h

//
//  Created by Bradley Austin Davis on 2018/10/29
//  Adapted for Vulkan in 2022-2025 by dr Karol Suprynowicz.
//  Copyright 2013-2018 High Fidelity, Inc.
//  Copyright 2023-2025 Overte e.V.
//
//  Distributed under the Apache License, Version 2.0.
//  See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html
//  SPDX-License-Identifier: Apache-2.0
//
//  Contains parts of Vulkan Samples, Copyright (c) 2018, Sascha Willems, distributed on MIT License.
//
 
#pragma once
 
#include "Config.h"
#include <cstring>
 
namespace vks {
 
    // A wrapper class for an allocation, either an Image or Buffer.  Not intended to be used used directly
    // but only as a base class providing common functionality for the classes below.
    //
    // Provides easy to use mechanisms for mapping, unmapping and copying host data to the device memory
    struct Allocation {
        static void initAllocator(const VkPhysicalDevice&, const VkDevice&);
 
        void* rawmap(size_t offset = 0, VkDeviceSize size = VK_WHOLE_SIZE);
        void unmap();
 
        template <typename T = void>
        inline T* map(size_t offset = 0, VkDeviceSize size = VK_WHOLE_SIZE) {
            return (T*)rawmap(offset, size);
        }
 
        inline void copy(size_t size, const void* data, VkDeviceSize offset = 0) const {
            memcpy((uint8_t*)mapped + offset, data, size);
        }
 
        template<typename T>
        inline void copy(const T& data, VkDeviceSize offset = 0) const {
            copy(sizeof(T), &data, offset);
        }
 
        template<typename T>
        inline void copy(const std::vector<T>& data, VkDeviceSize offset = 0) const {
            copy(sizeof(T) * data.size(), data.data(), offset);
        }
 
        void flush(VkDeviceSize size, VkDeviceSize offset = 0);
        void invalidate(VkDeviceSize size, VkDeviceSize offset = 0);
        virtual void destroy();
 
 
        VkDevice device;
        VkDeviceSize size{ 0 };
        VkDeviceSize alignment{ 0 };
        VkDeviceSize allocSize{ 0 };
 
#if VULKAN_USE_VMA
        static VmaAllocator& getAllocator();
 
        VmaAllocation allocation;
        VkMemoryPropertyFlags memoryPropertyFlags;
#else
        VkDeviceMemory memory;
#endif
        void* mapped{ nullptr };
 
    };
}