SPATMOD::IMAGE::PIXELTABLE Class Reference

Image pixel table. More...

#include <spatmod/imagepixeltable.h>

List of all members.

Public Member Functions
	PIXELTABLE (const PIXELTABLE &rhs)
	PIXELTABLE ()
	~PIXELTABLE ()
ERRVALUE	Create (const COLOR *colors, INT32 NumItems)
ERRVALUE	Create (const PIXEL &PixelProperties, UINT32 NumItems)
void	Exchange (PIXELTABLE &other)
ERRVALUE	GetColors (COLOR_ARRAY &Colors) const
ERRVALUE	GetItem (UINT32 index, PIXEL &value) const
UINT32	GetNumItems () const
const PIXEL &	GetPixelProperties () const
const void *	GetPtrItem (UINT16 SampleIdx, UINT32 ItemIndex) const
SAMPLETABLE &	GetSampleTable (UINT16 SampleIdx)
const SAMPLETABLE &	GetSampleTable (UINT16 SampleIdx) const
ERRVALUE	SetAllItems (const PIXEL &value)
ERRVALUE	SetItem (UINT32 index, const PIXEL &value)

---

Detailed Description

Image pixel table.

---

Constructor & Destructor Documentation

SPATMOD::IMAGE::PIXELTABLE::PIXELTABLE

(

)

Default constructor.

SPATMOD::IMAGE::PIXELTABLE::PIXELTABLE

(

const PIXELTABLE &

rhs

)

Copy constructor.

SPATMOD::IMAGE::PIXELTABLE::~PIXELTABLE

(

)

Destructor.

---

Member Function Documentation

ERRVALUE SPATMOD::IMAGE::PIXELTABLE::Create	(	const COLOR *	colors,
		INT32	NumItems
	)

Create from COLOR array.

If any color in array uses transparency the pixel type will be TYPE_RGBA, otherwise the pixel type will be TYPE_RGB. The data type will be DATATYPE_UINT8.

Parameters:

	colors	Array of colors
	NumItems	Number of array entries

ERRVALUE SPATMOD::IMAGE::PIXELTABLE::Create	(	const PIXEL &	PixelProperties,
		UINT32	NumItems
	)

Create pixel table.

Will also set all items to value specified by properties.

Parameters:

	PixelProperties	Pixel properties
	NumItems	Number of table items

void SPATMOD::IMAGE::PIXELTABLE::Exchange

(

PIXELTABLE &

other

)

Exchange data with another PIXELTABLE.

Parameters:

other

Pixel table to exchange with

ERRVALUE SPATMOD::IMAGE::PIXELTABLE::GetColors

(

COLOR_ARRAY &

Colors

)

const

Get colors as array.

Error will be returned if cannot convert.

Parameters:

Colors

Array of colors returned

ERRVALUE SPATMOD::IMAGE::PIXELTABLE::GetItem	(	UINT32	index,
		PIXEL &	value
	)			const

Get item from table.

Parameters:

	index	Index in table
	value	Pixel value returned

UINT32 SPATMOD::IMAGE::PIXELTABLE::GetNumItems

(

)

const

Get number of items in table.

const PIXEL& SPATMOD::IMAGE::PIXELTABLE::GetPixelProperties

(

)

const [inline]

Get pixel properties.

const void* SPATMOD::IMAGE::PIXELTABLE::GetPtrItem	(	UINT16	SampleIdx,
		UINT32	ItemIndex
	)			const [inline]

Get pointer to single item.

For efficiency should not be used in pixel processing loops.

SAMPLETABLE& SPATMOD::IMAGE::PIXELTABLE::GetSampleTable

(

UINT16

SampleIdx

)

[inline]

Get reference to sample table (non-const).

Parameters:

SampleIdx

Sample index

const SAMPLETABLE& SPATMOD::IMAGE::PIXELTABLE::GetSampleTable

(

UINT16

SampleIdx

)

const [inline]

Get reference to sample table.

Parameters:

SampleIdx

Sample index

ERRVALUE SPATMOD::IMAGE::PIXELTABLE::SetAllItems

(

const PIXEL &

value

)

Set all items to same value.

Parameters:

value

Pixel value to set

ERRVALUE SPATMOD::IMAGE::PIXELTABLE::SetItem	(	UINT32	index,
		const PIXEL &	value
	)

Set table item with index and property validation.

Parameters:

	index	Index in table
	value	Pixel value to set

---

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

• spatmod/imagepixeltable.h