scl::image Class Reference

#include <image.h>

Public Member Functions
int	GetWidth () const
int	GetHeight () const
int	GetComponentsCount () const
const u8 *	GetRawData () const
bool	IsEmpty () const
	image ()=default
	image (const image &Other)
image &	operator= (const image &Other)
	image (int Width, int Height, int ComponentsCount, bool AllocateMemory=true)
	image (int Width, int Height, int ComponentsCount, void *Data)
	image (const std::string &FileName)
	~image ()
void	Allocate ()
void	Free ()
bool	Load (const std::string &FileName)
void	FlipHorizontaly ()

Detailed Description

Image container class.

Definition at line 18 of file image.h.

Constructor & Destructor Documentation

image() [1/5]

scl::image::image ( )

default

Imaeg default constructor.

image() [2/5]

scl::image::image ( const image &  Other )

inline

Image copy constructor.

Definition at line 48 of file image.h.

        {
            if (Other.Data == nullptr) return;
 
            Width = Other.Width;
            Height = Other.Height;
            ComponentsCount = Other.ComponentsCount;
 
            size_t size = (size_t)Width * Height * ComponentsCount;
            Data = new u8[size];
            memcpy(Data, Other.Data, size);
        }

image() [3/5]

scl::image::image ( int  Width, int  Height, int  ComponentsCount, bool  AllocateMemory = true  )

inline

• Empty image specified size constructor.

Parameters

Width	- width of creating image.
Height	- height of creating image.
ComponentsCount	- dimentions (components per pixel) count.
AllocateMemory	- flag, showing weather allocate mrmory for data buffer or not.

Definition at line 85 of file image.h.

                                                                                      :
            Width(Width), Height(Height), ComponentsCount(ComponentsCount)
        {
            if (AllocateMemory) Allocate();
        }

image() [4/5]

scl::image::image ( int  Width, int  Height, int  ComponentsCount, void *  Data  )

inline

• Image by pixels array constructor.

Parameters

Width	- width of creating image.
Height	- height of creating image.
ComponentsCount	- dimentions (components per pixel) count.
Data	- image pixel array pointer with byte size [Width * Height * ComponentsCount].

Definition at line 99 of file image.h.

                                                                      :
            Width(Width), Height(Height), ComponentsCount(ComponentsCount)
        {
            size_t size = (size_t)Width * Height * ComponentsCount;
            this->Data = new u8[size];
            memcpy(this->Data, Data, size);
        }

image() [5/5]

scl::image::image ( const std::string &  FileName )

inline

• Image constructor loading data from file.

Parameters

FileName

- image file name.

Definition at line 112 of file image.h.

        {
            this->Load(FileName);
        }

~image()

scl::image::~image ( )

inline

Image default destructor.

Definition at line 118 of file image.h.

        {
            Free();
        }

Member Function Documentation

Allocate()

void scl::image::Allocate ( )

inline

• Allocate memory for image data buffer (of current image size).

Parameters

None.

Returns

None.

Definition at line 129 of file image.h.

        {
            Data = new u8[(u64)Width * Height * ComponentsCount];
        }

FlipHorizontaly()

void scl::image::FlipHorizontaly ( )

inline

• Flip image along X axis function.

Parameters

None.

Returns

None.

Definition at line 180 of file image.h.

        {
            u32 row_size = Width * ComponentsCount;
            u8 *tmp = new u8[row_size];
            for (u64 i = 0; i < Height / 2; ++i)
            {
                std::memmove(tmp, &Data[i * row_size], row_size);
                std::memmove(&Data[i * row_size], &Data[(Height - i - 1) * row_size], row_size);
                std::memmove(&Data[(Height - i - 1) * row_size], tmp, row_size);
            }
            delete[] tmp;
        }

Free()

void scl::image::Free ( )

inline

• Free memory of image data buffer.

Parameters

None.

Returns

None.

Definition at line 140 of file image.h.

        {
            Width = Height = ComponentsCount = 0;
            if (Data != nullptr) stbi_image_free(Data);
            Data = nullptr;
        }

GetComponentsCount()

int scl::image::GetComponentsCount ( ) const

inline

Image dimentions (components per pixel) count getter function.

Definition at line 31 of file image.h.

{ return ComponentsCount; }

GetHeight()

int scl::image::GetHeight ( ) const

inline

Image height getter function.

Definition at line 29 of file image.h.

{ return Height; }

GetRawData()

const u8 * scl::image::GetRawData ( ) const

inline

Image raw data pointer getter function.

Definition at line 33 of file image.h.

{ return Data; }

GetWidth()

int scl::image::GetWidth ( ) const

inline

Image getter/setter functions.

Image width getter function.

Definition at line 27 of file image.h.

{ return Width; }

IsEmpty()

bool scl::image::IsEmpty ( ) const

inline

• Check if image container filled with pixels function.

Parameters

None.

Returns

is image empty flag.

Definition at line 41 of file image.h.

{ return Data == nullptr; }

Load()

bool scl::image::Load ( const std::string &  FileName )

inline

• Image load from file function.

Parameters

FileName

- file name to load image from.

Returns

success flag.

Definition at line 153 of file image.h.

        {
            // За каждым малоком должен быть free.... (CGSG FOREVER!!!)
            if (Data != nullptr) delete[] Data;
 
            // Load image, check if successful
            int w, h, c;
            Data = stbi_load(FileName.c_str(), &w, &h, &c, 0);
            if (Data == nullptr)
            {
                SCL_CORE_ERROR("Error during loading image from file \"{}\"!", FileName);
                Width = Height = ComponentsCount = 0;
                if (Data) stbi_image_free(Data);
                return false;
            }
 
            // If image loaded successful, set image data
            Width = w, Height = h, ComponentsCount = c;
            return true;
        }

operator=()

image & scl::image::operator= ( const image &  Other )

inline

Image copy assigment operator.

Definition at line 62 of file image.h.

        {
            if (this == &Other || Other.Data == nullptr) return *this;
            if (Data != nullptr) delete[] Data;
 
            Width = Other.Width;
            Height = Other.Height;
            ComponentsCount = Other.ComponentsCount;
 
            size_t size = (size_t)Width * Height * ComponentsCount;
            Data = new u8[size];
            memcpy(Data, Other.Data, size);
            return *this;
        }

---

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

• utilities/image/image.h