IDirect3DViewport2::NextLight

The IDirect3DViewport2::NextLight method enumerates the Direct3DLight objects associated with the viewport.

HRESULT NextLight(
  LPDIRECT3DLIGHT lpDirect3DLight,  
  LPDIRECT3DLIGHT* lplpDirect3DLight,  
  DWORD dwFlags                     
);
 

Parameters

lpDirect3DLight

Address of a light in the list of lights associated with this viewport object.

lplpDirect3DLight

Address of a pointer that will contain the requested light in the list of lights associated with this viewport object. The requested light is specified in the dwFlags parameter.

dwFlags

Flags specifying which light to retrieve from the list of lights. The default setting is D3DNEXT_NEXT.

D3DNEXT_HEAD	Retrieve the item at the beginning of the list.
D3DNEXT_NEXT	Retrieve the next item in the list.
D3DNEXT_TAIL	Retrieve the item at the end of the list.

Return Values

If the method succeeds, the return value is D3D_OK.

If the method fails, the return value may be one of the following values:

DDERR_INVALIDOBJECT
DDERR_INVALIDPARAMS

Remarks

This method is unchanged from its implementation in the IDirect3DViewport interface.

QuickInfo

  Windows NT: Use version 5.0 or later.
  Windows: Use Windows 95 or later. Available as a redistributable for Windows 95.
  Windows CE: Unsupported.
  Header: Declared in d3d.h.
  Import Library: Use ddraw.lib.