LVectorBase::GetAmbientColor
#include "ltwrappr.h"
virtual L_INT LVectorBase::GetAmbientColor(pColor)
L_COLOR L_FAR *pColor; |
/* pointer to a variable to be updated */ |
Gets the ambient (room) light used when drawing a vector image.
Parameter |
Description |
pColor |
Pointer to an L_COLOR variable to be updated with the ambient light. |
Returns
SUCCESS |
The function was successful. |
< 1 |
An error occurred. Refer to Return Codes. |
Comments
This function will only be effective if the use of lights has been enabled using LVectorBase::SetUseLights.
The default ambient light is white (RGB(255, 255, 255)).
This function has no effect in the GDI engine.
Required DLLs and Libraries
LVKRN For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application. |
See Also
Functions: |
LVectorBase::SetAmbientColor, LVectorBase::SetUseLights, LVectorBase::GetUseLights, LVectorBase::SetEngine |
Topics: |
|
|
Example
For an example, refer to LVectorBase::SetAmbientColor.