Class atlas::vk::vk_swapchain

ClassList > atlas > vk > vk_swapchain

Public Functions

Type	Name
vk_command_buffer	active_command_buffer (uint32_t p_frame) const
VkFramebuffer	active_framebuffer (uint32_t p_frame) const
void	configure (const window_settings & p_settings) Constructs new swapchain with specified window-integration configuration settings.
surface_properties	data () const
void	destroy ()
uint32_t	image_size () const
	operator VkSwapchainKHR () const
	operator VkSwapchainKHR ()
void	present (const uint32_t & p_current_frame)
uint32_t	read_acquired_image () Used for when swapchain is resized then only reconfigured properties to get resizability.
window_settings	settings () const
void	submit (const VkCommandBuffer & p_command)
VkRenderPass	swapchain_renderpass () const
	vk_swapchain () = default
	vk_swapchain (const VkSurfaceKHR & p_surface, const window_settings & p_settings) Constructs a new vulkan swapchain with a window settings to apply to this swapchain.

Public Functions Documentation

function active_command_buffer

inline vk_command_buffer atlas::vk::vk_swapchain::active_command_buffer (
    uint32_t p_frame
) const

Returns:

current active command buffer being processed

---

function active_framebuffer

inline VkFramebuffer atlas::vk::vk_swapchain::active_framebuffer (
    uint32_t p_frame
) const

---

function configure

Constructs new swapchain with specified window-integration configuration settings.

void atlas::vk::vk_swapchain::configure (
    const window_settings & p_settings
) 

---

function data

inline surface_properties atlas::vk::vk_swapchain::data () const

---

function destroy

void atlas::vk::vk_swapchain::destroy () 

---

function image_size

inline uint32_t atlas::vk::vk_swapchain::image_size () const

---

function operator VkSwapchainKHR [1/2]

inline atlas::vk::vk_swapchain::operator VkSwapchainKHR () const

---

function operator VkSwapchainKHR [2/2]

inline atlas::vk::vk_swapchain::operator VkSwapchainKHR () 

---

function present

void atlas::vk::vk_swapchain::present (
    const uint32_t & p_current_frame
) 

---

function read_acquired_image

Used for when swapchain is resized then only reconfigured properties to get resizability.

uint32_t atlas::vk::vk_swapchain::read_acquired_image () 

Returns:

uint32_t the next available image to present acquired

---

function settings

inline window_settings atlas::vk::vk_swapchain::settings () const

---

function submit

void atlas::vk::vk_swapchain::submit (
    const VkCommandBuffer & p_command
) 

---

function swapchain_renderpass

inline VkRenderPass atlas::vk::vk_swapchain::swapchain_renderpass () const

---

function vk_swapchain [1/2]

atlas::vk::vk_swapchain::vk_swapchain () = default

---

function vk_swapchain [2/2]

Constructs a new vulkan swapchain with a window settings to apply to this swapchain.

atlas::vk::vk_swapchain::vk_swapchain (
    const VkSurfaceKHR & p_surface,
    const window_settings & p_settings
) 

Parameters:

• p_surface passing in the surface handler for swapchain uses

---

---

The documentation for this class was generated from the following file TheAtlasEngine/atlas/drivers/vulkan-cpp/vk_swapchain.hpp