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

#include <DescriptorBuffer.h>

Inheritance diagram for vsg::DescriptorBuffer:
Collaboration diagram for vsg::DescriptorBuffer:

Public Member Functions

 DescriptorBuffer (const DescriptorBuffer &rhs, const CopyOp &copyop={})
 DescriptorBuffer (ref_ptr< Data > data, uint32_t dstBinding=0, uint32_t dstArrayElement=0, VkDescriptorType descriptorType=VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER)
 DescriptorBuffer (const DataList &dataList, uint32_t dstBinding=0, uint32_t dstArrayElement=0, VkDescriptorType descriptorType=VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER)
 DescriptorBuffer (const BufferInfoList &in_bufferInfoList, uint32_t dstBinding=0, uint32_t dstArrayElement=0, VkDescriptorType descriptorType=VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER)
void compile (Context &context) override
void assignTo (Context &context, VkWriteDescriptorSet &wds) const override
uint32_t getNumDescriptors () const override
void copyDataListToBuffers ()
ref_ptr< Objectclone (const CopyOp &copyop={}) const override
int compare (const Object &rhs_object) const override
 compare two objects, return -1 if this object is less than rhs, return 0 if it's equal, return 1 if rhs is greater,
void read (Input &input) override
void write (Output &output) const override
Public Member Functions inherited from vsg::Inherit< Descriptor, DescriptorBuffer >
 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::Descriptor
 Descriptor (uint32_t in_dstBinding, uint32_t in_dstArrayElement, VkDescriptorType in_descriptorType)
 Descriptor (const Descriptor &rhs, const CopyOp &copyop={})
Public Member Functions inherited from vsg::Inherit< Object, Descriptor >
 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
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

BufferInfoList bufferInfoList
 VkWriteDescriptorSet.pBufferInfo settings.
Public Attributes inherited from vsg::Descriptor
uint32_t dstBinding
 Common VkWriteDescriptorSet settings.
uint32_t dstArrayElement
VkDescriptorType descriptorType

Additional Inherited Members

Static Public Member Functions inherited from vsg::Inherit< Descriptor, DescriptorBuffer >
static ref_ptr< DescriptorBuffercreate (Args &&... args)
static ref_ptr< DescriptorBuffercreate_if (bool flag, Args &&... args)
Static Public Member Functions inherited from vsg::Inherit< Object, Descriptor >
static ref_ptr< Descriptorcreate (Args &&... args)
static ref_ptr< Descriptorcreate_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

DescriptorBuffer is a Descriptor class that encapsulates the bufferInfoList used to set VkWriteDescriptorSet::pBufferInfo settings DescriptorBuffer is a means for passing uniform and storage buffers to shaders.

Member Function Documentation

◆ assignTo()

void vsg::DescriptorBuffer::assignTo ( Context & context,
VkWriteDescriptorSet & wds ) const
overridevirtual

Reimplemented from vsg::Descriptor.

◆ clone()

ref_ptr< Object > vsg::DescriptorBuffer::clone ( const CopyOp & copyop = {}) const
inlineoverridevirtual

clone this object using CopyOp's duplicates map to decide whether to clone or to return the original object. The default clone(CopyOp&) implementation simply returns ref_ptr<> to this object rather attempt to clone.

Reimplemented from vsg::Object.

◆ compare()

int vsg::DescriptorBuffer::compare ( const Object & rhs) const
overridevirtual

compare two objects, return -1 if this object is less than rhs, return 0 if it's equal, return 1 if rhs is greater,

Reimplemented from vsg::Descriptor.

◆ compile()

void vsg::DescriptorBuffer::compile ( Context & context)
overridevirtual

Reimplemented from vsg::Descriptor.

◆ getNumDescriptors()

uint32_t vsg::DescriptorBuffer::getNumDescriptors ( ) const
overridevirtual

Reimplemented from vsg::Descriptor.

◆ read()

void vsg::DescriptorBuffer::read ( Input & input)
overridevirtual

Reimplemented from vsg::Descriptor.

◆ write()

void vsg::DescriptorBuffer::write ( Output & output) const
overridevirtual

Reimplemented from vsg::Descriptor.


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