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

Encapsulation of vkCmdExecuteCommands with thread safe integration with SecondaryCommandGraph that provides the secondary CommandBuffer. More...

#include <ExecuteCommands.h>

Inheritance diagram for vsg::ExecuteCommands:
Collaboration diagram for vsg::ExecuteCommands:

Classes

struct  CommandGraphAndBuffer

Public Member Functions

void connect (ref_ptr< SecondaryCommandGraph > commandGraph)
 connect a SecondaryCommmandGraph that will provide the CommandBuffer each frame
void reset ()
 clean the internal cache of CommandBuffer and reset the Latch used to signal when all the connected CommandGraph have completed the recording of their CommandBuffer
void completed (const SecondaryCommandGraph &commandGraph, ref_ptr< CommandBuffer > commandBuffer)
 called by SecondaryCommandGraph to pass on the completed CommandBuffer that was recorded.
void record (CommandBuffer &commandBuffer) const override
 call vkCmdExecuteCommands with all the CommandBuffer that have been recorded with this ExecuteCommands
Public Member Functions inherited from vsg::Inherit< Command, ExecuteCommands >
 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::Command
 Command (const Command &rhs, const CopyOp &copyop={})
Public Member Functions inherited from vsg::Inherit< Compilable, Command >
 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::Compilable
 Compilable (const Compilable &rhs, const CopyOp &copyop={})
virtual void compile (Context &)
Public Member Functions inherited from vsg::Inherit< Node, Compilable >
 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::Node
 Node (const Node &rhs, const CopyOp &copyop={})
ref_ptr< Objectclone (const CopyOp &copyop={}) const override
Public Member Functions inherited from vsg::Inherit< Object, Node >
 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 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

Protected Attributes

std::mutex _mutex
ref_ptr< Latch_latch
std::vector< CommandGraphAndBuffer_commandGraphsAndBuffers

Additional Inherited Members

Static Public Member Functions inherited from vsg::Inherit< Command, ExecuteCommands >
static ref_ptr< ExecuteCommandscreate (Args &&... args)
static ref_ptr< ExecuteCommandscreate_if (bool flag, Args &&... args)
Static Public Member Functions inherited from vsg::Inherit< Compilable, Command >
static ref_ptr< Commandcreate (Args &&... args)
static ref_ptr< Commandcreate_if (bool flag, Args &&... args)
Static Public Member Functions inherited from vsg::Inherit< Node, Compilable >
static ref_ptr< Compilablecreate (Args &&... args)
static ref_ptr< Compilablecreate_if (bool flag, Args &&... args)
Static Public Member Functions inherited from vsg::Node
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_NODES_OBJECTS
static void operator delete (void *ptr)
Static Public Member Functions inherited from vsg::Inherit< Object, Node >
static ref_ptr< Nodecreate (Args &&... args)
static ref_ptr< Nodecreate_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)
Protected Member Functions inherited from vsg::Object
virtual void _attemptDelete () const
void setAuxiliary (Auxiliary *auxiliary)

Detailed Description

Encapsulation of vkCmdExecuteCommands with thread safe integration with SecondaryCommandGraph that provides the secondary CommandBuffer.

Member Function Documentation

◆ record()

void vsg::ExecuteCommands::record ( CommandBuffer & commandBuffer) const
overridevirtual

call vkCmdExecuteCommands with all the CommandBuffer that have been recorded with this ExecuteCommands

Implements vsg::Command.


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