IDirect3DDevice2::GetCurrentViewport

The IDirect3DDevice2::GetCurrentViewport method retrieves the current viewport.

HRESULT GetCurrentViewport(
  LPDIRECT3DVIEWPORT2 *lplpd3dViewport2  
);

Parameters

lplpd3dViewport2
Address that contains a pointer to the current viewport when the method returns. A reference is taken to the viewport object.

Return Values

If the method succeeds, the return value is DD_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 IDirect3DDevice2::SetCurrentViewport method.

Remarks

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

This method was introduced with the IDirect3DDevice2 interface.

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.

See Also

IDirect3DDevice2::SetCurrentViewport