VulkanQueue.h

Go to the documentation of this file.

/*--------------------------------------------------------------------------------------------
Copyright (c) 2019, 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: Graphics
File: VulkanQueue
Included in API: True
Author(s): Tyler Parke
 *-----------------------------------------------------------------------------------------**/
#pragma once
#include "VulkanDefines.h"
#include "Base/Headers/Pointer.hpp"
#include "Base/Headers/BaseFunctions.hpp"
#include "Base/Headers/RWLock.h"
struct VkQueue_T;
struct VkCommandPool_T;
struct VkCommandBuffer_T;
namespace NDEVR
{
    class VulkanInstance;
    /**--------------------------------------------------------------------------------------------------
    \brief A queue of commands or actions to be executed in order by the Vulkan engine.
    \warning Should not be used directly as not thread safe but instead accessed via VulkanQueue
    **/
    class VulkanQueueCore
    {
    public:
        VulkanQueueCore(const DynamicPointer<VulkanInstance>& instance, VkQueue_T* queue, VkCommandPool_T* command_pool);
        ~VulkanQueueCore();
        VkQueue_T* queue;
        VkCommandPool_T* command_pool;
        uint04 lastThread() const;
        uint04 currentThread() const;
        void setThread(uint04 thread);
        void clearLastThread();
    protected:
        uint04 m_last_thread;
        uint04 m_current_thread;
        DynamicPointer<VulkanInstance> m_instance;
    };
    /**--------------------------------------------------------------------------------------------------
    \brief A wrapper around a VulkanQueueCore that allows for thread-safe access to a specific queue.
    **/
    class VulkanQueue
    {
    public:
        VulkanQueue(VulkanQueueCore* core);
        ~VulkanQueue();
        VkQueue_T* queue() { return m_core->queue; };
        VkCommandPool_T* command_pool() { return m_core->command_pool; };
    protected:
        VulkanQueueCore* m_core;
        WLock m_queue_lock;
    };
}