#include "l_bitmap.h"
L_LTANN_API L_INT L_AnnGetTransparent(hObject, pbTransparent)
HANNOBJECT hObject; |
/* handle of the annotation object*/ |
L_BOOL *pbTransparent; |
/* address of the variable to be updated */ |
Gets a value indicating whether the bitmap stamp is using a transparent color.
Parameter |
Description |
|
hObject |
Handle of the annotation object |
|
pbTransparent |
Address of the variable to be updated with a value indicating whether the bitmap stamp is transparent. Possible values are: |
|
|
Value |
Meaning |
|
TRUE |
The bitmap stamp is using a transparent color. |
|
FALSE |
The bitmap stamp is not using a transparent color. |
Returns
SUCCESS |
The function was successful. |
< 1 |
An error occurred. Refer to Return Codes. |
Comments
Gets a value indicating whether the bitmap is using a transparent color. A transparent color is not painted when the image is painted.
The L_AnnGetTransparent function is valid only for the following object types when they are using a bitmap:
Point
Stamp (including the Rubber Stamp tools)
In addition, the Automation object stores transparency settings along with the other object default settings.
Call the L_AnnSetTransparent function to set such objects to use a transparent color. By default the transparent color is white (0x00FFFFFF). Call the L_AnnSetTransparentColor function to set the color to be used as the transparent color. Call the L_AnnGetTransparent function to get a value that indicates whether the bitmap being used by the annotation object is using a transparent color. Call the L_AnnGetTransparentColor function to get a value that indicates which color is being used as the transparent color.
Required DLLs and Libraries
LTANN For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application. |
Win32, x64.
See Also
Example
For an example, refer to L_AnnSetTransparent.