NDEVR
API Documentation
VulkanQueueCore

A queue of commands or actions to be executed in order by the Vulkan engine. More...

Collaboration diagram for VulkanQueueCore:
[legend]

Public Member Functions

 VulkanQueueCore (const DynamicPointer< VulkanInstance > &instance, VkQueue_T *queue, VkCommandPool_T *command_pool)
 Constructs a queue core wrapping native Vulkan queue and command pool handles.
 ~VulkanQueueCore ()
 Destructor.
void clearLastThread ()
 Clears the last thread record.
uint04 currentThread () const
 Returns the ID of the thread currently using this queue.
uint04 lastThread () const
 Returns the ID of the thread that last used this queue.
void setThread (uint04 thread)
 Sets the current thread using this queue.

Public Attributes

VkCommandPool_T * command_pool
 The native Vulkan command pool handle.
VkQueue_T * queue
 The native Vulkan queue handle.

Protected Attributes

uint04 m_current_thread
 The thread currently using this queue.
DynamicPointer< VulkanInstancem_instance
 The Vulkan instance this queue belongs to.
uint04 m_last_thread
 The thread that last used this queue.

Detailed Description

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

Definition at line 48 of file VulkanQueue.h.

Constructor & Destructor Documentation

◆ VulkanQueueCore()

VulkanQueueCore::VulkanQueueCore ( const DynamicPointer< VulkanInstance > & instance,
VkQueue_T * queue,
VkCommandPool_T * command_pool )

Constructs a queue core wrapping native Vulkan queue and command pool handles.

Parameters
[in]instanceThe Vulkan instance.
[in]queueThe native Vulkan queue handle.
[in]command_poolThe native Vulkan command pool handle.

References command_pool, and queue.

Member Function Documentation

◆ currentThread()

uint04 VulkanQueueCore::currentThread ( ) const

Returns the ID of the thread currently using this queue.

Returns
The thread ID.

◆ lastThread()

uint04 VulkanQueueCore::lastThread ( ) const

Returns the ID of the thread that last used this queue.

Returns
The thread ID.

◆ setThread()

void VulkanQueueCore::setThread ( uint04 thread)

Sets the current thread using this queue.

Parameters
[in]threadThe thread ID.

The documentation for this class was generated from the following file: