IDirect3D2::CreateLight

The IDirect3D2::CreateLight method allocates a Direct3DLight object. This object can then be associated with a viewport by using the IDirect3DViewport2::AddLight method.

HRESULT CreateLight(
  LPDIRECT3DLIGHT* lplpDirect3DLight,  
  IUnknown* pUnkOuter                  
);
 

Parameters

lplpDirect3DLight

Address that will be filled with a pointer to an IDirect3DLight interface if the call succeeds.

pUnkOuter

This parameter is provided for future compatibility with COM aggregation features. Currently, however, the IDirect3D2::CreateLight method returns an error if this parameter is anything but NULL.

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

QuickInfo

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