Edit

IDDCX_METADATA2 structure (iddcx.h)

  • Article

IDDCX_METADATA2 provides information about the current provided surface and what is displayed on it.

Syntax

struct IDDCX_METADATA2 {
  UINT                        Size;
  IDDCX_METADATA2_VALID_FLAGS ValidFlags;
  UINT                        PresentationFrameNumber;
  UINT                        DirtyRectCount;
  BOOL                        HwProtectedSurface;
  UINT64                      PresentDisplayQPCTime;
  IDXGIResource               *pSurface;
  DXGI_COLOR_SPACE_TYPE       SurfaceColorSpace;
  UINT                        SdrWhiteLevel;
  IDDCX_SYSTEM_BUFFER_INFO    SystemBufferInfo;
  IDDCX_HDR10_FRAME_METADATA  Hdr10FrameMetaData;
};

Members

Size

Total size of the structure, in bytes.

ValidFlags

A bitwise-OR of IDDCX_METADATA2_VALID_FLAGS values that indicate which fields in this structure have valid content.

PresentationFrameNumber

Presentation frame number of this surface.

DirtyRectCount

Number of dirty rects for this frame. Call IddCxSwapChainGetDirtyRects to get the dirty rects.

A DirtyRectCount of 1, where the single dirty rect has all values set to zero, indicates that there has not been any image updates from the previous frame. In this situation, the driver has the opportunity to re-encode the desktop image again to increase the visual quality. Once there are no more updates, the OS presents the same frame as many times as indicated by the IDDCX_ADAPTER_CAPS::StaticDesktopReencodeFrameCount value , then stops presenting until the next update.

HwProtectedSurface

Indicates whether the provided surface is hardware protected.

PresentDisplayQPCTime

System QPC time of when this surface should be displayed on the indirect display monitor.

pSurface

Pointer to a IDXGIResource DX surface that contains the image to encode and transmit. The driver can use this DX surface anytime until IddCxSwapChainReleaseAndAcquire is called again.

SurfaceColorSpace

A DXGI_COLOR_SPACE_TYPE value that indicates the color space of the provided surface. The color space typically matches that specified in the committed path.

SdrWhiteLevel

The white level in nits for any SDR content; for example, the mouse cursor. This value always defaults to 80 nits for non-HDR modes.

SystemBufferInfo

An IDDCX_SYSTEM_BUFFER_INFO structure in which the resulting information from the release and acquire operation is returned.

Hdr10FrameMetaData

An IDDCX_HDR10_FRAME_METADATA structure that contains the HDR10 metadata to use with this frame.

Remarks

For more information about HDR support, see IddCx version 1.10 updates.

Requirements

Requirement Value
Minimum supported client Windows 11, version 22H2 September Update (IddCx version 1.10)
Header iddcx.h

See also

IDARG_OUT_RELEASEANDACQUIREBUFFER2

IddCxSwapChainReleaseAndAcquireBuffer2