D3DDDICB_SETDISPLAYMODE structure (d3dumddi.h)

The D3DDDICB_SETDISPLAYMODE structure describes the primary allocation that is used to scan out to the display.

Syntax

typedef struct _D3DDDICB_SETDISPLAYMODE {
  [in]  D3DKMT_HANDLE hPrimaryAllocation;
  [out] UINT          PrivateDriverFormatAttribute;
} D3DDDICB_SETDISPLAYMODE;

Members

[in] hPrimaryAllocation

A D3DKMT_HANDLE data type that represents the kernel-mode handle to the primary allocation for scanning out. The Microsoft Direct3D runtime's pfnAllocateCb function returns this handle.

[out] PrivateDriverFormatAttribute

A private format attribute that the user-mode display driver should use to convert the current primary surface if the pfnSetDisplayModeCb callback function returned D3DDDIERR_INCOMPATIBLEPRIVATEFORMAT.

Remarks

The user-mode display driver can set the hPrimaryAllocation member in the call to pfnSetDisplayModeCb to scan out any allocation. However, the allocation must be marked as a primary (that is, the user-mode display driver must have set the Primary bit-field flag in the Flags member of the D3DDDI_ALLOCATIONINFO structure in a call to the pfnAllocateCb function to create the allocation).

Requirements

Requirement Value
Minimum supported client Available in Windows Vista and later versions of the Windows operating systems.
Header d3dumddi.h (include D3dumddi.h)

See also

D3DDDI_ALLOCATIONINFO

pfnAllocateCb

pfnSetDisplayModeCb