LBitmap::GetOverlayAttributes

L_INT nIndex;

/* the overlay index */

pOVERLAYATTRIBUTES pOverlayAttributes;

/* pointer to the overlay attributes structure to be updated */

L_UINT uStructSize;

/* the size of the OVERLAYATTRIBUTES structure */

L_UINT uFlags;

/* flags that determine which attributes should be retrieved */

Parameter

Description

nIndex

The index of the overlay whose attributes we want to retrieve. This index is zero-based.

pOverlayAttributes

Structure which will be filled with the overlay attributes.

uStructSize

Size of the OVERLAYATTRIBUTES structure pointed to by pOverlayAttributes - pass sizeof(OVERLAYATTRIBUTES).

uFlags

Flags that determine which attributes to retrieve. You can combine values by using a bitwise OR ( | ). Possible values are:

Value

Meaning

OVERLAYATTRIBUTES_ORIGIN

[0x0001] Retrieve the top-left position. pOverlayAttributes ->ptOrigin will be updated with the top-left offset. 

OVERLAYATTRIBUTES_COLOR

[0x0002] Retrieve the color. pOverlayAttributes ->crColor will be updated with the color.

OVERLAYATTRIBUTES_FLAGS

[0x0004] Retrieve the flags. pOverlayAttributes ->uFlags will be updated with the flags.

OVERLAYATTRIBUTES_BITINDEX

[0x0008] Retrieve the corresponding bitplane position. pOverlayAttributes-> uBitPosition will be updated with the bitplane index. 

OVERLAYATTRIBUTES_DICOM

[0x0010] Retrieve the DICOM-related attributes, this includes:

pOverlayAttributes->uRows,

pOverlayAttributes->uColumns,

pOverlayAttributes->szType,

pOverlayAttributes->uBitsAllocated,

pOverlayAttributes->szDescription,

pOverlayAttributes->szSubtype,

pOverlayAttributes->szLabel,

pOverlayAttributes->nROIArea,

pOverlayAttributes->fROIMean,

pOverlayAttributes->fROIStandardDeviation,

pOverlayAttributes->nNumFramesInOverlay,

pOverlayAttributes->uImageFrameOrigin,

pOverlayAttributes->szActivationLayer

SUCCESS

The function was successful.

< 1

An error occurred. Refer to Return Codes.

LTKRN

For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application.

Functions:

LBitmap::BricksTexture, LBitmap::Canvas, LBitmap::DisplaceMap, LBitmap::Fragment, LBitmap::Vignette, Class Members

Topics:

Raster Image Functions: Doing Geometric Transformations

Resizing Considerations

Overlay Overview