LBitmap::GetOverlayAttributes (original) (raw)
Summary
Gets one or more overlay attributes for a certain index.
Syntax
#include "ltwrappr.h"
virtual L_INT LBitmap::GetOverlayAttributes(nIndex, pOverlayAttributes, uStructSize, uFlags)
Parameters
L_INT nIndex
The index of the overlay whose attributes we want to retrieve. This index is zero-based.
pOVERLAYATTRIBUTES pOverlayAttributes
Structure which will be filled with the overlay attributes.
L_UINT uStructSize
Size of the OVERLAYATTRIBUTES structure pointed to by pOverlayAttributes - pass sizeof(OVERLAYATTRIBUTES).
L_UINT 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 |
Returns
| Value | Meaning |
|---|---|
| SUCCESS | The function was successful. |
| < 1 | An error occurred. Refer to Return Codes. |
Comments
One or more overlay attributes will be retrieved. Their values will be stored in the structure pointed by pOverlayAttributes. pOverlayAttributes ->uStructSize will be set to the value of the parameter uStructSize. Only uStructSize and the values retrieved by the function will be set. The other values are left unchanged.
Required DLLs and Libraries
- 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.
Platforms
Win32, x64.
See Also
Functions
- LBitmap::BricksTexture
- LBitmap::Canvas
- LBitmap::DisplaceMap
- LBitmap::Fragment
- LBitmap::Vignette
- Class Members
Topics
Example
For an example, refer to LBitmap::SetOverlayAttributes.
LEADTOOLS Raster Imaging C++ Class Library Help