LiteFX::Rendering::ICommandBuffer

The interface for a command buffer.

Synopsis

Declared in <litefx/rendering_api.hpp>

class [[dllimport, dllexport]] ICommandBuffer
    : public SharedObject

Base Classes

Name	Description
SharedObject	Base class for an object that can be shared.

Types

Name	Description
TrackedResources	Stores the resources that are tracked by the command buffer until they can be safely released.

Type Aliases

Name
_Esft_type

Member Functions

Name	Description
~ICommandBuffer [destructor] [virtual]	Destructor
barrier	Executes the transitions that have been added to barrier.
bind	bind overloads
buildAccelerationStructure	buildAccelerationStructure overloads
copyAccelerationStructure	Copies the acceleration structure from into the acceleration structure to.
dispatch	Executes a compute shader.
dispatchIndirect	Executes a set of indirect dispatches.
dispatchMesh	Executes a mesh shader pipeline.
dispatchMeshIndirect	Executes a set of indirect mesh shader dispatches.
draw	draw overloads
drawIndexed	drawIndexed overloads
drawIndexedIndirect	Executes a set of indirect indexed draw calls.
drawIndirect	Executes a set of indirect non-indexed draw calls.
execute	execute overloads
makeBarrier	Creates a new barrier instance.
pushConstants	Pushes a block of memory into the push constants backing memory.
queue	Gets a pointer to the command queue that this command buffer was allocated from or nullptr, if the queue has already been released.
recording [virtual]	Returns true, if the command buffer is currently recording and false otherwise.
secondary [virtual]	Returns true, if the command buffer is a secondary command buffer, or false otherwise.
setBlendFactors [virtual]	Sets the blend factors for the subsequent draw calls.
setDepthBounds [virtual]	Sets the depth range for the depth bounds test.
setScissors	setScissors overloads
setStencilRef [virtual]	Sets the stencil reference for the subsequent draw calls.
setViewports	setViewports overloads
shared_from_this	Returns a shared pointer to the current object instance.
submit [virtual]	Submits the command buffer to parent command
traceRays	Executes a query on a ray-tracing pipeline.
track	track overloads
trackedResources [virtual]	Returns the resources that are currently tracked by the command buffer.
transfer	transfer overloads
updateAccelerationStructure	updateAccelerationStructure overloads
use	Sets the active pipeline state.
weak_from_this	Returns a weak pointer to the current object instance.
writeTimingEvent [virtual]	Writes the current GPU time stamp value for the timing event.

Protected Types

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

Protected Member Functions

Name	Description
ICommandBuffer [constructor]	Constructors
operator=	Assignment operators
releaseSharedState [virtual]	Called by the parent command queue to signal that the command buffer should release it's shared state.

Protected Static Member Functions

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

Friends

Name	Description
LiteFX::Rendering::ICommandQueue	The interface for a command queue.

Derived Classes

Name	Description
CommandBuffer	Represents a command buffer, that buffers commands that should be submitted to a CommandQueue.