PFND3DDDI_SETLIGHT callback function (d3dumddi.h)

Article
02/22/2024

The SetLight function sets properties for a light source.

Syntax

PFND3DDDI_SETLIGHT Pfnd3dddiSetlight;

HRESULT Pfnd3dddiSetlight(
  [in] HANDLE hDevice,
       const D3DDDIARG_SETLIGHT *unnamedParam2,
       const D3DDDI_LIGHT *unnamedParam3
)
{...}

Parameters

[in] hDevice

A handle to the display device (graphics context).

unnamedParam2

pData [in]

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

unnamedParam3

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

Requirement	Value
Minimum supported client	Available in Windows Vista and later versions of the Windows operating systems.
Target Platform	Desktop
Header	d3dumddi.h (include D3dumddi.h)