#include <GpuResourceManager.h>

Inheritance diagram for ne::GpuResourceManager:

Public Member Functions
virtual size_t	getTotalVideoMemoryInMb () const =0

virtual size_t	getUsedVideoMemoryInMb () const =0

virtual std::variant< std::unique_ptr< GpuResource >, Error >	loadTextureFromDisk (const std::string &sResourceName, const std::filesystem::path &pathToTextureFile)=0

virtual std::variant< std::unique_ptr< UploadBuffer >, Error >	createResourceWithCpuWriteAccess (const std::string &sResourceName, size_t iElementSizeInBytes, size_t iElementCount, std::optional< bool > isUsedInShadersAsArrayResource)=0

virtual std::variant< std::unique_ptr< GpuResource >, Error >	createResourceWithData (const std::string &sResourceName, const void *pBufferData, size_t iElementSizeInBytes, size_t iElementCount, ResourceUsageType usage, bool bIsShaderReadWriteResource)=0

virtual std::variant< std::unique_ptr< GpuResource >, Error >	createResource (const std::string &sResourceName, size_t iElementSizeInBytes, size_t iElementCount, ResourceUsageType usage, bool bIsShaderReadWriteResource)=0

virtual std::variant< std::unique_ptr< GpuResource >, Error >	createShaderReadWriteTextureResource (const std::string &sResourceName, unsigned int iWidth, unsigned int iHeight, ShaderReadWriteTextureResourceFormat format)=0

virtual std::string	getCurrentStateInfo ()=0

Renderer *	getRenderer () const

TextureManager *	getTextureManager () const

ShadowMapManager *	getShadowMapManager () const

size_t	getTotalAliveResourceCount ()

Protected Member Functions
virtual std::variant< std::unique_ptr< GpuResource >, Error >	createShadowMapTexture (const std::string &sResourceName, unsigned int iTextureSize, bool bPointLightColorCubemap)=0

	GpuResourceManager (Renderer *pRenderer)

void	resetTextureManager ()

void	resetShadowMapManager ()

Static Protected Member Functions
static std::variant< std::unique_ptr< GpuResourceManager >, Error >	create (Renderer *pRenderer)

static std::variant< std::unique_ptr< GpuResourceManager >, Error >	createRendererSpecificManager (Renderer *pRenderer)

Private Attributes
std::unique_ptr< TextureManager >	pTextureManager

std::unique_ptr< ShadowMapManager >	pShadowMapManager

std::atomic< size_t >	iAliveResourceCount {0}

Renderer *	pRenderer = nullptr

Friends
class	Renderer

class	ShadowMapManager

class	GpuResource

Detailed Description

Allows creating GPU resources.

Constructor & Destructor Documentation

◆ GpuResourceManager()

ne::GpuResourceManager::GpuResourceManager ( Renderer * pRenderer )

protected

Creates partially initialized manager, used internally.

Remarks: Prefer to use create.

Parameters

pRenderer Renderer that owns this manager.

Member Function Documentation

◆ create()

std::variant< std::unique_ptr< GpuResourceManager >, Error > ne::GpuResourceManager::create ( Renderer * pRenderer )

staticprotected

Creates a new platform-specific resource manager.

Parameters

pRenderer Renderer.

Returns: Error if something went wrong, otherwise fully initialized resource manager.

◆ createRendererSpecificManager()

std::variant< std::unique_ptr< GpuResourceManager >, Error > ne::GpuResourceManager::createRendererSpecificManager ( Renderer * pRenderer )

staticprotected

Used internally to create initial (base) manager object.

Remarks: Prefer to use create.

Parameters

pRenderer Renderer

Returns: Error if something went wrong, otherwise partially initialized manager.

◆ createResource()

virtual std::variant< std::unique_ptr< GpuResource >, Error > ne::GpuResourceManager::createResource	(	const std::string &	sResourceName,
		size_t	iElementSizeInBytes,
		size_t	iElementCount,
		ResourceUsageType	usage,
		bool	bIsShaderReadWriteResource
	)

pure virtual

Creates a new GPU resource (buffer, not a texture) without any initial data.

Remarks: This function can be useful if you plan to create a resource to be filled from a (compute) shader and then use this data in some other shader.

Parameters

sResourceName	Resource name, used for logging.
iElementSizeInBytes	Size of one buffer element in bytes.
iElementCount	Number of elements in the resulting buffer.
usage	Describes how you plan to use this resource.
bIsShaderReadWriteResource	Specify `true` if you plan to modify the resource from shaders, otherwise `false`.

Returns: Error if something went wrong, otherwise created resource with filled data.

Implemented in ne::DirectXResourceManager, and ne::VulkanResourceManager.

◆ createResourceWithCpuWriteAccess()

virtual std::variant< std::unique_ptr< UploadBuffer >, Error > ne::GpuResourceManager::createResourceWithCpuWriteAccess	(	const std::string &	sResourceName,
		size_t	iElementSizeInBytes,
		size_t	iElementCount,
		std::optional< bool >	isUsedInShadersAsArrayResource
	)

pure virtual

Creates a new GPU resource with available CPU write access (only CPU write not read), typically used for resources that needs to be frequently updated from the CPU side.

Example:

struct ObjectData{
    glm::mat4x4 world;
};
 
auto result = pResourceManager->createResourceWithCpuWriteAccess(
    "object constant data",
    sizeof(ObjectData),
    1,
    false);

Parameters

sResourceName	Resource name, used for logging.
iElementSizeInBytes	Size of one buffer element in bytes.
iElementCount	Number of elements in the resulting buffer.
isUsedInShadersAsArrayResource	Specify `empty` if this resource is not going to be used in shaders, `false` if this resource will be used in shaders as a single constant (cbuffer in HLSL, uniform in GLSL), might cause padding to 256 bytes and size limitation up to 64 KB, specify `true` if this resource will be used in shaders as an array resource (StructuredBuffer in HLSL, storage buffer in GLSL - not an array but it will be a storage buffer).

Returns: Error if something went wrong, otherwise created resource.

Implemented in ne::DirectXResourceManager, and ne::VulkanResourceManager.

◆ createResourceWithData()

virtual std::variant< std::unique_ptr< GpuResource >, Error > ne::GpuResourceManager::createResourceWithData	(	const std::string &	sResourceName,
		const void *	pBufferData,
		size_t	iElementSizeInBytes,
		size_t	iElementCount,
		ResourceUsageType	usage,
		bool	bIsShaderReadWriteResource
	)

pure virtual

Creates a new GPU resource (buffer, not a texture) and fills it with the specified data.

Example:

std::vector<glm::vec3> vVertices;
 
auto result = pResourceManager->createResourceWithData(
    "mesh vertex buffer",
    vVertices.data(),
    sizeof(glm::vec3),
    vVertices.size(),
    true);

Parameters

sResourceName	Resource name, used for logging.
pBufferData	Pointer to the data that the new resource will contain.
iElementSizeInBytes	Size of one buffer element in bytes.
iElementCount	Number of elements in the resulting buffer.
usage	Describes how you plan to use this resource.
bIsShaderReadWriteResource	Specify `true` if you plan to modify the resource from shaders, otherwise `false`.

Returns: Error if something went wrong, otherwise created resource with filled data.

Implemented in ne::DirectXResourceManager, and ne::VulkanResourceManager.

◆ createShaderReadWriteTextureResource()

virtual std::variant< std::unique_ptr< GpuResource >, Error > ne::GpuResourceManager::createShaderReadWriteTextureResource	(	const std::string &	sResourceName,
		unsigned int	iWidth,
		unsigned int	iHeight,
		ShaderReadWriteTextureResourceFormat	format
	)

pure virtual

Creates a texture resource that is available as a read/write resource in shaders.

Parameters

sResourceName	Resource name, used for logging.
iWidth	Width of the texture in pixels.
iHeight	Height of the texture in pixels.
format	Format of the texture.

Returns: Error if something went wrong, otherwise created texture resource.

Implemented in ne::DirectXResourceManager, and ne::VulkanResourceManager.

◆ createShadowMapTexture()

virtual std::variant< std::unique_ptr< GpuResource >, Error > ne::GpuResourceManager::createShadowMapTexture	(	const std::string &	sResourceName,
		unsigned int	iTextureSize,
		bool	bPointLightColorCubemap
	)

protectedpure virtual

Creates a GPU resource to be used as a shadow map.

Parameters

sResourceName	Resource name, used for logging.
iTextureSize	Size of one dimension of the texture in pixels. Must be power of 2 (128, 256, 512, 1024, 2048, etc.).
bPointLightColorCubemap	`false` is you need a single 2D texture resource or `true` to have 6 2D textures arranged as a cube map specifically for point lights.

Returns: Error if something went wrong, otherwise created texture resource.

Implemented in ne::DirectXResourceManager, and ne::VulkanResourceManager.

◆ getCurrentStateInfo()

virtual std::string ne::GpuResourceManager::getCurrentStateInfo ( )

pure virtual

Dumps internal state of the resource manager in JSON format.

Returns: JSON string.

Implemented in ne::DirectXResourceManager, and ne::VulkanResourceManager.

◆ getRenderer()

Renderer * ne::GpuResourceManager::getRenderer ( ) const

Returns renderer that owns this resource manager.

Remarks: Do not delete (free) returned pointer.

Returns: Renderer that owns this manager.

◆ getShadowMapManager()

ShadowMapManager * ne::GpuResourceManager::getShadowMapManager ( ) const

Returns shadow map manager.

Remarks: Do not delete (free) returned pointer.

Returns: Shadow map manager.

◆ getTextureManager()

TextureManager * ne::GpuResourceManager::getTextureManager ( ) const

Returns texture manager.

Remarks: Do not delete (free) returned pointer.

Returns: Texture manager.

◆ getTotalAliveResourceCount()

size_t ne::GpuResourceManager::getTotalAliveResourceCount ( )

Returns the total number of GPU resources currently alive.

Returns: GPU resource count.

◆ getTotalVideoMemoryInMb()

virtual size_t ne::GpuResourceManager::getTotalVideoMemoryInMb ( ) const

pure virtual

Returns total video memory size (VRAM) in megabytes.

Returns: Total video memory size in megabytes.

Implemented in ne::DirectXResourceManager, and ne::VulkanResourceManager.

◆ getUsedVideoMemoryInMb()

virtual size_t ne::GpuResourceManager::getUsedVideoMemoryInMb ( ) const

pure virtual

Returns the amount of video memory (VRAM) occupied by all currently allocated resources.

Returns: Size of the video memory used by allocated resources.

Implemented in ne::DirectXResourceManager, and ne::VulkanResourceManager.

◆ loadTextureFromDisk()

virtual std::variant< std::unique_ptr< GpuResource >, Error > ne::GpuResourceManager::loadTextureFromDisk	(	const std::string &	sResourceName,
		const std::filesystem::path &	pathToTextureFile
	)

pure virtual

Loads a texture from the specified path in the GPU memory.

Parameters

sResourceName	Resource name, used for logging.
pathToTextureFile	Path to the image file that stores texture data.

Returns: Error if something went wrong, otherwise created GPU resource that stores texture data.

Implemented in ne::DirectXResourceManager, and ne::VulkanResourceManager.

◆ resetShadowMapManager()

void ne::GpuResourceManager::resetShadowMapManager ( )

protected

Sets nullptr to shadow map manager's unique ptr to force destroy it (if exists).

Warning: Avoid using this function. Only use it if you need a special destruction order in your object.

◆ resetTextureManager()

void ne::GpuResourceManager::resetTextureManager ( )

protected

Sets nullptr to texture manager's unique ptr to force destroy it (if exists).

Warning: Avoid using this function. Only use it if you need a special destruction order in your object.

Member Data Documentation

◆ iAliveResourceCount

std::atomic<size_t> ne::GpuResourceManager::iAliveResourceCount {0}

private

Total number of created resources that were not destroyed yet.

◆ pRenderer

Renderer* ne::GpuResourceManager::pRenderer = nullptr

private

Do not delete (free) this pointer. Renderer that owns this manager.

◆ pShadowMapManager

std::unique_ptr<ShadowMapManager> ne::GpuResourceManager::pShadowMapManager

private

Stores all shadow maps.

◆ pTextureManager

std::unique_ptr<TextureManager> ne::GpuResourceManager::pTextureManager

private

Stores all texture GPU resources.

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

src/engine_lib/private/render/general/resources/GpuResourceManager.h
src/engine_lib/private/render/general/resources/GpuResourceManager.cpp

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ GpuResourceManager()

Member Function Documentation

◆ create()

◆ createRendererSpecificManager()

◆ createResource()

◆ createResourceWithCpuWriteAccess()

◆ createResourceWithData()

◆ createShaderReadWriteTextureResource()

◆ createShadowMapTexture()

◆ getCurrentStateInfo()

◆ getRenderer()

◆ getShadowMapManager()

◆ getTextureManager()

◆ getTotalAliveResourceCount()

◆ getTotalVideoMemoryInMb()

◆ getUsedVideoMemoryInMb()

◆ loadTextureFromDisk()

◆ resetShadowMapManager()

◆ resetTextureManager()

Member Data Documentation

◆ iAliveResourceCount

◆ pRenderer

◆ pShadowMapManager

◆ pTextureManager