Vulkan-specific implementation of ITextureRenderResources. More...

#include <vulkan_texture_resources.hpp>

Inherits rendering_engine::ITextureRenderResources.

Public Member Functions
	VulkanTextureResources (VulkanRenderer *renderer)
	Vulkan-specific implementation of ITextureRenderResources. More...

void	LoadToGPU (const ImageData &data) override
	Uploads the texture data from CPU to GPU memory using Vulkan. More...

void	ReleaseFromGPU () override
	Releases the texture data from GPU memory using Vulkan. More...

bool	IsTextureLoadedInGPU () override
	Checks if the texture is currently loaded in GPU memory. More...

size_t	GetSizeInGPUBytes () const override
	Returns the size of the texture in GPU memory in bytes. More...

VkImageView	GetVkImageView () const
	Returns the Vulkan image view associated with this texture resource. More...

VkSampler	GetVkSampler () const
	Returns the Vulkan sampler associated with this texture resource. More...

Public Member Functions inherited from rendering_engine::ITextureRenderResources
virtual	~ITextureRenderResources ()=default
	Virtual destructor. More...

virtual void	LoadToGPU (const ImageData &data)=0
	Uploads texture data from CPU to GPU memory. More...

virtual void	ReleaseFromGPU ()=0
	Releases texture memory from the GPU. More...

virtual bool	IsTextureLoadedInGPU ()=0
	Checks whether the texture is currently loaded in GPU memory. More...

virtual size_t	GetSizeInGPUBytes () const =0
	Returns the memory footprint of the texture on the GPU. More...

Protected Member Functions
void	CreateTextureImage ()

void	CreateVulkanImage (uint32_t width, uint32_t height, std::uint32_t mipmapLevels, VkSampleCountFlagBits numSamples, VkFormat format, VkImageTiling tiling, VkImageUsageFlags usage, VkMemoryPropertyFlags properties, VkImage &image, VkDeviceMemory &imageMemory)

void	CreateTextureImageView ()

VkImageView	CreateImageView (VkImage image, VkFormat format, VkImageAspectFlags aspectFlags, std::uint32_t mipmapLevels)

void	CreateTextureSampler ()

Protected Attributes
bool	bIsTextureLoadedInGPU

VulkanRenderer *	mRenderer

const ImageData *	mImageData

std::uint32_t	mMipmapLevels

VkImage	mTextureImage

VkDeviceMemory	mTextureImageMemory

VkImageView	mTextureImageView

VkSampler	mTextureSampler

VkDeviceSize	mGpuMemorySize

Detailed Description

Vulkan-specific implementation of ITextureRenderResources.

This class manages texture memory and resources on the GPU using Vulkan.

Definition at line 41 of file vulkan_texture_resources.hpp.

Constructor & Destructor Documentation

◆ VulkanTextureResources()

rendering_engine::VulkanTextureResources::VulkanTextureResources ( VulkanRenderer * renderer )

Vulkan-specific implementation of ITextureRenderResources.

Definition at line 7 of file vulkan_texture_resources.cpp.

    :
    bIsTextureLoadedInGPU(false),
    mRenderer(renderer),
    mImageData(nullptr),
    mGpuMemorySize(0)
{}

Member Function Documentation

◆ CreateImageView()

VkImageView rendering_engine::VulkanTextureResources::CreateImageView	(	VkImage	image,
		VkFormat	format,
		VkImageAspectFlags	aspectFlags,
		std::uint32_t	mipmapLevels
	)

protected

Definition at line 144 of file vulkan_texture_resources.cpp.

{
    VkImageViewCreateInfo viewInfo{};
    viewInfo.sType = VK_STRUCTURE_TYPE_IMAGE_VIEW_CREATE_INFO;
    viewInfo.image = image;
    viewInfo.viewType = VK_IMAGE_VIEW_TYPE_2D;
    viewInfo.format = format;
    viewInfo.subresourceRange.aspectMask = aspectFlags;
    viewInfo.subresourceRange.baseMipLevel = 0;
    viewInfo.subresourceRange.levelCount = mipmapLevels;
    viewInfo.subresourceRange.baseArrayLayer = 0;
    viewInfo.subresourceRange.layerCount = 1;
 
    VkImageView imageView;
    if (vkCreateImageView(mRenderer->GetLogicalDevice(), &viewInfo, nullptr, &imageView) != VK_SUCCESS)
    {
        throw std::runtime_error("failed to create texture image view!");
    }
 
    return imageView;
}

◆ CreateTextureImage()

void rendering_engine::VulkanTextureResources::CreateTextureImage ( )

protected

Definition at line 47 of file vulkan_texture_resources.cpp.

{
    if (!mImageData)
    {
        throw std::runtime_error("ImageData is not initialized!");
    }
 
    unsigned int const width = mImageData->GetWidth();
    unsigned int const height = mImageData->GetHeight();
 
    mMipmapLevels = static_cast<uint32_t>(std::floor(std::log2(std::max(width, height)))) + 1;
    auto const pixelVector = mImageData->GetImageDataRGBA();
 
    VkDeviceSize imageSize = width * height * 4;
 
    if (pixelVector.size() == 0)
    {
        throw std::runtime_error("failed to load texture image!");
    }
 
    VkBuffer stagingBuffer;
    VkDeviceMemory stagingBufferMemory;
 
    mRenderer->CreateBuffer(imageSize, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, VK_MEMORY_PROPERTY_HOST_VISIBLE_BIT | VK_MEMORY_PROPERTY_HOST_COHERENT_BIT, stagingBuffer, stagingBufferMemory);
 
    unsigned char* pixels = new unsigned char[width * height * 4];
    std::copy(pixelVector.begin(), pixelVector.end(), pixels);
    void* data;
    vkMapMemory(mRenderer->GetLogicalDevice(), stagingBufferMemory, 0, imageSize, 0, &data);
    memcpy(data, pixels, static_cast<size_t>(imageSize));
    vkUnmapMemory(mRenderer->GetLogicalDevice(), stagingBufferMemory);
    delete[] pixels;
 
    CreateVulkanImage(width, height, mMipmapLevels, VK_SAMPLE_COUNT_1_BIT, VK_FORMAT_R8G8B8A8_SRGB, VK_IMAGE_TILING_OPTIMAL, VK_IMAGE_USAGE_TRANSFER_SRC_BIT | VK_IMAGE_USAGE_TRANSFER_DST_BIT | VK_IMAGE_USAGE_SAMPLED_BIT,
        VK_MEMORY_PROPERTY_DEVICE_LOCAL_BIT, mTextureImage, mTextureImageMemory);
 
    mRenderer->TransitionImageLayout(mTextureImage, VK_FORMAT_R8G8B8A8_SRGB, VK_IMAGE_LAYOUT_UNDEFINED, VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, mMipmapLevels);
    mRenderer->CopyBufferToImage(stagingBuffer, mTextureImage, static_cast<uint32_t>(width), static_cast<uint32_t>(height));
 
    vkDestroyBuffer(mRenderer->GetLogicalDevice(), stagingBuffer, nullptr);
    vkFreeMemory(mRenderer->GetLogicalDevice(), stagingBufferMemory, nullptr);
 
    mRenderer->GenerateMipmaps(mTextureImage, VK_FORMAT_R8G8B8A8_SRGB, width, height, mMipmapLevels);
}

◆ CreateTextureImageView()

void rendering_engine::VulkanTextureResources::CreateTextureImageView ( )

protected

Definition at line 139 of file vulkan_texture_resources.cpp.

{
    mTextureImageView = CreateImageView(mTextureImage, VK_FORMAT_R8G8B8A8_SRGB, VK_IMAGE_ASPECT_COLOR_BIT, mMipmapLevels);
}

◆ CreateTextureSampler()

void rendering_engine::VulkanTextureResources::CreateTextureSampler ( )

protected

Definition at line 166 of file vulkan_texture_resources.cpp.

{
    VkSamplerCreateInfo samplerInfo{};
 
    VkPhysicalDeviceProperties properties{};
    vkGetPhysicalDeviceProperties(mRenderer->GetPhysicalDevice(), &properties);
 
    samplerInfo.sType = VK_STRUCTURE_TYPE_SAMPLER_CREATE_INFO;
    samplerInfo.magFilter = VK_FILTER_LINEAR;
    samplerInfo.minFilter = VK_FILTER_LINEAR;
 
    samplerInfo.addressModeU = VK_SAMPLER_ADDRESS_MODE_REPEAT;
    samplerInfo.addressModeV = VK_SAMPLER_ADDRESS_MODE_REPEAT;
    samplerInfo.addressModeW = VK_SAMPLER_ADDRESS_MODE_REPEAT;
 
    if (mRenderer->GetPhysDevSupportedFeatures().samplerAnisotropy)
    {
        samplerInfo.anisotropyEnable = VK_TRUE;
        samplerInfo.maxAnisotropy = properties.limits.maxSamplerAnisotropy;
    }
    else
    {
        samplerInfo.anisotropyEnable = VK_FALSE;
        samplerInfo.maxAnisotropy = 1.0f;
    }
 
    samplerInfo.borderColor = VK_BORDER_COLOR_INT_OPAQUE_BLACK;
    samplerInfo.unnormalizedCoordinates = VK_FALSE;
 
    samplerInfo.compareEnable = VK_FALSE;
    samplerInfo.compareOp = VK_COMPARE_OP_ALWAYS;
 
    samplerInfo.mipmapMode = VK_SAMPLER_MIPMAP_MODE_LINEAR;
    samplerInfo.mipLodBias = 0.0f;
    samplerInfo.minLod = 0.0f;
    samplerInfo.maxLod = static_cast<float>(mMipmapLevels - 1);
 
    if (vkCreateSampler(mRenderer->GetLogicalDevice(), &samplerInfo, nullptr, &mTextureSampler) != VK_SUCCESS)
    {
        throw std::runtime_error("failed to create texture sampler!");
    }
}

◆ CreateVulkanImage()

void rendering_engine::VulkanTextureResources::CreateVulkanImage	(	uint32_t	width,
		uint32_t	height,
		std::uint32_t	mipmapLevels,
		VkSampleCountFlagBits	numSamples,
		VkFormat	format,
		VkImageTiling	tiling,
		VkImageUsageFlags	usage,
		VkMemoryPropertyFlags	properties,
		VkImage &	image,
		VkDeviceMemory &	imageMemory
	)

protected

Definition at line 92 of file vulkan_texture_resources.cpp.

{
    VkImageCreateInfo imageInfo{};
    imageInfo.sType = VK_STRUCTURE_TYPE_IMAGE_CREATE_INFO;
    imageInfo.imageType = VK_IMAGE_TYPE_2D;
    imageInfo.extent.width = static_cast<uint32_t>(width);
    imageInfo.extent.height = static_cast<uint32_t>(height);
    imageInfo.extent.depth = 1;
    imageInfo.mipLevels = mipmapLevels;
    imageInfo.arrayLayers = 1;
 
    imageInfo.format = format;
    imageInfo.tiling = tiling;
 
    imageInfo.initialLayout = VK_IMAGE_LAYOUT_UNDEFINED;
 
    imageInfo.usage = usage;
 
    imageInfo.sharingMode = VK_SHARING_MODE_EXCLUSIVE;
 
    imageInfo.samples = numSamples;
    imageInfo.flags = 0; // Optional
 
    if (vkCreateImage(mRenderer->GetLogicalDevice(), &imageInfo, nullptr, &image) != VK_SUCCESS)
    {
        throw std::runtime_error("failed to create image!");
    }
 
    VkMemoryRequirements memRequirements;
    vkGetImageMemoryRequirements(mRenderer->GetLogicalDevice(), image, &memRequirements);
 
    VkMemoryAllocateInfo allocInfo{};
    allocInfo.allocationSize = memRequirements.size;
    allocInfo.sType = VK_STRUCTURE_TYPE_MEMORY_ALLOCATE_INFO;
    allocInfo.allocationSize = memRequirements.size;
    allocInfo.memoryTypeIndex = mRenderer->FindMemoryType(memRequirements.memoryTypeBits, properties);
 
    if (vkAllocateMemory(mRenderer->GetLogicalDevice(), &allocInfo, nullptr, &imageMemory) != VK_SUCCESS) {
        throw std::runtime_error("failed to allocate image memory!");
    }
 
    mGpuMemorySize = allocInfo.allocationSize;
 
    vkBindImageMemory(mRenderer->GetLogicalDevice(), image, imageMemory, 0);
    allocInfo.allocationSize;
}

◆ GetSizeInGPUBytes()

size_t rendering_engine::VulkanTextureResources::GetSizeInGPUBytes ( ) const

overridevirtual

Returns the size of the texture in GPU memory in bytes.

Returns: Size in bytes.

Implements rendering_engine::ITextureRenderResources.

Definition at line 41 of file vulkan_texture_resources.cpp.

{
    return static_cast<size_t>(mGpuMemorySize);
}

◆ GetVkImageView()

VkImageView rendering_engine::VulkanTextureResources::GetVkImageView ( ) const

inline

Returns the Vulkan image view associated with this texture resource.

This image view is typically used for binding the texture to shaders via descriptor sets.

Returns: The VkImageView handle for this texture resource.

Definition at line 88 of file vulkan_texture_resources.hpp.

88{ return mTextureImageView; }

◆ GetVkSampler()

VkSampler rendering_engine::VulkanTextureResources::GetVkSampler ( ) const

inline

Returns the Vulkan sampler associated with this texture resource.

This sampler is used to define how the texture is sampled in shaders (e.g., filtering, addressing modes).

Returns: The VkSampler handle for this texture resource.

Definition at line 97 of file vulkan_texture_resources.hpp.

97{ return mTextureSampler; }

◆ IsTextureLoadedInGPU()

bool rendering_engine::VulkanTextureResources::IsTextureLoadedInGPU ( )

overridevirtual

Checks if the texture is currently loaded in GPU memory.

Returns: True if the texture is in GPU memory, false otherwise.

Implements rendering_engine::ITextureRenderResources.

Definition at line 36 of file vulkan_texture_resources.cpp.

{
    return bIsTextureLoadedInGPU;
}

◆ LoadToGPU()

void rendering_engine::VulkanTextureResources::LoadToGPU ( const ImageData & data )

overridevirtual

Uploads the texture data from CPU to GPU memory using Vulkan.

Parameters

data	The image data to upload.

Implements rendering_engine::ITextureRenderResources.

Definition at line 15 of file vulkan_texture_resources.cpp.

{
    mImageData = &data;
 
    CreateTextureImage();
    CreateTextureImageView();
    CreateTextureSampler();
 
    bIsTextureLoadedInGPU = true;
}

◆ ReleaseFromGPU()

void rendering_engine::VulkanTextureResources::ReleaseFromGPU ( )

overridevirtual

Releases the texture data from GPU memory using Vulkan.

Implements rendering_engine::ITextureRenderResources.

Definition at line 26 of file vulkan_texture_resources.cpp.

{
    vkDestroySampler(mRenderer->GetLogicalDevice(), mTextureSampler, nullptr);
    vkDestroyImageView(mRenderer->GetLogicalDevice(), mTextureImageView, nullptr);
    vkDestroyImage(mRenderer->GetLogicalDevice(), mTextureImage, nullptr);
    vkFreeMemory(mRenderer->GetLogicalDevice(), mTextureImageMemory, nullptr);
 
    bIsTextureLoadedInGPU = false;
}

Member Data Documentation

◆ bIsTextureLoadedInGPU

bool rendering_engine::VulkanTextureResources::bIsTextureLoadedInGPU

protected

Definition at line 112 of file vulkan_texture_resources.hpp.

◆ mGpuMemorySize

VkDeviceSize rendering_engine::VulkanTextureResources::mGpuMemorySize

protected

Definition at line 120 of file vulkan_texture_resources.hpp.

◆ mImageData

const ImageData* rendering_engine::VulkanTextureResources::mImageData

protected

Definition at line 114 of file vulkan_texture_resources.hpp.

◆ mMipmapLevels

std::uint32_t rendering_engine::VulkanTextureResources::mMipmapLevels

protected

Definition at line 115 of file vulkan_texture_resources.hpp.

◆ mRenderer

VulkanRenderer* rendering_engine::VulkanTextureResources::mRenderer

protected

Definition at line 113 of file vulkan_texture_resources.hpp.

◆ mTextureImage

VkImage rendering_engine::VulkanTextureResources::mTextureImage

protected

Definition at line 116 of file vulkan_texture_resources.hpp.

◆ mTextureImageMemory

VkDeviceMemory rendering_engine::VulkanTextureResources::mTextureImageMemory

protected

Definition at line 117 of file vulkan_texture_resources.hpp.

◆ mTextureImageView

VkImageView rendering_engine::VulkanTextureResources::mTextureImageView

protected

Definition at line 118 of file vulkan_texture_resources.hpp.

◆ mTextureSampler

VkSampler rendering_engine::VulkanTextureResources::mTextureSampler

protected

Definition at line 119 of file vulkan_texture_resources.hpp.

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

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ VulkanTextureResources()

Member Function Documentation

◆ CreateImageView()

◆ CreateTextureImage()

◆ CreateTextureImageView()

◆ CreateTextureSampler()

◆ CreateVulkanImage()

◆ GetSizeInGPUBytes()

◆ GetVkImageView()

◆ GetVkSampler()

◆ IsTextureLoadedInGPU()

◆ LoadToGPU()

◆ ReleaseFromGPU()

Member Data Documentation

◆ bIsTextureLoadedInGPU

◆ mGpuMemorySize

◆ mImageData

◆ mMipmapLevels

◆ mRenderer

◆ mTextureImage

◆ mTextureImageMemory

◆ mTextureImageView

◆ mTextureSampler