QVulkanWindow 类是方便子类为 QWindow 以履行 Vulkan 渲染。 更多...
| 头： | #include <QVulkanWindow> |
| CMake: |
find_package(Qt6 COMPONENTS Gui REQUIRED)
target_link_libraries(mytarget PRIVATE Qt6::Gui) |
| qmake: | QT += gui |
| Since: | Qt 5.10 |
| 继承： | QWindow |
| enum | Flag { PersistentResources } |
| flags | Flags |
| QueueCreateInfoModifier |
| QVulkanWindow (QWindow * parent = nullptr) | |
| virtual | ~QVulkanWindow () |
| QList<VkPhysicalDeviceProperties> | availablePhysicalDevices () |
| QMatrix4x4 | clipCorrectionMatrix () |
| VkFormat | colorFormat () const |
| int | concurrentFrameCount () const |
| virtual QVulkanWindowRenderer * | createRenderer () |
| VkCommandBuffer | currentCommandBuffer () const |
| int | currentFrame () const |
| VkFramebuffer | currentFramebuffer () const |
| int | currentSwapChainImageIndex () const |
| VkRenderPass | defaultRenderPass () const |
| VkFormat | depthStencilFormat () const |
| VkImage | depthStencilImage () const |
| VkImageView | depthStencilImageView () const |
| VkDevice | device () const |
| uint32_t | deviceLocalMemoryIndex () const |
| QVulkanWindow::Flags | flags () const |
| void | frameReady () |
| QImage | grab () |
| VkCommandPool | graphicsCommandPool () const |
| VkQueue | graphicsQueue () const |
| uint32_t | graphicsQueueFamilyIndex () const |
| uint32_t | hostVisibleMemoryIndex () const |
| bool | isValid () const |
| VkImage | msaaColorImage (int idx ) const |
| VkImageView | msaaColorImageView (int idx ) const |
| VkPhysicalDevice | physicalDevice () const |
| const VkPhysicalDeviceProperties * | physicalDeviceProperties () const |
| VkSampleCountFlagBits | sampleCountFlagBits () const |
| void | setDeviceExtensions (const QByteArrayList & extensions ) |
| void | setFlags (QVulkanWindow::Flags flags ) |
| void | setPhysicalDeviceIndex (int idx ) |
| void | setPreferredColorFormats (const QList<VkFormat> & 格式 ) |
| void | setQueueCreateInfoModifier (const QVulkanWindow::QueueCreateInfoModifier & modifier ) |
| void | setSampleCount (int sampleCount ) |
| QVulkanInfoVector<QVulkanExtension> | supportedDeviceExtensions () |
| QList<int> | supportedSampleCounts () |
| bool | supportsGrab () const |
| VkImage | swapChainImage (int idx ) const |
| int | swapChainImageCount () const |
| QSize | swapChainImageSize () const |
| VkImageView | swapChainImageView (int idx ) const |
| void | frameGrabbed (const QImage & image ) |
| const int | MAX_CONCURRENT_FRAME_COUNT |
QVulkanWindow is a Vulkan-capable QWindow that manages a Vulkan device, a graphics queue, a command pool and buffer, a depth-stencil image and a double-buffered FIFO swapchain, while taking care of correct behavior when it comes to events like resize, special situations like not having a device queue supporting both graphics and presentation, device lost scenarios, and additional functionality like reading the rendered content back. Conceptually it is the counterpart of QOpenGLWindow in the Vulkan world.
注意： QVulkanWindow does not always eliminate the need to implement a fully custom QWindow subclass as it will not necessarily be sufficient in advanced use cases.
QVulkanWindow can be embedded into QWidget -based user interfaces via QWidget::createWindowContainer (). This approach has a number of limitations, however. Make sure to study the 文档编制 首先。
A typical application using QVulkanWindow may look like the following:
class VulkanRenderer : public QVulkanWindowRenderer { public: VulkanRenderer(QVulkanWindow *w) : m_window(w), m_devFuncs(nullptr) { } void initResources() override { m_devFuncs = m_window->vulkanInstance()->deviceFunctions(m_window->device()); // .. } void initSwapChainResources() override { /* ... */ } void releaseSwapChainResources() override { /* ... */ } void releaseResources() override { /* ... */ } void startNextFrame() override { VkCommandBuffer cmdBuf = m_window->currentCommandBuffer(); // ... m_devFuncs->vkCmdBeginRenderPass(commandBuffer, renderPassBegin, contents); // ... m_window->frameReady(); } private: QVulkanWindow *m_window; QVulkanDeviceFunctions *m_devFuncs; }; class VulkanWindow : public QVulkanWindow { public: QVulkanWindowRenderer *createRenderer() override { return new VulkanRenderer(this); } }; int main(int argc, char *argv[]) { QGuiApplication app(argc, argv); QVulkanInstance inst; // enable the standard validation layers, when available inst.setLayers({ "VK_LAYER_KHRONOS_validation" }); if (!inst.create()) qFatal("Failed to create Vulkan instance: %d", inst.errorCode()); VulkanWindow w; w.setVulkanInstance(&inst); w.showMaximized(); return app.exec(); }
As it can be seen in the example, the main patterns in QVulkanWindow usage are:
For troubleshooting, enable the logging category
qt.vulkan
. Critical errors are printed via
qWarning
() 自动。
There are two notable differences to be aware of: First, with Vulkan Y points down the screen in clip space, while OpenGL uses an upwards pointing Y axis. Second, the standard OpenGL projection matrix assume a near and far plane values of -1 and 1, while Vulkan prefers 0 and 1.
In order to help applications migrate from OpenGL-based code without having to flip Y coordinates in the vertex data, and to allow using QMatrix4x4 functions like QMatrix4x4::perspective () while keeping the Vulkan viewport's minDepth and maxDepth set to 0 and 1, QVulkanWindow provides a correction matrix retrievable by calling clipCorrectionMatrix ().
While disabled by default, multisample antialiasing is fully supported by QVulkanWindow. Additional color buffers and resolving into the swapchain's non-multisample buffers are all managed automatically.
To query the supported sample counts, call supportedSampleCounts (). When the returned set contains 4, 8, ..., passing one of those values to setSampleCount () requests multisample rendering.
注意： unlike QSurfaceFormat::setSamples (), the list of supported sample counts are exposed to the applications in advance and there is no automatic falling back to lower sample counts in setSampleCount (). If the requested value is not supported, a warning is shown and a no multisampling will be used.
当 supportsGrab () returns true, QVulkanWindow can perform readbacks from the color buffer into a QImage . grab () is a slow and inefficient operation, so frequent usage should be avoided. It is nonetheless valuable since it allows applications to take screenshots, or tools and tests to process and verify the output of the GPU rendering.
While many applications will be fine with the default behavior of QVulkanWindow when it comes to swapchain image formats,
setPreferredColorFormats
() allows requesting a pre-defined format. This is useful most notably when working in the sRGB color space. Passing a format like
VK_FORMAT_B8G8R8A8_SRGB
results in choosing an sRGB format, when available.
During application development it can be extremely valuable to have the Vulkan validation layers enabled. As shown in the example code above, calling QVulkanInstance::setLayers () on the QVulkanInstance before QVulkanInstance::create () enables validation, assuming the Vulkan driver stack in the system contains the necessary layers.
注意： Be aware of platform-specific differences. On desktop platforms installing the Vulkan SDK is typically sufficient. However, Android for example requires deploying additional shared libraries together with the application, and also mandates a different list of validation layer names. See the Android Vulkan development pages 了解更多信息。
注意： QVulkanWindow does not expose device layers since this functionality has been deprecated since version 1.0.13 of the Vulkan API.
另请参阅 QVulkanInstance and QWindow .
This enum describes the flags that can be passed to setFlags ().
| 常量 | 值 | 描述 |
|---|---|---|
QVulkanWindow::PersistentResources
|
0x01
|
Ensures no graphics resources are released when the window becomes unexposed. The default behavior is to release everything, and reinitialize later when becoming visible again. |
Flags 类型是 typedef 对于 QFlags <Flag>。它存储 Flag 值的 OR 组合。
A function that is called during graphics initialization to add additional queues that should be created.
Set if the renderer needs additional queues besides the default graphics queue (e.g. a transfer queue). The provided queue family properties can be used to select the indices for the additional queues. The renderer can subsequently request the actual queue in initResources().
注意： When requesting additional graphics queues, Qt itself always requests a graphics queue. You'll need to search queueCreateInfo for the appropriate entry and manipulate it to obtain the additional queue.
另请参阅 setQueueCreateInfoModifier ().
Constructs a new QVulkanWindow with the given parent .
The surface type is set to QSurface::VulkanSurface .
[signal]
void
QVulkanWindow::
frameGrabbed
(const
QImage
&
image
)
此信号被发射当 image is ready.
[虚拟]
QVulkanWindow::
~QVulkanWindow
()
析构函数。
Returns the list of properties for the supported physical devices in the system.
注意： This function can be called before making the window visible.
返回 QMatrix4x4 that can be used to correct for coordinate system differences between OpenGL and Vulkan.
By pre-multiplying the projection matrix with this matrix, applications can continue to assume that Y is pointing upwards, and can set minDepth and maxDepth in the viewport to 0 and 1, respectively, without having to do any further corrections to the vertex Z positions. Geometry from OpenGL applications can then be used as-is, assuming a rasterization state matching the OpenGL culling and front face settings.
Returns the color buffer format used by the swapchain.
注意： Calling this function is only valid from the invocation of QVulkanWindowRenderer::initResources () up until QVulkanWindowRenderer::releaseResources ().
另请参阅 setPreferredColorFormats ().
Returns the number of frames that can be potentially active at the same time.
注意： The value is constant for the entire lifetime of the QVulkanWindow .
class Renderer {
void startNextFrame();
// ...
VkDescriptorBufferInfo m_uniformBufInfo[QVulkanWindow::MAX_CONCURRENT_FRAME_COUNT];
QVulkanWindow *m_window = nullptr;
};
void Renderer::startNextFrame()
{
const int count = m_window->concurrentFrameCount();
// for (int i = 0; i < count; ++i)
// m_uniformBufInfo[i] = ...
// ...
}
另请参阅 currentFrame ().
[虚拟]
QVulkanWindowRenderer
*QVulkanWindow::
createRenderer
()
Returns a new instance of QVulkanWindowRenderer .
This virtual function is called once during the lifetime of the window, at some point after making it visible for the first time.
The default implementation returns null and so no rendering will be performed apart from clearing the buffers.
The window takes ownership of the returned renderer object.
Returns The active command buffer for the current swap chain image. Implementations of QVulkanWindowRenderer::startNextFrame () are expected to add commands to this command buffer.
注意： This function must only be called from within startNextFrame() and, in case of asynchronous command generation, up until the call to frameReady ().
Returns the current frame index in the range [0, concurrentFrameCount () - 1].
Renderer implementations will have to ensure that uniform data and other dynamic resources exist in multiple copies, in order to prevent frame N altering the data used by the still-active frames N - 1, N - 2, ... N - concurrentFrameCount () + 1.
To avoid relying on dynamic array sizes, applications can use MAX_CONCURRENT_FRAME_COUNT when declaring arrays. This is guaranteed to be always equal to or greater than the value returned from concurrentFrameCount (). Such arrays can then be indexed by the value returned from this function.
class Renderer {
void startNextFrame();
// ...
VkDescriptorBufferInfo m_uniformBufInfo[QVulkanWindow::MAX_CONCURRENT_FRAME_COUNT];
QVulkanWindow *m_window = nullptr;
};
void Renderer::startNextFrame()
{
VkDescriptorBufferInfo &uniformBufInfo(m_uniformBufInfo[m_window->currentFrame()]);
// ...
}
注意： This function must only be called from within startNextFrame() and, in case of asynchronous command generation, up until the call to frameReady ().
另请参阅 concurrentFrameCount ().
Returns a VkFramebuffer for the current swapchain image using the default render pass.
The framebuffer has two attachments (color, depth-stencil) when multisampling is not in use, and three (color resolve, depth-stencil, multisample color) when
sampleCountFlagBits
() is greater than
VK_SAMPLE_COUNT_1_BIT
. Renderers must take this into account, for example when providing clear values.
注意： Applications are not required to use this framebuffer in case they provide their own render pass instead of using the one returned from defaultRenderPass ().
注意： This function must only be called from within startNextFrame() and, in case of asynchronous command generation, up until the call to frameReady ().
另请参阅 defaultRenderPass ().
Returns the current swap chain image index in the range [0, swapChainImageCount () - 1].
注意： This function must only be called from within startNextFrame() and, in case of asynchronous command generation, up until the call to frameReady ().
Returns a typical render pass with one sub-pass.
注意：
Applications are not required to use this render pass. However, they are then responsible for ensuring the current swap chain and depth-stencil images get transitioned from
VK_IMAGE_LAYOUT_UNDEFINED
to
VK_IMAGE_LAYOUT_PRESENT_SRC_KHR
and
VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL
either via the application's custom render pass or by other means.
注意： Stencil read/write is not enabled in this render pass.
注意： Calling this function is only valid from the invocation of QVulkanWindowRenderer::initResources () up until QVulkanWindowRenderer::releaseResources ().
另请参阅 currentFramebuffer ().
Returns the format used by the depth-stencil buffer(s).
注意： Calling this function is only valid from the invocation of QVulkanWindowRenderer::initResources () up until QVulkanWindowRenderer::releaseResources ().
Returns the depth-stencil image.
注意： Calling this function is only valid from the invocation of QVulkanWindowRenderer::initSwapChainResources () up until QVulkanWindowRenderer::releaseSwapChainResources ().
Returns the depth-stencil image view.
注意： Calling this function is only valid from the invocation of QVulkanWindowRenderer::initSwapChainResources () up until QVulkanWindowRenderer::releaseSwapChainResources ().
Returns the active logical device.
注意： Calling this function is only valid from the invocation of QVulkanWindowRenderer::initResources () up until QVulkanWindowRenderer::releaseResources ().
Returns a device local memory type index suitable for general use.
注意： Calling this function is only valid from the invocation of QVulkanWindowRenderer::initResources () up until QVulkanWindowRenderer::releaseResources ().
注意：
It is not guaranteed that this memory type is always suitable. The correct, cross-implementation solution - especially for device local images - is to manually pick a memory type after checking the mask returned from
vkGetImageMemoryRequirements
.
Return the requested flags.
另请参阅 setFlags ().
This function must be called exactly once in response to each invocation of the QVulkanWindowRenderer::startNextFrame () implementation. At the time of this call, the main command buffer, exposed via currentCommandBuffer (), must have all necessary rendering commands added to it since this function will trigger submitting the commands and queuing the present command.
注意： This function must only be called from the gui/main thread, which is where QVulkanWindowRenderer 's functions are invoked and where the QVulkanWindow instance lives.
另请参阅 QVulkanWindowRenderer::startNextFrame ().
Builds and renders the next frame without presenting it, then performs a blocking readback of the image content.
Returns the image if the renderer's startNextFrame() implementation calls back frameReady () directly. Otherwise, returns an incomplete image, that has the correct size but not the content yet. The content will be delivered via the frameGrabbed () signal in the latter case.
注意： This function should not be called when a frame is in progress (that is, frameReady () has not yet been called back by the application).
注意： This function is potentially expensive due to the additional, blocking readback.
注意：
This function currently requires that the swapchain supports usage as a transfer source (
VK_IMAGE_USAGE_TRANSFER_SRC_BIT
), and will fail otherwise.
Returns the active graphics command pool.
注意： Calling this function is only valid from the invocation of QVulkanWindowRenderer::initResources () up until QVulkanWindowRenderer::releaseResources ().
Returns the active graphics queue.
注意： Calling this function is only valid from the invocation of QVulkanWindowRenderer::initResources () up until QVulkanWindowRenderer::releaseResources ().
[since 5.15]
uint32_t
QVulkanWindow::
graphicsQueueFamilyIndex
() const
Returns the family index of the active graphics queue.
注意： Calling this function is only valid from the invocation of QVulkanWindowRenderer::initResources () up until QVulkanWindowRenderer::releaseResources (). Implementations of QVulkanWindowRenderer::updateQueueCreateInfo() can also call this function.
该函数在 Qt 5.15 引入。
Returns a host visible memory type index suitable for general use.
The returned memory type will be both host visible and coherent. In addition, it will also be cached, if possible.
注意： Calling this function is only valid from the invocation of QVulkanWindowRenderer::initResources () up until QVulkanWindowRenderer::releaseResources ().
Returns true if this window has successfully initialized all Vulkan resources, including the swapchain.
注意： Initialization happens on the first expose event after the window is made visible.
Returns the specified multisample color image, or
VK_NULL_HANDLE
if multisampling is not in use.
idx must be in the range [0, swapChainImageCount () - 1].
注意： Calling this function is only valid from the invocation of QVulkanWindowRenderer::initSwapChainResources () up until QVulkanWindowRenderer::releaseSwapChainResources ().
Returns the specified multisample color image view, or
VK_NULL_HANDLE
if multisampling is not in use.
idx must be in the range [0, swapChainImageCount () - 1].
注意： Calling this function is only valid from the invocation of QVulkanWindowRenderer::initSwapChainResources () up until QVulkanWindowRenderer::releaseSwapChainResources ().
Returns the active physical device.
注意： Calling this function is only valid from the invocation of QVulkanWindowRenderer::preInitResources () up until QVulkanWindowRenderer::releaseResources ().
Returns a pointer to the properties for the active physical device.
注意： Calling this function is only valid from the invocation of QVulkanWindowRenderer::preInitResources () up until QVulkanWindowRenderer::releaseResources ().
Returns the current sample count as a
VkSampleCountFlagBits
值。
When targeting the default render target, the
rasterizationSamples
field of
VkPipelineMultisampleStateCreateInfo
must be set to this value.
另请参阅 setSampleCount () 和 supportedSampleCounts ().
Sets the list of device extensions to be enabled.
Unsupported extensions are ignored.
The swapchain extension will always be added automatically, no need to include it in this list.
注意： This function must be called before the window is made visible or at latest in QVulkanWindowRenderer::preInitResources (), and has no effect if called afterwards.
Configures the behavior based on the provided flags .
注意： This function must be called before the window is made visible or at latest in QVulkanWindowRenderer::preInitResources (), and has no effect if called afterwards.
另请参阅 flags ().
Requests the usage of the physical device with index idx . The index corresponds to the list returned from availablePhysicalDevices ().
By default the first physical device is used.
注意： This function must be called before the window is made visible or at latest in QVulkanWindowRenderer::preInitResources (), and has no effect if called afterwards.
Sets the preferred 格式 of the swapchain.
By default no application-preferred format is set. In this case the surface's preferred format will be used or, in absence of that,
VK_FORMAT_B8G8R8A8_UNORM
.
The list in 格式 is ordered. If the first format is not supported, the second will be considered, and so on. When no formats in the list are supported, the behavior is the same as in the default case.
To query the actual format after initialization, call colorFormat ().
注意： This function must be called before the window is made visible or at latest in QVulkanWindowRenderer::preInitResources (), and has no effect if called afterwards.
注意： 重实现 QVulkanWindowRenderer::preInitResources () allows dynamically examining the list of supported formats, should that be desired. There the surface is retrievable via QVulkanInstace::surfaceForWindow(), while this function can still safely be called to affect the later stages of initialization.
另请参阅 colorFormat ().
[since 5.15]
void
QVulkanWindow::
setQueueCreateInfoModifier
(const
QVulkanWindow::QueueCreateInfoModifier
&
modifier
)
Sets the queue create info modification function modifier .
该函数在 Qt 5.15 引入。
另请参阅 QueueCreateInfoModifier .
Requests multisample antialiasing with the given sampleCount . The valid values are 1, 2, 4, 8, ... up until the maximum value supported by the physical device.
When the sample count is greater than 1, QVulkanWindow will create a multisample color buffer instead of simply targeting the swapchain's images. The rendering in the multisample buffer will get resolved into the non-multisample buffers at the end of each frame.
To examine the list of supported sample counts, call supportedSampleCounts ().
When setting up the rendering pipeline, call
sampleCountFlagBits
() to query the active sample count as a
VkSampleCountFlagBits
值。
注意： This function must be called before the window is made visible or at latest in QVulkanWindowRenderer::preInitResources (), and has no effect if called afterwards.
另请参阅 supportedSampleCounts () 和 sampleCountFlagBits ().
Returns the list of the extensions that are supported by logical devices created from the physical device selected by setPhysicalDeviceIndex ().
注意： This function can be called before making the window visible.
Returns the set of supported sample counts when using the physical device selected by setPhysicalDeviceIndex (), as a sorted list.
默认情况下 QVulkanWindow uses a sample count of 1. By calling setSampleCount () with a different value (2, 4, 8, ...) from the set returned by this function, multisample anti-aliasing can be requested.
注意： This function can be called before making the window visible.
另请参阅 setSampleCount ().
Returns true if the swapchain supports usage as transfer source, meaning grab () is functional.
注意： Calling this function is only valid from the invocation of QVulkanWindowRenderer::initSwapChainResources () up until QVulkanWindowRenderer::releaseSwapChainResources ().
Returns the specified swap chain image.
idx must be in the range [0, swapChainImageCount () - 1].
注意： Calling this function is only valid from the invocation of QVulkanWindowRenderer::initSwapChainResources () up until QVulkanWindowRenderer::releaseSwapChainResources ().
Returns the number of images in the swap chain.
注意： Accessing this is necessary when providing a custom render pass and framebuffer. The framebuffer is specific to the current swapchain image and hence the application must provide multiple framebuffers.
注意： Calling this function is only valid from the invocation of QVulkanWindowRenderer::initSwapChainResources () up until QVulkanWindowRenderer::releaseSwapChainResources ().
Returns the image size of the swapchain.
This usually matches the size of the window, but may also differ in case
vkGetPhysicalDeviceSurfaceCapabilitiesKHR
reports a fixed size.
注意： Calling this function is only valid from the invocation of QVulkanWindowRenderer::initSwapChainResources () up until QVulkanWindowRenderer::releaseSwapChainResources ().
Returns the specified swap chain image view.
idx must be in the range [0, swapChainImageCount () - 1].
注意： Calling this function is only valid from the invocation of QVulkanWindowRenderer::initSwapChainResources () up until QVulkanWindowRenderer::releaseSwapChainResources ().
This variable holds a constant value that is always equal to or greater than the maximum value of concurrentFrameCount ().