Edit

Share via

DXGI_OUTDUPL_DESC structure (dxgi1_2.h)

  • Article

The DXGI_OUTDUPL_DESC structure describes the dimension of the output and the surface that contains the desktop image. The format of the desktop image is always DXGI_FORMAT_B8G8R8A8_UNORM.

Syntax

typedef struct DXGI_OUTDUPL_DESC {
  DXGI_MODE_DESC     ModeDesc;
  DXGI_MODE_ROTATION Rotation;
  BOOL               DesktopImageInSystemMemory;
} DXGI_OUTDUPL_DESC;

Members

ModeDesc

A DXGI_MODE_DESC structure that describes the display mode of the duplicated output.

Rotation

A member of the DXGI_MODE_ROTATION enumerated type that describes how the duplicated output rotates an image.

DesktopImageInSystemMemory

Specifies whether the resource that contains the desktop image is already located in system memory. TRUE if the resource is in system memory; otherwise, FALSE. If this value is TRUE and the application requires CPU access, it can use the IDXGIOutputDuplication::MapDesktopSurface and IDXGIOutputDuplication::UnMapDesktopSurface methods to avoid copying the data into a staging buffer.

Remarks

This structure is used by GetDesc.

Requirements

Requirement Value
Minimum supported client Windows 8 and Platform Update for Windows 7 [desktop apps only]
Minimum supported server Windows Server 2012 and Platform Update for Windows Server 2008 R2 [desktop apps only]
Header dxgi1_2.h

See also

DXGI Structures