omni::Buffer< T > Struct Template Reference

A buffer holds an w x h pixel array. More...

#include <Buffer.h>

Collaboration diagram for omni::Buffer< T >:

Public Types
typedef T	pixel_type
	Our pixel type. More...
typedef std::vector< pixel_type >	data_type
	Our data type (a dynamic array) More...

Public Member Functions
	Buffer ()
	Standard constructor. More...
	Buffer (int _width, int _height)
	Constructor with automatic resize. More...
void	put (int _x, int _y, const pixel_type &_pixel)
	Write pixel value to position (x,y) More...
void	put (size_t _offset, const pixel_type &_pixel)
	Write pixel value to offset (= x * width + y) More...
pixel_type &	operator() (int _x, int _y)
	Return pixel on position (x,y) More...
pixel_type const &	operator() (int _x, int _y) const
	Return pixel on position (x,y) (const version) More...
pixel_type &	operator() (size_t _offset)
	Return pixel on offset (= x * width + y) More...
pixel_type const &	operator() (size_t _offset) const
	Return pixel on offset (= x * width + y) (const version) More...
pixel_type &	operator[] (size_t _offset)
	Subscript operator for accessing elements by index. More...
pixel_type const &	operator[] (size_t _offset) const
	Subscript operator for accessing elements by index (const version) More...
pixel_type &	pixel (int _x, int _y)
	Return pixel on position (x,y) More...
Buffer	cropRect (QRect const &_rect) const
pixel_type const &	pixel (int _x, int _y) const
	Return pixel on position (x,y) (const version) More...
pixel_type &	pixel (size_t _offset)
	Return pixel on offset (= x * width + y) More...
pixel_type const &	pixel (size_t _offset) const
	Return pixel on offset (= x * width + y) (const version) More...
int	width () const
	Return width of the buffer. More...
int	height () const
	Return height of the buffer. More...
data_type const &	data () const
	Return const reference to data. More...
void	clear ()
	Clear buffer with black color. More...
void	clear (const pixel_type &_pixel)
	Clear buffer with specific pixel. More...
bool	empty () const
	Returns true if width and height are zero. More...
size_t	size () const
	Returns size of buffer (= width * height) More...
void	resize (int _width, int _height)
	Resize buffer to given width and height. More...
QImage	toQImage () const
	Convert buffer to QImage. More...
void *	ptr ()
	Return void pointer to data. More...
void const *	ptr () const
	Return void pointer to data (const version) More...
void	toStream (QDataStream &_os) const
	Write blend mask to stream. More...
void	fromStream (QDataStream &_is)
	Read blend mask from stream. More...

Private Attributes
int	width_
int	height_
data_type	data_

Friends
bool	operator== (Buffer const &_lhs, Buffer const &_rhs)
	Test for equality, buffer is ignored. More...

Detailed Description

template<typename T>
struct omni::Buffer< T >

A buffer holds an w x h pixel array.

Member Typedef Documentation

template<typename T>

typedef std::vector<pixel_type> omni::Buffer< T >::data_type

Our data type (a dynamic array)

template<typename T>

typedef T omni::Buffer< T >::pixel_type

Our pixel type.

Constructor & Destructor Documentation

template<typename T>

omni::Buffer< T >::Buffer ( )

inline

Standard constructor.

: width_(0), height_(0) {}

template<typename T>

omni::Buffer< T >::Buffer ( int  _width, int  _height  )

inline

Constructor with automatic resize.

                                    {
      resize(_width, _height);
    }

Member Function Documentation

template<typename T>

void omni::Buffer< T >::clear ( )

inline

Clear buffer with black color.

    {
      data_ = data_type(data_.size(), 0);
    }

template<typename T>

void omni::Buffer< T >::clear ( const pixel_type &  _pixel )

inline

Clear buffer with specific pixel.

    {
      data_ = data_type(data_.size(), _pixel);
    }

template<typename T>

Buffer omni::Buffer< T >::cropRect ( QRect const &  _rect ) const

inline

    {
      Buffer _buffer(_rect.width(), _rect.height());

      for (int y = 0; y < _rect.height(); ++y)
        for (int x = 0; x < _rect.width(); ++x)
        {
          _buffer(x, y) = pixel(x + _rect.x(), y + _rect.y());
        }

      return _buffer;
    }

template<typename T>

data_type const& omni::Buffer< T >::data ( ) const

inline

Return const reference to data.

    {
      return data_;
    }

template<typename T>

bool omni::Buffer< T >::empty ( ) const

inline

Returns true if width and height are zero.

    {
      return data_.empty();
    }

template<typename T>

void omni::Buffer< T >::fromStream ( QDataStream &  _is )

inline

Read blend mask from stream.

                                      {
      deserialize(_is, width_);
      deserialize(_is, height_);
      deserialize(_is, data_);
    }

template<typename T>

int omni::Buffer< T >::height ( ) const

inline

Return height of the buffer.

    {
      return height_;
    }

template<typename T>

pixel_type& omni::Buffer< T >::operator() ( int  _x, int  _y  )

inline

Return pixel on position (x,y)

    {
      return pixel(_x, _y);
    }

template<typename T>

pixel_type const& omni::Buffer< T >::operator() ( int  _x, int  _y  ) const

inline

Return pixel on position (x,y) (const version)

    {
      return pixel(_x, _y);
    }

template<typename T>

pixel_type& omni::Buffer< T >::operator() ( size_t  _offset )

inline

Return pixel on offset (= x * width + y)

    {
      return pixel(_offset);
    }

template<typename T>

pixel_type const& omni::Buffer< T >::operator() ( size_t  _offset ) const

inline

Return pixel on offset (= x * width + y) (const version)

    {
      return pixel(_offset);
    }

template<typename T>

pixel_type& omni::Buffer< T >::operator[] ( size_t  _offset )

inline

Subscript operator for accessing elements by index.

                                           {
      return pixel(_offset);
    }

template<typename T>

pixel_type const& omni::Buffer< T >::operator[] ( size_t  _offset ) const

inline

Subscript operator for accessing elements by index (const version)

                                                       {
      return pixel(_offset);
    }

template<typename T>

pixel_type& omni::Buffer< T >::pixel ( int  _x, int  _y  )

inline

Return pixel on position (x,y)

    {
      return pixel(_y * width() + _x);
    }

template<typename T>

pixel_type const& omni::Buffer< T >::pixel ( int  _x, int  _y  ) const

inline

Return pixel on position (x,y) (const version)

    {
      return pixel(_y * width() + _x);
    }

template<typename T>

pixel_type& omni::Buffer< T >::pixel ( size_t  _offset )

inline

Return pixel on offset (= x * width + y)

                                      {
      return data_[_offset];
    }

template<typename T>

pixel_type const& omni::Buffer< T >::pixel ( size_t  _offset ) const

inline

Return pixel on offset (= x * width + y) (const version)

                                                  {
      return data_[_offset];
    }

template<typename T>

void* omni::Buffer< T >::ptr ( )

inline

Return void pointer to data.

    {
      return static_cast<void *>(data_.data());
    }

template<typename T>

void const* omni::Buffer< T >::ptr ( ) const

inline

Return void pointer to data (const version)

    {
      return static_cast<void const*>(data_.data());
    }

template<typename T>

void omni::Buffer< T >::put ( int  _x, int  _y, const pixel_type &  _pixel  )

inline

Write pixel value to position (x,y)

    {
      put(_y * width() + _x, _pixel);
    }

template<typename T>

void omni::Buffer< T >::put ( size_t  _offset, const pixel_type &  _pixel  )

inline

Write pixel value to offset (= x * width + y)

    {
      data_[_offset] = _pixel;
    }

template<typename T>

void omni::Buffer< T >::resize ( int  _width, int  _height  )

inline

Resize buffer to given width and height.

    {
      if (_width * _height <= 0) return;

      width_  = _width;
      height_ = _height;
      data_.resize(width_ * height_);
    }

template<typename T>

size_t omni::Buffer< T >::size ( ) const

inline

Returns size of buffer (= width * height)

                        {
      return data_.size();
    }

template<typename T>

QImage omni::Buffer< T >::toQImage ( ) const

inline

Convert buffer to QImage.

    {
      QImage _output(width(), height(), QImage::Format_RGB32);

      for (int y = 0; y < height(); ++y)
        for (int x = 0; x < width(); ++x)
        {
          auto _p = pixel(x, y);
          _output.setPixel(x, y, convertPixel<QColor>(_p).rgb());
        }

      return _output;
    }

template<typename T>

void omni::Buffer< T >::toStream ( QDataStream &  _os ) const

inline

Write blend mask to stream.

                                          {
      serialize(_os, width_);
      serialize(_os, height_);
      serialize(_os, data_);
    }

template<typename T>

int omni::Buffer< T >::width ( ) const

inline

Return width of the buffer.

    {
      return width_;
    }

Friends And Related Function Documentation

template<typename T>

bool operator== ( Buffer< T > const &  _lhs, Buffer< T > const &  _rhs  )

friend

Test for equality, buffer is ignored.

                                                                   {
      return
        OMNI_TEST_MEMBER_EQUAL(width_) &&
        OMNI_TEST_MEMBER_EQUAL(height_) &&
        OMNI_TEST_MEMBER_EQUAL(data_);
    }

Field Documentation

template<typename T>

data_type omni::Buffer< T >::data_

private

template<typename T>

int omni::Buffer< T >::height_

private

template<typename T>

int omni::Buffer< T >::width_

private

---

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

• include/omni/Buffer.h