Typedef for QFlags<VulkanOptions> which contains an OR combination of VulkanOptions values.

Refer to QVulkanWindow::VulkanOptions for the enum documentation.

This enum describes the flags that can be passed to setFlags().

Constructs a new QVulkanWindow with the given parent. The surface type is set to QSurface::VulkanSurface.

Destroys the QVulkanWindow.

Returns the list of properties for the supported physical devices in the system.

This method can be called before making the window visible.

Returns a 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.

Note

Calling this method is only valid from the invocation of QVulkanWindowRenderer::initResources() up until QVulkanWindowRenderer::releaseResources().

See also

setPreferredColorFormats()

Returns the number of frames which can be potentially active at the same time. This value is constant for the entire lifetime of the QVulkanWindow.

See also

currentFrame()

Returns a new instance of QVulkanWindowRenderer. This method 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.

Note

This method 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.

This method must only be called from within startNextFrame() and in case of asynchronous command generation, up until the call to frameReady().

See also

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.

Note

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 method must only be called from within startNextFrame() and in case of asynchronous command generation, up until the call to frameReady().

See also

defaultRenderPass()

Returns the current swap chain image index in the range [0, swapChainImageCount() - 1].

Note

This method 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.

Note

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 method is only valid from the invocation of QVulkanWindowRenderer::initResources() up until QVulkanWindowRenderer::releaseResources().

See also

currentFramebuffer()

Returns the format used by the depth stencil buffers.

Note

Calling this method is only valid from the invocation of QVulkanWindowRenderer::initResources() up until QVulkanWindowRenderer::releaseResources().

Returns the depth-stencil image.

Note

Calling this function is only valid from the invocation of QVulkanWindowRenderer::initSwapChainResources() up until QVulkanWindowRenderer::releaseSwapChainResources().

Returns the depth-stencil image view.

Note

Calling this function is only valid from the invocation of QVulkanWindowRenderer::initSwapChainResources() up until QVulkanWindowRenderer::releaseSwapChainResources().

Returns the active logical device.

Note

Calling this method is only valid from the invocation of QVulkanWindowRenderer::initResources() up until QVulkanWindowRenderer::releaseResources().

Returns a device local memory type index suitable for general use.

Note

Calling this method 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.

The expose event is sent by the window system whenever the QWindow exposure changes. The application can start rendering into the window with QBackingStore and QOpenGLContext as soon as it gets an exposeEvent() such that isExposed() is true.

If the window is moved off screen, is made totally obscured by another window, iconified or similar, this function might be called and the value of isExposed() might change to false. When this happens, an application should stop its rendering as it is no longer visible to the user.

A resize event will always be sent before the expose event the first time a window is shown.

See also

isExposed()

Reimplemented from QWindow::exposeEvent()

Return the requested flags.

This method 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 method will trigger submitting the commands and queuing the present command.

Note

This method must only be called from the gui/main thread which is where QVulkanWindowRenderer's methods are invoked and where the QVulkanWindow instance lives.

See also

QVulkanWindowRenderer::startNextFrame()

Returns the active graphics command pool.

Note

Calling this method is only valid from the invocation of QVulkanWindowRenderer::initResources() up until QVulkanWindowRenderer::releaseResources().

Returns the active graphics queue.

Note

Calling this method is only valid from the invocation of QVulkanWindowRenderer::initResources() up until QVulkanWindowRenderer::releaseResources().

Returns the family index of the active graphics queue.

Note

Calling this method is only valid from the invocation of QVulkanWindowRenderer::initResources() up until QVulkanWindowRenderer::releaseResources(). Implementations of QVulkanWindowRenderer::updateQueueCreateInfo() can also call this method.

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.

Note

Calling this method 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.

Note

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. The given idx must be in the range [0, swapChainImageCount() - 1].

Note

Calling this method 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. The given idx must be in the range [0, swapChainImageCount() - 1].

Note

Calling this method is only valid from the invocation of QVulkanWindowRenderer::initSwapChainResources() up until QVulkanWindowRenderer::releaseSwapChainResources().

Returns the active physical device.

Note

Calling this method is only valid from the invocation of QVulkanWindowRenderer::preInitResources() up until QVulkanWindowRenderer::releaseResources().

Returns a pointer to the properties for the active physical device.

Note

Calling this method is only valid from the invocation of QVulkanWindowRenderer::preInitResources() up until QVulkanWindowRenderer::releaseResources().

Returns the current sample count as a VkSampleCountFlagBits value. When targeting the default render target, the rasterizationSamples field of VkPipelineMultisampleStateCreateInfo must be set to this value.

See also

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.

Note

This method 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.

Note

This method must be called before the window is made visible or at latest in QVulkanWindowRenderer::preInitResources(), and has no effect if called afterwards.

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.

Note

This method 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 formats 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 formats 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().

Note

This method must be called before the window is made visible or at latest in QVulkanWindowRenderer::preInitResources(), and has no effect if called afterwards.

Reimplementing QVulkanWindowRenderer::preInitResources() allows dynamically examining the list of supported formats, should that be desired. There the surface is retrievable via QVulkanInstace::surfaceForWindow(), while this method can still safely be called to affect the later stages of initialization.

See also

colorFormat()

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 value.

Note

This method must be called before the window is made visible or at latest in QVulkanWindowRenderer::preInitResources(), and has no effect if called afterwards.

See also

supportedSampleCounts(), sampleCountFlagBits()

Returns the list of the extensions that are supported by logical devices created from the physical device selected by setPhysicalDeviceIndex().

This method 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.

By default QVulkanWindow uses a sample count of 1. By calling setSampleCount() with a different value (2, 4, 8, ...) from the set returned by this method, multisample anti-aliasing can be requested.

This method can be called before making the window visible.

See also

setSampleCount()

Returns the specified swap chain image. The given idx must be in the range [0, swapChainImageCount() - 1].

It is only valid to call this method between calling QVulkanWindowRenderer::initSwapChainResources() and QVulkanWindowRenderer::releaseSwapChainResources().

Returns the number of images in the swap chain. Calling this method is required 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.

It is only valid to call this method between calling QVulkanWindowRenderer::initSwapChainResources() and 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.

It is only valid to call this method between calling QVulkanWindowRenderer::initSwapChainResources() and QVulkanWindowRenderer::releaseSwapChainResources().

Returns the specified swap chain image view. The given idx must be in the range [0, swapChainImageCount() - 1].

It is only valid to call this method between calling QVulkanWindowRenderer::initSwapChainResources() and QVulkanWindowRenderer::releaseSwapChainResources().

A constant value which is always equal to or greater than the maximum value of concurrentFrameCount().