#include <qrhivulkan_p.h>

Inheritance diagram for QVkCommandBuffer:

Collaboration diagram for QVkCommandBuffer:

Classes
struct	Command

Public Types
enum	PassType { NoPass , RenderPass , ComputePass }

Public Types inherited from QRhiCommandBuffer
enum	IndexFormat { IndexUInt16 , IndexUInt32 }
	Specifies the index data type. More...

enum	BeginPassFlag { ExternalContent = 0x01 , DoNotTrackResourcesForCompute = 0x02 }
	Flag values for QRhi::beginPass() More...

using	DynamicOffset = QPair<int, quint32>
	Synonym for QPair<int, quint32>.

using	VertexInput = QPair<QRhiBuffer *, quint32>
	Synonym for QPair<QRhiBuffer *, quint32>.

Public Types inherited from QRhiResource
enum	Type { Buffer , Texture , Sampler , RenderBuffer , RenderPassDescriptor , SwapChainRenderTarget , TextureRenderTarget , ShaderResourceBindings , GraphicsPipeline , SwapChain , ComputePipeline , CommandBuffer }
	Specifies type of the resource. More...

Public Member Functions
	QVkCommandBuffer (QRhiImplementation *rhi)

	~QVkCommandBuffer ()

void	destroy () override
	Releases (or requests deferred releasing of) the underlying native graphics resources.

const QRhiNativeHandles *	nativeHandles ()

void	resetState ()

void	resetCachedState ()

void	resetCommands ()

void	resetPools ()

Public Member Functions inherited from QRhiCommandBuffer
QRhiResource::Type	resourceType () const override

void	resourceUpdate (QRhiResourceUpdateBatch *resourceUpdates)
	Sometimes committing resource updates is necessary or just more convenient without starting a render pass.

void	beginPass (QRhiRenderTarget rt, const QColor &colorClearValue, const QRhiDepthStencilClearValue &depthStencilClearValue, QRhiResourceUpdateBatch resourceUpdates=nullptr, BeginPassFlags flags={})
	Records starting a new render pass targeting the render target rt.

void	endPass (QRhiResourceUpdateBatch *resourceUpdates=nullptr)
	Records ending the current render pass.

void	setGraphicsPipeline (QRhiGraphicsPipeline *ps)
	Records setting a new graphics pipeline ps.

void	setShaderResources (QRhiShaderResourceBindings srb=nullptr, int dynamicOffsetCount=0, const DynamicOffset dynamicOffsets=nullptr)
	Records binding a set of shader resources, such as, uniform buffers or textures, that are made visible to one or more shader stages.

void	setVertexInput (int startBinding, int bindingCount, const VertexInput bindings, QRhiBuffer indexBuf=nullptr, quint32 indexOffset=0, IndexFormat indexFormat=IndexUInt16)
	Records vertex input bindings.

void	setViewport (const QRhiViewport &viewport)
	Records setting the active viewport rectangle specified in viewport.

void	setScissor (const QRhiScissor &scissor)
	Records setting the active scissor rectangle specified in scissor.

void	setBlendConstants (const QColor &c)
	Records setting the active blend constants to c.

void	setStencilRef (quint32 refValue)
	Records setting the active stencil reference value to refValue.

void	draw (quint32 vertexCount, quint32 instanceCount=1, quint32 firstVertex=0, quint32 firstInstance=0)
	Records a non-indexed draw.

void	drawIndexed (quint32 indexCount, quint32 instanceCount=1, quint32 firstIndex=0, qint32 vertexOffset=0, quint32 firstInstance=0)
	Records an indexed draw.

void	debugMarkBegin (const QByteArray &name)
	Records a named debug group on the command buffer with the specified name.

void	debugMarkEnd ()
	Records the end of a debug group.

void	debugMarkMsg (const QByteArray &msg)
	Inserts a debug message msg into the command stream.

void	beginComputePass (QRhiResourceUpdateBatch *resourceUpdates=nullptr, BeginPassFlags flags={})
	Records starting a new compute pass.

void	endComputePass (QRhiResourceUpdateBatch *resourceUpdates=nullptr)
	Records ending the current compute pass.

void	setComputePipeline (QRhiComputePipeline *ps)
	Records setting a new compute pipeline ps.

void	dispatch (int x, int y, int z)
	Records dispatching compute work items, with x, y, and z specifying the number of local workgroups in the corresponding dimension.

const QRhiNativeHandles *	nativeHandles ()

void	beginExternal ()
	To be called when the application before the application is about to enqueue commands to the current pass' command buffer by calling graphics API functions directly.

void	endExternal ()
	To be called once the externally added commands are recorded to the command buffer or context.

double	lastCompletedGpuTime ()

Public Member Functions inherited from QRhiResource
virtual	~QRhiResource ()
	Destructor.

void	deleteLater ()
	When called without a frame being recorded, this function is equivalent to deleting the object.

QByteArray	name () const

void	setName (const QByteArray &name)
	Sets a name for the object.

quint64	globalResourceId () const

QRhi *	rhi () const

Public Attributes
VkCommandBuffer	cb = VK_NULL_HANDLE

QRhiVulkanCommandBufferNativeHandles	nativeHandlesStruct

PassType	recordingPass

bool	passUsesSecondaryCb

double	lastGpuTime = 0

QRhiRenderTarget *	currentTarget

QRhiGraphicsPipeline *	currentGraphicsPipeline

QRhiComputePipeline *	currentComputePipeline

uint	currentPipelineGeneration

QRhiShaderResourceBindings *	currentGraphicsSrb

QRhiShaderResourceBindings *	currentComputeSrb

uint	currentSrbGeneration

int	currentDescSetSlot

VkBuffer	currentIndexBuffer

quint32	currentIndexOffset

VkIndexType	currentIndexFormat

VkBuffer	currentVertexBuffers [VERTEX_INPUT_RESOURCE_SLOT_COUNT]

quint32	currentVertexOffsets [VERTEX_INPUT_RESOURCE_SLOT_COUNT]

QVarLengthArray< VkCommandBuffer, 4 >	activeSecondaryCbStack

bool	inExternal

struct {

QHash< QRhiResource *, QPair< VkAccessFlags, bool > > writtenResources

}	computePassState

QRhiBackendCommandList< Command >	commands

QVarLengthArray< QRhiPassResourceTracker, 8 >	passResTrackers

int	currentPassResTrackerIndex

struct {

QVarLengthArray< VkClearValue, 4 > clearValue

QVarLengthArray< VkBufferImageCopy, 16 > bufferImageCopy

QVarLengthArray< uint32_t, 4 > dynamicOffset

QVarLengthArray< VkBuffer, 4 > vertexBuffer

QVarLengthArray< VkDeviceSize, 4 > vertexBufferOffset

QVarLengthArray< QByteArray, 4 > debugMarkerData

QVarLengthArray< VkImageMemoryBarrier, 8 > imageBarrier

QVarLengthArray< VkBufferMemoryBarrier, 8 > bufferBarrier

}	pools

Static Public Attributes
static const int	VERTEX_INPUT_RESOURCE_SLOT_COUNT = 32

Friends
class	QRhiVulkan

Additional Inherited Members
Protected Member Functions inherited from QRhiCommandBuffer
	QRhiCommandBuffer (QRhiImplementation *rhi)

Protected Member Functions inherited from QRhiResource
	QRhiResource (QRhiImplementation *rhi)

Protected Attributes inherited from QRhiResource
QRhiImplementation *	m_rhi = nullptr

quint64	m_id

QByteArray	m_objectName

Detailed Description

Definition at line 311 of file qrhivulkan_p.h.

Member Enumeration Documentation

◆ PassType

enum QVkCommandBuffer::PassType

Enumerator
NoPass
RenderPass
ComputePass

Definition at line 322 of file qrhivulkan_p.h.

Constructor & Destructor Documentation

◆ QVkCommandBuffer()

QVkCommandBuffer::QVkCommandBuffer ( QRhiImplementation * rhi )

Definition at line 7846 of file qrhivulkan.cpp.

References resetState().

Here is the call graph for this function:

◆ ~QVkCommandBuffer()

QVkCommandBuffer::~QVkCommandBuffer ( )

Definition at line 7852 of file qrhivulkan.cpp.

References destroy().

Here is the call graph for this function:

Member Function Documentation

◆ destroy()

void QVkCommandBuffer::destroy ( )

overridevirtual

Releases (or requests deferred releasing of) the underlying native graphics resources.

Safe to call multiple times, subsequent invocations will be a no-op then.

Once destroy() is called, the QRhiResource instance can be reused, by calling create() again. That will then result in creating new native graphics resources underneath.