Blt
Expand Minimize

SetLight routine

The SetLight function sets properties for a light source.

Syntax


PFND3DDDI_SETLIGHT SetLight;

__checkReturn HRESULT APIENTRY SetLight(
  _In_  HANDLE hDevice,
  _In_  const D3DDDIARG_SETLIGHT *pData,
  _In_  const D3DDDI_LIGHT *pLightProperties
)
{ ... }

Parameters

hDevice [in]

A handle to the display device (graphics context).

pData [in]

A pointer to a D3DDDIARG_SETLIGHT structure that describes how to set the light source.

pLightProperties [in]

A pointer to a D3DDDI_LIGHT structure that describes the light properties to set.

Return value

SetLight returns S_OK or an appropriate error result if the light properties are not successfully set.

Remarks

Light properties describe the type and color of a light source. Depending on the type of light that is being used, a light can have properties for attenuation and range or for spotlight effects. However, not all types of lights will use all of the properties. For more information about light properties, see the Microsoft Windows SDK documentation.

Requirements

Version

Available in Windows Vista and later versions of the Windows operating systems.

Header

D3dumddi.h (include D3dumddi.h)

See also

D3DDDIARG_SETLIGHT
D3DDDI_LIGHT
D3DDDI_DEVICEFUNCS

 

 

Send comments about this topic to Microsoft

Show:
© 2014 Microsoft