Image_PixMapData< ColorType_t > Struct Template Reference

POD template structure to access image buffer. More...

#include <Image_PixMapData.hxx>

Public Member Functions
const ColorType_t *	Data () const
ColorType_t *	ChangeData ()
const ColorType_t *	Row (const Standard_Size theRow) const
ColorType_t *	ChangeRow (const Standard_Size theRow)
const ColorType_t &	Value (const Standard_Size theRow, const Standard_Size theCol) const
ColorType_t &	ChangeValue (const Standard_Size theRow, const Standard_Size theCol)
Standard_Size	MaxRowAligmentBytes () const
	Compute the maximal row alignment for current row size. More...
Standard_Size	SizeBytes () const
Standard_Size	SizeX () const
Standard_Size	SizeY () const

Data Fields
Standard_Byte *	myDataPtr
	pointer to the data More...
Standard_Byte *	myTopRowPtr
	pointer to the topmost row (depending on scanlines order in memory) More...
Standard_Size	mySizeBPP
	bytes per pixel More...
Standard_Size	mySizeX
	width in pixels More...
Standard_Size	mySizeY
	height in pixels More...
Standard_Size	mySizeRowBytes
	number of bytes per line (in most cases equal to 3 * sizeX) More...
Standard_Size	myTopToDown
	image scanlines direction in memory from Top to the Down More...

Detailed Description

template<typename ColorType_t>
struct Image_PixMapData< ColorType_t >

POD template structure to access image buffer.

Member Function Documentation

template<typename ColorType_t>

ColorType_t* Image_PixMapData< ColorType_t >::ChangeData ( )

inline

Returns

data pointer for low-level operations (copying entire buffer, parsing with extra tools etc.).

template<typename ColorType_t>

ColorType_t* Image_PixMapData< ColorType_t >::ChangeRow ( const Standard_Size  theRow )

inline

Returns

data pointer to requested row (first column).

template<typename ColorType_t>

ColorType_t& Image_PixMapData< ColorType_t >::ChangeValue ( const Standard_Size  theRow, const Standard_Size  theCol  )

inline

Returns

data pointer to requested position.

template<typename ColorType_t>

const ColorType_t* Image_PixMapData< ColorType_t >::Data ( ) const

inline

Returns

data pointer for low-level operations (copying entire buffer, parsing with extra tools etc.).

template<typename ColorType_t>

Standard_Size Image_PixMapData< ColorType_t >::MaxRowAligmentBytes ( ) const

inline

Compute the maximal row alignment for current row size.

Returns

maximal row alignment in bytes (up to 16 bytes).

template<typename ColorType_t>

const ColorType_t* Image_PixMapData< ColorType_t >::Row ( const Standard_Size  theRow ) const

inline

Returns

data pointer to requested row (first column).

template<typename ColorType_t>

Standard_Size Image_PixMapData< ColorType_t >::SizeBytes ( ) const

inline

Returns

bytes allocated for the whole image plane.

template<typename ColorType_t>

Standard_Size Image_PixMapData< ColorType_t >::SizeX ( ) const

inline

Returns

image width in pixels

template<typename ColorType_t>

Standard_Size Image_PixMapData< ColorType_t >::SizeY ( ) const

inline

Returns

image height in pixels

template<typename ColorType_t>

const ColorType_t& Image_PixMapData< ColorType_t >::Value ( const Standard_Size  theRow, const Standard_Size  theCol  ) const

inline

Returns

data pointer to requested position.

Field Documentation

template<typename ColorType_t>

Standard_Byte* Image_PixMapData< ColorType_t >::myDataPtr

pointer to the data

template<typename ColorType_t>

Standard_Size Image_PixMapData< ColorType_t >::mySizeBPP

bytes per pixel

template<typename ColorType_t>

Standard_Size Image_PixMapData< ColorType_t >::mySizeRowBytes

number of bytes per line (in most cases equal to 3 * sizeX)

template<typename ColorType_t>

Standard_Size Image_PixMapData< ColorType_t >::mySizeX

width in pixels

template<typename ColorType_t>

Standard_Size Image_PixMapData< ColorType_t >::mySizeY

height in pixels

template<typename ColorType_t>

Standard_Byte* Image_PixMapData< ColorType_t >::myTopRowPtr

pointer to the topmost row (depending on scanlines order in memory)

template<typename ColorType_t>

Standard_Size Image_PixMapData< ColorType_t >::myTopToDown

image scanlines direction in memory from Top to the Down

---

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

• Image_PixMapData.hxx