summaryrefslogtreecommitdiffstats
path: root/src/gui/vulkan/qvulkaninstance.cpp
diff options
context:
space:
mode:
Diffstat (limited to 'src/gui/vulkan/qvulkaninstance.cpp')
-rw-r--r--src/gui/vulkan/qvulkaninstance.cpp26
1 files changed, 23 insertions, 3 deletions
diff --git a/src/gui/vulkan/qvulkaninstance.cpp b/src/gui/vulkan/qvulkaninstance.cpp
index e0f1b1a5f3..538a59c28f 100644
--- a/src/gui/vulkan/qvulkaninstance.cpp
+++ b/src/gui/vulkan/qvulkaninstance.cpp
@@ -154,9 +154,9 @@ QT_BEGIN_NAMESPACE
\note QVulkanFunctions and QVulkanDeviceFunctions are generated from the
Vulkan API XML specifications when building the Qt libraries. Therefore no
- documentation is provided for them. They contain the Vulkan 1.0 functions
+ documentation is provided for them. They contain the Vulkan 1.2 functions
with the same signatures as described in the
- \l{https://www.khronos.org/registry/vulkan/specs/1.0/html/}{Vulkan API
+ \l{https://www.khronos.org/registry/vulkan/specs/1.2/html/}{Vulkan API
documentation}.
\section1 Getting a Native Vulkan Surface for a Window
@@ -726,7 +726,17 @@ QPlatformVulkanInstance *QVulkanInstance::handle() const
\note The returned object is owned and managed by the QVulkanInstance. Do
not destroy or alter it.
- \sa deviceFunctions()
+ The functions from the core Vulkan 1.0 API will be available always. When it
+ comes to higher Vulkan versions, such as, 1.1 and 1.2, the QVulkanFunctions
+ object will try to resolve the core API functions for those as well, but if
+ the Vulkan instance implementation at run time has no support for those,
+ calling any such unsupported function will lead to unspecified behavior. In
+ addition, to properly enable support for Vulkan versions higher than 1.0, an
+ appropriate instance API version may need to be set by calling
+ setApiVersion() before create(). To query the Vulkan implementation's
+ instance-level version, call supportedApiVersion().
+
+ \sa deviceFunctions(), supportedApiVersion()
*/
QVulkanFunctions *QVulkanInstance::functions() const
{
@@ -751,6 +761,16 @@ QVulkanFunctions *QVulkanInstance::functions() const
to the application to notify the QVulkanInstance by calling
resetDeviceFunctions().
+ The functions from the core Vulkan 1.0 API will be available always. When
+ it comes to higher Vulkan versions, such as, 1.1 and 1.2, the
+ QVulkanDeviceFunctions object will try to resolve the core API functions
+ for those as well, but if the Vulkan physical device at run time has no
+ support for those, calling any such unsupported function will lead to
+ unspecified behavior. To properly enable support for Vulkan versions higher
+ than 1.0, an appropriate instance API version may need to be set by calling
+ setApiVersion() before create(). In addition, applications are expected to
+ check the physical device's apiVersion in VkPhysicalDeviceProperties.
+
\sa functions(), resetDeviceFunctions()
*/
QVulkanDeviceFunctions *QVulkanInstance::deviceFunctions(VkDevice device)