Graphics Driver APIs

Data Structures
struct	NV_DISPLAY_DRIVER_VERSION
struct	NV_DISPLAY_DRIVER_MEMORY_INFO_V1
struct	NV_DISPLAY_DRIVER_MEMORY_INFO_V2
struct	NV_DISPLAY_DRIVER_MEMORY_INFO_V3
struct	NV_GPU_MEMORY_INFO_EX_V1

Macros
#define	NV_DISPLAY_DRIVER_VERSION_VER   MAKE_NVAPI_VERSION(NV_DISPLAY_DRIVER_VERSION,1)
#define	NV_DISPLAY_DRIVER_MEMORY_INFO_VER_1   MAKE_NVAPI_VERSION(NV_DISPLAY_DRIVER_MEMORY_INFO_V1,1)
#define	NV_DISPLAY_DRIVER_MEMORY_INFO_VER_2   MAKE_NVAPI_VERSION(NV_DISPLAY_DRIVER_MEMORY_INFO_V2,2)
#define	NV_DISPLAY_DRIVER_MEMORY_INFO_VER_3   MAKE_NVAPI_VERSION(NV_DISPLAY_DRIVER_MEMORY_INFO_V3,3)
#define	NV_DISPLAY_DRIVER_MEMORY_INFO_VER   NV_DISPLAY_DRIVER_MEMORY_INFO_VER_3
#define	NV_GPU_MEMORY_INFO_EX_VER_1   MAKE_NVAPI_VERSION(NV_GPU_MEMORY_INFO_EX_V1,1)
#define	NV_GPU_MEMORY_INFO_EX_VER   NV_GPU_MEMORY_INFO_EX_VER_1

Typedefs
typedef NV_DISPLAY_DRIVER_MEMORY_INFO_V3	NV_DISPLAY_DRIVER_MEMORY_INFO
typedef NV_GPU_MEMORY_INFO_EX_V1	NV_GPU_MEMORY_INFO_EX

Functions
	__nvapi_deprecated_function ("Do not use this function - it is deprecated in release 290. Instead, use NvAPI_SYS_GetDriverAndBranchVersion.") NVAPI_INTERFACE NvAPI_GetDisplayDriverVersion(NvDisplayHandle hNvDisplay
NVAPI_INTERFACE	NvAPI_SYS_GetDriverAndBranchVersion (NvU32 *pDriverVersion, NvAPI_ShortString szBuildBranchString)
	__nvapi_deprecated_function ("Do not use this function - it is deprecated in release 520. Instead, use NvAPI_GPU_GetMemoryInfoEx.") NVAPI_INTERFACE NvAPI_GPU_GetMemoryInfo(NvPhysicalGpuHandle hPhysicalGpu
NVAPI_INTERFACE	NvAPI_GPU_GetMemoryInfoEx (NvPhysicalGpuHandle hPhysicalGpu, NV_GPU_MEMORY_INFO_EX *pMemoryInfo)

Detailed Description

The display driver APIs are used to retrieve information about the display driver.

Macro Definition Documentation

NV_DISPLAY_DRIVER_MEMORY_INFO_VER

#define NV_DISPLAY_DRIVER_MEMORY_INFO_VER   NV_DISPLAY_DRIVER_MEMORY_INFO_VER_3

NV_DISPLAY_DRIVER_MEMORY_INFO_VER_1

#define NV_DISPLAY_DRIVER_MEMORY_INFO_VER_1   MAKE_NVAPI_VERSION(NV_DISPLAY_DRIVER_MEMORY_INFO_V1,1)

Macro for constructing the version field of NV_DISPLAY_DRIVER_MEMORY_INFO_V1

NV_DISPLAY_DRIVER_MEMORY_INFO_VER_2

#define NV_DISPLAY_DRIVER_MEMORY_INFO_VER_2   MAKE_NVAPI_VERSION(NV_DISPLAY_DRIVER_MEMORY_INFO_V2,2)

Macro for constructing the version field of NV_DISPLAY_DRIVER_MEMORY_INFO_V2

NV_DISPLAY_DRIVER_MEMORY_INFO_VER_3

#define NV_DISPLAY_DRIVER_MEMORY_INFO_VER_3   MAKE_NVAPI_VERSION(NV_DISPLAY_DRIVER_MEMORY_INFO_V3,3)

Macro for constructing the version field of NV_DISPLAY_DRIVER_MEMORY_INFO_V3

NV_DISPLAY_DRIVER_VERSION_VER

#define NV_DISPLAY_DRIVER_VERSION_VER   MAKE_NVAPI_VERSION(NV_DISPLAY_DRIVER_VERSION,1)

NV_GPU_MEMORY_INFO_EX_VER

#define NV_GPU_MEMORY_INFO_EX_VER   NV_GPU_MEMORY_INFO_EX_VER_1

NV_GPU_MEMORY_INFO_EX_VER_1

#define NV_GPU_MEMORY_INFO_EX_VER_1   MAKE_NVAPI_VERSION(NV_GPU_MEMORY_INFO_EX_V1,1)

Macro for constructing the version field of NV_GPU_MEMORY_INFO_EX_V1

Typedef Documentation

NV_DISPLAY_DRIVER_MEMORY_INFO

typedef NV_DISPLAY_DRIVER_MEMORY_INFO_V3 NV_DISPLAY_DRIVER_MEMORY_INFO

NV_GPU_MEMORY_INFO_EX

typedef NV_GPU_MEMORY_INFO_EX_V1 NV_GPU_MEMORY_INFO_EX

Function Documentation

__nvapi_deprecated_function() [1/2]

__nvapi_deprecated_function	(	"Do not use this function - it is deprecated in release 290.	Instead,
		use NvAPI_SYS_GetDriverAndBranchVersion."
	)

__nvapi_deprecated_function() [2/2]

__nvapi_deprecated_function	(	"Do not use this function - it is deprecated in release 520.	Instead,
		use NvAPI_GPU_GetMemoryInfoEx."
	)

DESCRIPTION: This function retrieves the available driver memory footprint for the specified GPU. If the GPU is in TCC Mode, only dedicatedVideoMemory will be returned in pMemoryInfo (NV_DISPLAY_DRIVER_MEMORY_INFO).

TCC_SUPPORTED

Since

Release: 177

Parameters

[in]	hPhysicalGpu	Handle of the physical GPU for which the memory information is to be extracted.
[out]	pMemoryInfo	The memory footprint available in the driver. See NV_DISPLAY_DRIVER_MEMORY_INFO.

Return values

NVAPI_INVALID_ARGUMENT	pMemoryInfo is NULL.
NVAPI_OK	Call successful.
NVAPI_NVIDIA_DEVICE_NOT_FOUND	No NVIDIA GPU driving a display was found.
NVAPI_INCOMPATIBLE_STRUCT_VERSION	NV_DISPLAY_DRIVER_MEMORY_INFO structure version mismatch.

NvAPI_GPU_GetMemoryInfoEx()

NVAPI_INTERFACE NvAPI_GPU_GetMemoryInfoEx	(	NvPhysicalGpuHandle	hPhysicalGpu,
		NV_GPU_MEMORY_INFO_EX *	pMemoryInfo
	)

DESCRIPTION: This function retrieves the available driver memory footprint for the specified GPU. If the GPU is in TCC Mode, only dedicatedVideoMemory will be returned in pMemoryInfo (NV_GPU_MEMORY_INFO_EX).

SUPPORTED OS: Windows 10 and higher

TCC_SUPPORTED

Since

Release: 520

Parameters

[in]	hPhysicalGpu	Handle of the physical GPU for which the memory information is to be extracted.
[out]	pMemoryInfo	The memory footprint available in the driver. See NV_GPU_MEMORY_INFO_EX.

Return values

NVAPI_INVALID_ARGUMENT	pMemoryInfo is NULL.
NVAPI_OK	Call successful.
NVAPI_NVIDIA_DEVICE_NOT_FOUND	No NVIDIA GPU driving a display was found.
NVAPI_INCOMPATIBLE_STRUCT_VERSION	NV_GPU_MEMORY_INFO_EX structure version mismatch.

NvAPI_SYS_GetDriverAndBranchVersion()

NVAPI_INTERFACE NvAPI_SYS_GetDriverAndBranchVersion	(	NvU32 *	pDriverVersion,
		NvAPI_ShortString	szBuildBranchString
	)

DESCRIPTION: This API returns display driver version and driver-branch string.

SUPPORTED OS: Windows 7 and higher

Parameters

[out]	pDriverVersion	Contains the driver version after successful return.
[out]	szBuildBranchString	Contains the driver-branch string after successful return.

Return values

NVAPI_INVALID_ARGUMENT	either pDriverVersion is NULL or enum index too big
NVAPI_OK	- completed request
NVAPI_API_NOT_INTIALIZED	- NVAPI not initialized
NVAPI_ERROR	- miscellaneous error occurred