IDirect3DRMLightArray

Applications use the methods of the IDirect3DRMLightArray interface to organize light objects. This section is a reference to the methods of this interface. For a conceptual overview, see Lights.

The IDirect3DRMLightArray interface supports the following methods:

GetElement
GetSize

The IDirect3DRMLightArray interface, like all COM interfaces, inherits the IUnknown interface methods. The IUnknown interface supports the following three methods:

AddRef
QueryInterface
Release

The Direct3DRMLightArray object is obtained by calling the IDirect3DRMFrame3::GetLights method.

IDirect3DRMLightArray::GetElement

IDirect3DRMLightArray

Retrieves a specified element in a Direct3DRMLightArray object.

Syntax

HRESULT GetElement(
  DWORD index,
  LPDIRECT3DRMLIGHT  *lplpD3DRMLight
  );

Parameters

index
Element in the array.
lplpD3DRMLight
Address that will be filled with a pointer to an IDirect3DRMLight interface.

Return Value

Returns D3DRM_OK if successful, or an error otherwise. For a list of possible errors, see Direct3D Retained Mode Return Values.

IDirect3DRMLightArray::GetSize

IDirect3DRMLightArray

Retrieves the number of elements contained in a Direct3DRMLightArray object.

Syntax

DWORD GetSize( );

Return Value

Returns the number of elements.