Raven::VulkanSwapchain Class Reference

Holds semaphores used for synchronizing image acquisition and rendering. More...

#include <VulkanSwapchain.h>

Inherits Raven::Swapchain.

Public Member Functions
ILLUMINE_API	VulkanSwapchain (u32 width, u32 height, bool vsync)
	Constructs a VulkanSwapchain.
ILLUMINE_API void	Shutdown () override
	Destroys the Vulkan swapchain and associated resources.
ILLUMINE_API void	Present () override
	Presents the currently rendered image to the display.
ILLUMINE_API void	Recreate (u32 width, u32 height, bool enabled) override
	Triggers a recreation of the swapchain.
float	GetAspectRatio () const override
	Returns the current aspect ratio of the swapchain.
ILLUMINE_API void	BeginFrame () override
	Begins a new frame for rendering.
	operator VkSwapchainKHR () const
	Implicit conversion to VkSwapchainKHR.
std::pair< u32, u32 >	GetExtent ()
	Returns the current width and height of the swapchain.
u32	GetImageIndex () const
	Gets the index of the current swapchain image.
u8	GetCurrentFrame () const
	Gets the current frame index for frame-in-flight tracking.
void *	GetFence () const override
	Returns the fence used for synchronizing the current frame.
void *	GetFence (const u32 frame) const override
const Semaphores &	GetSemaphores () const
	Gets the semaphores used for synchronization.
VkImage	GetImage (u32 index)
	Gets a Vulkan image by index.
std::vector< VkImageView >	GetImageViews () const
	Returns all swapchain image views.
u32	GetImageCount ()
	Returns the total number of swapchain images.
Public Member Functions inherited from Raven::Swapchain
virtual	~Swapchain ()=default
Public Member Functions inherited from Raven::RefCounted
	RefCounted ()
virtual	~RefCounted ()
void	IncRefCount ()
void	DecRefCount ()
u32	GetRefCount () const

Static Public Member Functions
static VulkanSwapchain &	Get ()
	Returns a reference to the active VulkanSwapchain instance.
Static Public Member Functions inherited from Raven::Swapchain
static Ref< Swapchain >	Create (u32 width, u32 height, bool vsync)
	Factory method to create a platform-specific swapchain instance.

Detailed Description

Holds semaphores used for synchronizing image acquisition and rendering.

Vulkan implementation of the platform-agnostic Swapchain.

Each frame-in-flight uses a pair of semaphores:

• ImageAvailableSemaphore: signals when the swapchain image is ready to be rendered to.
• RenderFinishedSemaphore: signals when rendering is complete and ready for presentation.

Handles Vulkan-specific swapchain creation, synchronization, resizing, and presentation.

Constructor & Destructor Documentation

VulkanSwapchain()

Raven::VulkanSwapchain::VulkanSwapchain	(	u32	width,
		u32	height,
		bool	vsync )

Constructs a VulkanSwapchain.

Parameters

width	Pointer to the current window width.
height	Pointer to the current window height.
vsync	Whether vertical synchronization is enabled.

Member Function Documentation

BeginFrame()

void Raven::VulkanSwapchain::BeginFrame ( )

overridevirtual

Begins a new frame for rendering.

Acquires a new image from the swapchain and prepares for rendering.

Implements Raven::Swapchain.

Get()

VulkanSwapchain & Raven::VulkanSwapchain::Get ( )

inlinestatic

Returns a reference to the active VulkanSwapchain instance.

GetAspectRatio()

float Raven::VulkanSwapchain::GetAspectRatio ( ) const

inlineoverridevirtual

Returns the current aspect ratio of the swapchain.

Implements Raven::Swapchain.

GetCurrentFrame()

u8 Raven::VulkanSwapchain::GetCurrentFrame ( ) const

inline

Gets the current frame index for frame-in-flight tracking.

GetExtent()

std::pair< u32, u32 > Raven::VulkanSwapchain::GetExtent ( )

inline

Returns the current width and height of the swapchain.

GetFence() [1/2]

void * Raven::VulkanSwapchain::GetFence ( ) const

inlineoverridevirtual

Returns the fence used for synchronizing the current frame.

Implements Raven::Swapchain.

GetFence() [2/2]

void * Raven::VulkanSwapchain::GetFence ( const u32 frame ) const

inlineoverridevirtual

Implements Raven::Swapchain.

GetImage()

VkImage Raven::VulkanSwapchain::GetImage ( u32 index )

inline

Gets a Vulkan image by index.

Parameters

index

Index of the image.

Returns

The Vulkan image.

GetImageCount()

u32 Raven::VulkanSwapchain::GetImageCount ( )

inline

Returns the total number of swapchain images.

GetImageIndex()

u32 Raven::VulkanSwapchain::GetImageIndex ( ) const

inline

Gets the index of the current swapchain image.

GetImageViews()

std::vector< VkImageView > Raven::VulkanSwapchain::GetImageViews ( ) const

inline

Returns all swapchain image views.

GetSemaphores()

const Semaphores & Raven::VulkanSwapchain::GetSemaphores ( ) const

inline

Gets the semaphores used for synchronization.

operator VkSwapchainKHR()

Raven::VulkanSwapchain::operator VkSwapchainKHR ( ) const

inline

Implicit conversion to VkSwapchainKHR.

Present()

void Raven::VulkanSwapchain::Present ( )

overridevirtual

Presents the currently rendered image to the display.

Implements Raven::Swapchain.

Recreate()

void Raven::VulkanSwapchain::Recreate ( u32 width, u32 height, bool enabled )

overridevirtual

Triggers a recreation of the swapchain.

Parameters

width	New width.
height	New height.
enabled	Enable/Disable VSync

Implements Raven::Swapchain.

Shutdown()

void Raven::VulkanSwapchain::Shutdown ( )

overridevirtual

Destroys the Vulkan swapchain and associated resources.

Implements Raven::Swapchain.

---

The documentation for this class was generated from the following files:

• Illumine/src/Renderer/backend/Vulkan/VulkanSwapchain.h
• Illumine/src/Renderer/backend/Vulkan/VulkanSwapchain.cpp