LiteFX::Rendering::CommandQueue

Represents a command queue.

Synopsis

Declared in <litefx/rendering.hpp>

template<typename TCommandBuffer>
requires meta::implements<TCommandBuffer, CommandBuffer<typename TCommandBuffer::command_buffer_type, typename TCommandBuffer::buffer_type, typename TCommandBuffer::vertex_buffer_type, typename TCommandBuffer::index_buffer_type, typename TCommandBuffer::image_type, typename TCommandBuffer::barrier_type, typename TCommandBuffer::pipeline_type, typename TCommandBuffer::bottom_level_acceleration_structure_type, typename TCommandBuffer::top_level_acceleration_structure_type>>
class CommandQueue
    : public ICommandQueue

Base Classes

Name	Description
ICommandQueue	The interface for a command queue.

Types

Name	Description
QueueSubmittedEventArgs	Event arguments for a ICommandQueue::submitted event.
QueueSubmittingEventArgs	Event arguments for a ICommandQueue::submitting event.

Type Aliases

Name
_Esft_type
command_buffer_type

Member Functions

Name	Description
~CommandQueue [destructor] [virtual]	Destructor
beginDebugRegion [virtual]	Starts a new debug region.
createCommandBuffer [virtual]	Creates a command buffer that can be used to allocate commands on the queue.
currentFence [virtual]	Returns the value of the latest fence inserted into the queue.
endDebugRegion [virtual]	Ends the current debug region.
lastCompletedFence [virtual]	Returns the last fence that was completed on the queue.
priority [virtual]	Returns the priority of the queue.
setDebugMarker [virtual]	Inserts a debug marker.
shared_from_this	Returns a shared pointer to the current object instance.
submit	submit overloads
type [virtual]	Returns the type of the queue.
waitFor	waitFor overloads
weak_from_this	Returns a weak pointer to the current object instance.

Data Members

Name	Description
submitted	Invoked, after one or more command buffers have been submitted to the queue.
submitting	Invoked, when one or more command buffers are submitted to the queue.

Static Data Members

Name	Description
DEFAULT_DEBUG_COLOR	The default color value for a debug region or marker, if no other has been specified.

Using Declarations

Name
submit

Protected Types

Name	Description
Allocator	An allocator used to allocate the shared object.

Protected Member Functions

Name	Description
CommandQueue [constructor]	Constructors
operator=	Assignment operators
releaseSharedState

Protected Static Member Functions

Name	Description
create	Generic factory method used to create instances of the shared object.

Template Parameters

Name	Description
TCommandBuffer	The type of the command buffer for this queue. Must implement CommandBuffer.

Derived Classes

Name	Description
DirectX12Queue	Implements a DirectX 12 command queue.
VulkanQueue	Implements a Vulkan command queue.