Gets one or more overlay attributes for the specified index.
#include "l_bitmap.h"
L_LTKRN_API L_INT L_GetOverlayAttributes(pBitmap, nIndex, pOverlayAttributes, uStructSize, uFlags)
Pointer to the bitmap handle referencing the main bitmap.
The index of the overlay for which to get the attributes. This index is zero-based.
Pointer to the structure to be updated with the specified overlay attributes.
Size of the OVERLAYATTRIBUTES structure pointed to by pOverlayAttributes
. Pass sizeof(OVERLAYATTRIBUTES).
Flags that determine which attributes to retrieve. You can or these flags. Possible values are:
Value | Meaning |
---|---|
OVERLAYATTRIBUTES_ORIGIN | [0x0001] The top-left position should be retrieved. pOverlayAttributes ->ptOrigin will be updated with the top-left offset. |
OVERLAYATTRIBUTES_COLOR | [0x0002] Indicates the color should be retrieved. pOverlayAttributes->crColor will be updated with the color. |
OVERLAYATTRIBUTES_FLAGS | [0x0004] Indicates the flags should be retrieved. pOverlayAttributes->uFlags will be updated with the flags. |
OVERLAYATTRIBUTES_BITINDEX | [0x0008] Indicates the corresponding bitplane position should be retrieved. pOverlayAttributes-> uBitPosition will be updated with the bitplane index. |
OVERLAYATTRIBUTES_DICOM | [0x0010] Indicates that the DICOM-related attributes should be retrieved, 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. |
The retrieved values will be stored in the structure pointed by pOverlayAttributes
. pOverlayAttributes->uStructSize will be set to the value of the parameter uStructSize
. Only the uStructSize member of pOverlayAttributes and the values retrieved by the function will be updated. The other values are left unchanged.
Win32, x64, Linux.
For an example, refer to L_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
Your email has been sent to support! Someone should be in touch! If your matter is urgent please come back into chat.
Chat Hours:
Monday - Friday, 8:30am to 6pm ET
Thank you for your feedback!
Please fill out the form again to start a new chat.
All agents are currently offline.
Chat Hours:
Monday - Friday
8:30AM - 6PM EST
To contact us please fill out this form and we will contact you via email.