L_VecSetUseLights

#include "lvkrn.h"

L_INT EXT_FUNCTION L_VecSetUseLights(pVector, bUseLights)

pVECTORHANDLE pVector;

/* pointer to a vector handle */

L_BOOL bUseLights;

/* flag that indicates whether to enable or disable the use of lights */

Enables or disables using lights when drawing a vector handle.

Parameter

Description

pVector

Pointer to a vector handle.

bUseLights

Flag that indicates whether or not to use lights when drawing the vector handle. Possible values are:

 

Value

Meaning

 

TRUE

Use lights when drawing a vector handle.

 

FALSE

Do not use lights when drawing a vector handle.

Returns

SUCCESS

The function was successful.

< 1

An error occurred. Refer to Return Codes.

Comments

If the use of lights is disabled, ambient light will have no effect on how the image is drawn.

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:

L_VecGetUseLights, L_VecSetAmbientColor, L_VecGetAmbientColor

Example

/* This example will toggle light use for a vector handle */

void ToggleUseLights( pVECTORHANDLE pVector )
{
   if( !L_VecGetUseLights( pVector ) )
      L_VecSetUseLights( pVector, TRUE );
   else
      L_VecSetUseLights( pVector, FALSE );
}