geometrize::Bitmap Class Reference

The Bitmap class is a helper class for working with bitmap data. More...

#include <bitmap.h>

Public Member Functions
	Bitmap (std::uint32_t width, std::uint32_t height, geometrize::rgba color)
	Bitmap Creates a new bitmap. More...
	Bitmap (std::uint32_t width, std::uint32_t height, const std::vector< std::uint8_t > &data)
	Bitmap Creates a new bitmap from the supplied byte data. More...
	~Bitmap ()=default
Bitmap &	operator= (const geometrize::Bitmap &)=default
	Bitmap (const geometrize::Bitmap &)=default
std::uint32_t	getWidth () const
	getWidth Gets the width of the bitmap. More...
std::uint32_t	getHeight () const
	getHeight Gets the height of the bitmap. More...
std::vector< std::uint8_t >	copyData () const
	copyData Gets a copy of the raw bitmap data. More...
const std::vector< std::uint8_t > &	getDataRef () const
	getDataRef Gets a reference to the raw bitmap data. More...
geometrize::rgba	getPixel (std::uint32_t x, std::uint32_t y) const
	getPixel Gets a pixel color value. More...
void	setPixel (std::uint32_t x, std::uint32_t y, geometrize::rgba color)
	setPixel Sets a pixel color value. More...
void	fill (geometrize::rgba color)
	fill Fills the bitmap with the given color. More...

Private Attributes
std::uint32_t	m_width
	The width of the bitmap. More...
std::uint32_t	m_height
	The height of the bitmap. More...
std::vector< std::uint8_t >	m_data
	The bitmap data. More...

Detailed Description

The Bitmap class is a helper class for working with bitmap data.

Author

Sam Twidale (https://samcodes.co.uk/)

Constructor & Destructor Documentation

Bitmap() [1/3]

geometrize::Bitmap::Bitmap	(	std::uint32_t	width,
		std::uint32_t	height,
		geometrize::rgba	color
	)

Bitmap Creates a new bitmap.

Parameters

width	The width of the bitmap.
height	The height of the bitmap.
color	The starting color of the bitmap (RGBA format).

                                                                                            : m_width{width}, m_height{height}, m_data(width * height * 4U)
{
    fill(color);
}

Here is the call graph for this function:

Bitmap() [2/3]

geometrize::Bitmap::Bitmap	(	std::uint32_t	width,
		std::uint32_t	height,
		const std::vector< std::uint8_t > &	data
	)

Bitmap Creates a new bitmap from the supplied byte data.

Parameters

width	The width of the bitmap.
height	The height of the bitmap.
data	The byte data to fill the bitmap with, must be width * height * depth (4) long.

                                                                                                   : m_width{width}, m_height{height}, m_data{data}
{
    assert((width * height * 4U) == data.size());
}

~Bitmap()

geometrize::Bitmap::~Bitmap ( )

default

Bitmap() [3/3]

geometrize::Bitmap::Bitmap ( const geometrize::Bitmap &  )

default

Member Function Documentation

copyData()

std::vector< std::uint8_t > geometrize::Bitmap::copyData

(

)

const

copyData Gets a copy of the raw bitmap data.

Returns

The bitmap data.

{
    return m_data;
}

fill()

void geometrize::Bitmap::fill

(

geometrize::rgba

color

)

fill Fills the bitmap with the given color.

Parameters

color

The color to fill the bitmap with.

{
    for(std::size_t i = 0; i < m_data.size(); i += 4U) {
        m_data[i] = color.r;
        m_data[i + 1U] = color.g;
        m_data[i + 2U] = color.b;
        m_data[i + 3U] = color.a;
    }
}

Here is the caller graph for this function:

getDataRef()

const std::vector< std::uint8_t > & geometrize::Bitmap::getDataRef

(

)

const

getDataRef Gets a reference to the raw bitmap data.

Returns

The bitmap data.

{
    return m_data;
}

Here is the caller graph for this function:

getHeight()

std::uint32_t geometrize::Bitmap::getHeight

(

)

const

getHeight Gets the height of the bitmap.

{
    return m_height;
}

Here is the caller graph for this function:

getPixel()

geometrize::rgba geometrize::Bitmap::getPixel	(	std::uint32_t	x,
		std::uint32_t	y
	)		const

getPixel Gets a pixel color value.

Parameters

x	The x-coordinate of the pixel.
y	The y-coordinate of the pixel.

Returns

The pixel RGBA color value.

{
    const std::size_t index{(m_width * y + x) * 4U};
    return geometrize::rgba{m_data[index], m_data[index + 1U], m_data[index + 2U], m_data[index + 3U]};
}

Here is the caller graph for this function:

getWidth()

std::uint32_t geometrize::Bitmap::getWidth

(

)

const

getWidth Gets the width of the bitmap.

{
    return m_width;
}

Here is the caller graph for this function:

operator=()

Bitmap & geometrize::Bitmap::operator= ( const geometrize::Bitmap &  )

default

setPixel()

void geometrize::Bitmap::setPixel	(	std::uint32_t	x,
		std::uint32_t	y,
		geometrize::rgba	color
	)

setPixel Sets a pixel color value.

Parameters

x	The x-coordinate of the pixel.
y	The y-coordinate of the pixel.
color	The pixel RGBA color value.

{
    const std::uint32_t index{(m_width * y + x) * 4U};
    m_data[index] = color.r;
    m_data[index + 1U] = color.g;
    m_data[index + 2U] = color.b;
    m_data[index + 3U] = color.a;
}

Here is the caller graph for this function:

Member Data Documentation

m_data

std::vector<std::uint8_t> geometrize::Bitmap::m_data

private

The bitmap data.

m_height

std::uint32_t geometrize::Bitmap::m_height

private

The height of the bitmap.

m_width

std::uint32_t geometrize::Bitmap::m_width

private

The width of the bitmap.

---

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

• /home/appveyor/projects/geometrize-lib-docs/geometrize-lib/geometrize/geometrize/bitmap/bitmap.h
• /home/appveyor/projects/geometrize-lib-docs/geometrize-lib/geometrize/geometrize/bitmap/bitmap.cpp