Edit

Share via

IDXGIAdapter3::QueryVideoMemoryInfo method (dxgi1_4.h)

  • Article

This method informs the process of the current budget and process usage.

Syntax

HRESULT QueryVideoMemoryInfo(
  [in]  UINT                         NodeIndex,
  [in]  DXGI_MEMORY_SEGMENT_GROUP    MemorySegmentGroup,
  [out] DXGI_QUERY_VIDEO_MEMORY_INFO *pVideoMemoryInfo
);

Parameters

[in] NodeIndex

Type: UINT

Specifies the device's physical adapter for which the video memory information is queried. For single-GPU operation, set this to zero. If there are multiple GPU nodes, set this to the index of the node (the device's physical adapter) for which the video memory information is queried. See Multi-adapter systems.

[in] MemorySegmentGroup

Type: DXGI_MEMORY_SEGMENT_GROUP

Specifies a DXGI_MEMORY_SEGMENT_GROUP that identifies the group as local or non-local.

[out] pVideoMemoryInfo

Type: DXGI_QUERY_VIDEO_MEMORY_INFO*

Fills in a DXGI_QUERY_VIDEO_MEMORY_INFO structure with the current values.

Return value

Type: HRESULT

Returns S_OK if successful; an error code otherwise. For a list of error codes, see DXGI_ERROR.

Remarks

Applications must explicitly manage their usage of physical memory explicitly and keep usage within the budget assigned to the application process. Processes that cannot kept their usage within their assigned budgets will likely experience stuttering, as they are intermittently frozen and paged-out to allow other processes to run.

Requirements

Requirement Value
Target Platform Windows
Header dxgi1_4.h (include DXGI1_3.h)
Library Dxgi.lib
DLL Dxgi.dll

See also

IDXGIAdapter3