FRenderCommandList

Navigation

API > API/Runtime > API/Runtime/RenderCore

Represents a command list of render commands that can be recorded on a thread and submitted. Recording is done using the FRecordScope which sets the command list in TLS, diverting any render commands enqueued via ENQUEUE_RENDER_COMMAND into the command list. Command lists can submit into other command lists as well as the main render command pipes. Command lists are useful for a couple reasons. First, the cost of queuing commands into command lists is very light when recording into command lists as there are no locks, at the cost of deferring submission of the work. Second, command lists can be submitted and recorded asynchronously from each other.

Command lists actually contain several sub-command lists, one for each render command pipe. At submission time the sub-command lists are submitted separately. It doesn't matter if commands are enqueued to a pipe, they all go into the same command list.

Command lists have two operations, Close and Submit. Call Close when recording is complete. Call Submit to patch the command list into a parent command list or the global render command pipes. Use FRenderCommandDispatcher::Submit to submit command lists.

Command lists support a fast-path with ERenderCommandListFlags::CloseOnSubmit. This fuses the Close / Submit operations but enables an optimization to skip empty lists at the end, which is helpful when managing a large number of command lists (see FParallelForContext for a concrete use case).

Syntax

class FRenderCommandList : public TConcurrentLinearObject< FRenderCommandList >  
Copy full snippet

class FRenderCommandList : public TConcurrentLinearObject< FRenderCommandList >

Inheritance Hierarchy

• TConcurrentLinearObject → FRenderCommandList

Constructors

Destructors

Classes

Enums

Public

Typedefs

Constants

Variables

Public

Protected

Functions

Public

Static