Class atlas::vk::vk_present_queue

ClassList > atlas > vk > vk_present_queue

Handles submissions to the specific queue for presentation. More...

• #include <vk_present_queue.hpp>

Public Functions

Type	Name
uint32_t	acquired_frame ()
void	destroy () Explicitly invoking cleanup for the presentation queue.
bool	is_alive () const
	operator VkQueue ()
	operator VkQueue () const
void	present_frame (const uint32_t & p_current_frame) Then again, this probably won't be needed.
bool	resize_requested () const
void	set_resize_status (bool p_status)
void	submit_immediate_async (const VkCommandBuffer & p_command) Submitting current command buffer with async enabled.
void	submit_immediate_sync (const VkCommandBuffer & p_command) Submitting current command buffer with async disabled.
	vk_present_queue () = default
	vk_present_queue (const VkSwapchainKHR & p_swapchain, const vk_queue_options & p_queue_options) Constructs new presentation queue.
void	wait_idle () Ensures that operations finished within this queue before processing new frames.

Detailed Description

This queue is for submitting presentation images through this queue that gets displayed onto the swapchain

Used by the vk_swapchain to present currently processed command buffers to the swapchain

Public Functions Documentation

function acquired_frame

uint32_t atlas::vk::vk_present_queue::acquired_frame () 

Returns:

uint32_t next index to the presentable image for the current frame

---

function destroy

Explicitly invoking cleanup for the presentation queue.

void atlas::vk::vk_present_queue::destroy () 

---

function is_alive

inline bool atlas::vk::vk_present_queue::is_alive () const

Returns:

bool if the presentation queue handler is valid or not

---

function operator VkQueue [1/2]

inline atlas::vk::vk_present_queue::operator VkQueue () 

---

function operator VkQueue [2/2]

inline atlas::vk::vk_present_queue::operator VkQueue () const

---

function present_frame

Then again, this probably won't be needed.

void atlas::vk::vk_present_queue::present_frame (
    const uint32_t & p_current_frame
) 

Parameters:

• p_current_frame current frame of image presentable to the swapchain

---

function resize_requested

inline bool atlas::vk::vk_present_queue::resize_requested () const

---

function set_resize_status

inline void atlas::vk::vk_present_queue::set_resize_status (
    bool p_status
) 

---

function submit_immediate_async

Submitting current command buffer with async enabled.

void atlas::vk::vk_present_queue::submit_immediate_async (
    const VkCommandBuffer & p_command
) 

---

function submit_immediate_sync

Submitting current command buffer with async disabled.

void atlas::vk::vk_present_queue::submit_immediate_sync (
    const VkCommandBuffer & p_command
) 

---

function vk_present_queue [1/2]

atlas::vk::vk_present_queue::vk_present_queue () = default

---

function vk_present_queue [2/2]

Constructs new presentation queue.

atlas::vk::vk_present_queue::vk_present_queue (
    const VkSwapchainKHR & p_swapchain,
    const vk_queue_options & p_queue_options
) 

Parameters:

• p_swapchain presentation queue needs a swapchain of where the images are being rendered to
• p_queue_options specifies options on the types of queue family index, and queue associated index to which queue family handler for submitting work to

---

function wait_idle

Ensures that operations finished within this queue before processing new frames.

void atlas::vk::vk_present_queue::wait_idle () 

Synchronization handling

---

---

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