cs237::IndexBuffer< I > Class Template Reference

Buffer class for index data; the type parameter I is the index type. More...

#include <cs237-buffer.hpp>

Inheritance diagram for cs237::IndexBuffer< I >:

Collaboration diagram for cs237::IndexBuffer< I >:

Public Types
using	IndexType = I
	the type of indices

Public Member Functions
	IndexBuffer (Application *app, uint32_t nIndices)
	IndexBuffer (Application *app, vk::ArrayProxy< I > const &src)
uint32_t	nIndices () const
	get the number of indices in the buffer
void	copyTo (vk::ArrayProxy< I > const &src)
void	copyTo (vk::ArrayProxy< I > const &src, uint32_t offset)
Public Member Functions inherited from cs237::Buffer
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

Additional Inherited Members
Protected Member Functions inherited from cs237::Buffer
	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 inherited from cs237::Buffer
Application *	_app
	the application
vk::Buffer	_buf
	the Vulkan buffer object
MemoryObj *	_mem
	the Vulkan memory object that holds the buffer

Detailed Description

template<typename I>
class cs237::IndexBuffer< I >

Buffer class for index data; the type parameter I is the index type.

Member Typedef Documentation

IndexType

template<typename I >

using cs237::IndexBuffer< I >::IndexType = I

the type of indices

Constructor & Destructor Documentation

IndexBuffer() [1/2]

template<typename I >

cs237::IndexBuffer< I >::IndexBuffer ( Application *  app, uint32_t  nIndices  )

inline

constructor

Parameters

app	the owning application object
nIndices	the number of indices in the buffer

IndexBuffer() [2/2]

template<typename I >

cs237::IndexBuffer< I >::IndexBuffer ( Application *  app, vk::ArrayProxy< I > const &  src  )

inline

constructor with initialization

Parameters

app	the owning application object
src	the array of indices used to initialize the buffer

Member Function Documentation

copyTo() [1/2]

template<typename I >

void cs237::IndexBuffer< I >::copyTo ( vk::ArrayProxy< I > const &  src )

inline

copy indices to the device memory object

Parameters

src	the array of indices that are copied to the buffer

copyTo() [2/2]

template<typename I >

void cs237::IndexBuffer< I >::copyTo ( vk::ArrayProxy< I > const &  src, uint32_t  offset  )

inline

copy vertices to the device memory object

Parameters

src	the array of indices that are copied to the buffer
offset	offset from the beginning of the buffer to copy the data to

nIndices()

template<typename I >

uint32_t cs237::IndexBuffer< I >::nIndices ( ) const

inline

get the number of indices in 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