Edit

IDirect3DDevice9Ex::GetMaximumFrameLatency method (d3d9.h)

  • Article

Retrieves the number of frames of data that the system is allowed to queue.

Syntax

HRESULT GetMaximumFrameLatency(
  [out] UINT *pMaxLatency
);

Parameters

[out] pMaxLatency

Type: UINT*

Returns the number of frames that can be queued for render. The value is typically 3, but can range from 1 to 20.

Return value

Type: HRESULT

Possible return values include: D3D_OK, D3DERR_DEVICELOST, D3DERR_DEVICEREMOVED, D3DERR_DRIVERINTERNALERROR, D3DERR_INVALIDCALL, or D3DERR_OUTOFVIDEOMEMORY (see D3DERR).

Remarks

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.

Requirements

Requirement Value
Target Platform Windows
Header d3d9.h
Library D3D9.lib

See also

IDirect3DDevice9Ex