IDXGIAdapter3::SetVideoMemoryReservation method

This method sends the minimum required physical memory for an application, to the OS.

Syntax

HRESULT SetVideoMemoryReservation(
  [in] UINT                      NodeIndex,
  [in] DXGI_MEMORY_SEGMENT_GROUP MemorySegmentGroup,
  [in] UINT64                    Reservation
);

Parameters

NodeIndex [in]

Type: UINT

Specifies the device's physical adapter for which the video memory information is being set. 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 being set. See Multi-Adapter.

MemorySegmentGroup [in]

Type: DXGI_MEMORY_SEGMENT_GROUP

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

Reservation [in]

Type: UINT64

Specifies a UINT64 that sets the minimum required physical memory, in bytes.

Return value

Type: HRESULT

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

Remarks

Applications are encouraged to set a video reservation to denote the amount of physical memory they cannot go without. This value helps the OS quickly minimize the impact of large memory pressure situations.

Requirements

See also

IDXGIAdapter3