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

        void addStorageBuffer(uint04 binding);

        void addPushConstantRange(uint04 size);

        void create(const VulkanShader& shader);

        void bindBuffer(uint04 binding, VkBuffer vk_buffer, VkDeviceSize size);

        void pushConstants(VkCommandBuffer cmd, const void* data, uint04 size) const;

        void dispatch(VkCommandBuffer cmd, uint04 gx, uint04 gy, uint04 gz) const;

        static void computeBarrier(VkCommandBuffer cmd);

        void cleanup();
 
    private:
        ConstPointer<VulkanComputeDevice> m_compute_device; 
 
        Buffer<VkDescriptorSetLayoutBinding> m_bindings;    
        uint04 m_push_constant_size = 0;                    
 
        VkDescriptorSetLayout m_descriptor_set_layout = VK_NULL_HANDLE; 
        VkDescriptorPool m_descriptor_pool = VK_NULL_HANDLE;            
        VkDescriptorSet m_descriptor_set = VK_NULL_HANDLE;              
        VkPipelineLayout m_pipeline_layout = VK_NULL_HANDLE;            
        VkPipeline m_pipeline = VK_NULL_HANDLE;                         
    };
}