ID3D11DeviceContext::RSGetViewports method (d3d11.h)

  • Article

Gets the array of viewports bound to the rasterizer stage.

Syntax

void RSGetViewports(
  [in, out]       UINT           *pNumViewports,
  [out, optional] D3D11_VIEWPORT *pViewports
);

Parameters

[in, out] pNumViewports

Type: UINT*

A pointer to a variable that, on input, specifies the number of viewports (ranges from 0 to D3D11_VIEWPORT_AND_SCISSORRECT_OBJECT_COUNT_PER_PIPELINE) in the pViewports array; on output, the variable contains the actual number of viewports that are bound to the rasterizer stage. If pViewports is NULL, RSGetViewports fills the variable with the number of viewports currently bound.

Note  In some versions of the Windows SDK, a debug device will raise an exception if the input value in the variable to which pNumViewports points is greater than D3D11_VIEWPORT_AND_SCISSORRECT_OBJECT_COUNT_PER_PIPELINE even if pViewports is NULL. The regular runtime ignores the value in the variable to which pNumViewports points when pViewports is NULL. This behavior of a debug device might be corrected in a future release of the Windows SDK.
 

[out, optional] pViewports

Type: D3D11_VIEWPORT*

An array of D3D11_VIEWPORT structures for the viewports that are bound to the rasterizer stage. If the number of viewports (in the variable to which pNumViewports points) is greater than the actual number of viewports currently bound, unused elements of the array contain 0. For info about how the viewport size depends on the device feature level, which has changed between Direct3D 11 and Direct3D 10, see D3D11_VIEWPORT.

Return value

None

Remarks

Windows Phone 8: This API is supported.

Requirements

Requirement Value
Target Platform Windows
Header d3d11.h
Library D3D11.lib

See also

ID3D11DeviceContext