AOI_Object_Bitmap Class Reference

BitmapT container. More...

Public Member Functions
void	GetBitmapData (AOI_Bitmap &) const
void	GetMaskRange (uint16_t[MAX_CHANNELS], uint16_t[MAX_CHANNELS]) const
AOI_Object_Bitmap *	GetMaskImage () const
MaskType	GetMaskType () const
uint16_t	GetMaskMin (uint16_t) const
uint16_t	GetMaskMax (uint16_t) const
void	RemoveMask ()
AOI_ColorSpacePtr	GetColorSpace () const
void	OpenImageData () const
void	CloseImageData () const
bool	GetImageData (uint32_t startLine, uint32_t count, void *outData) const
float	GetPixel (int32_t, int32_t, AOI_Color &) const

Detailed Description

BitmapT container.

Definition at line 22 of file AOI_Bitmap.h.

Member Function Documentation

CloseImageData()

void AOI_Object_Bitmap::CloseImageData

(

)

const

Closes the image for direct pixel access and stores modifications. After this call rendering calls are allowed again. Every Open needs to be paired with a Close.

See also

OpenImageData, GetPixel, GetImageData

Definition at line 136 of file AOI_Bitmap.cpp.

GetBitmapData()

void AOI_Object_Bitmap::GetBitmapData

(

AOI_Bitmap &

inBit

)

const

Retrieves the specifications of the image contained in this BitmapT object.

Parameters

inBit

AOI_Bitmap structure that will receive the details of the bitmap.

See also

AOI_Bitmap

Definition at line 21 of file AOI_Bitmap.cpp.

GetColorSpace()

AOI_ColorSpacePtr AOI_Object_Bitmap::GetColorSpace

(

)

const

Retrieves the colorspace of the image.

/return Pointer to an AOI_ColorSpace object that defines to colorspace.

Definition at line 112 of file AOI_Bitmap.cpp.

GetImageData()

bool AOI_Object_Bitmap::GetImageData	(	uint32_t	startLine,
		uint32_t	count,
		void *	outData ) const

Retrieves raw image data. The caller must supply a buffer large enough to hold the raw image data. The size of the buffer must be: image-width * lines * bytes per pixel. Information about the raw image format can be retrieved using GetBitmapData. The image must be opened before this call can be executed.

Parameters

startLine	First line to retrieve. 0 based.
count	Number of image lines to retrieve. Mimumum 1 and maximum: image-height - startLine
outData	Buffer to receive the raw image data.

Returns

True if successfull. False if failed.

See also

OpenImageData, CloseImageData, GetBitmapData, GetPixel

Definition at line 170 of file AOI_Bitmap.cpp.

GetMaskImage()

AOI_Object_Bitmap * AOI_Object_Bitmap::GetMaskImage

(

)

const

Retrieves the image that defines the alpha channel of the image. The mask/alpha image does not need to be the same resolution and/or bit depth.

Returns

Pointer to the AOI_Object_Bitmap that holds the mask/alpha image.

Definition at line 54 of file AOI_Bitmap.cpp.

GetMaskMax()

uint16_t AOI_Object_Bitmap::GetMaskMax

(

uint16_t

idx

)

const

Retrieves the range of colors that are masked and will be transparent. For each channel a minimum and maximum is defined. When all channels of a bitmap are in the per channel ranges then the pixel is considered transparent and will result in an alpha=0.

Parameters

idx	Channel from which the range maximum to retrieve.

Returns

Maximum of the range defined for the given channel.

See also

GetMaskRange, GetMaskMin

Definition at line 94 of file AOI_Bitmap.cpp.

GetMaskMin()

uint16_t AOI_Object_Bitmap::GetMaskMin

(

uint16_t

idx

)

const

Retrieves the range of colors that are masked and will be transparent. For each channel a minimum and maximum is defined. When all channels of a bitmap are in the per channel ranges then the pixel is considered transparent and will result in an alpha=0.

Parameters

idx	Channel from which the range mimumum to retrieve.

Returns

Minimum of the range defined for the given channel.

See also

GetMaskRange, GetMaskMax

Definition at line 79 of file AOI_Bitmap.cpp.

GetMaskRange()

void AOI_Object_Bitmap::GetMaskRange	(	uint16_t	min[MAX_CHANNELS],
		uint16_t	max[MAX_CHANNELS] ) const

Retrieves the range of colors that are masked and will be transparent. For each channel a minimum and maximum is defined. When all channels of a bitmap are in the per channel ranges then the pixel is considered transparent and will result in an alpha=0

Parameters

min	Array to receive the range mimimum per channel.
max	Array to receive the range maximum per channel.

See also

GetMaskMin, GetMaskMax

Definition at line 42 of file AOI_Bitmap.cpp.

GetMaskType()

AOI_Object_Bitmap::MaskType AOI_Object_Bitmap::GetMaskType

(

)

const

Gets the mask/alpha type used by this image.

Returns

MaskType used.

Definition at line 64 of file AOI_Bitmap.cpp.

GetPixel()

float AOI_Object_Bitmap::GetPixel	(	int32_t	x,
		int32_t	y,
		AOI_Color &	color ) const

Retrieves the color information of a pixel at the given coordinates. The image must be opened before this call can be executed.

Parameters

x	x-coordinate of the pixel defined in pixels
y	y-coordinate of the pixel defined in pixels
color	AOI_Color structure that receives the pixel color info

Returns

Opacity of the pixel where 0 is transparent and 1 is opaque

See also

OpenImageData, CloseImageData, GetImageData

Definition at line 151 of file AOI_Bitmap.cpp.

OpenImageData()

void AOI_Object_Bitmap::OpenImageData

(

)

const

Opens the image for direct pixel access (read and write). While the image is open no rendering calls are to be done as the image is in an intermediate state. Every Open needs to be paired with a Close.

See also

CloseImageData, GetPixel, GetImageData

Definition at line 124 of file AOI_Bitmap.cpp.

RemoveMask()

void AOI_Object_Bitmap::RemoveMask

(

)

Removes any mask from the current image.

Definition at line 102 of file AOI_Bitmap.cpp.

---

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

• C:/Environments/desktop/Source/PDFEngine/OpenAPI/AOI_Bitmap.h
• C:/Environments/desktop/Source/PDFEngine/OpenAPI/AOI_Bitmap.cpp