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

#include <Buffer.h>

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

Classes

struct  VulkanData
 

Public Member Functions

 Buffer (VkDeviceSize in_size, VkBufferUsageFlags in_usage, VkSharingMode in_sharingMode)
 
VkBuffer vk (uint32_t deviceID) const
 Vulkan VkImage handle.
 
uint32_t sizeVulkanData () const
 return the number of VulkanData entries.
 
VkResult bind (DeviceMemory *deviceMemory, VkDeviceSize memoryOffset)
 
MemorySlots::OptionalOffset reserve (VkDeviceSize in_size, VkDeviceSize alignment)
 
void release (VkDeviceSize offset, VkDeviceSize in_size)
 
bool full () const
 
size_t maximumAvailableSpace () const
 
size_t totalAvailableSize () const
 
size_t totalReservedSize () const
 
VkMemoryRequirements getMemoryRequirements (uint32_t deviceID) const
 
DeviceMemorygetDeviceMemory (uint32_t deviceID)
 
const DeviceMemorygetDeviceMemory (uint32_t deviceID) const
 
VkDeviceSize getMemoryOffset (uint32_t deviceID) const
 
virtual bool compile (Device *device)
 
virtual bool compile (Context &context)
 
- Public Member Functions inherited from vsg::Inherit< Object, Buffer >
 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

VkBufferCreateFlags flags = 0
 
VkDeviceSize size
 
VkBufferUsageFlags usage
 
VkSharingMode sharingMode
 

Protected Attributes

vk_buffer< VulkanData_vulkanData
 
std::mutex _mutex
 
MemorySlots _memorySlots
 

Additional Inherited Members

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

Buffer encapsulates VkBuffer and VkBufferCreateInfo settings used to set it up. Buffer maps blocks of DeviceMemory for use with BufferInfo typically associated with DescriptorBuffer/BufferView/Vertex/Index arrays.


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