Skip to content

Class atlas::vk::vk_command_buffer

ClassList > atlas > vk > vk_command_buffer

Vulkan Command Buffers. More...

  • #include <vk_command_buffer.hpp>

Public Functions

Type Name
void begin (const VkCommandBufferUsageFlags & p_usage_flags)
Indication when for this command buffer to start recording (writing) commands to this command buffer.
void destroy ()
API for explicitly invoking cleanup on the command buffer.
void end ()
Indication when the command buffer to stop recording (write) commands to this buffer.
bool is_valid () const
Enable to check for command buffers if they are valid.
operator VkCommandBuffer () const
operator VkCommandBuffer ()
vk_command_buffer () = default
vk_command_buffer (const command_buffer_settings & p_settings)
Constructs new command buffer.

Detailed Description

Use this to create a command buffer according to vulkan specifications

vulkan command buffer is how vulkan submits commands specifically directly or indirectly to the GPU via vkQueueSubmit

Command buffers in vulkan only know about the queue family they are associated with, their primary flag, and allocation operation associated with.

Public Functions Documentation

function begin

Indication when for this command buffer to start recording (writing) commands to this command buffer.

void atlas::vk::vk_command_buffer::begin (
    const VkCommandBufferUsageFlags & p_usage_flags
) 


function destroy

API for explicitly invoking cleanup on the command buffer.

void atlas::vk::vk_command_buffer::destroy () 


function end

Indication when the command buffer to stop recording (write) commands to this buffer.

void atlas::vk::vk_command_buffer::end () 


function is_valid

Enable to check for command buffers if they are valid.

inline bool atlas::vk::vk_command_buffer::is_valid () const


function operator VkCommandBuffer [1/2]

inline atlas::vk::vk_command_buffer::operator VkCommandBuffer () const

function operator VkCommandBuffer [2/2]

inline atlas::vk::vk_command_buffer::operator VkCommandBuffer () 

function vk_command_buffer [1/2]

atlas::vk::vk_command_buffer::vk_command_buffer () = default

function vk_command_buffer [2/2]

Constructs new command buffer.

atlas::vk::vk_command_buffer::vk_command_buffer (
    const command_buffer_settings & p_settings
) 



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