vsg 1.1.10
VulkanSceneGraph library
Loading...
Searching...
No Matches
vsg::CommandPool Class Reference

#include <CommandPool.h>

Inheritance diagram for vsg::CommandPool:
Collaboration diagram for vsg::CommandPool:

Public Member Functions

 CommandPool (Device *device, uint32_t queueFamilyIndex, VkCommandPoolCreateFlags flags=0)
 operator VkCommandPool () const
VkCommandPool vk () const
void reset (VkCommandPoolResetFlags reset_flags=VK_COMMAND_POOL_RESET_RELEASE_RESOURCES_BIT) const
ref_ptr< CommandBufferallocate (VkCommandBufferLevel level=VK_COMMAND_BUFFER_LEVEL_PRIMARY)
 allocate CommandBuffer from CommandPool
DevicegetDevice ()
const DevicegetDevice () const
Public Member Functions inherited from vsg::Inherit< Object, CommandPool >
 Inherit (Args &&... args)
std::size_t sizeofObject () const noexcept override
const char * className () const noexcept override
const std::type_info & type_info () const noexcept override
bool is_compatible (const std::type_info &type) const noexcept override
int compare (const Object &rhs) const override
void accept (Visitor &visitor) override
Public Member Functions inherited from vsg::Object
 Object (const Object &object, const CopyOp &copyop={})
Objectoperator= (const Object &)
template<class T>
T * cast ()
template<class T>
const T * cast () const
virtual ref_ptr< Objectclone (const CopyOp &copyop={}) const
virtual void traverse (Visitor &)
virtual void accept (ConstVisitor &visitor) const
virtual void traverse (ConstVisitor &) const
virtual void accept (RecordTraversal &visitor) const
virtual void traverse (RecordTraversal &) const
virtual void read (Input &input)
virtual void write (Output &output) const
void ref () const noexcept
void unref () const noexcept
void unref_nodelete () const noexcept
unsigned int referenceCount () const noexcept
template<typename T>
void setValue (const std::string &key, const T &value)
void setValue (const std::string &key, const char *value)
 specialization of setValue to handle passing C strings
template<typename T>
bool getValue (const std::string &key, T &value) const
 get specified value type, return false if value associated with key is not assigned or is not the correct type
void setObject (const std::string &key, ref_ptr< Object > object)
 assign an Object associated with key
ObjectgetObject (const std::string &key)
 get Object pointer associated with key, return nullptr if no object associated with key has been assigned
const ObjectgetObject (const std::string &key) const
 get const Object pointer associated with key, return nullptr if no object associated with key has been assigned
template<class T>
T * getObject (const std::string &key)
 get object pointer of specified type associated with key, return nullptr if no object associated with key has been assigned
template<class T>
const T * getObject (const std::string &key) const
 get const object pointer of specified type associated with key, return nullptr if no object associated with key has been assigned
ref_ptr< ObjectgetRefObject (const std::string &key)
 get ref_ptr<Object> associated with key, return nullptr if no object associated with key has been assigned
ref_ptr< const ObjectgetRefObject (const std::string &key) const
 get ref_ptr<const Object> pointer associated with key, return nullptr if no object associated with key has been assigned
template<class T>
ref_ptr< T > getRefObject (const std::string &key)
 get ref_ptr<T> of specified type associated with key, return nullptr if no object associated with key has been assigned
template<class T>
const ref_ptr< const T > getRefObject (const std::string &key) const
 get ref_ptr<const T> of specified type associated with key, return nullptr if no object associated with key has been assigned
void removeObject (const std::string &key)
 remove meta object or value associated with key
AuxiliarygetOrCreateAuxiliary ()
AuxiliarygetAuxiliary ()
const AuxiliarygetAuxiliary () const

Public Attributes

const uint32_t queueFamilyIndex
const VkCommandPoolCreateFlags flags

Protected Member Functions

void free (CommandBuffer *commandBuffer)
 free CommandBuffer
Protected Member Functions inherited from vsg::Object
virtual void _attemptDelete () const
void setAuxiliary (Auxiliary *auxiliary)

Protected Attributes

friend CommandBuffer
std::mutex _mutex
VkCommandPool _commandPool
ref_ptr< Device_device

Additional Inherited Members

Static Public Member Functions inherited from vsg::Inherit< Object, CommandPool >
static ref_ptr< CommandPoolcreate (Args &&... args)
static ref_ptr< CommandPoolcreate_if (bool flag, Args &&... args)
Static Public Member Functions inherited from vsg::Object
static ref_ptr< Objectcreate ()
static ref_ptr< Objectcreate_if (bool flag)
static void * operator new (std::size_t count)
 provide new and delete to enable custom memory management via the vsg::Allocator singleton, using the MEMORY_AFFINTY_OBJECTS
static void operator delete (void *ptr)

Detailed Description

CommandPool encapsulates vkCommandPool. CommandPool are used in Vulkan as a source of Commands that are recorded to a CommandBuffer during the RecordTraversal, or dedicated command submissions.


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