QMetalTextureRenderTarget Struct Reference

#include <qrhimetal_p.h>

Inheritance diagram for QMetalTextureRenderTarget:

Collaboration diagram for QMetalTextureRenderTarget:

Public Member Functions
	QMetalTextureRenderTarget (QRhiImplementation *rhi, const QRhiTextureRenderTargetDescription &desc, Flags flags)
	~QMetalTextureRenderTarget ()
void	destroy () override
	Releases (or requests deferred releasing of) the underlying native graphics resources.
QSize	pixelSize () const override
float	devicePixelRatio () const override
int	sampleCount () const override
QRhiRenderPassDescriptor *	newCompatibleRenderPassDescriptor () override
bool	create () override
	Creates the corresponding native graphics resources.
Public Member Functions inherited from QRhiTextureRenderTarget
QRhiResource::Type	resourceType () const override
QRhiTextureRenderTargetDescription	description () const
void	setDescription (const QRhiTextureRenderTargetDescription &desc)
	Sets the render target description desc.
Flags	flags () const
void	setFlags (Flags f)
	Sets the flags to f.
Public Member Functions inherited from QRhiRenderTarget
QRhiRenderPassDescriptor *	renderPassDescriptor () const
void	setRenderPassDescriptor (QRhiRenderPassDescriptor *desc)
	Sets the QRhiRenderPassDescriptor desc for use with this render target.
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
QMetalRenderTargetData *	d

Friends
class	QRhiMetal

Additional Inherited Members
Public Types inherited from QRhiTextureRenderTarget
enum	Flag { PreserveColorContents = 1 << 0 , PreserveDepthStencilContents = 1 << 1 , DoNotStoreDepthStencilContents = 1 << 2 }
	Flag values describing the load/store behavior for the render target. More...
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...
Protected Member Functions inherited from QRhiTextureRenderTarget
	QRhiTextureRenderTarget (QRhiImplementation *rhi, const QRhiTextureRenderTargetDescription &desc_, Flags flags_)
Protected Member Functions inherited from QRhiRenderTarget
	QRhiRenderTarget (QRhiImplementation *rhi)
Protected Member Functions inherited from QRhiResource
	QRhiResource (QRhiImplementation *rhi)
Protected Attributes inherited from QRhiTextureRenderTarget
QRhiTextureRenderTargetDescription	m_desc
Flags	m_flags
Protected Attributes inherited from QRhiRenderTarget
QRhiRenderPassDescriptor *	m_renderPassDesc = nullptr
Protected Attributes inherited from QRhiResource
QRhiImplementation *	m_rhi = nullptr
quint64	m_id
QByteArray	m_objectName

Detailed Description

Definition at line 161 of file qrhimetal_p.h.

Constructor & Destructor Documentation

QMetalTextureRenderTarget()

QMetalTextureRenderTarget::QMetalTextureRenderTarget	(	QRhiImplementation *	rhi,
		const QRhiTextureRenderTargetDescription &	desc,
		Flags	flags )

Definition at line 4304 of file qrhimetal.mm.

~QMetalTextureRenderTarget()

QMetalTextureRenderTarget::~QMetalTextureRenderTarget

(

)

Definition at line 4312 of file qrhimetal.mm.

Member Function Documentation

create()

bool QMetalTextureRenderTarget::create ( )

overridevirtual

Creates the corresponding native graphics resources.

If there are already resources present due to an earlier create() with no corresponding destroy(), then destroy() is called implicitly first.

Note

renderPassDescriptor() must be set before calling create(). To obtain a QRhiRenderPassDescriptor compatible with the render target, call newCompatibleRenderPassDescriptor() before create() but after setting all other parameters, such as description() and flags(). To save resources, reuse the same QRhiRenderPassDescriptor with multiple QRhiTextureRenderTarget instances, whenever possible. Sharing the same render pass descriptor is only possible when the render targets have the same number and type of attachments (the actual textures can differ) and the same flags.

resources, such as QRhiTexture instances, referenced in description() must already have create() called on them.

Returns

true when successful, false when a graphics operation failed. Regardless of the return value, calling destroy() is always safe.

Implements QRhiTextureRenderTarget.

Definition at line 4353 of file qrhimetal.mm.

destroy()

void QMetalTextureRenderTarget::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 4318 of file qrhimetal.mm.

devicePixelRatio()

float QMetalTextureRenderTarget::devicePixelRatio ( ) const

overridevirtual

Returns

the device pixel ratio. For QRhiTextureRenderTarget this is always

1. For targets retrieved from a QRhiSwapChain the value reflects the \l{QWindow::devicePixelRatio()}{device pixel ratio} of the targeted QWindow.

Implements QRhiRenderTarget.

Definition at line 4444 of file qrhimetal.mm.

newCompatibleRenderPassDescriptor()

QRhiRenderPassDescriptor * QMetalTextureRenderTarget::newCompatibleRenderPassDescriptor ( )

overridevirtual

Returns

a new QRhiRenderPassDescriptor that is compatible with this render target.

The returned value is used in two ways: it can be passed to setRenderPassDescriptor() and QRhiGraphicsPipeline::setRenderPassDescriptor(). A render pass descriptor describes the attachments (color, depth/stencil) and the load/store behavior that can be affected by flags(). A QRhiGraphicsPipeline can only be used in combination with a render target that has a \l{QRhiRenderPassDescriptor::isCompatible()}{compatible} QRhiRenderPassDescriptor set.

Two QRhiTextureRenderTarget instances can share the same render pass descriptor as long as they have the same number and type of attachments. The associated QRhiTexture or QRhiRenderBuffer instances are not part of the render pass descriptor so those can differ in the two QRhiTextureRenderTarget instances.

Note

resources, such as QRhiTexture instances, referenced in description() must already have create() called on them.

See also

create()

Implements QRhiTextureRenderTarget.

Definition at line 4325 of file qrhimetal.mm.

pixelSize()

QSize QMetalTextureRenderTarget::pixelSize ( ) const

overridevirtual

Returns

the size in pixels.

Valid only after create() has been called successfully. Until then the result is a default-constructed QSize.

With QRhiTextureRenderTarget the returned size is the size of the associated attachments at the time of create(), in practice the size of the first color attachment, or the depth/stencil buffer if there are no color attachments. If the associated textures or renderbuffers are resized and rebuilt afterwards, then pixelSize() performs an implicit call to create() in order to rebuild the underlying data structures. This implicit check is similar to what QRhiCommandBuffer::beginPass() does, and ensures that the returned size is always up-to-date.

Implements QRhiRenderTarget.

Definition at line 4436 of file qrhimetal.mm.

sampleCount()

int QMetalTextureRenderTarget::sampleCount ( ) const

overridevirtual

Returns

the sample count or 1 if multisample antialiasing is not relevant for this render target.

Implements QRhiRenderTarget.

Definition at line 4449 of file qrhimetal.mm.

Friends And Related Symbol Documentation

QRhiMetal

friend class QRhiMetal

friend

Definition at line 175 of file qrhimetal_p.h.

Member Data Documentation

d

QMetalRenderTargetData* QMetalTextureRenderTarget::d

Definition at line 174 of file qrhimetal_p.h.

---

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

• qtbase/src/gui/rhi/qrhimetal_p.h (caf22e481d41d09d608cf1c94dfb740c419d81db)
• qtbase/src/gui/rhi/qrhimetal.mm (383ed62676ff3ecfcd2f4b06365e07e4699a2f42)