|
ovi_GetSetBackColor |
|---|
| ovi_GetSetBackColor(getSet;overlayRef;backColor ;backAlpha) <- errorCode | |||
|---|---|---|---|
| Parameter | Type | Description | |
| -> | getSet | Integer | Get (0) or set (1) the parameter |
| -> | overlayRef | Long Integer | Overlay window reference |
| <-> | backColor | Long Integer | Back color, format 0x00RRGGBB |
| <-> | backAlpha | Real | Back 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 backColor and backAlpha the RGB color and alpha channel used to paint the background of the window. If getSet is 1 (constant kovi_SET), the routine sets the background of the window to backColor with backAlph.
backColor 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 ", …
backAlpha is the value of the alpha channel used to set the transparency of the window. 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, to 0.5 and to 1. The front color used is blue, and we put a white document behind the windows.