Skip to content

LiteFX

LiteFX::Rendering::Backends::VulkanCommandBuffer

`LiteFX::Rendering::Backends::VulkanCommandBuffer`¶

Records commands for a VulkanQueue

Synopsis¶

Declared in <litefx/backends/vulkan.hpp>

class [[dllimport, dllexport]] VulkanCommandBuffer final
    : public CommandBuffer<VulkanCommandBuffer, IVulkanBuffer, IVulkanVertexBuffer, IVulkanIndexBuffer, IVulkanImage, VulkanBarrier, VulkanPipelineState, VulkanBottomLevelAccelerationStructure, VulkanTopLevelAccelerationStructure>
    , public Resource<VkCommandBuffer>

Base Classes¶

Name	Description
`CommandBuffer<VulkanCommandBuffer, IVulkanBuffer, IVulkanVertexBuffer, IVulkanIndexBuffer, IVulkanImage, VulkanBarrier, VulkanPipelineState, VulkanBottomLevelAccelerationStructure, VulkanTopLevelAccelerationStructure>`	Represents a command buffer, that buffers commands that should be submitted to a `CommandQueue`.
`Resource<VkCommandBuffer>`	Implements the `IResource` interface.

Type Aliases¶

Name
`barrier_type`
`base_type`
`bottom_level_acceleration_structure_type`
`buffer_type`
`command_buffer_type`
`descriptor_set_layout_type`
`descriptor_set_type`
`handle_type`
`image_type`
`index_buffer_type`
`pipeline_layout_type`
`pipeline_type`
`push_constants_layout_type`
`top_level_acceleration_structure_type`
`vertex_buffer_type`

Member Functions¶

Name	Description
`~VulkanCommandBuffer` [destructor] [virtual]	Destructor
`barrier`	Executes the transitions that have been added to `barrier.`
`begin`	`begin` overloads
`bind`	`bind` overloads
`buildAccelerationStructure`	`buildAccelerationStructure` overloads
`copyAccelerationStructure`	Copies the acceleration structure `from` into the acceleration structure `to.`
`dispatch` [virtual]	Executes a compute shader.
`dispatchIndirect`	Executes a set of indirect dispatches.
`dispatchMesh` [virtual]	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.
`end` [virtual]	Ends recording commands on the command buffer.
`execute`	`execute` overloads
`handle` [virtual]	Returns the resource managed by the class.
`isSecondary` [virtual]	Returns `true`, if the command buffer is a secondary command buffer, or `false` otherwise.
`makeBarrier` [virtual]	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.
`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
`submit` [virtual]	Submits the command buffer to parent command
`traceRays`	Executes a query on a ray-tracing pipeline.
`track`	`track` overloads
`transfer`	`transfer` overloads
`updateAccelerationStructure`	`updateAccelerationStructure` overloads
`use`	Sets the active pipeline state.
`writeTimingEvent` [virtual]	Writes the current GPU time stamp value for the timing event.

Static Member Functions¶

Name	Description
`create`	Initializes a command buffer from a command queue.

Using Declarations¶

Name
`barrier`
`bind`
`buildAccelerationStructure`
`copyAccelerationStructure`
`dispatch`
`dispatchIndirect`
`dispatchMesh`
`draw`
`drawIndexed`
`drawIndexedIndirect`
`drawIndirect`
`pushConstants`
`transfer`
`updateAccelerationStructure`
`use`

Protected Member Functions¶

Name	Description
`operator=`	Assignment operators
`handle` [virtual]	Returns the resource managed by the class.

Friends¶

Name	Description
`LiteFX::SharedObject::Allocator`	An allocator used to allocate the shared object.
`LiteFX::Rendering::Backends::VulkanCommandBuffer::VulkanCommandBufferImpl`
`LiteFX::PimplPtr`	A smart pointer that manages an implementation instance for a public interface class.

See Also¶

VulkanQueue