QMetalRenderBuffer Struct Reference

#include <qrhimetal_p.h>

Inheritance diagram for QMetalRenderBuffer:

Collaboration diagram for QMetalRenderBuffer:

Public Member Functions
	QMetalRenderBuffer (QRhiImplementation *rhi, Type type, const QSize &pixelSize, int sampleCount, QRhiRenderBuffer::Flags flags, QRhiTexture::Format backingFormatHint)
	~QMetalRenderBuffer ()
void	destroy () override
	Releases (or requests deferred releasing of) the underlying native graphics resources.
bool	create () override
	Creates the corresponding native graphics resources.
QRhiTexture::Format	backingFormat () const override
Public Member Functions inherited from QRhiRenderBuffer
QRhiResource::Type	resourceType () const override
Type	type () const
void	setType (Type t)
	Sets the type to t.
QSize	pixelSize () const
void	setPixelSize (const QSize &sz)
	Sets the size (in pixels) to sz.
int	sampleCount () const
void	setSampleCount (int s)
	Sets the sample count to s.
Flags	flags () const
void	setFlags (Flags f)
	Sets the flags to f.
virtual bool	createFrom (NativeRenderBuffer src)
	Similar to create() except that no new native renderbuffer objects are created.
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
QMetalRenderBufferData *	d
int	samples = 1
uint	generation = 0
int	lastActiveFrameSlot = -1

Friends
class	QRhiMetal

Additional Inherited Members
Public Types inherited from QRhiRenderBuffer
enum	Type { DepthStencil , Color }
	Specifies the type of the renderbuffer. More...
enum	Flag { UsedWithSwapChainOnly = 1 << 0 }
	\variable QRhiRenderBuffer::NativeRenderBuffer::object More...
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 QRhiRenderBuffer
	QRhiRenderBuffer (QRhiImplementation *rhi, Type type_, const QSize &pixelSize_, int sampleCount_, Flags flags_, QRhiTexture::Format backingFormatHint_)
Protected Member Functions inherited from QRhiResource
	QRhiResource (QRhiImplementation *rhi)
Protected Attributes inherited from QRhiRenderBuffer
Type	m_type
QSize	m_pixelSize
int	m_sampleCount
Flags	m_flags
QRhiTexture::Format	m_backingFormatHint
Protected Attributes inherited from QRhiResource
QRhiImplementation *	m_rhi = nullptr
quint64	m_id
QByteArray	m_objectName

Detailed Description

Definition at line 50 of file qrhimetal_p.h.

Constructor & Destructor Documentation

QMetalRenderBuffer()

QMetalRenderBuffer::QMetalRenderBuffer	(	QRhiImplementation *	rhi,
		Type	type,
		const QSize &	pixelSize,
		int	sampleCount,
		QRhiRenderBuffer::Flags	flags,
		QRhiTexture::Format	backingFormatHint )

Definition at line 3614 of file qrhimetal.mm.

~QMetalRenderBuffer()

QMetalRenderBuffer::~QMetalRenderBuffer

(

)

Definition at line 3622 of file qrhimetal.mm.

References d, and destroy().

Here is the call graph for this function:

Member Function Documentation

backingFormat()

QRhiTexture::Format QMetalRenderBuffer::backingFormat ( ) const

overridevirtual

Implements QRhiRenderBuffer.

Definition at line 3713 of file qrhimetal.mm.

References QRhiRenderBuffer::m_backingFormatHint, QRhiRenderBuffer::m_type, QRhiTexture::RGBA8, and QRhiTexture::UnknownFormat.

create()

bool QMetalRenderBuffer::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.

Returns

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

Implements QRhiRenderBuffer.

Definition at line 3647 of file qrhimetal.mm.

References QRhiRenderBuffer::Color, QByteArray::constData(), d, QRhiRenderBuffer::DepthStencil, destroy(), QMetalRenderBufferData::format, generation, QSize::height(), init(), QByteArray::isEmpty(), QSize::isEmpty(), lastActiveFrameSlot, QRhiRenderBuffer::m_backingFormatHint, QRhiResource::m_objectName, QRhiRenderBuffer::m_pixelSize, QRhiRenderBuffer::m_sampleCount, QRhiRenderBuffer::m_type, QRHI_RES_RHI, release(), QMetalRenderBufferData::tex, toMetalTextureFormat(), QRhiTexture::UnknownFormat, and QSize::width().

Here is the call graph for this function:

destroy()

void QMetalRenderBuffer::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 3628 of file qrhimetal.mm.

References d, QRhiMetalData::DeferredReleaseEntry::lastActiveFrameSlot, lastActiveFrameSlot, QRHI_RES_RHI, QRhiMetalData::DeferredReleaseEntry::RenderBuffer, QRhiMetalData::DeferredReleaseEntry::renderbuffer, QMetalRenderBufferData::tex, and QRhiMetalData::DeferredReleaseEntry::type.

Referenced by ~QMetalRenderBuffer(), and create().

Here is the caller graph for this function:

Friends And Related Symbol Documentation

QRhiMetal

friend class QRhiMetal

friend

Definition at line 64 of file qrhimetal_p.h.

Member Data Documentation

d

QMetalRenderBufferData* QMetalRenderBuffer::d

Definition at line 60 of file qrhimetal_p.h.

Referenced by ~QMetalRenderBuffer(), create(), and destroy().

generation

uint QMetalRenderBuffer::generation = 0

Definition at line 62 of file qrhimetal_p.h.

Referenced by create().

lastActiveFrameSlot

int QMetalRenderBuffer::lastActiveFrameSlot = -1

Definition at line 63 of file qrhimetal_p.h.

Referenced by create(), and destroy().

samples

int QMetalRenderBuffer::samples = 1

Definition at line 61 of file qrhimetal_p.h.

---

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

• qtbase/src/gui/rhi/qrhimetal_p.h (bb1d9bab36d779e595a924e3218d4066d84fca38)
• qtbase/src/gui/rhi/qrhimetal.mm (f16036fc18804b19ecded11f43a154659e7f2b60)