IDirect3DDevice8::SetViewport

Sets the viewport parameters for the device.

HRESULT SetViewport(
  CONST D3DVIEWPORT8* pViewport
);

Parameters

pViewport

[in] Pointer to a D3DVIEWPORT8 structure, specifying the viewport parameters to set.

Return Values

If the method succeeds, the return value is D3D_OK.

If the method fails, it will return D3DERR_INVALIDCALL. This will happen if pViewport is invalid, or if pViewport describes a region that cannot exist within the render target surface.

Remarks

Microsoft® Direct3D® sets the following default values for the viewport.

D3DVIEWPORT8 vp;
vp.X      = 0;
vp.Y      = 0;
vp.Width  = RenderTarget.Width;
vp.Height = RenderTarget.Height;
vp.MinZ   = 0.0f;
vp.MaxZ   = 1.0f;

SetViewport can be used to draw on part of the screen. Make sure to call it before any geometry is drawn so the viewport settings will take effect.

To draw multiple views within a scene, repeat the SetViewport and draw geometry sequence for each view.

Requirements

  Header: Declared in D3d8.h.
  Import Library: Use D3d8.lib.

See Also

IDirect3DDevice8::GetViewport