virtual L_INT LBitmap::GetOverlayAttributes(nIndex, pOverlayAttributes, uStructSize, uFlags)
Gets one or more overlay attributes for a certain index.
The index of the overlay whose attributes we want to retrieve. This index is zero-based.
Structure which will be filled with the overlay attributes.
Size of the OVERLAYATTRIBUTES structure pointed to by pOverlayAttributes - pass sizeof(OVERLAYATTRIBUTES).
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 |
Value | Meaning |
---|---|
SUCCESS | The function was successful. |
< 1 | An error occurred. Refer to Return Codes. |
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.
Win32, x64.
For an example, refer to LBitmap::SetOverlayAttributes.
Help Collections
Raster .NET | C API | C++ Class Library | HTML5 JavaScript
Document .NET | C API | C++ Class Library | HTML5 JavaScript
Medical .NET | C API | C++ Class Library | HTML5 JavaScript
Medical Web Viewer .NET
Multimedia
Direct Show .NET | C API | Filters
Media Foundation .NET | C API | Transforms
Supported Platforms
.NET, Java, Android, and iOS/macOS Assemblies
Imaging, Medical, and Document
C API/C++ Class Libraries
Imaging, Medical, and Document
HTML5 JavaScript Libraries
Imaging, Medical, and Document