LiteFX::Rendering::ICommandQueue¶
The interface for a command queue.
Synopsis¶
Declared in <litefx/rendering_api.hpp>
class [[dllimport, dllexport]] ICommandQueue
: public SharedObject
Base Classes¶
| Name | Description |
|---|---|
SharedObject | Base class for an object that can be shared. |
Types¶
| Name | Description |
|---|---|
QueueSubmittedEventArgs | Event arguments for a ICommandQueue::submitted event. |
QueueSubmittingEventArgs | Event arguments for a ICommandQueue::submitting event. |
Type Aliases¶
| Name |
|---|
_Esft_type |
Member Functions¶
| Name | Description |
|---|---|
~ICommandQueue [destructor] [virtual] | Destructor |
beginDebugRegion [virtual] | Starts a new debug region. |
createCommandBuffer | 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. |
Protected Types¶
| Name | Description |
|---|---|
Allocator | An allocator used to allocate the shared object. |
Protected Member Functions¶
| Name | Description |
|---|---|
ICommandQueue [constructor] | Constructors |
operator= | Assignment operators |
releaseSharedState |
Protected Static Member Functions¶
| Name | Description |
|---|---|
create | Generic factory method used to create instances of the shared object. |
Derived Classes¶
| Name | Description |
|---|---|
CommandQueue | Represents a command queue. |