All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages
Radiant::VideoImage::Plane Class Reference

Holds the data for one image plane. More...

#include <Radiant/VideoImage.hpp>

Public Member Functions

void freeMemory ()
 Frees the memory associated with the plane.
 
unsigned char * line (int y)
 Get a line from the image. More...
 
const unsigned char * line (int y) const
 Get a line from the image. More...
 
 Plane ()
 Constructor.
 
void set (unsigned char *data, int linesize, PlaneType type)
 Makes a shallow copy of the data. More...
 

Public Attributes

unsigned char * m_data
 Pointer to the data.
 
int m_linesize
 Line size (interval)
 
PlaneType m_type
 Plane contents.
 

Detailed Description

Holds the data for one image plane.

See Also
VideoImage

Member Function Documentation

unsigned char* Radiant::VideoImage::Plane::line ( int  y)
inline

Get a line from the image.

Parameters
yIndex of line
Returns
Pointer to the beginning of the line
const unsigned char* Radiant::VideoImage::Plane::line ( int  y) const
inline

Get a line from the image.

Parameters
yIndex of line
Returns
Pointer to the beginning of the line
void Radiant::VideoImage::Plane::set ( unsigned char *  data,
int  linesize,
PlaneType  type 
)
inline

Makes a shallow copy of the data.

Parameters
dataPointer to copy
linesizeLinesize of the copied date
typeType of the plane