vsg 1.1.8
VulkanSceneGraph library
Loading...
Searching...
No Matches
vsg::DescriptorPools Class Reference

Container for DescriptorPools. More...

#include <DescriptorPools.h>

Inheritance diagram for vsg::DescriptorPools:
Collaboration diagram for vsg::DescriptorPools:

Public Member Functions

 DescriptorPools (ref_ptr< Device > in_device)
 
void reserve (const ResourceRequirements &requirements)
 check if there are enough Descriptorsets/Descrioptors, if not allocated a new DescriptorPool for these resources
 
ref_ptr< DescriptorSet::ImplementationallocateDescriptorSet (DescriptorSetLayout *descriptorSetLayout)
 
void report (std::ostream &out, indentation indent={}) const
 write the internal details to stream.
 
bool available (uint32_t &numSets, DescriptorPoolSizes &availableDescriptorPoolSizes) const
 compute the number of sets and descriptors available.
 
bool used (uint32_t &numSets, DescriptorPoolSizes &descriptorPoolSizes) const
 compute the number of sets and descriptors used.
 
bool allocated (uint32_t &numSets, DescriptorPoolSizes &descriptorPoolSizes) const
 compute the number of sets and descriptors allocated.
 
- Public Member Functions inherited from vsg::Inherit< Object, DescriptorPools >
 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 &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 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

ref_ptr< Devicedevice
 
std::list< ref_ptr< DescriptorPool > > descriptorPools
 
uint32_t minimum_maxSets = 0
 
uint32_t maximum_maxSets = 2048
 
double scale_maxSets = 2.0
 
uint32_t reserve_count = 0
 
uint32_t reserve_maxSets = 0
 
DescriptorPoolSizes reserve_descriptorPoolSizes
 

Protected Member Functions

void getDescriptorPoolSizesToUse (uint32_t &maxSets, DescriptorPoolSizes &descriptorPoolSizes)
 get the maxSets and descriptorPoolSizes to use
 
- Protected Member Functions inherited from vsg::Object
virtual void _attemptDelete () const
 
void setAuxiliary (Auxiliary *auxiliary)
 

Additional Inherited Members

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

Container for DescriptorPools.


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