png::packed_pixel_row< pixel > Class Template Reference

The packed pixel row class template. More...

#include <pixel_buffer.hpp>

List of all members.

Public Types
typedef detail::const_packed_pixel_proxy < pixel >	const_pixel_proxy
	The immutable packed pixel proxy type.
typedef detail::packed_pixel_proxy < pixel >	pixel_proxy
	The mutable packed pixel proxy type.
Public Member Functions
	packed_pixel_row (size_t size=0)
	Constructs a pixel row object for size packed pixels.
size_t	size () const
void	resize (size_t size)
	Resizes the pixel row to hold up to size packed pixels.
const_pixel_proxy	at (size_t index) const
	Returns an immutable proxy the to the pixel at index.
pixel_proxy	at (size_t index)
	Returns a mutable proxy the to the pixel at index.
const_pixel_proxy	operator[] (size_t index) const
	Returns an immutable proxy the to the pixel at index. The non-checking version.
pixel_proxy	operator[] (size_t index)
	Returns n mutable proxy the to the pixel at index. The non-checking version.
byte *	get_data ()
	Returns the starting address of the row.

---

Detailed Description

template<class pixel>
class png::packed_pixel_row< pixel >

The packed pixel row class template.

Stores the pixel row as a std::vector of byte-s, providing access to individual packed pixels via proxy objects.

---

Member Typedef Documentation

template<class pixel>

typedef detail::const_packed_pixel_proxy< pixel > png::packed_pixel_row< pixel >::const_pixel_proxy

The immutable packed pixel proxy type.

template<class pixel>

typedef detail::packed_pixel_proxy< pixel > png::packed_pixel_row< pixel >::pixel_proxy

The mutable packed pixel proxy type.

---

Constructor & Destructor Documentation

template<class pixel>

png::packed_pixel_row< pixel >::packed_pixel_row

(

size_t

size = 0

)

[inline, explicit]

Constructs a pixel row object for size packed pixels.

References png::packed_pixel_row< pixel >::resize(), and png::packed_pixel_row< pixel >::size().

---

Member Function Documentation

template<class pixel>

size_t png::packed_pixel_row< pixel >::size

(

)

const [inline]

Referenced by png::packed_pixel_row< pixel >::packed_pixel_row(), and png::basic_pixel_buffer< packed_index_pixel< bits >, packed_pixel_row< packed_index_pixel< bits > > >::put_row().

template<class pixel>

void png::packed_pixel_row< pixel >::resize

(

size_t

size

)

[inline]

Resizes the pixel row to hold up to size packed pixels.

Referenced by png::packed_pixel_row< pixel >::packed_pixel_row().

template<class pixel>

const_pixel_proxy png::packed_pixel_row< pixel >::at

(

size_t

index

)

const [inline]

Returns an immutable proxy the to the pixel at index.

Referenced by png::basic_pixel_buffer< packed_index_pixel< bits >, packed_pixel_row< packed_index_pixel< bits > > >::get_pixel(), and png::basic_pixel_buffer< packed_index_pixel< bits >, packed_pixel_row< packed_index_pixel< bits > > >::set_pixel().

template<class pixel>

pixel_proxy png::packed_pixel_row< pixel >::at

(

size_t

index

)

[inline]

Returns a mutable proxy the to the pixel at index.

template<class pixel>

const_pixel_proxy png::packed_pixel_row< pixel >::operator[]

(

size_t

index

)

const [inline]

Returns an immutable proxy the to the pixel at index. The non-checking version.

template<class pixel>

pixel_proxy png::packed_pixel_row< pixel >::operator[]

(

size_t

index

)

[inline]

Returns n mutable proxy the to the pixel at index. The non-checking version.

template<class pixel>

byte* png::packed_pixel_row< pixel >::get_data

(

)

[inline]

Returns the starting address of the row.

Referenced by png::row_traits< packed_pixel_row< pixel > >::get_data().

---

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

• pixel_buffer.hpp