Combines CPU-side and GPU-side texture representations, managing both lifetimes and transitions. More...

#include <image_data_gpu.hpp>

Public Member Functions
	ImageDataGpu (std::string path, IRenderer *renderer)
	Constructs an ImageDataGpu object from an image file path.
	ImageDataGpu (std::vector< uint8_t > const &fileBytes, IRenderer *renderer)
	Constructs an ImageDataGpu object from raw image file bytes.
	~ImageDataGpu ()
	Destructor. Frees GPU memory if allocated.
void	UploadToGPU ()
	Uploads the texture data to GPU if not already uploaded.
void	ReleaseFromGPU ()
	Releases the GPU resources (image, sampler, view).
bool	IsOnGPU () const
	Checks whether the texture is currently loaded in GPU memory.
size_t	GetSizeInRAM () const
	Gets the size of the texture in RAM (in bytes).
size_t	GetSizeInGPU () const
	Gets the size of the texture in GPU memory (in bytes).
ImageData const &	GetCpuImageData () const
	Returns a const reference to the CPU-side image data.
ImageData &	GetCpuImageData ()
	Returns a modifiable reference to the CPU-side image data.
ITextureRenderResources *	GetTextureRenderResources () const
	Returns a pointer to the GPU texture resource interface.

Detailed Description

Combines CPU-side and GPU-side texture representations, managing both lifetimes and transitions.

This class owns the image data in RAM (via ImageData) and optionally uploads/releases the corresponding GPU-side representation. It provides accessors for both and tracks memory usage.

Definition at line 25 of file image_data_gpu.hpp.

Constructor & Destructor Documentation

◆ ImageDataGpu() [1/2]

ImageDataGpu::ImageDataGpu	(	std::string	path,
		IRenderer *	renderer )

Constructs an ImageDataGpu object from an image file path.

Parameters

path	Path to the image file (must be supported format such as .png or .jpg).
renderer	Pointer to the rendering engine interface (IRenderer).

Definition at line 10 of file image_data_gpu.cpp.

    :
    mPath{path},
    mRenderer{renderer},
    mImageData{nullptr},
    mGpuHandle{nullptr}
{
    mImageData = std::make_unique<ImageData>(path);
}

◆ ImageDataGpu() [2/2]

ImageDataGpu::ImageDataGpu	(	std::vector< uint8_t > const &	fileBytes,
		IRenderer *	renderer )

Constructs an ImageDataGpu object from raw image file bytes.

This constructor allows loading GPU-ready image data directly from a memory buffer rather than from disk. The input is interpreted as an encoded image (PNG or JPEG). After decoding via ImageData, the pixel data is uploaded to GPU memory through the provided IRenderer interface.

Parameters

fileBytes	Raw binary contents of an image file (PNG or JPEG).
renderer	Pointer to the rendering engine interface responsible for uploading the texture to GPU memory.

Definition at line 20 of file image_data_gpu.cpp.

    :
    mPath{},
    mRenderer{ renderer },
    mImageData{ nullptr },
    mGpuHandle{ nullptr }
{
    mImageData = std::make_unique<ImageData>(fileBytes);
}

◆ ~ImageDataGpu()

rendering_engine::ImageDataGpu::~ImageDataGpu ( )

Destructor. Frees GPU memory if allocated.

Definition at line 30 of file image_data_gpu.cpp.

31{

32}

Member Function Documentation

◆ GetCpuImageData() [1/2]

ImageData & ImageDataGpu::GetCpuImageData ( )

Returns a modifiable reference to the CPU-side image data.

Returns: Reference to the underlying ImageData.

Definition at line 106 of file image_data_gpu.cpp.

{
    return *mImageData;
}

◆ GetCpuImageData() [2/2]

ImageData const & ImageDataGpu::GetCpuImageData ( ) const

Returns a const reference to the CPU-side image data.

Returns: Const reference to the underlying ImageData.

Definition at line 101 of file image_data_gpu.cpp.

{
    return *mImageData;
}

◆ GetSizeInGPU()

size_t rendering_engine::ImageDataGpu::GetSizeInGPU ( ) const

Gets the size of the texture in GPU memory (in bytes).

Returns: Estimated GPU memory usage if uploaded, 0 otherwise.

Definition at line 91 of file image_data_gpu.cpp.

{
    if (!mGpuHandle)
    {
        return 0;
    }
 
    return mGpuHandle->GetSizeInGPUBytes();
}

◆ GetSizeInRAM()

size_t rendering_engine::ImageDataGpu::GetSizeInRAM ( ) const

Gets the size of the texture in RAM (in bytes).

Returns: Estimated RAM usage of the image data.

Definition at line 81 of file image_data_gpu.cpp.

{
    if (!mImageData)
    {
        return 0;
    }
 
    return mImageData->GetSizeInBytes();
}

◆ GetTextureRenderResources()

ITextureRenderResources * ImageDataGpu::GetTextureRenderResources ( ) const

Returns a pointer to the GPU texture resource interface.

Returns: Pointer to ITextureRenderResources if uploaded, nullptr otherwise.

Definition at line 111 of file image_data_gpu.cpp.

{
    return mGpuHandle.get();
}

◆ IsOnGPU()

bool ImageDataGpu::IsOnGPU ( ) const

Checks whether the texture is currently loaded in GPU memory.

Returns: true if texture has been uploaded to GPU, false otherwise.

Definition at line 72 of file image_data_gpu.cpp.

{
    if (!mGpuHandle)
    {
        return false;
    }
    mGpuHandle->IsTextureLoadedInGPU();
}

◆ ReleaseFromGPU()

void ImageDataGpu::ReleaseFromGPU ( )

Releases the GPU resources (image, sampler, view).

After this call, the texture will be stored in RAM only.

Definition at line 56 of file image_data_gpu.cpp.

{
    if (!mRenderer)
    {
        return;
    }
    if (!mGpuHandle)
    {
        return;
    }
 
    mGpuHandle->ReleaseFromGPU();
    mGpuHandle.release();
    mGpuHandle = nullptr;
}

◆ UploadToGPU()

void ImageDataGpu::UploadToGPU ( )

Uploads the texture data to GPU if not already uploaded.

This function instantiates GPU resource handlers and invokes texture uploading routines.

Definition at line 34 of file image_data_gpu.cpp.

{
    if (!mRenderer)
    {
        return;
    }
 
    if (mGpuHandle)
    {
        if (mGpuHandle->IsTextureLoadedInGPU())
        {
            ReleaseFromGPU();
        }
    }
    mGpuHandle = std::unique_ptr<ITextureRenderResources>(mRenderer->ProvideTextureRenderResources());
    if (!mGpuHandle)
    {
        return;
    }
    mGpuHandle->LoadToGPU(*mImageData);
}

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

Public Member Functions