QSGVulkanTexture Struct

struct QNativeInterface::QSGVulkanTexture

Provides access to and enables adopting Vulkan image objects. More...

Header: #include <QSGVulkanTexture>
CMake: find_package(Qt6 REQUIRED COMPONENTS Quick)
target_link_libraries(mytarget PRIVATE Qt6::Quick)
qmake: QT += quick
Since: Qt 6.0

Public Functions

virtual VkImage nativeImage() const = 0
virtual VkImageLayout nativeImageLayout() const = 0

Static Public Members

QSGTexture *fromNative(VkImage image, VkImageLayout layout, QQuickWindow *window, const QSize &size, QQuickWindow::CreateTextureOptions options = {})

Detailed Description

Member Function Documentation

[static, since 6.0] QSGTexture *QSGVulkanTexture::fromNative(VkImage image, VkImageLayout layout, QQuickWindow *window, const QSize &size, QQuickWindow::CreateTextureOptions options = {})

Creates a new QSGTexture wrapping an existing Vulkan image object for window.

The native object is wrapped, but not owned, by the resulting QSGTexture. The caller of the function is responsible for deleting the returned QSGTexture, but that will not destroy the underlying native object.

This function is currently suitable for 2D RGBA textures only.

Warning: This function will return null if the scene graph has not yet been initialized.

layout must specify the current layout of the image.

Use options to customize the texture attributes. Only the TextureHasAlphaChannel and TextureHasMipmaps are taken into account here.

size specifies the size in pixels.

Note: This function must be called on the scene graph rendering thread.

This function was introduced in Qt 6.0.

See also QQuickWindow::sceneGraphInitialized(), QSGTexture, Scene Graph - Metal Texture Import, and Scene Graph - Vulkan Texture Import.

[pure virtual] VkImage QSGVulkanTexture::nativeImage() const

Returns the VkImage handle.

[pure virtual] VkImageLayout QSGVulkanTexture::nativeImageLayout() const

Returns the image layout.

© 2022 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.