IDXGISwapChain::GetFrameStatistics method (dxgi.h)

Gets performance statistics about the last render frame.

Syntax

HRESULT GetFrameStatistics(
  [out] DXGI_FRAME_STATISTICS *pStats
);

Parameters

[out] pStats

Type: DXGI_FRAME_STATISTICS*

A pointer to a DXGI_FRAME_STATISTICS structure for the frame statistics.

Return value

Type: HRESULT

Returns one of the DXGI_ERROR values.

Remarks

You cannot use GetFrameStatistics for swap chains that both use the bit-block transfer (bitblt) presentation model and draw in windowed mode.

You can only use GetFrameStatistics for swap chains that either use the flip presentation model or draw in full-screen mode. You set the DXGI_SWAP_EFFECT_FLIP_SEQUENTIAL value in the SwapEffect member of the DXGI_SWAP_CHAIN_DESC1 structure to specify that the swap chain uses the flip presentation model.

Statistics are not reliable in many multiple monitor scenarios, as well as scenarios where other fullscreen apps are running.

It may be necessary to call DwmFlush before frame statistics are updated on systems that support Hardware Flip Queue.

Requirements

Requirement Value
Target Platform Windows
Header dxgi.h
Library DXGI.lib

See also

IDXGISwapChain