PFND3D10DDI_SETVIEWPORTS callback function (d3d10umddi.h)

Article
10/21/2021

The SetViewports function sets viewports.

Syntax

PFND3D10DDI_SETVIEWPORTS Pfnd3d10ddiSetviewports;

void Pfnd3d10ddiSetviewports(
       D3D10DDI_HDEVICE unnamedParam1,
  [in] UINT NumViewports,
  [in] UINT ClearViewports,
       const D3D10_DDI_VIEWPORT *unnamedParam4
)
{...}

Parameters

unnamedParam1

hDevice [in]

A handle to the display device (graphics context).

[in] NumViewports

The total number of viewports that the pViewports parameter specifies.

[in] ClearViewports

The number of viewports after the number of viewports that NumViewports specifies to be set to NULL. This number represents the difference between the previous number of viewports (that is, when the Microsoft Direct3D runtime previously called SetViewports) and the new number of viewports.

Note that the number that ClearViewports specifies is only an optimization aid because the user-mode display driver could calculate this number.

unnamedParam4

pViewports [in]

An array of D3D10_DDI_VIEWPORT structures for the viewports to set.

Return value

None

Remarks

The driver can use the pfnSetErrorCb callback function to set an error code.

Viewports specify the transformation post clip to the output render target and depth stencil resources. Any viewports that are not defined in a call to SetViewports are set to NULL. A NULL viewport is defined as follows.

struct D3D10_DDI_VIEWPORT {
  FLOAT  TopLeftX = NaN;
  FLOAT  TopLeftY = NaN;
  FLOAT  Width = NaN;
  FLOAT  Height = NaN;
  FLOAT  MinDepth = NaN;
  FLOAT  MaxDepth = NaN;
} D3D10_DDI_VIEWPORT;</pre>

This definition implies that the viewport is off.

The user-mode display driver must set all viewports atomically as one operation.

Although the NumViewports parameter specifies the number of viewports in the array that the pViewports parameter specifies, some values in the array can be NULL.

The range of viewports between the number that NumViewports specifies and the maximum number of viewports that are allowed is required to contain all NULL or unbound values. The number that the ClearViewports parameter specifies informs the driver about how many viewports the driver must clear out for the current atomic operation.

If the previous call to SetViewports passed a value of 2 in the NumViewports parameter and the current call to SetViewports passes a value of 4 in NumViewports, the current call to SetViewports also passes a value of 0 in the ClearViewports parameter. If the next successive call to SetViewports passes a value of 1 in NumViewports, the successive call also passes a value of 3 (4 - 1) in ClearViewports.

When the value of clear viewports is requested during user-mode query operations, the value is the difference between the maximum number of viewports and the viewports value.

SetViewports ensures that the viewports are valid. That is, SetViewports ensures that the dimensions of the viewports are within range (D3D10_VIEWPORT_BOUNDS_MIN, D3D10_VIEWPORT_BOUNDS_MAX, D3D10_MIN_DEPTH, and D3D10_MAX_DEPTH). SetViewports also ensures that no coordinates are NaN and flushes denormalized float values to zero.

The driver should not encounter any error, except for D3DDDIERR_DEVICEREMOVED. Therefore, if the driver passes any error, except for D3DDDIERR_DEVICEREMOVED, in a call to the pfnSetErrorCb function, the Microsoft Direct3D runtime will determine that the error is critical. Even if the device was removed, the driver is not required to return D3DDDIERR_DEVICEREMOVED; however, if device removal interfered with the operation of SetViewports (which typically should not happen), the driver can return D3DDDIERR_DEVICEREMOVED.

Requirements

Requirement	Value
Minimum supported client	Available in Windows Vista and later versions of the Windows operating systems.
Target Platform	Desktop
Header	d3d10umddi.h (include D3d10umddi.h)