NVAPI Reference Documentation
NVIDIA
Release 384: June 27
2017

System - General Interface

Data Structures

struct  NV_CHIPSET_INFO_v4
 
struct  NV_CHIPSET_INFO_v3
 
struct  NV_CHIPSET_INFO_v2
 
struct  NV_CHIPSET_INFO_v1
 
struct  NV_LID_DOCK_PARAMS
 

Macros

#define NV_CHIPSET_INFO_VER_1   MAKE_NVAPI_VERSION(NV_CHIPSET_INFO_v1,1)
 
#define NV_CHIPSET_INFO_VER_2   MAKE_NVAPI_VERSION(NV_CHIPSET_INFO_v2,2)
 
#define NV_CHIPSET_INFO_VER_3   MAKE_NVAPI_VERSION(NV_CHIPSET_INFO_v3,3)
 
#define NV_CHIPSET_INFO_VER_4   MAKE_NVAPI_VERSION(NV_CHIPSET_INFO_v4,4)
 
#define NV_CHIPSET_INFO   NV_CHIPSET_INFO_v4
 
#define NV_CHIPSET_INFO_VER   NV_CHIPSET_INFO_VER_4
 

Enumerations

enum  NV_CHIPSET_INFO_FLAGS { NV_CHIPSET_INFO_HYBRID = 0x00000001 }
 

Functions

NVAPI_INTERFACE NvAPI_SYS_GetChipSetInfo (NV_CHIPSET_INFO *pChipSetInfo)
 
NVAPI_INTERFACE NvAPI_SYS_GetLidAndDockInfo (NV_LID_DOCK_PARAMS *pLidAndDock)
 
NVAPI_INTERFACE NvAPI_SYS_GetDisplayIdFromGpuAndOutputId (NvPhysicalGpuHandle hPhysicalGpu, NvU32 outputId, NvU32 *displayId)
 
NVAPI_INTERFACE NvAPI_SYS_GetGpuAndOutputIdFromDisplayId (NvU32 displayId, NvPhysicalGpuHandle *hPhysicalGpu, NvU32 *outputId)
 
NVAPI_INTERFACE NvAPI_SYS_GetPhysicalGpuFromDisplayId (NvU32 displayId, NvPhysicalGpuHandle *hPhysicalGpu)
 

Detailed Description

The System APIs retrieve chipset information such as vendor/device name and IDs, and CPU information such as processor type, speed, embedded CPU name, etc.

Macro Definition Documentation

#define NV_CHIPSET_INFO   NV_CHIPSET_INFO_v4
#define NV_CHIPSET_INFO_VER   NV_CHIPSET_INFO_VER_4
#define NV_CHIPSET_INFO_VER_1   MAKE_NVAPI_VERSION(NV_CHIPSET_INFO_v1,1)
#define NV_CHIPSET_INFO_VER_2   MAKE_NVAPI_VERSION(NV_CHIPSET_INFO_v2,2)
#define NV_CHIPSET_INFO_VER_3   MAKE_NVAPI_VERSION(NV_CHIPSET_INFO_v3,3)
#define NV_CHIPSET_INFO_VER_4   MAKE_NVAPI_VERSION(NV_CHIPSET_INFO_v4,4)

Enumeration Type Documentation

Enumerator
NV_CHIPSET_INFO_HYBRID 

Function Documentation

NVAPI_INTERFACE NvAPI_SYS_GetChipSetInfo ( NV_CHIPSET_INFO pChipSetInfo)

This function returns information about the system's chipset.

SUPPORTED OS: Windows XP and higher

Since
Release: 95
Return values
NVAPI_INVALID_ARGUMENTpChipSetInfo is NULL.
NVAPI_OK*pChipSetInfo is now set.
NVAPI_INCOMPATIBLE_STRUCT_VERSIONNV_CHIPSET_INFO version not compatible with driver.
NVAPI_INTERFACE NvAPI_SYS_GetDisplayIdFromGpuAndOutputId ( NvPhysicalGpuHandle  hPhysicalGpu,
NvU32  outputId,
NvU32 displayId 
)

DESCRIPTION: This API converts a Physical GPU handle and output ID to a display ID.

SUPPORTED OS: Windows XP and higher

Parameters
[in]hPhysicalGpuHandle to the physical GPU
[in]outputIdConnected display output ID on the target GPU - must only have one bit set
[out]displayIdPointer to an NvU32 which contains the display ID
Return values
NVAPI_OK- completed request
NVAPI_API_NOT_INTIALIZED- NVAPI not initialized
NVAPI_ERROR- miscellaneous error occurred
NVAPI_INVALID_ARGUMENT- Invalid input parameter.
NVAPI_INTERFACE NvAPI_SYS_GetGpuAndOutputIdFromDisplayId ( NvU32  displayId,
NvPhysicalGpuHandle *  hPhysicalGpu,
NvU32 outputId 
)

DESCRIPTION: This API converts a display ID to a Physical GPU handle and output ID.

SUPPORTED OS: Windows XP and higher

Parameters
[in]displayIdDisplay ID of display to retrieve GPU and outputId for
[out]hPhysicalGpuHandle to the physical GPU
[out]outputId) Connected display output ID on the target GPU will only have one bit set.
Return values
NVAPI_OK
NVAPI_API_NOT_INTIALIZED
NVAPI_ID_OUT_OF_RANGEThe DisplayId corresponds to a display which is not within the normal outputId range.
NVAPI_ERROR
NVAPI_INVALID_ARGUMENT
NVAPI_INTERFACE NvAPI_SYS_GetLidAndDockInfo ( NV_LID_DOCK_PARAMS pLidAndDock)

DESCRIPTION: This function returns the current lid and dock information.

SUPPORTED OS: Windows XP and higher

Since
Release: 177
Return values
NVAPI_OK
NVAPI_ERROR
NVAPI_NOT_SUPPORTED
NVAPI_HANDLE_INVALIDATED
NVAPI_API_NOT_INTIALIZED
NVAPI_INTERFACE NvAPI_SYS_GetPhysicalGpuFromDisplayId ( NvU32  displayId,
NvPhysicalGpuHandle *  hPhysicalGpu 
)
1 DESCRIPTION: This API retrieves the Physical GPU handle of the connected display
2 
3 \since Release: 313
4 
5 SUPPORTED OS: Windows Vista and higher
6 
7 
8 PARAMETERS: displayId(IN) - Display ID of display to retrieve
9  GPU handle
10  hPhysicalGpu(OUT) - Handle to the physical GPU
11 
12 RETURN STATUS:
13  NVAPI_OK - completed request
14  NVAPI_API_NOT_INTIALIZED - NVAPI not initialized
15  NVAPI_ERROR - miscellaneous error occurred
16  NVAPI_INVALID_ARGUMENT - Invalid input parameter.


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

NVIDIA