RVC::OPACITYMASK::MAKEPARMS Class Reference

Class to handle values needed to define the characteristics of a opacity mask. More...

#include <rvc/opacitymask.h>

List of all members.

Public Member Functions
	MAKEPARMS (IMAGE::CELLTYPE CellType=IMAGE::CELLTYPE_Unsigned_8, RASTER::COMPTYPE CompType=RASTER::COMPTYPE_None, UINT8 InitialValue=255)
IMAGE::CELLTYPE	GetCellType () const
RASTER::COMPTYPE	GetCompressionType () const
UINT8	GetInitialValue () const
void	SetCellType (CELLTYPE CellType)
void	SetCompression (RASTER::COMPTYPE CompType)
void	SetInitialValue (UINT8 InitValue)

---

Detailed Description

Class to handle values needed to define the characteristics of a opacity mask.

---

Constructor & Destructor Documentation

RVC::OPACITYMASK::MAKEPARMS::MAKEPARMS	(	IMAGE::CELLTYPE	CellType = IMAGE::CELLTYPE_Unsigned_8,
		RASTER::COMPTYPE	CompType = RASTER::COMPTYPE_None,
		UINT8	InitialValue = 255
	)

Constructor.

---

Member Function Documentation

IMAGE::CELLTYPE RVC::OPACITYMASK::MAKEPARMS::GetCellType

(

)

const [inline]

Obtain image cell type.

Returns:

RVC::IMAGE::CELLTYPE for the opacity mask.

RASTER::COMPTYPE RVC::OPACITYMASK::MAKEPARMS::GetCompressionType

(

)

const [inline]

Obtain raster compression type.

Returns:

RVC::RASTER::COMPTYPE for the raster.

UINT8 RVC::OPACITYMASK::MAKEPARMS::GetInitialValue

(

)

const [inline]

Get initial value.

void RVC::OPACITYMASK::MAKEPARMS::SetCellType

(

CELLTYPE

CellType

)

Set image cell type.

Use IMAGE::CELLTYPE_Binary for 1 = Opaque, 0 = Transparent Use IMAGE::CELLTYPE_Unsigned_8 for 255 = Opaque -> 0 = Transparent

void RVC::OPACITYMASK::MAKEPARMS::SetCompression

(

RASTER::COMPTYPE

CompType

)

Set raster compression values.

Parameters:

CompType

Raster compression type

void RVC::OPACITYMASK::MAKEPARMS::SetInitialValue

(

UINT8

InitValue

)

[inline]

Set initial value.

If not set will make all opaque.

---

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

• rvc/opacitymask.h