QNullRenderPassDescriptor Struct Reference

#include <qrhinull_p.h>

Inheritance diagram for QNullRenderPassDescriptor:

Collaboration diagram for QNullRenderPassDescriptor:

Public Member Functions
	QNullRenderPassDescriptor (QRhiImplementation *rhi)
	~QNullRenderPassDescriptor ()
void	destroy () override
	Releases (or requests deferred releasing of) the underlying native graphics resources.
bool	isCompatible (const QRhiRenderPassDescriptor *other) const override
QRhiRenderPassDescriptor *	newCompatibleRenderPassDescriptor () const override
QVector< quint32 >	serializedFormat () const override
Public Member Functions inherited from QRhiRenderPassDescriptor
QRhiResource::Type	resourceType () const override
virtual const QRhiNativeHandles *	nativeHandles ()
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

Additional Inherited Members
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...
Protected Member Functions inherited from QRhiRenderPassDescriptor
	QRhiRenderPassDescriptor (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 70 of file qrhinull_p.h.

Constructor & Destructor Documentation

QNullRenderPassDescriptor()

QNullRenderPassDescriptor::QNullRenderPassDescriptor

(

QRhiImplementation *

rhi

)

Definition at line 744 of file qrhinull.cpp.

Referenced by newCompatibleRenderPassDescriptor().

Here is the caller graph for this function:

~QNullRenderPassDescriptor()

QNullRenderPassDescriptor::~QNullRenderPassDescriptor

(

)

Definition at line 749 of file qrhinull.cpp.

References destroy().

Here is the call graph for this function:

Member Function Documentation

destroy()

void QNullRenderPassDescriptor::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 754 of file qrhinull.cpp.

References QRHI_RES_RHI.

Referenced by ~QNullRenderPassDescriptor().

Here is the caller graph for this function:

isCompatible()

bool QNullRenderPassDescriptor::isCompatible ( const QRhiRenderPassDescriptor * other ) const

overridevirtual

Returns

true if the other QRhiRenderPassDescriptor is compatible with this one, meaning this and other can be used interchangebly in QRhiGraphicsPipeline::setRenderPassDescriptor().

The concept of the compatibility of renderpass descriptors is similar to the \l{QRhiShaderResourceBindings::isLayoutCompatible}{layout compatibility} of QRhiShaderResourceBindings instances. They allow better reuse of QRhiGraphicsPipeline instances: for example, a QRhiGraphicsPipeline instance cache is expected to use these functions to look for a matching pipeline, instead of just comparing pointers, thus allowing a different QRhiRenderPassDescriptor and QRhiShaderResourceBindings to be used in combination with the pipeline, as long as they are compatible.

The exact details of compatibility depend on the underlying graphics API. Two renderpass descriptors \l{QRhiTextureRenderTarget::newCompatibleRenderPassDescriptor()}{created} from the same QRhiTextureRenderTarget are always compatible.

Similarly to QRhiShaderResourceBindings, compatibility can also be tested without having two existing objects available. Extracting the opaque blob by calling serializedFormat() allows testing for compatibility by comparing the returned vector to another QRhiRenderPassDescriptor's serializedFormat(). This has benefits in certain situations, because it allows testing the compatibility of a QRhiRenderPassDescriptor with a QRhiGraphicsPipeline even when the QRhiRenderPassDescriptor the pipeline was originally built was is no longer available (but the data returned from its serializedFormat() still is).

See also

newCompatibleRenderPassDescriptor(), serializedFormat()

Implements QRhiRenderPassDescriptor.

Definition at line 761 of file qrhinull.cpp.

References other(), and Q_UNUSED.

Here is the call graph for this function:

newCompatibleRenderPassDescriptor()

QRhiRenderPassDescriptor * QNullRenderPassDescriptor::newCompatibleRenderPassDescriptor ( ) const

overridevirtual

Returns

a new QRhiRenderPassDescriptor that is \l{isCompatible()}{compatible} with this one.

This function allows cloning a QRhiRenderPassDescriptor. The returned object is ready to be used, and the ownership is transferred to the caller. Cloning a QRhiRenderPassDescriptor object can become useful in situations where the object is stored in data structures related to graphics pipelines (in order to allow creating new pipelines which in turn requires a renderpass descriptor object), and the lifetime of the renderpass descriptor created from a render target may be shorter than the pipelines. (for example, because the engine manages and destroys renderpasses together with the textures and render targets it was created from) In such a situation, it can be beneficial to store a cloned version in the data structures, and thus transferring ownership as well.

See also

isCompatible()

Implements QRhiRenderPassDescriptor.

Definition at line 767 of file qrhinull.cpp.

References QNullRenderPassDescriptor(), QRhiResource::m_rhi, and QRHI_RES_RHI.

Here is the call graph for this function:

serializedFormat()

QVector< quint32 > QNullRenderPassDescriptor::serializedFormat ( ) const

overridevirtual

Returns

a vector of integers containing an opaque blob describing the data relevant for \l{isCompatible()}{compatibility}.

Given two QRhiRenderPassDescriptor objects rp1 and rp2, if the data returned from this function is identical, then {rp1->isCompatible(rp2)}, and vice versa hold true as well.

Note

The returned data is meant to be used for storing in memory and comparisons during the lifetime of the QRhi the object belongs to. It is not meant for storing on disk, reusing between processes, or using with multiple QRhi instances with potentially different backends.

See also

isCompatible()

Implements QRhiRenderPassDescriptor.

Definition at line 775 of file qrhinull.cpp.

---

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

• qtbase/src/gui/rhi/qrhinull_p.h (1dd8b5ceec3a1cde987372a7f993c07f30e5af95)
• qtbase/src/gui/rhi/qrhinull.cpp (684070bc342ac8e041c7156f0aa594b89b2265db)