#include <qrhimetal_p.h>

Inheritance diagram for QMetalTexture:

Collaboration diagram for QMetalTexture:

Public Member Functions
	QMetalTexture (QRhiImplementation *rhi, Format format, const QSize &pixelSize, int depth, int arraySize, int sampleCount, Flags flags)

	~QMetalTexture ()

void	destroy () override
	Releases (or requests deferred releasing of) the underlying native graphics resources.

bool	create () override
	Creates the corresponding native graphics resources.

bool	createFrom (NativeTexture src) override
	Similar to create(), except that no new native textures are created.

NativeTexture	nativeTexture () override

bool	prepareCreate (QSize *adjustedSize=nullptr)

Public Member Functions inherited from QRhiTexture
QRhiResource::Type	resourceType () const override

Format	format () const

void	setFormat (Format fmt)
	Sets the requested texture format to fmt.

QSize	pixelSize () const

void	setPixelSize (const QSize &sz)
	Sets the texture size, specified in pixels, to sz.

int	depth () const

void	setDepth (int depth)
	Sets the depth for a 3D texture.

int	arraySize () const

void	setArraySize (int arraySize)
	Sets the texture arraySize.

int	arrayRangeStart () const

int	arrayRangeLength () const

void	setArrayRange (int startIndex, int count)
	Normally all array layers are exposed and it is up to the shader to select the layer via the third coordinate passed to the {texture()} GLSL function when sampling the `sampler2DArray`.

Flags	flags () const

void	setFlags (Flags f)
	Sets the texture flags to f.

int	sampleCount () const

void	setSampleCount (int s)
	Sets the sample count to s.

virtual bool	create ()=0
	Creates the corresponding native graphics resources.

virtual NativeTexture	nativeTexture ()

virtual bool	createFrom (NativeTexture src)
	Similar to create(), except that no new native textures are created.

virtual void	setNativeLayout (int layout)
	With some graphics APIs, such as Vulkan, integrating custom rendering code that uses the graphics API directly needs special care when it comes to image layouts.

Public Member Functions inherited from QRhiResource
virtual	~QRhiResource ()
	Destructor.

virtual Type	resourceType () const =0

virtual void	destroy ()=0
	Releases (or requests deferred releasing of) the underlying native graphics resources.

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
QMetalTextureData *	d

int	mipLevelCount = 0

int	samples = 1

uint	generation = 0

int	lastActiveFrameSlot = -1

Friends
class	QRhiMetal

struct	QMetalShaderResourceBindings

struct	QMetalTextureData

Additional Inherited Members
Public Types inherited from QRhiTexture
enum	Flag { RenderTarget = 1 << 0 , CubeMap = 1 << 2 , MipMapped = 1 << 3 , sRGB = 1 << 4 , UsedAsTransferSource = 1 << 5 , UsedWithGenerateMips = 1 << 6 , UsedWithLoadStore = 1 << 7 , UsedAsCompressedAtlas = 1 << 8 , ExternalOES = 1 << 9 , ThreeDimensional = 1 << 10 , TextureRectangleGL = 1 << 11 , TextureArray = 1 << 12 , OneDimensional = 1 << 13 }
	Flag values to specify how the texture is going to be used. More...

enum	Format { UnknownFormat , RGBA8 , BGRA8 , R8 , RG8 , R16 , RG16 , RED_OR_ALPHA8 , RGBA16F , RGBA32F , R16F , R32F , RGB10A2 , D16 , D24 , D24S8 , D32F , BC1 , BC2 , BC3 , BC4 , BC5 , BC6H , BC7 , ETC2_RGB8 , ETC2_RGB8A1 , ETC2_RGBA8 , ASTC_4x4 , ASTC_5x4 , ASTC_5x5 , ASTC_6x5 , ASTC_6x6 , ASTC_8x5 , ASTC_8x6 , ASTC_8x8 , ASTC_10x5 , ASTC_10x6 , ASTC_10x8 , ASTC_10x10 , ASTC_12x10 , ASTC_12x12 }
	Specifies the texture format. 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 QRhiTexture
	QRhiTexture (QRhiImplementation *rhi, Format format_, const QSize &pixelSize_, int depth_, int arraySize_, int sampleCount_, Flags flags_)
	\variable QRhiTexture::NativeTexture::object

Protected Member Functions inherited from QRhiResource
	QRhiResource (QRhiImplementation *rhi)

Protected Attributes inherited from QRhiTexture
Format	m_format

QSize	m_pixelSize

int	m_depth

int	m_arraySize

int	m_sampleCount

Flags	m_flags

int	m_arrayRangeStart = -1

int	m_arrayRangeLength = -1

Protected Attributes inherited from QRhiResource
QRhiImplementation *	m_rhi = nullptr

quint64	m_id

QByteArray	m_objectName

Detailed Description

Definition at line 69 of file qrhimetal_p.h.

Constructor & Destructor Documentation

◆ QMetalTexture()

QMetalTexture::QMetalTexture	(	QRhiImplementation *	rhi,
		Format	format,
		const QSize &	pixelSize,
		int	depth,
		int	arraySize,
		int	sampleCount,
		Flags	flags
	)

Definition at line 3665 of file qrhimetal.mm.

References d, i, QRhi::MAX_MIP_LEVELS, QMetalTextureData::perLevelViews, QMTL_FRAMES_IN_FLIGHT, and QMetalTextureData::stagingBuf.

◆ ~QMetalTexture()

QMetalTexture::~QMetalTexture ( )

Definition at line 3677 of file qrhimetal.mm.

References d, and destroy().

Here is the call graph for this function:

Member Function Documentation

◆ create()

bool QMetalTexture::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 QRhiTexture.

Definition at line 3779 of file qrhimetal.mm.

References QByteArray::constData(), QRhiTexture::CubeMap, d, desc, QMetalTextureData::format, generation, init(), iOS, QByteArray::isEmpty(), lastActiveFrameSlot, QRhiTexture::m_arraySize, QRhiTexture::m_depth, QRhiTexture::m_flags, QRhiResource::m_objectName, mipLevelCount, QRhiTexture::OneDimensional, QMetalTextureData::owns, prepareCreate(), qMax(), QRHI_RES_RHI, release(), QRhiTexture::RenderTarget, QMetalTextureData::tex, QRhiTexture::TextureArray, QRhiTexture::ThreeDimensional, and QRhiTexture::UsedWithLoadStore.

Here is the call graph for this function:

◆ createFrom()

bool QMetalTexture::createFrom ( QRhiTexture::NativeTexture src )

overridevirtual

Similar to create(), except that no new native textures are created.

Instead, the native texture resources specified by src is used.

This allows importing an existing native texture object (which must belong to the same device or sharing context, depending on the graphics API) from an external graphics engine.

Returns: true if the specified existing native texture object has been successfully wrapped as a non-owning QRhiTexture.

Note: format(), pixelSize(), sampleCount(), and flags() must still be set correctly. Passing incorrect sizes and other values to QRhi::newTexture() and then following it with a createFrom() expecting that the native texture object alone is sufficient to deduce such values is wrong and will lead to problems.; QRhiTexture does not take ownership of the texture object. destroy() does not free the object or any associated memory.

The opposite of this operation, exposing a QRhiTexture-created native texture object to a foreign engine, is possible via nativeTexture().

Note: When importing a 3D texture, or a texture array object, or, with OpenGL ES, an external texture, it is then especially important to set the corresponding flags (ThreeDimensional, TextureArray, ExternalOES) via setFlags() before calling this function.

Reimplemented from QRhiTexture.

Definition at line 3842 of file qrhimetal.mm.

References d, generation, lastActiveFrameSlot, QMetalTextureData::owns, prepareCreate(), QRHI_RES_RHI, and QMetalTextureData::tex.

Here is the call graph for this function:

◆ destroy()

void QMetalTexture::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 3683 of file qrhimetal.mm.

References d, e, i, lastActiveFrameSlot, QRhi::MAX_MIP_LEVELS, QMetalTextureData::owns, QMetalTextureData::perLevelViews, QMTL_FRAMES_IN_FLIGHT, QRHI_RES_RHI, QMetalTextureData::stagingBuf, QMetalTextureData::tex, and QRhiMetalData::DeferredReleaseEntry::Texture.

Referenced by ~QMetalTexture(), and prepareCreate().

Here is the caller graph for this function:

◆ nativeTexture()

QRhiTexture::NativeTexture QMetalTexture::nativeTexture ( )

overridevirtual

Returns: the underlying native resources for this texture. The returned value will be empty if exposing the underlying native resources is not supported by the backend.