#include <qrhivulkan_p.h>

Inheritance diagram for QVkTexture:

Collaboration diagram for QVkTexture:

Classes
struct	UsageState

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

	~QVkTexture ()

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

void	setNativeLayout (int layout) override
	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.

bool	prepareCreate (QSize *adjustedSize=nullptr)

bool	finishCreate ()

VkImageView	perLevelImageViewForLoadStore (int level)

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.

ViewFormat	readViewFormat () const
	\variable QRhiTexture::ViewFormat::format

void	setReadViewFormat (const ViewFormat &fmt)

ViewFormat	writeViewFormat () const

void	setWriteViewFormat (const ViewFormat &fmt)

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
VkImage	image = VK_NULL_HANDLE

VkImageView	imageView = VK_NULL_HANDLE

QVkAlloc	imageAlloc = nullptr

VkBuffer	stagingBuffers [QVK_FRAMES_IN_FLIGHT]

QVkAlloc	stagingAllocations [QVK_FRAMES_IN_FLIGHT]

VkImageView	perLevelImageViews [QRhi::MAX_MIP_LEVELS]

bool	owns = true

UsageState	usageState

VkFormat	vkformat

uint	mipLevelCount = 0

VkSampleCountFlagBits	samples

VkFormat	viewFormat

VkFormat	viewFormatForSampling

int	lastActiveFrameSlot = -1

uint	generation = 0

Friends
class	QRhiVulkan

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

ViewFormat	m_readViewFormat = { UnknownFormat, false }

ViewFormat	m_writeViewFormat = { UnknownFormat, false }

Protected Attributes inherited from QRhiResource
QRhiImplementation *	m_rhi = nullptr

quint64	m_id

QByteArray	m_objectName

Detailed Description

Definition at line 93 of file qrhivulkan_p.h.

Constructor & Destructor Documentation

◆ QVkTexture()

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

Definition at line 6404 of file qrhivulkan.cpp.

References i, QRhi::MAX_MIP_LEVELS, perLevelImageViews, QVK_FRAMES_IN_FLIGHT, stagingAllocations, and stagingBuffers.

◆ ~QVkTexture()

QVkTexture::~QVkTexture ( )

Definition at line 6416 of file qrhivulkan.cpp.

References destroy().

Here is the call graph for this function:

Member Function Documentation

◆ create()

bool QVkTexture::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 6595 of file qrhivulkan.cpp.

References allocation, QRhiTexture::CubeMap, finishCreate(), imageAlloc, isDepthTextureFormat(), QRhiTexture::m_arraySize, QRhiTexture::m_depth, QRhiTexture::m_flags, QRhiTexture::m_format, QRhiResource::m_objectName, mipLevelCount, QRhiTexture::OneDimensional, owns, prepareCreate(), qMax(), QRHI_RES_RHI, qWarning, QRhiTexture::RenderTarget, samples, QRhiTexture::TextureArray, QRhiTexture::ThreeDimensional, toVmaAllocator(), QRhiTexture::UsedAsTransferSource, QRhiTexture::UsedWithGenerateMips, QRhiTexture::UsedWithLoadStore, and vkformat.

Referenced by QVkRenderBuffer::create().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ createFrom()

bool QVkTexture::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 6683 of file qrhivulkan.cpp.

References finishCreate(), QVkTexture::UsageState::layout, owns, prepareCreate(), QRHI_RES_RHI, and usageState.

Here is the call graph for this function:

◆ destroy()

void QVkTexture::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 6421 of file qrhivulkan.cpp.

References i, image, imageAlloc, imageView, lastActiveFrameSlot, QRhiVulkan::DeferredReleaseEntry::lastActiveFrameSlot, QRhi::MAX_MIP_LEVELS, owns, perLevelImageViews, QRHI_RES_RHI, QVK_FRAMES_IN_FLIGHT, stagingAllocations, stagingBuffers, QRhiVulkan::DeferredReleaseEntry::Texture, QRhiVulkan::DeferredReleaseEntry::texture, and QRhiVulkan::DeferredReleaseEntry::type.

Referenced by ~QVkTexture(), QVkRenderBuffer::destroy(), and prepareCreate().

Here is the caller graph for this function:

◆ finishCreate()

bool QVkTexture::finishCreate ( )

Definition at line 6551 of file qrhivulkan.cpp.

References aspectMaskForTextureFormat(), QRhiTexture::CubeMap, generation, image, imageView, lastActiveFrameSlot, QRhiTexture::m_arrayRangeLength, QRhiTexture::m_arrayRangeStart, QRhiTexture::m_arraySize, QRhiTexture::m_flags, QRhiTexture::m_format, mipLevelCount, QRhiTexture::OneDimensional, qMax(), QRHI_RES_RHI, qWarning, QRhiTexture::TextureArray, QRhiTexture::ThreeDimensional, and viewFormatForSampling.

Referenced by create(), and createFrom().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ nativeTexture()

QRhiTexture::NativeTexture QVkTexture::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.

See also: createFrom()

Reimplemented from QRhiTexture.

Definition at line 6705 of file qrhivulkan.cpp.

References QVkTexture::UsageState::layout, and usageState.

◆ perLevelImageViewForLoadStore()

VkImageView QVkTexture::perLevelImageViewForLoadStore ( int level )

Definition at line 6715 of file qrhivulkan.cpp.

References aspectMaskForTextureFormat(), QRhiTexture::CubeMap, image, QRhiTexture::m_arraySize, QRhiTexture::m_flags, QRhiTexture::m_format, mipLevelCount, QRhiTexture::OneDimensional, perLevelImageViews, Q_ASSERT, qMax(), QRHI_RES_RHI, qWarning, QRhiTexture::TextureArray, QRhiTexture::ThreeDimensional, and viewFormat.

Here is the call graph for this function:

◆ prepareCreate()

bool QVkTexture::prepareCreate ( QSize * adjustedSize = nullptr )

Definition at line 6458 of file qrhivulkan.cpp.

References QVkTexture::UsageState::access, QRhiTexture::CubeMap, destroy(), QRhiTexture::ViewFormat::format, QSize::isEmpty(), QVkTexture::UsageState::layout, QRhiTexture::m_arraySize, QRhiTexture::m_depth, QRhiTexture::m_flags, QRhiTexture::m_format, QRhiTexture::m_pixelSize, QRhiTexture::m_readViewFormat, QRhiTexture::m_sampleCount, QRhiTexture::m_writeViewFormat, QRhi::MAX_MIP_LEVELS, mipLevelCount, QRhiTexture::MipMapped, QRhiTexture::OneDimensional, qMax(), QRHI_RES_RHI, qWarning, QRhiTexture::sRGB, QRhiTexture::ViewFormat::srgb, QVkTexture::UsageState::stage, QRhiTexture::TextureArray, QRhiTexture::ThreeDimensional, toVkTextureFormat(), QRhiTexture::UnknownFormat, usageState, viewFormat, viewFormatForSampling, vkformat, and QSize::width().

Referenced by create(), and createFrom().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setNativeLayout()

void QVkTexture::setNativeLayout ( int layout )

overridevirtual

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.

This function allows communicating the expected layout the image backing the QRhiTexture is in after the native rendering commands.

For example, consider rendering into a QRhiTexture's VkImage directly with Vulkan in a code block enclosed by QRhiCommandBuffer::beginExternal() and QRhiCommandBuffer::endExternal(), followed by using the image for texture sampling in a QRhi-based render pass. To avoid potentially incorrect image layout transitions, this function can be used to indicate what the image layout will be once the commands recorded in said code block complete.

Calling this function makes sense only after QRhiCommandBuffer::endExternal() and before a subsequent QRhiCommandBuffer::beginPass().

This function has no effect with QRhi backends where the underlying graphics API does not expose a concept of image layouts.

Note: With Vulkan layout is a VkImageLayout. With Direct 3D 12 layout is a value composed of the bits from D3D12_RESOURCE_STATES.

Reimplemented from QRhiTexture.

Definition at line 6710 of file qrhivulkan.cpp.

References layout, QVkTexture::UsageState::layout, and usageState.

Friends And Related Symbol Documentation

◆ QRhiVulkan

friend class QRhiVulkan

friend

Definition at line 131 of file qrhivulkan_p.h.

Member Data Documentation

◆ generation

uint QVkTexture::generation = 0

Definition at line 130 of file qrhivulkan_p.h.

Referenced by finishCreate().

◆ image

VkImage QVkTexture::image = VK_NULL_HANDLE

Definition at line 108 of file qrhivulkan_p.h.

Referenced by destroy(), finishCreate(), and perLevelImageViewForLoadStore().

◆ imageAlloc

QVkAlloc QVkTexture::imageAlloc = nullptr

Definition at line 110 of file qrhivulkan_p.h.

Referenced by create(), and destroy().

◆ imageView

VkImageView QVkTexture::imageView = VK_NULL_HANDLE

Definition at line 109 of file qrhivulkan_p.h.

Referenced by destroy(), and finishCreate().

◆ lastActiveFrameSlot

int QVkTexture::lastActiveFrameSlot = -1

Definition at line 129 of file qrhivulkan_p.h.

Referenced by QVkRenderBuffer::destroy(), destroy(), and finishCreate().

◆ mipLevelCount

uint QVkTexture::mipLevelCount = 0

Definition at line 125 of file qrhivulkan_p.h.

Referenced by create(), finishCreate(), perLevelImageViewForLoadStore(), and prepareCreate().

◆ owns

bool QVkTexture::owns = true

Definition at line 114 of file qrhivulkan_p.h.

Referenced by create(), createFrom(), and destroy().

◆ perLevelImageViews

VkImageView QVkTexture::perLevelImageViews[QRhi::MAX_MIP_LEVELS]

Definition at line 113 of file qrhivulkan_p.h.

Referenced by QVkTexture(), destroy(), and perLevelImageViewForLoadStore().

◆ samples

VkSampleCountFlagBits QVkTexture::samples

Definition at line 126 of file qrhivulkan_p.h.

Referenced by create().

◆ stagingAllocations

QVkAlloc QVkTexture::stagingAllocations[QVK_FRAMES_IN_FLIGHT]

Definition at line 112 of file qrhivulkan_p.h.

Referenced by QVkTexture(), and destroy().

◆ stagingBuffers

VkBuffer QVkTexture::stagingBuffers[QVK_FRAMES_IN_FLIGHT]

Definition at line 111 of file qrhivulkan_p.h.

Referenced by QVkTexture(), and destroy().

◆ usageState

UsageState QVkTexture::usageState

Definition at line 123 of file qrhivulkan_p.h.

Referenced by createFrom(), nativeTexture(), prepareCreate(), and setNativeLayout().

◆ viewFormat

VkFormat QVkTexture::viewFormat

Definition at line 127 of file qrhivulkan_p.h.

Referenced by perLevelImageViewForLoadStore(), and prepareCreate().

◆ viewFormatForSampling

VkFormat QVkTexture::viewFormatForSampling

Definition at line 128 of file qrhivulkan_p.h.

Referenced by finishCreate(), and prepareCreate().

◆ vkformat

VkFormat QVkTexture::vkformat

Definition at line 124 of file qrhivulkan_p.h.

Referenced by QVkRenderBuffer::create(), create(), and prepareCreate().

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

qtbase/src/gui/rhi/qrhivulkan_p.h (c09270753d3ec35c89c6f73a5fd4f197321e74fb)
qtbase/src/gui/rhi/qrhivulkan.cpp (c09270753d3ec35c89c6f73a5fd4f197321e74fb)

Classes

Public Member Functions

Public Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QVkTexture()

◆ ~QVkTexture()

Member Function Documentation

◆ create()

◆ createFrom()

◆ destroy()

◆ finishCreate()

◆ nativeTexture()

◆ perLevelImageViewForLoadStore()

◆ prepareCreate()

◆ setNativeLayout()

Friends And Related Symbol Documentation

◆ QRhiVulkan

Member Data Documentation

◆ generation

◆ image

◆ imageAlloc

◆ imageView

◆ lastActiveFrameSlot

◆ mipLevelCount

◆ owns

◆ perLevelImageViews

◆ samples

◆ stagingAllocations

◆ stagingBuffers

◆ usageState

◆ viewFormat

◆ viewFormatForSampling

◆ vkformat