Skip to content

Latest commit

 

History

History
90 lines (68 loc) · 3.77 KB

nf-dxgi-idxgidevice1-setmaximumframelatency.md

File metadata and controls

90 lines (68 loc) · 3.77 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:dxgi.IDXGIDevice1.SetMaximumFrameLatency
IDXGIDevice1::SetMaximumFrameLatency (dxgi.h)
Sets the number of frames that the system is allowed to queue for rendering.
IDXGIDevice1 interface [DXGI]
SetMaximumFrameLatency method
IDXGIDevice1.SetMaximumFrameLatency
IDXGIDevice1::SetMaximumFrameLatency
SetMaximumFrameLatency
SetMaximumFrameLatency method [DXGI]
SetMaximumFrameLatency method [DXGI]
IDXGIDevice1 interface
da92b152-07cc-06ca-caa5-a8982fe8fc2f
direct3ddxgi.idxgidevice1_setmaximumframelatency
dxgi/IDXGIDevice1::SetMaximumFrameLatency
direct3ddxgi\idxgidevice1_setmaximumframelatency.htm
direct3ddxgi
ea477f33-2dba-44ac-9b47-8fd2ce6cec30
12/05/2018
IDXGIDevice1 interface [DXGI],SetMaximumFrameLatency method, IDXGIDevice1.SetMaximumFrameLatency, IDXGIDevice1::SetMaximumFrameLatency, SetMaximumFrameLatency, SetMaximumFrameLatency method [DXGI], SetMaximumFrameLatency method [DXGI],IDXGIDevice1 interface, da92b152-07cc-06ca-caa5-a8982fe8fc2f, direct3ddxgi.idxgidevice1_setmaximumframelatency, dxgi/IDXGIDevice1::SetMaximumFrameLatency
dxgi.h
Windows
Windows 7 [desktop apps \| UWP apps]
Windows Server 2008 R2 [desktop apps \| UWP apps]
DXGI.lib
Windows
19H1
IDXGIDevice1::SetMaximumFrameLatency
dxgi/IDXGIDevice1::SetMaximumFrameLatency
c++
APIRef
kbSyntax
COM
DXGI.lib
DXGI.dll
IDXGIDevice1.SetMaximumFrameLatency

IDXGIDevice1::SetMaximumFrameLatency

-description

Sets the number of frames that the system is allowed to queue for rendering.

-parameters

-param MaxLatency

Type: UINT

The maximum number of back buffer frames that a driver can queue. The value defaults to 3, but can range from 1 to 16. A value of 0 will reset latency to the default. For multi-head devices, this value is specified per-head.

-returns

Type: HRESULT

Returns S_OK if successful; otherwise, DXGI_ERROR_DEVICE_REMOVED if the device was removed.

-remarks

This method is not supported by DXGI 1.0, which shipped in Windows Vista and Windows Server 2008. DXGI 1.1 support is required, which is available on Windows 7, Windows Server 2008 R2, and as an update to Windows Vista with Service Pack 2 (SP2) (KB 971644) and Windows Server 2008 (KB 971512).

Frame latency is the number of frames that are allowed to be stored in a queue before submission for rendering. Latency is often used to control how the CPU chooses between responding to user input and frames that are in the render queue. It is often beneficial for applications that have no user input (for example, video playback) to queue more than 3 frames of data.

-see-also

DXGI Interfaces

IDXGIDevice1

IDXGIDevice1::GetMaximumFrameLatency