Zivid::Image< PixelFormat > Class Template Reference

A 2-dimensional image More...

#include <Zivid/Image.h>

Inheritance diagram for Zivid::Image< PixelFormat >:

Public Member Functions
	Image ()=default
	Create an empty image More...
void	save (const std::string &fileName) const
	Save the image to a file. The supported file type is PNG with extension .png. This method will throw an exception if failing to save to the provided fileName. More...
Public Member Functions inherited from Zivid::Array2D< PixelFormat >
	Array2D ()
	Create an empty Array2D More...
size_t	width () const
	Get the width of the array (number of columns) More...
size_t	height () const
	Get the height of the array (number of rows) More...
size_t	size () const
	Get the number of elements in the array More...
bool	isEmpty () const
	Check if the array is empty More...
const PixelFormat *	data () const
	Pointer to the first data element of the array More...
const PixelFormat &	operator() (size_t idx) const
	Constant reference to an element given by a 1D linear index More...
const PixelFormat &	operator() (size_t i, size_t j) const
	Constant reference to an element given by row and column More...
std::string	toString () const
	Get array information as string More...

Additional Inherited Members
Public Types inherited from Zivid::Array2D< PixelFormat >
using	ValueType = PixelFormat
	The type of the elements stored in the Array2D More...

Detailed Description

template<class PixelFormat>
class Zivid::Image< PixelFormat >

A 2-dimensional image

The type of each pixel in the image is given by template parameter PixelFormat. Currently the only supported PixelFormat is ColorRGBA.

Constructor & Destructor Documentation

Image()

template<class PixelFormat >

Zivid::Image< PixelFormat >::Image ( )

default

Create an empty image

Member Function Documentation

save()

template<class PixelFormat >

void Zivid::Image< PixelFormat >::save ( const std::string &  fileName ) const

inline

Save the image to a file. The supported file type is PNG with extension .png. This method will throw an exception if failing to save to the provided fileName.

---

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

• Zivid/Image.h