NVAPI Reference Documentation
NVIDIA
Release 384: June 27
2017

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
 

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
 

Typedefs

typedef NV_DISPLAY_DRIVER_MEMORY_INFO_V3 NV_DISPLAY_DRIVER_MEMORY_INFO
 

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_INTERFACE NvAPI_GPU_GetMemoryInfo (NvPhysicalGpuHandle hPhysicalGpu, NV_DISPLAY_DRIVER_MEMORY_INFO *pMemoryInfo)
 

Detailed Description

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

Macro Definition Documentation

#define NV_DISPLAY_DRIVER_MEMORY_INFO_VER   NV_DISPLAY_DRIVER_MEMORY_INFO_VER_3
#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

#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

#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

#define NV_DISPLAY_DRIVER_VERSION_VER   MAKE_NVAPI_VERSION(NV_DISPLAY_DRIVER_VERSION,1)

Typedef Documentation

Function Documentation

__nvapi_deprecated_function ( "Do not use this function - it is deprecated in release 290.  Instead,
use NvAPI_SYS_GetDriverAndBranchVersion."   
)
NVAPI_INTERFACE NvAPI_GPU_GetMemoryInfo ( NvPhysicalGpuHandle  hPhysicalGpu,
NV_DISPLAY_DRIVER_MEMORY_INFO 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_DISPLAY_DRIVER_MEMORY_INFO).

SUPPORTED OS: Windows XP and higher

TCC_SUPPORTED

Since
Release: 177
Parameters
[in]hPhysicalGpuHandle of the physical GPU for which the memory information is to be extracted.
[out]pMemoryInfoThe memory footprint available in the driver. See NV_DISPLAY_DRIVER_MEMORY_INFO.
Return values
NVAPI_INVALID_ARGUMENTpMemoryInfo is NULL.
NVAPI_OKCall successful.
NVAPI_NVIDIA_DEVICE_NOT_FOUNDNo NVIDIA GPU driving a display was found.
NVAPI_INCOMPATIBLE_STRUCT_VERSIONNV_DISPLAY_DRIVER_MEMORY_INFO structure version mismatch.
NVAPI_INTERFACE NvAPI_SYS_GetDriverAndBranchVersion ( NvU32 pDriverVersion,
NvAPI_ShortString  szBuildBranchString 
)

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

SUPPORTED OS: Windows XP and higher

Parameters
[out]pDriverVersionContains the driver version after successful return.
[out]szBuildBranchStringContains the driver-branch string after successful return.
Return values
NVAPI_INVALID_ARGUMENTeither pDriverVersion is NULL or enum index too big
NVAPI_OK- completed request
NVAPI_API_NOT_INTIALIZED- NVAPI not initialized
NVAPI_ERROR- miscellaneous error occurred


Copyright (c) 2007-2017 NVIDIA Corporation. All rights reserved.

NVIDIA