Edit

Share via

DXGI_FRAME_PRESENTATION_MODE enumeration (dxgi1_3.h)

  • Article

Indicates options for presenting frames to the swap chain.

Syntax

typedef enum DXGI_FRAME_PRESENTATION_MODE {
  DXGI_FRAME_PRESENTATION_MODE_COMPOSED = 0,
  DXGI_FRAME_PRESENTATION_MODE_OVERLAY = 1,
  DXGI_FRAME_PRESENTATION_MODE_NONE = 2,
  DXGI_FRAME_PRESENTATION_MODE_COMPOSITION_FAILURE = 3
} ;

Constants

 
DXGI_FRAME_PRESENTATION_MODE_COMPOSED
Value: 0
Specifies that the presentation mode is a composition surface, meaning that the conversion from YUV to RGB is happening once per output refresh (for example, 60 Hz).
When this value is returned, the media app should discontinue use of the decode swap chain and perform YUV to RGB conversion itself, reducing the frequency of YUV to RGB conversion to once per video frame.
DXGI_FRAME_PRESENTATION_MODE_OVERLAY
Value: 1
Specifies that the presentation mode is an overlay surface, meaning that the YUV to RGB conversion is happening efficiently in hardware (once per video frame).
When this value is returned, the media app can continue to use the decode swap chain.
See IDXGIDecodeSwapChain.
DXGI_FRAME_PRESENTATION_MODE_NONE
Value: 2
No presentation is specified.
DXGI_FRAME_PRESENTATION_MODE_COMPOSITION_FAILURE
Value: 3
An issue occurred that caused content protection to be invalidated in a swap-chain with hardware content protection, and is usually because the system ran out of hardware protected memory. The app will need to do one of the following:


  • Drastically reduce the amount of hardware protected memory used. For example, media applications might be able to reduce their buffering.

  • Stop using hardware protection if possible.


Note that simply re-creating the swap chain or the device will usually have no impact as the DWM will continue to run out of memory and will return the same failure.

Remarks

This enum is used by the DXGI_FRAME_STATISTICS_MEDIA structure.

Requirements

Requirement Value
Header dxgi1_3.h (include DXGIPartner.h)

See also

DXGI Enumerations