NDEVR
API Documentation
VulkanQueue.h
1/*--------------------------------------------------------------------------------------------
2Copyright (c) 2019, NDEVR LLC
3tyler.parke@ndevr.org
4 __ __ ____ _____ __ __ _______
5 | \ | | | __ \ | ___|\ \ / / | __ \
6 | \ | | | | \ \ | |___ \ \ / / | |__) |
7 | . \| | | |__/ / | |___ \ V / | _ /
8 | |\ |_|_____/__|_____|___\_/____| | \ \
9 |__| \__________________________________| \__\
10
11Subject to the terms of the Enterprise+ Agreement, NDEVR hereby grants
12Licensee a limited, non-exclusive, non-transferable, royalty-free license
13(without the right to sublicense) to use the API solely for the purpose of
14Licensee's internal development efforts to develop applications for which
15the API was provided.
16
17The above copyright notice and this permission notice shall be included in all
18copies or substantial portions of the Software.
19
20THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
21INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
22PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
23FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
24OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
25DEALINGS IN THE SOFTWARE.
26
27Library: Graphics
28File: VulkanQueue
29Included in API: True
30Author(s): Tyler Parke
31 *-----------------------------------------------------------------------------------------**/
32#pragma once
33#include "VulkanDefines.h"
34#include "Base/Headers/Pointer.hpp"
35#include "Base/Headers/BaseFunctions.hpp"
36#include "Base/Headers/RWLock.h"
37struct VkQueue_T;
38struct VkCommandPool_T;
39struct VkCommandBuffer_T;
40namespace NDEVR
41{
42 class VulkanInstance;
73
78 {
79 public:
86 VkQueue_T* queue() { return m_core->queue; };
88 VkCommandPool_T* command_pool() { return m_core->command_pool; };
89 protected:
92 };
93}
Provides a modifiable pointer that has shared ownership of a dynamically allocated object.
Definition Pointer.hpp:356
The connection between the NDEVR API and the Vulkan library.
A queue of commands or actions to be executed in order by the Vulkan engine.
Definition VulkanQueue.h:49
VkCommandPool_T * command_pool
The native Vulkan command pool handle.
Definition VulkanQueue.h:59
VkQueue_T * queue
The native Vulkan queue handle.
Definition VulkanQueue.h:58
uint04 lastThread() const
Returns the ID of the thread that last used this queue.
uint04 m_current_thread
The thread currently using this queue.
Definition VulkanQueue.h:70
~VulkanQueueCore()
Destructor.
uint04 currentThread() const
Returns the ID of the thread currently using this queue.
void clearLastThread()
Clears the last thread record.
void setThread(uint04 thread)
Sets the current thread using this queue.
DynamicPointer< VulkanInstance > m_instance
The Vulkan instance this queue belongs to.
Definition VulkanQueue.h:71
VulkanQueueCore(const DynamicPointer< VulkanInstance > &instance, VkQueue_T *queue, VkCommandPool_T *command_pool)
Constructs a queue core wrapping native Vulkan queue and command pool handles.
uint04 m_last_thread
The thread that last used this queue.
Definition VulkanQueue.h:69
VulkanQueueCore * m_core
The underlying queue core.
Definition VulkanQueue.h:90
VkCommandPool_T * command_pool()
Returns the native Vulkan command pool handle.
Definition VulkanQueue.h:88
VulkanQueue(VulkanQueueCore *core)
Constructs a thread-safe queue wrapper, acquiring a lock on the core.
WLock m_queue_lock
Write lock held for the duration of this object's lifetime.
Definition VulkanQueue.h:91
VkQueue_T * queue()
Returns the native Vulkan queue handle.
Definition VulkanQueue.h:86
~VulkanQueue()
Destructor.
Used to lock a particular variable for writing.
Definition RWLock.h:272
The primary namespace for the NDEVR SDK.
uint32_t uint04
-Defines an alias representing a 4 byte, unsigned integer -Can represent exact integer values 0 throu...