IDirect3DDevice3::NextViewport

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

HRESULT NextViewport(
  LPDIRECT3DVIEWPORT3 lpDirect3DViewport,  
  LPDIRECT3DVIEWPORT3 *lplpAnotherViewport,  
  DWORD dwFlags                             
);
 

Parameters

lpDirect3DViewport

Address of the IDirect3DViewport3 interface of a viewport in the list of viewports associated with this Direct3D device.

lplpAnotherViewport

Address that will contain a pointer to the IDirect3DViewport3 interface for another viewport in the device's viewport list. Which viewport the method retrieves is determined by the flag in the dwFlags parameter.

dwFlags

Flag specifying which viewport to retrieve from the list of viewports. This must be set to one of the following flags:

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:

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 lplpAnotherViewport is NULL.

In the IDirect3DDevice2 interface, this method requires pointers to IDirect3DViewport2 interfaces, not IDirect3DViewport3 interfaces.

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.