|
ovi_GetSetFrontColor |
|---|
| ovi_GetSetFrontColor(getSet;overlayRef;frontColor ;frontColor) <- errorCode | |||
|---|---|---|---|
| Parameter | Type | Description | |
| -> | getSet | Integer | Get (0) or set (1) the parameter |
| -> | overlayRef | Long Integer | Overlay window reference |
| <-> | frontColor | Long Integer | Front color, format 0x00RRGGBB |
| <-> | frontColor | Real | Front alpha channel (from 0 to 1) |
| <- | errorCode | Long Integer | Error Code (0 = no error) |
overlayRef is a reference to an overlay window returned by ovi_NewWindow.
If getSet is 0 (constant kovi_GET), the routine returns in frontColor and frontAlpha the RGB color and alpha channel used to draw the text in the window. If getSet is 1 (constant kovi_SET), the routine sets the front color used to draw the text to frontColor and frontAlpha.
frontColor is a long integer expressed as usually in 4D, the 3 low bytes being the red, green and blue values of the color. Examples: 0x00FF0000 is " full red ", 0x0000FF00 is " Full green ", …
frontAlpha is the value of the alpha channel used to set the transparency of the text. The values must be in the range from 0 (transparent) to 1 (opaque).
Here are 3 screen shots of an overlay window that has a red backgroung with alpha channel set to 0.5. The front color is blue.