cs237::Buffer Class Reference

A base class for buffer objects of all kinds. More...

#include <cs237-buffer.hpp>

Inheritance diagram for cs237::Buffer:

Collaboration diagram for cs237::Buffer:

Public Member Functions
vk::Buffer	vkBuffer () const
	get the Vulkan buffer object for this buffer
const MemoryObj *	memory () const
	get the memory object for this buffer
vk::MemoryRequirements	requirements ()
	get the memory requirements of this buffer

Protected Member Functions
	Buffer (Application *app, vk::BufferUsageFlags usage, size_t sz)
	~Buffer ()
	destructor
void	_copyTo (const void *src, size_t offset, size_t sz)
void	_copyTo (const void *src)

Protected Attributes
Application *	_app
	the application
vk::Buffer	_buf
	the Vulkan buffer object
MemoryObj *	_mem
	the Vulkan memory object that holds the buffer

Detailed Description

A base class for buffer objects of all kinds.

Constructor & Destructor Documentation

Buffer()

cs237::Buffer::Buffer ( Application *  app, vk::BufferUsageFlags  usage, size_t  sz  )

inlineprotected

constructor

Parameters

app	the owning application object
usage	specify the purpose of the buffer object
sz	the buffer's size in bytes

~Buffer()

cs237::Buffer::~Buffer ( )

inlineprotected

destructor

Member Function Documentation

_copyTo() [1/2]

void cs237::Buffer::_copyTo ( const void *  src )

inlineprotected

copy data to the device memory object

Parameters

src	address of data to copy

_copyTo() [2/2]

void cs237::Buffer::_copyTo ( const void *  src, size_t  offset, size_t  sz  )

inlineprotected

copy data to a subrange of the device memory object

Parameters

src	address of data to copy
offset	offset (in bytes) from the beginning of the buffer to copy the data to
sz	size in bytes of the data to copy

memory()

const MemoryObj * cs237::Buffer::memory ( ) const

inline

get the memory object for this buffer

requirements()

vk::MemoryRequirements cs237::Buffer::requirements ( )

inline

get the memory requirements of this buffer

vkBuffer()

vk::Buffer cs237::Buffer::vkBuffer ( ) const

inline

get the Vulkan buffer object for this buffer

Member Data Documentation

_app

Application* cs237::Buffer::_app

protected

the application

_buf

vk::Buffer cs237::Buffer::_buf

protected

the Vulkan buffer object

_mem

MemoryObj* cs237::Buffer::_mem

protected

the Vulkan memory object that holds the buffer

---

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

• /Users/jhr/Classes/23700/f2023/solutions/cs237-library/include/cs237-buffer.hpp