#include <qrhigles2_p.h>

Inheritance diagram for QGles2CommandBuffer:

Collaboration diagram for QGles2CommandBuffer:

Classes
struct	Command
struct	ComputePassState
struct	GraphicsPassState
struct	TextureUnitState

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 = std::pair<int, quint32>
	Synonym for std::pair<int, quint32>.
using	VertexInput = std::pair<QRhiBuffer *, quint32>
	Synonym for std::pair<QRhiBuffer *, quint32>.
Public Types inherited from QRhiResource
enum	Type { Buffer , Texture , Sampler , RenderBuffer , RenderPassDescriptor , SwapChainRenderTarget , TextureRenderTarget , ShaderResourceBindings , GraphicsPipeline , SwapChain , ComputePipeline , CommandBuffer , ShadingRateMap }
	Specifies type of the resource. More...

Public Member Functions
	QGles2CommandBuffer (QRhiImplementation *rhi)
	~QGles2CommandBuffer ()
void	destroy () override
	Releases (or requests deferred releasing of) the underlying native graphics resources.
const void *	retainData (const QByteArray &data)
const uchar *	retainBufferData (const QRhiBufferData &data)
const void *	retainImage (const QImage &image)
void	resetCommands ()
void	resetState ()
void	resetCachedState ()
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	setShadingRate (const QSize &coarsePixelSize)
	Sets the shading rate for the following draw calls to coarsePixelSize.
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
QRhiBackendCommandList< Command >	commands
QVarLengthArray< QRhiPassResourceTracker, 8 >	passResTrackers
int	currentPassResTrackerIndex
PassType	recordingPass
bool	passNeedsResourceTracking
double	lastGpuTime = 0
QRhiRenderTarget *	currentTarget
QRhiGraphicsPipeline *	currentGraphicsPipeline
QRhiComputePipeline *	currentComputePipeline
uint	currentPipelineGeneration
QRhiShaderResourceBindings *	currentGraphicsSrb
QRhiShaderResourceBindings *	currentComputeSrb
uint	currentSrbGeneration
struct QGles2CommandBuffer::GraphicsPassState	graphicsPassState
struct QGles2CommandBuffer::ComputePassState	computePassState
struct QGles2CommandBuffer::TextureUnitState	textureUnitState [16]
QVarLengthArray< QByteArray, 4 >	dataRetainPool
QVarLengthArray< QRhiBufferData, 4 >	bufferDataRetainPool
QVarLengthArray< QImage, 4 >	imageRetainPool

Static Public Attributes
static const int	MAX_DYNAMIC_OFFSET_COUNT = 8

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 306 of file qrhigles2_p.h.

Member Enumeration Documentation

◆ PassType

enum QGles2CommandBuffer::PassType

Enumerator
NoPass
RenderPass
ComputePass

Definition at line 557 of file qrhigles2_p.h.

Constructor & Destructor Documentation

◆ QGles2CommandBuffer()

QGles2CommandBuffer::QGles2CommandBuffer ( QRhiImplementation * rhi )

Definition at line 6802 of file qrhigles2.cpp.

◆ ~QGles2CommandBuffer()

QGles2CommandBuffer::~QGles2CommandBuffer ( )

Definition at line 6808 of file qrhigles2.cpp.

Member Function Documentation

◆ destroy()

void QGles2CommandBuffer::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.

Note: Resources referenced by commands for the current frame should not be released until the frame is submitted by QRhi::endFrame().

The QRhiResource destructor also performs the same task, so calling this function is not necessary before deleting a QRhiResource.

See also: deleteLater()

Implements QRhiResource.

Definition at line 6813 of file qrhigles2.cpp.

◆ resetCachedState()

void QGles2CommandBuffer::resetCachedState ( )

inline

Definition at line 671 of file qrhigles2_p.h.

References currentPipelineGeneration, currentSrbGeneration, and QGles2CommandBuffer::ComputePassState::reset().

Referenced by QRhiGles2::beginComputePass(), QRhiGles2::beginPass(), QRhiGles2::endExternal(), and resetState().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ resetCommands()

void QGles2CommandBuffer::resetCommands ( )

inline

Definition at line 654 of file qrhigles2_p.h.

References currentPassResTrackerIndex.

Referenced by QRhiGles2::beginExternal(), and resetState().

Here is the caller graph for this function:

◆ resetState()

void QGles2CommandBuffer::resetState ( )

inline

Definition at line 663 of file qrhigles2_p.h.

References NoPass, passNeedsResourceTracking, recordingPass, resetCachedState(), and resetCommands().

Here is the call graph for this function:

◆ retainBufferData()

const uchar * QGles2CommandBuffer::retainBufferData ( const QRhiBufferData & data )

inline

Definition at line 646 of file qrhigles2_p.h.

◆ retainData()

const void * QGles2CommandBuffer::retainData ( const QByteArray & data )

inline

Definition at line 642 of file qrhigles2_p.h.

◆ retainImage()

const void * QGles2CommandBuffer::retainImage ( const QImage & image )

inline

Definition at line 650 of file qrhigles2_p.h.

Member Data Documentation

◆ bufferDataRetainPool

QVarLengthArray<QRhiBufferData, 4> QGles2CommandBuffer::bufferDataRetainPool

Definition at line 638 of file qrhigles2_p.h.

◆ commands

QRhiBackendCommandList<Command> QGles2CommandBuffer::commands

Definition at line 563 of file qrhigles2_p.h.

◆ computePassState

struct QGles2CommandBuffer::ComputePassState QGles2CommandBuffer::computePassState

◆ currentComputePipeline

QRhiComputePipeline* QGles2CommandBuffer::currentComputePipeline

Definition at line 572 of file qrhigles2_p.h.

◆ currentComputeSrb

QRhiShaderResourceBindings* QGles2CommandBuffer::currentComputeSrb

Definition at line 575 of file qrhigles2_p.h.

◆ currentGraphicsPipeline

QRhiGraphicsPipeline* QGles2CommandBuffer::currentGraphicsPipeline

Definition at line 571 of file qrhigles2_p.h.

◆ currentGraphicsSrb

QRhiShaderResourceBindings* QGles2CommandBuffer::currentGraphicsSrb

Definition at line 574 of file qrhigles2_p.h.

◆ currentPassResTrackerIndex

int QGles2CommandBuffer::currentPassResTrackerIndex

Definition at line 565 of file qrhigles2_p.h.

Referenced by QRhiGles2::endExternal(), QRhiGles2::enqueueBarriersForPass(), resetCommands(), QRhiGles2::setShaderResources(), and QRhiGles2::setVertexInput().

◆ currentPipelineGeneration

uint QGles2CommandBuffer::currentPipelineGeneration

Definition at line 573 of file qrhigles2_p.h.

Referenced by resetCachedState().

◆ currentSrbGeneration

uint QGles2CommandBuffer::currentSrbGeneration

Definition at line 576 of file qrhigles2_p.h.

Referenced by resetCachedState().

◆ currentTarget

QRhiRenderTarget* QGles2CommandBuffer::currentTarget

Definition at line 570 of file qrhigles2_p.h.

◆ dataRetainPool

QVarLengthArray<QByteArray, 4> QGles2CommandBuffer::dataRetainPool

Definition at line 637 of file qrhigles2_p.h.

◆ graphicsPassState

struct QGles2CommandBuffer::GraphicsPassState QGles2CommandBuffer::graphicsPassState

◆ imageRetainPool

QVarLengthArray<QImage, 4> QGles2CommandBuffer::imageRetainPool

Definition at line 639 of file qrhigles2_p.h.

◆ lastGpuTime

double QGles2CommandBuffer::lastGpuTime = 0

Definition at line 569 of file qrhigles2_p.h.

Referenced by QRhiGles2::lastCompletedGpuTime().

◆ MAX_DYNAMIC_OFFSET_COUNT

const int QGles2CommandBuffer::MAX_DYNAMIC_OFFSET_COUNT = 8

static

Definition at line 313 of file qrhigles2_p.h.

Referenced by QRhiGles2::setShaderResources().

◆ passNeedsResourceTracking

bool QGles2CommandBuffer::passNeedsResourceTracking

Definition at line 568 of file qrhigles2_p.h.

Referenced by resetState(), QRhiGles2::setShaderResources(), and QRhiGles2::setVertexInput().

◆ passResTrackers

QVarLengthArray<QRhiPassResourceTracker, 8> QGles2CommandBuffer::passResTrackers

Definition at line 564 of file qrhigles2_p.h.

◆ recordingPass

◆ textureUnitState

struct QGles2CommandBuffer::TextureUnitState QGles2CommandBuffer::textureUnitState[16]

The documentation for this struct was generated from the following files:

qtbase/src/gui/rhi/qrhigles2_p.h (9805a4cba511d13bb3c64fd4e0e61895e2fdb666)
qtbase/src/gui/rhi/qrhigles2.cpp (9805a4cba511d13bb3c64fd4e0e61895e2fdb666)

Classes

Public Types

Public Member Functions

Public Attributes

Static Public Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ PassType

Constructor & Destructor Documentation

◆ QGles2CommandBuffer()

◆ ~QGles2CommandBuffer()

Member Function Documentation

◆ destroy()

◆ resetCachedState()

◆ resetCommands()

◆ resetState()

◆ retainBufferData()

◆ retainData()

◆ retainImage()

Member Data Documentation

◆ bufferDataRetainPool

◆ commands

◆ computePassState

◆ currentComputePipeline

◆ currentComputeSrb

◆ currentGraphicsPipeline

◆ currentGraphicsSrb

◆ currentPassResTrackerIndex

◆ currentPipelineGeneration

◆ currentSrbGeneration

◆ currentTarget

◆ dataRetainPool

◆ graphicsPassState

◆ imageRetainPool

◆ lastGpuTime

◆ MAX_DYNAMIC_OFFSET_COUNT

◆ passNeedsResourceTracking

◆ passResTrackers

◆ recordingPass

◆ textureUnitState