rendering_engine::VulkanMeshResources Class Reference

Vulkan implementation of the mesh GPU resource interface. More...

#include <vulkan_mesh_resources.hpp>

Inherits rendering_engine::IMeshRenderResources.

Public Member Functions
	VulkanMeshResources (VulkanRenderer *renderer)
	Construct Vulkan mesh resources. More...
void	CreateVertexBuffer (std::vector< Vertex2D > vertices) override
	Create a GPU vertex buffer from 2D vertex data. More...
void	CreateVertexBuffer (std::vector< VertexPositionColorTexture > vertices) override
	Create a GPU vertex buffer from 3D unlit vertex data. More...
void	CreateVertexBuffer (std::vector< VertexPositionColorTextureNormalTangent > vertices) override
	Create a GPU vertex buffer from 3D lit vertex data. More...
void	CreateIndexBuffer (std::vector< uint32_t > indices) override
	Create a GPU index buffer. More...
bool	IsOnGPU () const override
	Query whether buffers are currently resident on the GPU. More...
void	Shutdown () override
	Release all GPU resources associated with this mesh. More...
VkBuffer	GetVertexBuffer () const
	Get the Vulkan vertex buffer handle. More...
VkBuffer	GetIndexBuffer () const
	Get the Vulkan index buffer handle. More...
size_t	GetVertexBufferSize () const override
	Get the size (in bytes) of the GPU vertex buffer. More...
size_t	GetIndexBufferSize () const override
	Get the size (in bytes) of the GPU index buffer. More...
Public Member Functions inherited from rendering_engine::IMeshRenderResources
virtual	~IMeshRenderResources ()=default
	Virtual destructor. More...
virtual void	CreateVertexBuffer (std::vector< Vertex2D > vertices)=0
	Create a GPU vertex buffer from 2D vertex data. More...
virtual void	CreateVertexBuffer (std::vector< VertexPositionColorTexture > vertices)=0
	Create a GPU vertex buffer from 3D unlit vertex data. More...
virtual void	CreateVertexBuffer (std::vector< VertexPositionColorTextureNormalTangent > vertices)=0
	Create a GPU vertex buffer from 3D lit vertex data. More...
virtual void	CreateIndexBuffer (std::vector< uint32_t > indices)=0
	Create a GPU index buffer. More...
virtual bool	IsOnGPU () const =0
	Check if the buffers are currently resident on the GPU. More...
virtual void	Shutdown ()=0
	Release all GPU resources associated with this mesh. More...
virtual size_t	GetVertexBufferSize () const =0
	Get the size (in bytes) of the GPU vertex buffer. More...
virtual size_t	GetIndexBufferSize () const =0
	Get the size (in bytes) of the GPU index buffer. More...

Detailed Description

Vulkan implementation of the mesh GPU resource interface.

Manages Vulkan buffers and device memory for mesh vertex and index data. Supports multiple vertex types and provides direct access to underlying VkBuffer handles.

Definition at line 22 of file vulkan_mesh_resources.hpp.

Constructor & Destructor Documentation

VulkanMeshResources()

rendering_engine::VulkanMeshResources::VulkanMeshResources

(

VulkanRenderer *

renderer

)

Construct Vulkan mesh resources.

Parameters

renderer

Pointer to the owning VulkanRenderer.

Definition at line 9 of file vulkan_mesh_resources.cpp.

    :
    mRenderer(renderer),
    bIsOnGPU(false),
    mVertexBufferSize(0),
    mIndexBufferSize(0)
{
}

Member Function Documentation

CreateIndexBuffer()

void rendering_engine::VulkanMeshResources::CreateIndexBuffer ( std::vector< uint32_t >  indices )

overridevirtual

Create a GPU index buffer.

Parameters

indices

Vector of indices.

Implements rendering_engine::IMeshRenderResources.

Definition at line 96 of file vulkan_mesh_resources.cpp.

{
    auto logicalDevice = mRenderer->GetLogicalDevice();
 
    VkDeviceSize bufferSize = sizeof(indices[0]) * indices.size();
    mIndexBufferSize = static_cast<size_t>(bufferSize);
 
    VkBuffer stagingBuffer;
    VkDeviceMemory stagingBufferMemory;
    mRenderer->CreateBuffer(bufferSize, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, VK_MEMORY_PROPERTY_HOST_VISIBLE_BIT | VK_MEMORY_PROPERTY_HOST_COHERENT_BIT, stagingBuffer, stagingBufferMemory);
 
    void* data;
    vkMapMemory(logicalDevice, stagingBufferMemory, 0, bufferSize, 0, &data);
    memcpy(data, indices.data(), mIndexBufferSize);
    vkUnmapMemory(logicalDevice, stagingBufferMemory);
 
    mRenderer->CreateBuffer(bufferSize, VK_BUFFER_USAGE_TRANSFER_DST_BIT | VK_BUFFER_USAGE_INDEX_BUFFER_BIT, VK_MEMORY_PROPERTY_DEVICE_LOCAL_BIT, mIndexBuffer, mIndexBufferMemory);
 
    mRenderer->CopyBuffer(stagingBuffer, mIndexBuffer, bufferSize);
 
    vkDestroyBuffer(logicalDevice, stagingBuffer, nullptr);
    vkFreeMemory(logicalDevice, stagingBufferMemory, nullptr);
}

CreateVertexBuffer() [1/3]

void rendering_engine::VulkanMeshResources::CreateVertexBuffer ( std::vector< Vertex2D >  vertices )

overridevirtual

Create a GPU vertex buffer from 2D vertex data.

Parameters

vertices

Vector of 2D vertex data.

Implements rendering_engine::IMeshRenderResources.

Definition at line 18 of file vulkan_mesh_resources.cpp.

{
    auto logicalDevice = mRenderer->GetLogicalDevice();
 
    VkDeviceSize bufferSize = sizeof(vertices[0]) * vertices.size();
    mVertexBufferSize = static_cast<size_t>(bufferSize);
    VkBuffer stagingBuffer;
    VkDeviceMemory stagingBufferMemory;
    mRenderer->CreateBuffer(bufferSize, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, VK_MEMORY_PROPERTY_HOST_VISIBLE_BIT | VK_MEMORY_PROPERTY_HOST_COHERENT_BIT,
        stagingBuffer, stagingBufferMemory);
 
    void* data;
    vkMapMemory(logicalDevice, stagingBufferMemory, 0, bufferSize, 0, &data);
 
    memcpy(data, vertices.data(), mVertexBufferSize);
    vkUnmapMemory(logicalDevice, stagingBufferMemory);
    mRenderer->CreateBuffer(bufferSize, VK_BUFFER_USAGE_TRANSFER_DST_BIT | VK_BUFFER_USAGE_VERTEX_BUFFER_BIT, VK_MEMORY_PROPERTY_DEVICE_LOCAL_BIT,
        mVertexBuffer, mVertexBufferMemory);
 
    mRenderer->CopyBuffer(stagingBuffer, mVertexBuffer, bufferSize);
 
    bIsOnGPU = true;
    vkDestroyBuffer(logicalDevice, stagingBuffer, nullptr);
    vkFreeMemory(logicalDevice, stagingBufferMemory, nullptr);
}

CreateVertexBuffer() [2/3]

void rendering_engine::VulkanMeshResources::CreateVertexBuffer ( std::vector< VertexPositionColorTexture >  vertices )

overridevirtual

Create a GPU vertex buffer from 3D unlit vertex data.

Parameters

vertices

Vector of VertexPositionColorTexture data.

Implements rendering_engine::IMeshRenderResources.

Definition at line 44 of file vulkan_mesh_resources.cpp.

{
    auto logicalDevice = mRenderer->GetLogicalDevice();
 
    VkDeviceSize bufferSize = sizeof(vertices[0]) * vertices.size();
    mVertexBufferSize = static_cast<size_t>(bufferSize);
    VkBuffer stagingBuffer;
    VkDeviceMemory stagingBufferMemory;
    mRenderer->CreateBuffer(bufferSize, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, VK_MEMORY_PROPERTY_HOST_VISIBLE_BIT | VK_MEMORY_PROPERTY_HOST_COHERENT_BIT,
        stagingBuffer, stagingBufferMemory);
 
    void* data;
    vkMapMemory(logicalDevice, stagingBufferMemory, 0, bufferSize, 0, &data);
 
    memcpy(data, vertices.data(), mVertexBufferSize);
    vkUnmapMemory(logicalDevice, stagingBufferMemory);
    mRenderer->CreateBuffer(bufferSize, VK_BUFFER_USAGE_TRANSFER_DST_BIT | VK_BUFFER_USAGE_VERTEX_BUFFER_BIT, VK_MEMORY_PROPERTY_DEVICE_LOCAL_BIT,
        mVertexBuffer, mVertexBufferMemory);
 
    mRenderer->CopyBuffer(stagingBuffer, mVertexBuffer, bufferSize);
 
    bIsOnGPU = true;
    vkDestroyBuffer(logicalDevice, stagingBuffer, nullptr);
    vkFreeMemory(logicalDevice, stagingBufferMemory, nullptr);
}

CreateVertexBuffer() [3/3]

void rendering_engine::VulkanMeshResources::CreateVertexBuffer ( std::vector< VertexPositionColorTextureNormalTangent >  vertices )

overridevirtual

Create a GPU vertex buffer from 3D lit vertex data.

Parameters

vertices

Vector of VertexPositionColorTextureNormalTangent data.

Implements rendering_engine::IMeshRenderResources.

Definition at line 70 of file vulkan_mesh_resources.cpp.

{
    auto logicalDevice = mRenderer->GetLogicalDevice();
 
    VkDeviceSize bufferSize = sizeof(vertices[0]) * vertices.size();
    mVertexBufferSize = static_cast<size_t>(bufferSize);
    VkBuffer stagingBuffer;
    VkDeviceMemory stagingBufferMemory;
    mRenderer->CreateBuffer(bufferSize, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, VK_MEMORY_PROPERTY_HOST_VISIBLE_BIT | VK_MEMORY_PROPERTY_HOST_COHERENT_BIT,
        stagingBuffer, stagingBufferMemory);
 
    void* data;
    vkMapMemory(logicalDevice, stagingBufferMemory, 0, bufferSize, 0, &data);
    
    memcpy(data, vertices.data(), mVertexBufferSize);
    vkUnmapMemory(logicalDevice, stagingBufferMemory);
    mRenderer->CreateBuffer(bufferSize, VK_BUFFER_USAGE_TRANSFER_DST_BIT | VK_BUFFER_USAGE_VERTEX_BUFFER_BIT, VK_MEMORY_PROPERTY_DEVICE_LOCAL_BIT,
        mVertexBuffer, mVertexBufferMemory);
 
    mRenderer->CopyBuffer(stagingBuffer, mVertexBuffer, bufferSize);
 
    bIsOnGPU = true;
    vkDestroyBuffer(logicalDevice, stagingBuffer, nullptr);
    vkFreeMemory(logicalDevice, stagingBufferMemory, nullptr);
}

GetIndexBuffer()

VkBuffer rendering_engine::VulkanMeshResources::GetIndexBuffer

(

)

const

Get the Vulkan index buffer handle.

Returns

VkBuffer handle for the index buffer.

Definition at line 159 of file vulkan_mesh_resources.cpp.

{
    return mIndexBuffer;
}

GetIndexBufferSize()

size_t rendering_engine::VulkanMeshResources::GetIndexBufferSize ( ) const

inlineoverridevirtual

Get the size (in bytes) of the GPU index buffer.

Returns

Size in bytes of the index buffer.

Implements rendering_engine::IMeshRenderResources.

Definition at line 169 of file vulkan_mesh_resources.cpp.

{
    return mIndexBufferSize;
}

GetVertexBuffer()

VkBuffer rendering_engine::VulkanMeshResources::GetVertexBuffer

(

)

const

Get the Vulkan vertex buffer handle.

Returns

VkBuffer handle for the vertex buffer.

Definition at line 154 of file vulkan_mesh_resources.cpp.

{
    return mVertexBuffer;
}

GetVertexBufferSize()

size_t rendering_engine::VulkanMeshResources::GetVertexBufferSize ( ) const

inlineoverridevirtual

Get the size (in bytes) of the GPU vertex buffer.

Returns

Size in bytes of the vertex buffer.

Implements rendering_engine::IMeshRenderResources.

Definition at line 164 of file vulkan_mesh_resources.cpp.

{
    return mVertexBufferSize;
}

IsOnGPU()

bool rendering_engine::VulkanMeshResources::IsOnGPU ( ) const

inlineoverridevirtual

Query whether buffers are currently resident on the GPU.

Returns

True if buffers are allocated and uploaded, false otherwise.

Implements rendering_engine::IMeshRenderResources.

Definition at line 120 of file vulkan_mesh_resources.cpp.

{
    return bIsOnGPU;
}

Shutdown()

void rendering_engine::VulkanMeshResources::Shutdown ( )

overridevirtual

Release all GPU resources associated with this mesh.

Implements rendering_engine::IMeshRenderResources.

Definition at line 125 of file vulkan_mesh_resources.cpp.

{
    DeferredItem indexBuffer;
    indexBuffer.type = DeferredType::Buffer;
    indexBuffer.buffer = mIndexBuffer;
    mRenderer->AddDeferredDestroy(indexBuffer);
    mIndexBuffer = VK_NULL_HANDLE;
 
    DeferredItem indexBufferMemory;
    indexBufferMemory.type = DeferredType::Memory;
    indexBufferMemory.memory = mIndexBufferMemory;
    mRenderer->AddDeferredDestroy(indexBufferMemory);
    mIndexBufferMemory = VK_NULL_HANDLE;
 
    DeferredItem vertexBuffer;
    vertexBuffer.type = DeferredType::Buffer;
    vertexBuffer.buffer = mVertexBuffer;
    mRenderer->AddDeferredDestroy(vertexBuffer);
    mVertexBuffer = VK_NULL_HANDLE;
 
    DeferredItem vertexBufferMemory;
    vertexBufferMemory.type = DeferredType::Memory;
    vertexBufferMemory.memory = mVertexBufferMemory;
    mRenderer->AddDeferredDestroy(vertexBufferMemory);
    mVertexBufferMemory = VK_NULL_HANDLE;
 
    bIsOnGPU = false;
}

---

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

• vulkan_mesh_resources.hpp
• vulkan_mesh_resources.cpp