rendering_engine::ImageData Class Reference

Represents raw 2D image data stored in memory. More...

#include <image_data.hpp>

Public Member Functions
	ImageData ()
	Constructs an empty image. More...
	ImageData (unsigned int width, unsigned int height)
	Constructs a blank image with specified dimensions. More...
	ImageData (std::string filepath)
	Loads image data from a file. More...
	ImageData (std::vector< uint8_t > const &fileBytes)
	Constructs an image by decoding raw file bytes. More...
	ImageData (unsigned int width, unsigned int height, std::vector< std::uint8_t > const &pixelsRGBA)
	Constructs image from raw RGBA pixel buffer. More...
	~ImageData ()
	Destructor that frees memory. More...
	ImageData (const ImageData &src)
	Copy constructor. More...
ImageData &	operator= (const ImageData &rhs)
	Copy assignment operator. More...
unsigned int	GetWidth () const
	Returns the image width. More...
unsigned int	GetHeight () const
	Returns the image height. More...
void	Fill (Color color)
	Fills the image with a solid color. More...
void	SetPixel (unsigned int x, unsigned int y, Color color)
	Sets the color of a specific pixel. More...
const Color	GetPixel (unsigned int x, unsigned int y) const
	Retrieves the color of a specific pixel. More...
std::vector< uint8_t >	GetImageDataRGBA () const
	Gets raw image data in RGBA format. More...
std::vector< uint8_t >	GetImageDataRGB () const
	Gets raw image data in RGB format. More...
size_t	GetSizeInBytes () const
	Gets the total size of the image in memory. More...
void	WriteJpegFile (char const *filename)
	Writes the image data to a JPEG file. More...
void	WritePngFile (char const *filename)
	Writes the image data to a PNG file. More...

Static Public Member Functions
static void	DrawImageOnImageAtPos (unsigned int const x, unsigned int const y, ImageData &toImage, ImageData &fromImage)
	Overlays one image on top of another at a given position. More...

Protected Member Functions
void	AllocateMemory (unsigned int width, unsigned int height)
	Allocates memory for internal pixel storage. More...
void	CleanAllocatedMemory ()
	Frees allocated memory. More...
void	LoadImageDataRGBA (std::vector< std::uint8_t > const &pixels)
	Loads image data from a 32-bit RGBA buffer. More...
void	LoadImageDataRGB (std::vector< std::uint8_t > const &pixels)
	Loads image data from a 24-bit RGB buffer. More...
bool	LoadTexturePngFile (char const *filename)
	Loads image from a PNG file. More...
bool	LoadTextureJpegFile (char const *filename)
	Loads image from a JPEG file. More...
size_t	GetLinearIndex (unsigned int x, unsigned int y) const
Color &	PixelRef (unsigned int x, unsigned int y)
const Color &	PixelRef (unsigned int x, unsigned int y) const

Detailed Description

Represents raw 2D image data stored in memory.

Definition at line 79 of file image_data.hpp.

Constructor & Destructor Documentation

ImageData() [1/6]

rendering_engine::ImageData::ImageData

(

)

Constructs an empty image.

Definition at line 12 of file image_data.cpp.

    :
    ImageData::ImageData(0U, 0U)
{
}

ImageData() [2/6]

rendering_engine::ImageData::ImageData	(	unsigned int	width,
		unsigned int	height
	)

Constructs a blank image with specified dimensions.

Parameters

width	Image width in pixels
height	Image height in pixels

Definition at line 18 of file image_data.cpp.

    :
    mWidth( width ),
    mHeight( height )
{
    AllocateMemory( mWidth, mHeight );
}

ImageData() [3/6]

rendering_engine::ImageData::ImageData

(

std::string

filepath

)

Loads image data from a file.

Parameters

filepath

Path to the image file (JPG or PNG)

Definition at line 26 of file image_data.cpp.

    :
    ImageData::ImageData()
{
    auto const pathToTexture = boost::filesystem::path(filepath);
    if( boost::filesystem::exists(pathToTexture) && boost::filesystem::is_regular_file(pathToTexture) )
    {
        boost::filesystem::path const pathToTexture = boost::filesystem::path(filepath);
        
        size_t const dot = pathToTexture.string().find_last_of(".");
        std::string const fileExtension = pathToTexture.string().substr(dot + 1);
 
        if( std::string{ "jpg" } == fileExtension )
        {
            LoadTextureJpegFile(pathToTexture.string().c_str());
        }
        else
        {
            if( std::string{ "png" } == fileExtension )
            {
                LoadTexturePngFile(pathToTexture.string().c_str());
            }
            else
            {
                throw std::runtime_error("Unsupported texture file format!");
            }
        }
    }
    else
    {
        throw std::runtime_error("Path to texture file is incorrect.");
    }
}

ImageData() [4/6]

rendering_engine::ImageData::ImageData

(

std::vector< uint8_t > const &

fileBytes

)

Constructs an image by decoding raw file bytes.

This constructor allows loading an image from a memory buffer rather than a file on disk. The data is interpreted as either PNG or JPEG depending on format detection. Decoded pixel data is stored internally in 32-bit RGBA format.

Parameters

fileBytes

Raw contents of an image file (PNG or JPEG).

Definition at line 60 of file image_data.cpp.

{
    if (fileBytes.size() < 4)
        throw std::runtime_error("Invalid image buffer");
 
    // PNG signature
    if (fileBytes[0] == 0x89 &&
        fileBytes[1] == 'P' &&
        fileBytes[2] == 'N' &&
        fileBytes[3] == 'G')
    {
        std::vector<std::uint8_t> pixelsRGBA;
 
        if (!ReadPngFromMemory(fileBytes.data(), fileBytes.size(), mWidth, mHeight, pixelsRGBA))
            throw std::runtime_error("PNG memory decode failed");
 
        AllocateMemory(mWidth, mHeight);
        Fill(Color(0, 0, 0, 255));
        LoadImageDataRGBA(pixelsRGBA);
        return;
    }
 
    // JPEG signature: FF D8 FF
    if (fileBytes[0] == 0xFF &&
        fileBytes[1] == 0xD8 &&
        fileBytes[2] == 0xFF)
    {
        std::vector<std::uint8_t> pixelsRGB;
 
        if (!ReadJpegFromMemory(fileBytes.data(), fileBytes.size(), mWidth, mHeight, pixelsRGB))
            throw std::runtime_error("JPEG memory decode failed");
 
        AllocateMemory(mWidth, mHeight);
        LoadImageDataRGB(pixelsRGB);
 
        return;
    }
 
    throw std::runtime_error("Unsupported image format in memory buffer");
}

ImageData() [5/6]

rendering_engine::ImageData::ImageData	(	unsigned int	width,
		unsigned int	height,
		std::vector< std::uint8_t > const &	pixelsRGBA
	)

Constructs image from raw RGBA pixel buffer.

Parameters

width	Image width
height	Image height
pixelsRGBA	Vector of RGBA pixel data (4 bytes per pixel)

Definition at line 101 of file image_data.cpp.

    :
ImageData::ImageData(width, height)
{
    Fill(Color(255, 255, 255, 255));
    LoadImageDataRGBA( pixelsRGBA );
}

~ImageData()

rendering_engine::ImageData::~ImageData

(

)

Destructor that frees memory.

Definition at line 109 of file image_data.cpp.

{
    CleanAllocatedMemory();
}

ImageData() [6/6]

rendering_engine::ImageData::ImageData

(

const ImageData &

src

)

Copy constructor.

Definition at line 114 of file image_data.cpp.

    : 
    mWidth(src.mWidth),
    mHeight(src.mHeight),
    mData(src.mData)
{
}

Member Function Documentation

AllocateMemory()

void rendering_engine::ImageData::AllocateMemory ( unsigned int  width, unsigned int  height  )

protected

Allocates memory for internal pixel storage.

Parameters

width	Image width
height	Image height

Definition at line 308 of file image_data.cpp.

{
    mWidth = width;
    mHeight = height;
    mData.resize(static_cast<size_t>(mWidth) * static_cast<size_t>(mHeight));
}

CleanAllocatedMemory()

void rendering_engine::ImageData::CleanAllocatedMemory ( )

protected

Frees allocated memory.

Definition at line 315 of file image_data.cpp.

{
    mData.clear();
 
    mWidth = 0;
    mHeight = 0;
}

DrawImageOnImageAtPos()

void rendering_engine::ImageData::DrawImageOnImageAtPos ( unsigned int const  x, unsigned int const  y, ImageData &  toImage, ImageData &  fromImage  )

static

Overlays one image on top of another at a given position.

Parameters

x	Top-left X coordinate for the overlay
y	Top-left Y coordinate for the overlay
toImage	Destination image
fromImage	Source image

Definition at line 159 of file image_data.cpp.

{
    // If fromImage can not be placed entirely, it will be cropped on right and bottom side
 
    // Source image draw from top left pixel
 
    // At first check if point pos is inside toImage
    if (x >= toImage.GetWidth() || y >= toImage.GetHeight())
    {
        return;
    }
 
    if (toImage.GetWidth() == 0U || toImage.GetHeight() == 0U ||
        fromImage.GetWidth() == 0U || fromImage.GetHeight() == 0U)
    {
        return;
    }
 
    // Crop
    unsigned int left;
    if ((toImage.GetWidth() - x) < fromImage.GetWidth())
    {
        left = toImage.GetWidth() - x;
    }
    else
    {
        left = fromImage.GetWidth();
    }
 
    unsigned int bottom;
    if ((toImage.GetHeight() - y) < fromImage.GetHeight())
    {
        bottom = toImage.GetHeight() - y;
    }
    else
    {
        bottom = fromImage.GetHeight();
    }
 
    if (left == 0U || bottom == 0U)
    {
        return;
    }
 
    for (unsigned int deltaY = 0; deltaY < bottom; ++deltaY)
    {
        const size_t srcRowOffset =
            static_cast<size_t>(deltaY) * static_cast<size_t>(fromImage.GetWidth());
 
        const size_t dstRowOffset =
            static_cast<size_t>(y + deltaY) * static_cast<size_t>(toImage.GetWidth()) +
            static_cast<size_t>(x);
 
        std::memcpy(
            toImage.mData.data() + dstRowOffset,
            fromImage.mData.data() + srcRowOffset,
            static_cast<size_t>(left) * sizeof(Color));
    }
}

Fill()

void rendering_engine::ImageData::Fill

(

Color

color

)

Fills the image with a solid color.

Parameters

color

The color to fill with

Definition at line 135 of file image_data.cpp.

{
    std::fill(mData.begin(), mData.end(), color);
}

GetHeight()

unsigned int rendering_engine::ImageData::GetHeight ( ) const

inline

Returns the image height.

Definition at line 145 of file image_data.hpp.

    {
        return mHeight;
    }

GetImageDataRGB()

std::vector< uint8_t > rendering_engine::ImageData::GetImageDataRGB

(

)

const

Gets raw image data in RGB format.

Returns

A vector containing 3 bytes per pixel (RGB)

Definition at line 235 of file image_data.cpp.

{
    if (mWidth == 0 || mHeight == 0)
    {
        return {};
    }
 
    const size_t pixelCount =
        static_cast<size_t>(mWidth) * static_cast<size_t>(mHeight);
 
    std::vector<uint8_t> result(pixelCount * 3);
 
    const Color* src = mData.data();
    uint8_t* dst = result.data();
 
    for (size_t i = 0; i < pixelCount; ++i)
    {
        dst[i * 3 + 0] = src[i].r;
        dst[i * 3 + 1] = src[i].g;
        dst[i * 3 + 2] = src[i].b;
    }
 
    return result;
}

GetImageDataRGBA()

std::vector< uint8_t > rendering_engine::ImageData::GetImageDataRGBA

(

)

const

Gets raw image data in RGBA format.

Returns

A vector containing 4 bytes per pixel (RGBA)

Definition at line 219 of file image_data.cpp.

{
    if (mWidth == 0 || mHeight == 0)
    {
        return {};
    }
 
    const size_t totalBytes =
        static_cast<size_t>(mWidth) * static_cast<size_t>(mHeight) * 4;
 
    std::vector<uint8_t> result(totalBytes);
    std::memcpy(result.data(), mData.data(), totalBytes);
 
    return result;
}

GetLinearIndex()

size_t rendering_engine::ImageData::GetLinearIndex ( unsigned int  x, unsigned int  y  ) const

inlineprotected

Definition at line 246 of file image_data.hpp.

    {
        return static_cast<size_t>(y) * static_cast<size_t>(mWidth) + static_cast<size_t>(x);
    }

GetPixel()

const Color rendering_engine::ImageData::GetPixel	(	unsigned int	x,
		unsigned int	y
	)		const

Retrieves the color of a specific pixel.

Parameters

x	X coordinate
y	Y coordinate

Returns

The color of the pixel

Definition at line 148 of file image_data.cpp.

{
    if (x >= mWidth || y >= mHeight)
    {
        LOG_ERROR("Out of bounds access in GetPixel");
        return Color{};
    }
 
    return PixelRef(x, y);
}

GetSizeInBytes()

size_t rendering_engine::ImageData::GetSizeInBytes ( ) const

inline

Gets the total size of the image in memory.

Returns

Size in bytes

Definition at line 197 of file image_data.hpp.

    {
        return static_cast<size_t>(mWidth) * static_cast<size_t>(mHeight) * sizeof(Color);
    }

GetWidth()

unsigned int rendering_engine::ImageData::GetWidth ( ) const

inline

Returns the image width.

Definition at line 137 of file image_data.hpp.

    {
        return mWidth;
    }

LoadImageDataRGB()

void rendering_engine::ImageData::LoadImageDataRGB ( std::vector< std::uint8_t > const &  pixels )

protected

Loads image data from a 24-bit RGB buffer.

Definition at line 338 of file image_data.cpp.

{
    const size_t pixelCount =
        static_cast<size_t>(mWidth) * static_cast<size_t>(mHeight);
 
    const size_t expectedSize = pixelCount * 3;
    if (pixels.size() != expectedSize)
    {
        throw std::runtime_error("Array data size doesn't match image dimension.");
    }
 
    mData.resize(pixelCount);
 
    const uint8_t* src = pixels.data();
    Color* dst = mData.data();
 
    for (size_t i = 0; i < pixelCount; ++i)
    {
        dst[i].r = src[i * 3 + 0];
        dst[i].g = src[i * 3 + 1];
        dst[i].b = src[i * 3 + 2];
        dst[i].a = 255;
    }
}

LoadImageDataRGBA()

void rendering_engine::ImageData::LoadImageDataRGBA ( std::vector< std::uint8_t > const &  pixels )

protected

Loads image data from a 32-bit RGBA buffer.

Definition at line 323 of file image_data.cpp.

{
    const size_t expectedSize =
        static_cast<size_t>(mWidth) * static_cast<size_t>(mHeight) * 4;
 
    if (pixels.size() != expectedSize)
    {
        throw std::runtime_error("Array data size doesn't match image dimension.");
    }
 
    mData.resize(mWidth * mHeight);
 
    std::memcpy(mData.data(), pixels.data(), expectedSize);
}

LoadTextureJpegFile()

bool rendering_engine::ImageData::LoadTextureJpegFile ( char const *  filename )

protected

Loads image from a JPEG file.

Definition at line 265 of file image_data.cpp.

{
    CleanAllocatedMemory();
    unsigned int width = 0;
    unsigned int height = 0;
    std::vector<std::uint8_t> rgbImageDataVector;
 
    bool result = ReadJpegFile(filename, width, height, rgbImageDataVector);
    if(result && (rgbImageDataVector.size() == (3U * width * height)))
    {
        mWidth = width;
        mHeight = height;
        AllocateMemory(width, height);
        LoadImageDataRGB(rgbImageDataVector);
    }
 
    return result;
}

LoadTexturePngFile()

bool rendering_engine::ImageData::LoadTexturePngFile ( char const *  filename )

protected

Loads image from a PNG file.

Definition at line 289 of file image_data.cpp.

{
    CleanAllocatedMemory();
    unsigned int width = 0;
    unsigned int height = 0;
    std::vector<std::uint8_t> rgbaImageDataVector;
 
    bool result = ReadPngFile(filename, width, height, rgbaImageDataVector);
 
    if( result && (rgbaImageDataVector.size() == (4U * width * height)) )
    {
        mWidth = width;
        mHeight = height;
        AllocateMemory(width, height);
        LoadImageDataRGBA(rgbaImageDataVector);
    }
    return true;
}

operator=()

ImageData & rendering_engine::ImageData::operator=

(

const ImageData &

rhs

)

Copy assignment operator.

Definition at line 122 of file image_data.cpp.

{
    if (this == &rhs)
    {
        return *this;
    }
 
    mWidth = rhs.mWidth;
    mHeight = rhs.mHeight;
    mData = rhs.mData;
    return *this;
}

PixelRef() [1/2]

Color & rendering_engine::ImageData::PixelRef ( unsigned int  x, unsigned int  y  )

inlineprotected

Definition at line 251 of file image_data.hpp.

    {
        return mData[GetLinearIndex(x, y)];
    }

PixelRef() [2/2]

const Color & rendering_engine::ImageData::PixelRef ( unsigned int  x, unsigned int  y  ) const

inlineprotected

Definition at line 256 of file image_data.hpp.

    {
        return mData[GetLinearIndex(x, y)];
    }

SetPixel()

void rendering_engine::ImageData::SetPixel	(	unsigned int	x,
		unsigned int	y,
		Color	color
	)

Sets the color of a specific pixel.

Parameters

x	X coordinate
y	Y coordinate
color	The color to set

Definition at line 140 of file image_data.cpp.

{
    if (x < mWidth && y < mHeight)
    {
        PixelRef(x, y) = color;
    }
}

WriteJpegFile()

void rendering_engine::ImageData::WriteJpegFile

(

char const *

filename

)

Writes the image data to a JPEG file.

Parameters

filename

Path to output file

Definition at line 260 of file image_data.cpp.

{
    SaveTextureFileJpeg(*this, filename);
}

WritePngFile()

void rendering_engine::ImageData::WritePngFile

(

char const *

filename

)

Writes the image data to a PNG file.

Parameters

filename

Path to output file

Definition at line 284 of file image_data.cpp.

{
    SaveTextureFilePng(*this, filename);
}

---

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

• image_data.hpp
• image_data.cpp