This function returns an array of logical GPU handles.

Each handle represents one or more GPUs acting in concert as a single graphics device.

At least one GPU must be present in the system and running an NVIDIA display driver.

The array nvGPUHandle will be filled with logical GPU handle values. The returned gpuCount determines how many entries in the array are valid.

Note:

All logical GPUs handles get invalidated on a GPU topology change, so the calling application is required to renum the logical GPU handles to get latest physical handle mapping after every GPU topology change activated by a call to NvAPI_SetGpuTopologies().

To detect if SLI rendering is enabled, use NvAPI_D3D_GetCurrentSLIState().

SUPPORTED OS: Mac OS X, Windows XP and higher

Since:

Version: 82.61

Return values:

	NVAPI_INVALID_ARGUMENT	nvGPUHandle or pGpuCount is NULL
	NVAPI_OK	One or more handles were returned
	NVAPI_NVIDIA_DEVICE_NOT_FOUND	No NVIDIA GPU driving a display was found

This function returns an array of physical GPU handles. Each handle represents a physical GPU present in the system. That GPU may be part of an SLI configuration, or may not be visible to the OS directly.

At least one GPU must be present in the system and running an NVIDIA display driver.

The array nvGPUHandle will be filled with physical GPU handle values. The returned gpuCount determines how many entries in the array are valid.

Note:

In drivers older than 105.00, all physical GPU handles get invalidated on a modeset. So the calling applications need to renum the handles after every modeset.
With drivers 105.00 and up, all physical GPU handles are constant. Physical GPU handles are constant as long as the GPUs are not physically moved and the SBIOS VGA order is unchanged.

SUPPORTED OS: Mac OS X, Windows XP and higher

Introduced in

Version: 82.61

Return values:

	NVAPI_INVALID_ARGUMENT	nvGPUHandle or pGpuCount is NULL
	NVAPI_OK	One or more handles were returned
	NVAPI_NVIDIA_DEVICE_NOT_FOUND	No NVIDIA GPU driving a display was found

This function returns the logical GPU handle associated with the specified display. At least one GPU must be present in the system and running an NVIDIA display driver.

SUPPORTED OS: Mac OS X, Windows XP and higher

Since:

Version: 82.61

Return values:

	NVAPI_INVALID_ARGUMENT	hNvDisp is not valid; pLogicalGPU is NULL
	NVAPI_OK	One or more handles were returned
	NVAPI_NVIDIA_DEVICE_NOT_FOUND	No NVIDIA GPU driving a display was found

This function returns the logical GPU handle associated with specified physical GPU handle. At least one GPU must be present in the system and running an NVIDIA display driver.

SUPPORTED OS: Mac OS X, Windows XP and higher

Since:

Version: 82.61

Return values:

	NVAPI_INVALID_ARGUMENT	hPhysicalGPU is not valid; pLogicalGPU is NULL
	NVAPI_OK	One or more handles were returned
	NVAPI_NVIDIA_DEVICE_NOT_FOUND	No NVIDIA GPU driving a display was found

This function returns a physical GPU handle associated with the specified unattached display.

At least one GPU must be present in the system and running an NVIDIA display driver.

SUPPORTED OS: Mac OS X, Windows XP and higher

Since:

Version: 82.61

Return values:

	NVAPI_INVALID_ARGUMENT	hNvUnAttachedDisp is not valid or pPhysicalGpu is NULL.
	NVAPI_OK	One or more handles were returned
	NVAPI_NVIDIA_DEVICE_NOT_FOUND	No NVIDIA GPU driving a display was found

This function returns an array of physical GPU handles associated with the specified display.

At least one GPU must be present in the system and running an NVIDIA display driver.

The array nvGPUHandle will be filled with physical GPU handle values. The returned gpuCount determines how many entries in the array are valid.

SUPPORTED OS: Mac OS X, Windows XP and higher

Since:

Version: 82.61

Return values:

	NVAPI_INVALID_ARGUMENT	hNvDisp is not valid; nvGPUHandle or pGpuCount is NULL
	NVAPI_OK	One or more handles were returned
	NVAPI_NVIDIA_DEVICE_NOT_FOUND	no NVIDIA GPU driving a display was found

This function returns the physical GPU handles associated with the specified logical GPU handle. At least one GPU must be present in the system and running an NVIDIA display driver.

The array hPhysicalGPU will be filled with physical GPU handle values. The returned gpuCount determines how many entries in the array are valid.

SUPPORTED OS: Mac OS X, Windows XP and higher

Since:

Version: 82.61

Return values:

	NVAPI_INVALID_ARGUMENT	hLogicalGPU is not valid; hPhysicalGPU is NULL
	NVAPI_OK	One or more handles were returned
	NVAPI_NVIDIA_DEVICE_NOT_FOUND	No NVIDIA GPU driving a display was found
	NVAPI_EXPECTED_LOGICAL_GPU_HANDLE	hLogicalGPU was not a logical GPU handle

This function is the same as NvAPI_GPU_GetAllOutputs but returns only the set of GPU output identifiers that are actively driving display devices.

SUPPORTED OS: Windows XP and higher

Since:

Version: 87.10

Return values:

	NVAPI_INVALID_ARGUMENT	hPhysicalGpu or pOutputsMask is NULL.
	NVAPI_OK	*pOutputsMask contains a set of GPU-output identifiers.
	NVAPI_NVIDIA_DEVICE_NOT_FOUND	No NVIDIA GPU driving a display was found.
	NVAPI_EXPECTED_PHYSICAL_GPU_HANDLE	hPhysicalGpu was not a physical GPU handle.

This function returns the AGP aperture in megabytes.

SUPPORTED OS: Mac OS X, Windows XP and higher

Since:

Version: 92.10

Return values:

	NVAPI_INVALID_ARGUMENT	pSize is NULL.
	NVAPI_OK	Call successful.
	NVAPI_NVIDIA_DEVICE_NOT_FOUND	No NVIDIA GPU driving a display was found.
	NVAPI_EXPECTED_PHYSICAL_GPU_HANDLE	hPhysicalGpu was not a physical GPU handle.

This function returns set of all GPU-output identifiers as a bitmask.

SUPPORTED OS: Windows XP and higher

Since:

Version: 87.00

Return values:

	NVAPI_INVALID_ARGUMENT	hPhysicalGpu or pOutputsMask is NULL.
	NVAPI_OK	*pOutputsMask contains a set of GPU-output identifiers.
	NVAPI_NVIDIA_DEVICE_NOT_FOUND	No NVIDIA GPU driving a display was found.
	NVAPI_EXPECTED_PHYSICAL_GPU_HANDLE	hPhysicalGpu was not a physical GPU handle.

DESCRIPTION: Returns the ID of the bus associated with this GPU.

SUPPORTED OS: Mac OS X, Windows XP and higher

Since:

Version: 167.00

Return values:

	NVAPI_INVALID_ARGUMENT	hPhysicalGpu or pBusId is NULL.
	NVAPI_OK	*pBusId contains the bus ID.
	NVAPI_NVIDIA_DEVICE_NOT_FOUND	No NVIDIA GPU driving a display was found.
	NVAPI_EXPECTED_PHYSICAL_GPU_HANDLE	hPhysicalGpu was not a physical GPU handle.

DESCRIPTION: Returns the ID of the bus slot associated with this GPU.

SUPPORTED OS: Mac OS X, Windows XP and higher

Since:

Version: 167.00

Return values:

	NVAPI_INVALID_ARGUMENT	hPhysicalGpu or pBusSlotId is NULL.
	NVAPI_OK	*pBusSlotId contains the bus slot ID.
	NVAPI_NVIDIA_DEVICE_NOT_FOUND	No NVIDIA GPU driving a display was found.
	NVAPI_EXPECTED_PHYSICAL_GPU_HANDLE	hPhysicalGpu was not a physical GPU handle.

This function returns the type of bus associated with this GPU.

SUPPORTED OS: Mac OS X, Windows XP and higher

Since:

Version: 92.10

Return values:

	NVAPI_INVALID_ARGUMENT	hPhysicalGpu or pBusType is NULL.
	NVAPI_OK	*pBusType contains bus identifier.
	NVAPI_NVIDIA_DEVICE_NOT_FOUND	No NVIDIA GPU driving a display was found.
	NVAPI_EXPECTED_PHYSICAL_GPU_HANDLE	hPhysicalGpu was not a physical GPU handle.

This function is the same as NvAPI_GPU_GetAllOutputs() but returns only the set of GPU output identifiers that are connected to display devices.

SUPPORTED OS: Windows XP and higher

Since:

Version: 82.61

Return values:

	NVAPI_INVALID_ARGUMENT	hPhysicalGpu or pOutputsMask is NULL.
	NVAPI_OK	*pOutputsMask contains a set of GPU-output identifiers.
	NVAPI_NVIDIA_DEVICE_NOT_FOUND	No NVIDIA GPU driving a display was found.
	NVAPI_EXPECTED_PHYSICAL_GPU_HANDLE	hPhysicalGpu was not a physical GPU handle.

This function is similar to NvAPI_GPU_GetConnectedOutputs(), and returns the connected display identifiers that are connected as an output mask but unlike NvAPI_GPU_GetConnectedOutputs() this API "always" reflects the Lid State in the output mask. Thus if you expect the LID close state to be available in the connection mask use this API.

• If LID is closed then this API will remove the LID panel from the connected display identifiers.
• If LID is open then this API will reflect the LID panel in the connected display identifiers.

This API should be used on notebook systems and on systems where the LID state is required in the connection output mask. On desktop systems the returned identifiers will match NvAPI_GPU_GetConnectedOutputs().

SUPPORTED OS: Windows XP and higher

Since:

Version: 97.20

Return values:

	NVAPI_INVALID_ARGUMENT	hPhysicalGpu or pOutputsMask is NULL
	NVAPI_OK	*pOutputsMask contains a set of GPU-output identifiers
	NVAPI_NVIDIA_DEVICE_NOT_FOUND	No NVIDIA GPU driving a display was found
	NVAPI_EXPECTED_PHYSICAL_GPU_HANDLE	hPhysicalGpu was not a physical GPU handle

DESCRIPTION: This function is the same as NvAPI_GPU_GetConnectedOutputs() but returns only the set of GPU-output identifiers that can be selected in an SLI configuration. With SLI disabled this function matches NvAPI_GPU_GetConnectedOutputs().

SUPPORTED OS: Windows XP and higher

Since:

Version: 171.14

Return values:

	NVAPI_INVALID_ARGUMENT	hPhysicalGpu or pOutputsMask is NULL
	NVAPI_OK	*pOutputsMask contains a set of GPU-output identifiers
	NVAPI_NVIDIA_DEVICE_NOT_FOUND	No NVIDIA GPU driving a display was found
	NVAPI_EXPECTED_PHYSICAL_GPU_HANDLE,:	hPhysicalGpu was not a physical GPU handle

DESCRIPTION: This function is the same as NvAPI_GPU_GetConnectedOutputsWithLidState() but returns only the set of GPU-output identifiers that can be selected in an SLI configuration. With SLI disabled, this function matches NvAPI_GPU_GetConnectedOutputsWithLidState().

SUPPORTED OS: Windows XP and higher

Since:

Version: 171.14

Return values:

	NVAPI_INVALID_ARGUMENT	hPhysicalGpu or pOutputsMask is NULL
	NVAPI_OK	*pOutputsMask contains a set of GPU-output identifiers
	NVAPI_NVIDIA_DEVICE_NOT_FOUND	No NVIDIA GPU driving a display was found
	NVAPI_EXPECTED_PHYSICAL_GPU_HANDLE	hPhysicalGpu was not a physical GPU handle

This function returns the current AGP Rate (0 = AGP not present, 1 = 1x, 2 = 2x, etc.).

SUPPORTED OS: Mac OS X, Windows XP and higher

Since:

Version: 92.10

Return values:

	NVAPI_INVALID_ARGUMENT	pRate is NULL.
	NVAPI_OK	Call successful.
	NVAPI_NVIDIA_DEVICE_NOT_FOUND	No NVIDIA GPU driving a display was found.
	NVAPI_EXPECTED_PHYSICAL_GPU_HANDLE	hPhysicalGpu was not a physical GPU handle.

This function returns the number of PCIE lanes being used for the PCIE interface downstream from the GPU.

SUPPORTED OS: Mac OS X, Windows XP and higher

Since:

Version: 92.10

Return values:

	NVAPI_INVALID_ARGUMENT	pWidth is NULL.
	NVAPI_OK	Call successful.
	NVAPI_NVIDIA_DEVICE_NOT_FOUND	No NVIDIA GPU driving a display was found.
	NVAPI_EXPECTED_PHYSICAL_GPU_HANDLE	hPhysicalGpu was not a physical GPU handle.

This function returns the EDID data for the specified GPU handle and connection bit mask. displayOutputId should have exactly 1 bit set to indicate a single display. See NvAPI Handles.

SUPPORTED OS: Windows XP and higher

Since:

Version: 88.50

Return values:

	NVAPI_INVALID_ARGUMENT	pEDID is NULL; displayOutputId has 0 or > 1 bits set
	NVAPI_OK	*pEDID contains valid data.
	NVAPI_NVIDIA_DEVICE_NOT_FOUND	No NVIDIA GPU driving a display was found.
	NVAPI_EXPECTED_PHYSICAL_GPU_HANDLE	hPhysicalGpu was not a physical GPU handle.
	NVAPI_DATA_NOT_FOUND	The requested display does not contain an EDID.

This function retrieves the full GPU name as an ASCII string - for example, "Quadro FX 1400".

SUPPORTED OS: Mac OS X, Windows XP and higher

Since:

Version: 92.10

Returns:

NVAPI_ERROR or NVAPI_OK

DESCRIPTION: This function returns the GPU type (integrated or discrete). See NV_GPU_TYPE.

SUPPORTED OS: Mac OS X, Windows XP and higher

Since:

Version: 174.32

Return values:

	NVAPI_INVALID_ARGUMENT	hPhysicalGpu
	NVAPI_OK	*pGpuType contains the GPU type
	NVAPI_NVIDIA_DEVICE_NOT_FOUND	No NVIDIA GPU driving a display was found
	NVAPI_EXPECTED_PHYSICAL_GPU_HANDLE,:	hPhysicalGpu was not a physical GPU handle

This function returns the interrupt number associated with this GPU.

SUPPORTED OS: Mac OS X, Windows XP and higher

Since:

Version: 92.10

Return values:

	NVAPI_INVALID_ARGUMENT	hPhysicalGpu or pIRQ is NULL.
	NVAPI_OK	*pIRQ contains interrupt number.
	NVAPI_NVIDIA_DEVICE_NOT_FOUND	No NVIDIA GPU driving a display was found.
	NVAPI_EXPECTED_PHYSICAL_GPU_HANDLE	hPhysicalGpu was not a physical GPU handle.

This function returns the output type for a specific physical GPU handle and outputId (exactly 1 bit set - see NvAPI Handles).

SUPPORTED OS: Windows XP and higher

Earliest supported ForceWare version: 82.61

Return values:

	NVAPI_INVALID_ARGUMENT	hPhysicalGpu, outputId, or pOutputsMask is NULL; or outputId has > 1 bit set
	NVAPI_OK	*pOutputType contains a NvGpuOutputType value
	NVAPI_NVIDIA_DEVICE_NOT_FOUND	No NVIDIA GPU driving a display was found
	NVAPI_EXPECTED_PHYSICAL_GPU_HANDLE	hPhysicalGpu was not a physical GPU handle

This function returns the PCI identifiers associated with this GPU.

SUPPORTED OS: Mac OS X, Windows XP and higher

Since:

Version: 92.10

Parameters:

	DeviceId	The internal PCI device identifier for the GPU.
	SubSystemId	The internal PCI subsystem identifier for the GPU.
	RevisionId	The internal PCI device-specific revision identifier for the GPU.
	ExtDeviceId	The external PCI device identifier for the GPU.

Return values:

	NVAPI_INVALID_ARGUMENT	hPhysicalGpu or an argument is NULL
	NVAPI_OK	Arguments are populated with PCI identifiers
	NVAPI_NVIDIA_DEVICE_NOT_FOUND	No NVIDIA GPU driving a display was found
	NVAPI_EXPECTED_PHYSICAL_GPU_HANDLE	hPhysicalGpu was not a physical GPU handle

This functioon returns the physical size of framebuffer in KB. This does NOT include any system RAM that may be dedicated for use by the GPU.

SUPPORTED OS: Mac OS X, Windows XP and higher

Since:

Version: 92.10

Return values:

	NVAPI_INVALID_ARGUMENT	pSize is NULL
	NVAPI_OK	Call successful
	NVAPI_NVIDIA_DEVICE_NOT_FOUND	No NVIDIA GPU driving a display was found
	NVAPI_EXPECTED_PHYSICAL_GPU_HANDLE	hPhysicalGpu was not a physical GPU handle

This function identifies whether the GPU is a notebook GPU or a desktop GPU.

SUPPORTED OS: Windows XP and higher

Since:

Version: 97.20

Return values:

	NVAPI_INVALID_ARGUMENT	hPhysicalGpu or pOutputsMask is NULL
	NVAPI_OK	*pSystemType contains the GPU system type
	NVAPI_NVIDIA_DEVICE_NOT_FOUND	No NVIDIA GPU driving a display was found
	NVAPI_EXPECTED_PHYSICAL_GPU_HANDLE,:	hPhysicalGpu was not a physical GPU handle

This function returns the OEM revision of the video BIOS associated with this GPU.

SUPPORTED OS: Mac OS X, Windows XP and higher

Since:

Version: 92.10

Return values:

	NVAPI_INVALID_ARGUMENT	hPhysicalGpu or pBiosRevision is NULL
	NVAPI_OK	*pBiosRevision contains revision number
	NVAPI_NVIDIA_DEVICE_NOT_FOUND	No NVIDIA GPU driving a display was found
	NVAPI_EXPECTED_PHYSICAL_GPU_HANDLE	hPhysicalGpu was not a physical GPU handle

This function returns the revision of the video BIOS associated with this GPU.

SUPPORTED OS: Mac OS X, Windows XP and higher

Since:

Version: 92.10

Return values:

	NVAPI_INVALID_ARGUMENT	hPhysicalGpu or pBiosRevision is NULL.
	NVAPI_OK	*pBiosRevision contains revision number.
	NVAPI_NVIDIA_DEVICE_NOT_FOUND	No NVIDIA GPU driving a display was found.
	NVAPI_EXPECTED_PHYSICAL_GPU_HANDLE	hPhysicalGpu was not a physical GPU handle.

This function returns the full video BIOS version string in the form of xx.xx.xx.xx.yy where

• xx numbers come from NvAPI_GPU_GetVbiosRevision() and
• yy comes from NvAPI_GPU_GetVbiosOEMRevision().

SUPPORTED OS: Mac OS X, Windows XP and higher

Since:

Version: 92.10

Return values:

	NVAPI_INVALID_ARGUMENT	hPhysicalGpu is NULL.
	NVAPI_OK	szBiosRevision contains version string.
	NVAPI_NVIDIA_DEVICE_NOT_FOUND	No NVIDIA GPU driving a display was found.
	NVAPI_EXPECTED_PHYSICAL_GPU_HANDLE	hPhysicalGpu was not a physical GPU handle.

This function returns the virtual size of framebuffer in KB. This includes the physical RAM plus any system RAM that has been dedicated for use by the GPU.

SUPPORTED OS: Mac OS X, Windows XP and higher

Since:

Version: 92.10

Return values:

	NVAPI_INVALID_ARGUMENT	pSize is NULL.
	NVAPI_OK	Call successful.
	NVAPI_NVIDIA_DEVICE_NOT_FOUND	No NVIDIA GPU driving a display was found.
	NVAPI_EXPECTED_PHYSICAL_GPU_HANDLE	hPhysicalGpu was not a physical GPU handle.

This function determines if a set of GPU outputs can be active simultaneously. While a GPU may have <n> outputs, typically they cannot all be active at the same time due to internal resource sharing.

Given a physical GPU handle and a mask of candidate outputs, this call will return NVAPI_OK if all of the specified outputs can be driven simultaneously. It will return NVAPI_INVALID_COMBINATION if they cannot.

Use NvAPI_GPU_GetAllOutputs() to determine which outputs are candidates.

SUPPORTED OS: Windows XP and higher

Since:

Version: 87.10

Return values:

	NVAPI_OK	Combination of outputs in outputsMask are valid (can be active simultaneously).
	NVAPI_INVALID_COMBINATION	Combination of outputs in outputsMask are NOT valid.
	NVAPI_INVALID_ARGUMENT	hPhysicalGpu or outputsMask does not have at least 2 bits set.
	NVAPI_EXPECTED_PHYSICAL_GPU_HANDLE	hPhysicalGpu was not a physical GPU handle.
	NVAPI_NVIDIA_DEVICE_NOT_FOUND	No NVIDIA GPU driving a display was found.