IDirect3DDevice2::NextViewport

The IDirect3DDevice2::NextViewport method enumerates the viewports associated with the device.

HRESULT NextViewport(
  LPDIRECT3DVIEWPORT2 lpDirect3DViewport2,  
  LPDIRECT3DVIEWPORT2 *lplpDirect3DViewport2,  
  DWORD dwFlags                             
);
 

Parameters

lpDirect3DViewport2

Address of a viewport in the list of viewports associated with this Direct3DDevice2 object.

lplpDirect3DViewport2

Address of the next viewport in the list of viewports associated with this Direct3DDevice2 object.

dwFlags

Flags specifying which viewport to retrieve from the list of viewports. 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

If you attempt to retrieve the next viewport in the list when you are at the end of the list, this method returns D3D_OK but lplpDirect3DViewport2 is NULL.

In the IDirect3DDevice interface, this method requires pointers to IDirect3DViewport interfaces, not IDirect3DViewport2 interfaces.

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.