sal3d::Frame::Plane< T > Class Template Reference

Access to pixel values in a plane. More...

#include <Frame.hpp>

List of all members.

Public Member Functions
	Plane (const Frame &f, int plane)
	Constructor from a given Frame.
int	width () const
	Width of the referred Frame.
int	height () const
	Height of the referred Frame.
const Row	operator[] (int y) const
	A const Row accessor to the Frame.
Row	operator[] (int y)
	A Row accessor to the Frame.
const T &	pixel (int x, int y) const
	Access pixel values of the plane, read only.
T &	pixel (int x, int y)
	Access pixel values of the plane.

---

Detailed Description

template<typename T>
class sal3d::Frame::Plane< T >

Access to pixel values in a plane.

This class offers read and write access to pixels of a Frame, of the data type mandated by the template.

Objects of this class do not include a reference to the referred Frame, so the user should keep the Frame in memory while using related Plane objects.

Traversing all the pixels in a plane can be done with efficient creating a Plane object from a Frame, iterating over rows creating Row objects, and then iterating inside each Row.

---

Constructor & Destructor Documentation

template<typename T >

sal3d::Frame::Plane< T >::Plane	(	const Frame &	f,
		int	plane
	)		[inline]

Constructor from a given Frame.

Get the Plane accessor to a given plane of a Frame

References sal3d::Frame::height(), sal3d::Frame::vpa(), and sal3d::Frame::width().

---

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

• Frame.hpp