Renderer::Backend::Vulkan::CBuffer Class Reference

#include <Buffer.h>

Inheritance diagram for Renderer::Backend::Vulkan::CBuffer:

Collaboration diagram for Renderer::Backend::Vulkan::CBuffer:

Public Member Functions
	~CBuffer () override
IDevice *	GetDevice () override
Type	GetType () const override
uint32_t	GetSize () const override
uint32_t	GetUsage () const override
VkBuffer	GetVkBuffer ()
void *	GetMappedData ()
Public Member Functions inherited from Renderer::Backend::IBuffer
virtual Type	GetType () const =0
virtual uint32_t	GetSize () const =0
virtual uint32_t	GetUsage () const =0
bool	IsDynamic () const
Public Member Functions inherited from Renderer::Backend::IDeviceObject< IBuffer >
virtual	~IDeviceObject ()
virtual IDevice *	GetDevice ()=0
T *	As ()

Private Member Functions
	CBuffer ()

Static Private Member Functions
static std::unique_ptr< CBuffer >	Create (CDevice *device, const char *name, const Type type, const uint32_t size, const uint32_t usage)

Private Attributes
CDevice *	m_Device = nullptr
Type	m_Type = Type::VERTEX
uint32_t	m_Size = 0
uint32_t	m_Usage = 0
VkBuffer	m_Buffer = VK_NULL_HANDLE
VmaAllocation	m_Allocation = VK_NULL_HANDLE
VmaAllocationInfo	m_AllocationInfo {}

Friends
class	CDevice

Additional Inherited Members
Public Types inherited from Renderer::Backend::IBuffer
enum class	Type { VERTEX , INDEX , UPLOAD , UNIFORM }

Constructor & Destructor Documentation

~CBuffer()

Renderer::Backend::Vulkan::CBuffer::~CBuffer ( )

override

CBuffer()

Renderer::Backend::Vulkan::CBuffer::CBuffer ( )

privatedefault

Member Function Documentation

Create()

std::unique_ptr< CBuffer > Renderer::Backend::Vulkan::CBuffer::Create ( CDevice *  device, const char *  name, const Type  type, const uint32_t  size, const uint32_t  usage  )

staticprivate

GetDevice()

IDevice * Renderer::Backend::Vulkan::CBuffer::GetDevice ( )

overridevirtual

Implements Renderer::Backend::IDeviceObject< IBuffer >.

GetMappedData()

void * Renderer::Backend::Vulkan::CBuffer::GetMappedData ( )

inline

Returns

mapped data for UPLOAD buffers else returns nullptr.

GetSize()

uint32_t Renderer::Backend::Vulkan::CBuffer::GetSize ( ) const

inlineoverridevirtual

Implements Renderer::Backend::IBuffer.

GetType()

Type Renderer::Backend::Vulkan::CBuffer::GetType ( ) const

inlineoverridevirtual

Implements Renderer::Backend::IBuffer.

GetUsage()

uint32_t Renderer::Backend::Vulkan::CBuffer::GetUsage ( ) const

inlineoverridevirtual

Implements Renderer::Backend::IBuffer.

GetVkBuffer()

VkBuffer Renderer::Backend::Vulkan::CBuffer::GetVkBuffer ( )

inline

Friends And Related Function Documentation

CDevice

friend class CDevice

friend

Member Data Documentation

m_Allocation

VmaAllocation Renderer::Backend::Vulkan::CBuffer::m_Allocation = VK_NULL_HANDLE

private

m_AllocationInfo

VmaAllocationInfo Renderer::Backend::Vulkan::CBuffer::m_AllocationInfo {}

private

m_Buffer

VkBuffer Renderer::Backend::Vulkan::CBuffer::m_Buffer = VK_NULL_HANDLE

private

m_Device

CDevice* Renderer::Backend::Vulkan::CBuffer::m_Device = nullptr

private

m_Size

uint32_t Renderer::Backend::Vulkan::CBuffer::m_Size = 0

private

m_Type

Type Renderer::Backend::Vulkan::CBuffer::m_Type = Type::VERTEX

private

m_Usage

uint32_t Renderer::Backend::Vulkan::CBuffer::m_Usage = 0

private

---

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

• /home/docker/jenkins/workspace/technical-docs/source/renderer/backend/vulkan/Buffer.h
• /home/docker/jenkins/workspace/technical-docs/source/renderer/backend/vulkan/Buffer.cpp