IDirect3DViewport3::DeleteLight

The IDirect3DViewport3::DeleteLight method removes the specified light from the list of Direct3DLight objects associated with this viewport, and decrements the reference count for the light object.

HRESULT DeleteLight(
  LPDIRECT3DLIGHT lpDirect3DLight  
);
 

Parameters

lpDirect3DLight
Address of the IDirect3DLight interface for the light that should be disassociated with this viewport.

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 IDirect3DViewport2 interface.

QuickInfo

  Windows NT/2000: Requires Windows 2000.
  Windows 95/98: Requires Windows 95 or later. Available as a redistributable for Windows 95.
  Header: Declared in d3d.h.
  Import Library: Use ddraw.lib.