tp::Swapchain class

Manages presenting the rendering results to a surface.

Remark

On either of the acquire or present operations, the status of the swapchain can change. This indicates whether the swapchain needs to be recreated and which operations are supported.

The usual workflow for presenting an image is as follows:

Acquire the next image through tp::Swapchain::acquireNextImage, receiving the synchronization primitives as well as the image itself. TODO: Clarivy that we don't actually need to discard
In a tp::Job, call tp::Job::cmdDiscardContents on the acquired image, unless its previous contents are needed.
Populate the swapchain image with data for the next frame.
Export the swapchain image with tp::Job::cmdExportResource, specifying the tp::ReadAccess::ImagePresentKHR read access and the queue the present operation will take place in if it's different from the queue the job will be submitted to.
Submit the job(s) accessing the swapchain image such that the first one waits on the tp::AcquiredImageInfo::acquireSemaphore external semaphore and the last one signals the tp::AcquiredImageInfo::presentSemaphore semaphore.
Present the image by calling tp::Device::submitPresentImagesKHR with the matching swapchain and image index.

Base classes

class Ownable: A customizable base class that is used for objects returned by the API in an OwningPtr.

Public functions

auto acquireNextImage(Timeout timeout = Timeout::Indefinite()) -> std::optional<AcquiredImageInfo>: Acquires the next available image in the swapchain.
auto getStatus() const -> SwapchainStatus: Returns the current status of the swapchain.
auto vkGetSwapchainHandle() const -> VkSwapchainHandleKHR: Returns the Vulkan VkSwapchainKHR handle.

Function documentation

std::optional<AcquiredImageInfo> tp::Swapchain::acquireNextImage(Timeout timeout = Timeout::Indefinite())

Acquires the next available image in the swapchain.

Parameters
timeout	The time limit for waiting.
Returns	The details of the acquired image, unless the operation timed out.