`LiteFX::Rendering::SwapChain`¶

Represents a swap chain, i.e. a chain of multiple IImage instances, that can be presented to a ISurface.

Synopsis¶

template<typename TImageInterface>
requires std::derived_from<TImageInterface, IImage>
class SwapChain
    : public ISwapChain

Name	Description
`ISwapChain`	Interface for a swap chain.

Name	Description
`BackBufferSwapEventArgs`	Event arguments for a `ISwapChain::swapped` event.
`ResetEventArgs`	Event arguments for a `ISwapChain::reseted` event.

Name
`image_interface_type`

Name	Description
`~SwapChain` [destructor] [virtual]	Destructor
`addTimingEvent` [virtual]	Adds a new timing event.
`buffers` [virtual]	Returns the number of images in the swap chain.
`device` [virtual]	Returns the swap chain's parent device instance.
`getSurfaceFormats` [virtual]	Returns an array of supported formats, that can be drawn to the surface.
`image`	`image` overloads
`images` [virtual]	Returns an array of the swap chain present images.
`present` [virtual]	Queues a present that gets executed after `fence` has been signaled on the default graphics queue.
`readTimingEvent` [virtual]	Reads the current time stamp value (in ticks) of a timing event.
`registerTimingEvent`	Creates a new instance of a `TimingEvent`.
`renderArea` [virtual]	Returns the size of the render area.
`reset` [virtual]	Causes the swap chain to be re-created. All frame and command buffers will be invalidated and rebuilt.
`resolveQueryId` [virtual]	Returns the query ID for the timing event.
`surfaceFormat` [virtual]	Returns the swap chain image format.
`swapBackBuffer` [virtual]	Swaps the front buffer with the next back buffer in order.
`timingEvent` [virtual]	Returns the timing event registered for `queryId.`
`timingEvents` [virtual]	Returns all registered timing events.
`verticalSynchronization` [virtual]	Returns `true`, if vertical synchronization should be used, otherwise `false`.

Name	Description
`reseted`	Invoked, after the swap chain has been reseted.
`swapped`	Invoked, when the swap chain has swapped the back buffers.

Name	Description
`SwapChain` [constructor]	Constructors
`operator=`	Assignment operators

Name	Description
TImageInterface	The type of the image interface. Must inherit from `IImage`.

Name	Description
`DirectX12SwapChain`	Implements a DirectX 12 swap chain.
`VulkanSwapChain`	Implements a Vulkan swap chain.