VulkanComputeDevice.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: VulkanComputeDevice
Included in API: True
Author(s): Tyler Parke
 *-----------------------------------------------------------------------------------------**/
#pragma once
#include "DLLInfo.h"
#include "../../VulkanGraphics/Headers/VulkanDevice.h"
#include <NDEVR/Pointer.h>
 
namespace NDEVR
{
    class VULKAN_COMPUTE_API VulkanComputeDevice
    {
    public:
        VulkanComputeDevice(const ConstPointer<VulkanDevice>& device);
        ~VulkanComputeDevice();

        bool supportsCompute() const;

        uint04 computeFamilyIndex() const { return m_compute_family_index; }

        bool hasDedicatedComputeQueue() const { return m_is_dedicated_compute; }

        const ConstPointer<VulkanDevice>& vulkanDevice() const { return m_device; }

        VkDevice device() const { return m_device->device(); }

        VkQueue computeQueue() const { return m_compute_queue; }

        VkCommandPool computeCommandPool() const { return m_compute_command_pool; }

        VkCommandBuffer beginComputeCommands() const;

        void endComputeCommands(VkCommandBuffer cmd, bool wait_for_completion) const;

        Buffer<VkCommandBuffer> allocateComputeCommandBuffers(uint04 count) const;

        void resetComputeCommandBuffer(VkCommandBuffer cmd) const;

        void submitComputeCommands(VkCommandBuffer cmd) const;

        void waitComputeQueue() const;

        void freeComputeCommandBuffers(const Buffer<VkCommandBuffer>& cmds) const;

        uint04 findMemoryType(uint04 type_filter, uint04 properties) const;

        void beginTransferBatch() const;

        void endTransferBatch() const;

        VkCommandBuffer batchCommandBuffer() const { return m_batch_cmd; }
 
    private:
        void discoverComputeQueue();
        void createComputeCommandPool();
 
    private:
        ConstPointer<VulkanDevice> m_device;                                    
        VkQueue m_compute_queue = VK_NULL_HANDLE;                               
        VkCommandPool m_compute_command_pool = VK_NULL_HANDLE;                  
        mutable VkCommandBuffer m_batch_cmd = VK_NULL_HANDLE;                   
        uint04 m_compute_family_index = Constant<uint04>::Invalid;              
        bool m_is_dedicated_compute = false;                                    
    };
}