VulkanComputeBuffer.h

/*--------------------------------------------------------------------------------------------
Copyright (c) 2026, NDEVR LLC
tyler.parke@ndevr.org
  __    __   ____     _____ __     __  _______
 |  \  |  | |  __ \  |  ___|\ \   / / |   __  \
 |   \ |  | | |  \ \ | |___  \ \ / /  |  |__)  |
 |  . \|  | | |__/ / | |___   \ V /   |   _   /
 |  |\    |_|_____/__|_____|___\_/____|  | \  \
 |__| \__________________________________|  \__\
 
Subject to the terms of the Enterprise+ Agreement, NDEVR hereby grants
Licensee a limited, non-exclusive, non-transferable, royalty-free license
(without the right to sublicense) to use the API solely for the purpose of
Licensee's internal development efforts to develop applications for which
the API was provided.
 
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.
 
Library: VulkanCompute
File: VulkanComputeBuffer
Included in API: True
Author(s): Tyler Parke
 *-----------------------------------------------------------------------------------------**/
#pragma once
#include "DLLInfo.h"
#include "VulkanComputeDevice.h"
#include <NDEVR/Pointer.h>
 
namespace NDEVR
{
    class VULKAN_COMPUTE_API VulkanComputeBuffer
    {
    public:
        VulkanComputeBuffer(const ConstPointer<VulkanComputeDevice>& compute_device);
        ~VulkanComputeBuffer();

        void allocate(VkDeviceSize byte_size, bool device_local = false);

        void upload(const void* data, VkDeviceSize byte_size);

        void download(void* data, VkDeviceSize byte_size) const;

        void cleanup();

        VkBuffer buffer() const { return m_device_buffer; }

        VkDeviceSize byteSize() const { return m_byte_size; }

        bool isAllocated() const { return m_device_buffer != VK_NULL_HANDLE; }
 
    private:
        VkBuffer createBuffer(VkDeviceSize size, VkBufferUsageFlags usage, VkMemoryPropertyFlags properties, VkDeviceMemory& memory) const;
        void copyBuffer(VkBuffer src, VkBuffer dst, VkDeviceSize size) const;
 
    private:
        ConstPointer<VulkanComputeDevice> m_compute_device; 
        VkBuffer m_device_buffer = VK_NULL_HANDLE;          
        VkDeviceMemory m_device_memory = VK_NULL_HANDLE;    
        VkBuffer m_staging_buffer = VK_NULL_HANDLE;         
        VkDeviceMemory m_staging_memory = VK_NULL_HANDLE;   
        VkDeviceSize m_byte_size = 0;                       
        bool m_device_local = false;                        
    };
}