QMetalSwapChainRenderTarget Struct Reference

#include <qrhimetal_p.h>

Inheritance diagram for QMetalSwapChainRenderTarget:

Collaboration diagram for QMetalSwapChainRenderTarget:

Public Member Functions
	QMetalSwapChainRenderTarget (QRhiImplementation *rhi, QRhiSwapChain *swapchain)
	~QMetalSwapChainRenderTarget ()
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
Public Member Functions inherited from QRhiSwapChainRenderTarget
QRhiResource::Type	resourceType () const override
QRhiSwapChain *	swapChain () const
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

Additional Inherited Members
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 QRhiSwapChainRenderTarget
	QRhiSwapChainRenderTarget (QRhiImplementation *rhi, QRhiSwapChain *swapchain_)
Protected Member Functions inherited from QRhiRenderTarget
	QRhiRenderTarget (QRhiImplementation *rhi)
Protected Member Functions inherited from QRhiResource
	QRhiResource (QRhiImplementation *rhi)
Protected Attributes inherited from QRhiSwapChainRenderTarget
QRhiSwapChain *	m_swapchain
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 148 of file qrhimetal_p.h.

Constructor & Destructor Documentation

QMetalSwapChainRenderTarget()

QMetalSwapChainRenderTarget::QMetalSwapChainRenderTarget	(	QRhiImplementation *	rhi,
		QRhiSwapChain *	swapchain )

Definition at line 4272 of file qrhimetal.mm.

~QMetalSwapChainRenderTarget()

QMetalSwapChainRenderTarget::~QMetalSwapChainRenderTarget

(

)

Definition at line 4278 of file qrhimetal.mm.

Member Function Documentation

destroy()

void QMetalSwapChainRenderTarget::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 4284 of file qrhimetal.mm.

devicePixelRatio()

float QMetalSwapChainRenderTarget::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 4294 of file qrhimetal.mm.

pixelSize()

QSize QMetalSwapChainRenderTarget::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 4289 of file qrhimetal.mm.

sampleCount()

int QMetalSwapChainRenderTarget::sampleCount ( ) const

overridevirtual

Returns

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

Implements QRhiRenderTarget.

Definition at line 4299 of file qrhimetal.mm.

Member Data Documentation

d

QMetalRenderTargetData* QMetalSwapChainRenderTarget::d

Definition at line 158 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)