vsg  1.1.0
VulkanSceneGraph library
Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | List of all members
vsg::CommandBuffer Class Reference

CommandBuffer encapsulates VkCommandBuffer. More...

#include <CommandBuffer.h>

Inheritance diagram for vsg::CommandBuffer:
Inheritance graph
[legend]
Collaboration diagram for vsg::CommandBuffer:
Collaboration graph
[legend]

Public Member Functions

const VkCommandBuffer * data () const
 
 operator VkCommandBuffer () const
 
VkCommandBuffer vk () const
 
std::atomic_uint & numDependentSubmissions ()
 
VkCommandBufferLevel level () const
 
void reset ()
 reset the CommandBuffer for the new frame.
 
DevicegetDevice ()
 
const DevicegetDevice () const
 
CommandPoolgetCommandPool ()
 
const CommandPoolgetCommandPool () const
 
void setCurrentPipelineLayout (const PipelineLayout *pipelineLayout)
 
VkPipelineLayout getCurrentPipelineLayout () const
 
VkShaderStageFlags getCurrentPushConstantStageFlags () const
 
- Public Member Functions inherited from vsg::Inherit< Object, CommandBuffer >
 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
 
void accept (ConstVisitor &visitor) const override
 
void accept (RecordTraversal &visitor) const override
 
- Public Member Functions inherited from vsg::Object
 Object (const Object &)
 
Objectoperator= (const Object &)
 
template<class T >
T * cast ()
 
template<class T >
const T * cast () const
 
virtual void traverse (Visitor &)
 
virtual void traverse (ConstVisitor &) 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 deviceID
 
uint32_t viewID = 0
 
Mask traversalMask = MASK_ALL
 
Mask overrideMask = MASK_OFF
 
ViewDependentStateviewDependentState = nullptr
 
ref_ptr< ScratchMemoryscratchMemory
 

Protected Member Functions

 CommandBuffer (CommandPool *commandPool, VkCommandBuffer commandBuffer, VkCommandBufferLevel level)
 
- Protected Member Functions inherited from vsg::Object
virtual void _attemptDelete () const
 
void setAuxiliary (Auxiliary *auxiliary)
 

Protected Attributes

friend CommandPool
 
VkCommandBuffer _commandBuffer
 
VkCommandBufferLevel _level
 
std::atomic_uint _numDependentSubmissions {0}
 
ref_ptr< Device_device
 
ref_ptr< CommandPool_commandPool
 
VkPipelineLayout _currentPipelineLayout
 
VkShaderStageFlags _currentPushConstantStageFlags
 

Additional Inherited Members

- Static Public Member Functions inherited from vsg::Inherit< Object, CommandBuffer >
static ref_ptr< CommandBuffercreate (Args &&... args)
 
static ref_ptr< CommandBuffercreate_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

CommandBuffer encapsulates VkCommandBuffer.


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