IDirect3DDevice3::GetCurrentViewport

The IDirect3DDevice3::GetCurrentViewport method retrieves the current viewport.

HRESULT GetCurrentViewport(
  LPDIRECT3DVIEWPORT3 *lplpd3dViewport  
);

Parameters

lplpd3dViewport
Address that will contain a pointer to the current viewport's IDirect3DViewport3 interface when the method returns. A reference is taken to the viewport object.

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_INVALIDPARAMS One of the arguments is invalid.
D3DERR_NOCURRENTVIEWPORT No current viewport has been set by a call to the IDirect3DDevice3::SetCurrentViewport method.

Remarks

This method increases the reference count of the viewport interface retrieved in the lplpd3dViewport parameter. The application must release this interface when it is no longer needed.

This method was introduced with the IDirect3DDevice2 interface. In the IDirect3DDevice2 interface, this method accepts a pointer to an IDirect3DViewport interface, not an IDirect3DViewport3 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.

See Also

IDirect3DDevice3::SetCurrentViewport