|
NVAPI Reference Documentation
|
Release 560
|
Data Structures | |
| struct | _NV_GPU_DISPLAYIDS |
| struct | _NV_BOARD_INFO |
| struct | NV_GPU_ARCH_INFO_V1 |
| struct | NV_GPU_ARCH_INFO_V2 |
| struct | NV_I2C_INFO_V1 |
| struct | NV_I2C_INFO_V2 |
| struct | NV_I2C_INFO_V3 |
| struct | NV_GPU_GET_HDCP_SUPPORT_STATUS |
| struct | NV_COMPUTE_GPU_TOPOLOGY_V1 |
| struct | _NV_COMPUTE_GPU |
| struct | _NV_COMPUTE_GPU_TOPOLOGY_V2 |
| struct | NV_SCANOUT_INTENSITY_DATA_V1 |
| struct | NV_SCANOUT_INTENSITY_DATA_V2 |
| struct | _NV_SCANOUT_INTENSITY_STATE_DATA |
| struct | NV_SCANOUT_WARPING_DATA |
| struct | _NV_SCANOUT_WARPING_STATE_DATA |
| struct | _NV_SCANOUT_INFORMATION |
| struct | _NV_GPU_VIRTUALIZATION_INFO |
| struct | _NV_LOGICAL_GPU_DATA_V1 |
| struct | _NV_GPU_GSP_INFO_V1 |
| struct | _NV_GPU_QUERY_ILLUMINATION_SUPPORT_PARM_V1 |
| struct | _NV_GPU_GET_ILLUMINATION_PARM_V1 |
| struct | _NV_GPU_SET_ILLUMINATION_PARM_V1 |
Variables | |
| NvU32 * | pSize |
| NvU32 * | pRate |
| NvU32 * | pStatus |
The general GPU APIs are used to get general information about the GPU, such as outputs, VBIOS revision, APG rate, and frame buffer size.
| #define NV_BOARD_INFO_VER NV_BOARD_INFO_VER1 |
| #define NV_BOARD_INFO_VER1 MAKE_NVAPI_VERSION(NV_BOARD_INFO_V1,1) |
| #define NV_COMPUTE_GPU_TOPOLOGY_CUDA_AVAILABLE NV_BIT(4) |
This is Read only GPU flag.
| #define NV_COMPUTE_GPU_TOPOLOGY_CUDA_CAPABLE NV_BIT(16) |
This is Read only GPU flag.
| #define NV_COMPUTE_GPU_TOPOLOGY_CUDA_DISABLED NV_BIT(17) |
This is Read only GPU flag.
| #define NV_COMPUTE_GPU_TOPOLOGY_PHYSICS_AVAILABLE NV_BIT(21) |
This is Read only GPU flag - PhysX is able to use this GPU (PhysX is installed, etc)
| #define NV_COMPUTE_GPU_TOPOLOGY_PHYSICS_CAPABLE NV_BIT(0) |
This is Read only GPU flag - Physics capable GPU.
defgroup nvcomp_gpu_top NVIDIA Compute GPU Topology Flags
| #define NV_COMPUTE_GPU_TOPOLOGY_PHYSICS_DEDICATED NV_BIT(2) |
This is Read only GPU flag - Physics enabled GPU which is dedicated for physics indicates this compute capable GPU was automatically made usable for Physx on CUDA.
| #define NV_COMPUTE_GPU_TOPOLOGY_PHYSICS_ENABLE NV_BIT(1) |
This is Read/Write GPU flag - Indicates GPU is already enabled for physics.
| #define NV_COMPUTE_GPU_TOPOLOGY_PHYSICS_RECOMMENDED NV_BIT(3) |
This is Read only GPU flag - Physics GPU which is recommended by the driver.
| #define NV_COMPUTE_GPU_TOPOLOGY_VER MAKE_NVAPI_VERSION(NV_COMPUTE_GPU_TOPOLOGY_V2,2) |
| #define NV_COMPUTE_GPU_TOPOLOGY_VER1 MAKE_NVAPI_VERSION(NV_COMPUTE_GPU_TOPOLOGY_V1,1) |
Macro for constructing the version field of NV_COMPUTE_GPU_TOPOLOGY.
| #define NV_EDID_DATA_SIZE NV_EDID_V1_DATA_SIZE |
| #define NV_EDID_DATA_SIZE_MAX 1024 |
Used in NvAPI_DISP_GetEdidData This is the current size supported by Nvidia Display Driver and may change in future.
| #define NV_EDID_V1_DATA_SIZE 256 |
| #define NV_EDID_VER NV_EDID_VER3 |
| #define NV_EDID_VER1 MAKE_NVAPI_VERSION(NV_EDID_V1,1) |
| #define NV_EDID_VER2 MAKE_NVAPI_VERSION(NV_EDID_V2,2) |
| #define NV_EDID_VER3 MAKE_NVAPI_VERSION(NV_EDID_V3,3) |
| #define NV_GPU_ARCH_INFO_VER NV_GPU_ARCH_INFO_VER_2 |
| #define NV_GPU_ARCH_INFO_VER_1 MAKE_NVAPI_VERSION(NV_GPU_ARCH_INFO_V1,1) |
| #define NV_GPU_ARCH_INFO_VER_2 MAKE_NVAPI_VERSION(NV_GPU_ARCH_INFO_V2,2) |
| #define NV_GPU_CONNECTED_IDS_FLAG_EXCLUDE_MST NV_BIT(4) |
Excludes devices that are part of the multi stream topology.
| #define NV_GPU_CONNECTED_IDS_FLAG_FAKE NV_BIT(3) |
Get devices that includes the fake connected monitors.
| #define NV_GPU_CONNECTED_IDS_FLAG_LIDSTATE NV_BIT(2) |
Get devices such that to reflect the Lid State.
| #define NV_GPU_CONNECTED_IDS_FLAG_SLI NV_BIT(1) |
Get devices such that those can be selected in an SLI configuration.
| #define NV_GPU_CONNECTED_IDS_FLAG_UNCACHED NV_BIT(0) |
Get uncached connected devices.
| #define NV_GPU_DISPLAYIDS_VER NV_GPU_DISPLAYIDS_VER2 |
| #define NV_GPU_DISPLAYIDS_VER1 MAKE_NVAPI_VERSION(NV_GPU_DISPLAYIDS,1) |
Macro for constructing the version field of _NV_GPU_DISPLAYIDS
| #define NV_GPU_DISPLAYIDS_VER2 MAKE_NVAPI_VERSION(NV_GPU_DISPLAYIDS,3) |
| #define NV_GPU_GET_HDCP_SUPPORT_STATUS_VER MAKE_NVAPI_VERSION(NV_GPU_GET_HDCP_SUPPORT_STATUS,1) |
Macro for constructing the version for structure NV_GPU_GET_HDCP_SUPPORT_STATUS.
| #define NV_GPU_GET_ILLUMINATION_PARM_VER NV_GPU_GET_ILLUMINATION_PARM_VER_1 |
| #define NV_GPU_GET_ILLUMINATION_PARM_VER_1 MAKE_NVAPI_VERSION(NV_GPU_GET_ILLUMINATION_PARM_V1,1) |
| #define NV_GPU_GSP_INFO_VER1 MAKE_NVAPI_VERSION(NV_GPU_GSP_INFO_V1, 1) |
Macro for constructing the version field of NV_GPU_GSP_INFO_V1
| #define NV_GPU_QUERY_ILLUMINATION_SUPPORT_PARM_VER NV_GPU_QUERY_ILLUMINATION_SUPPORT_PARM_VER_1 |
| #define NV_GPU_QUERY_ILLUMINATION_SUPPORT_PARM_VER_1 MAKE_NVAPI_VERSION(NV_GPU_QUERY_ILLUMINATION_SUPPORT_PARM_V1,1) |
| #define NV_GPU_SET_ILLUMINATION_PARM_VER NV_GPU_SET_ILLUMINATION_PARM_VER_1 |
| #define NV_GPU_SET_ILLUMINATION_PARM_VER_1 MAKE_NVAPI_VERSION(NV_GPU_SET_ILLUMINATION_PARM_V1,1) |
| #define NV_GPU_VIRTUALIZATION_INFO_VER NV_GPU_VIRTUALIZATION_INFO_VER1 |
| #define NV_GPU_VIRTUALIZATION_INFO_VER1 MAKE_NVAPI_VERSION(NV_GPU_VIRTUALIZATION_INFO_V1,1) |
| #define NV_I2C_INFO_VER NV_I2C_INFO_VER3 |
| #define NV_I2C_INFO_VER1 MAKE_NVAPI_VERSION(NV_I2C_INFO_V1,1) |
| #define NV_I2C_INFO_VER2 MAKE_NVAPI_VERSION(NV_I2C_INFO_V2,2) |
| #define NV_I2C_INFO_VER3 MAKE_NVAPI_VERSION(NV_I2C_INFO_V3,3) |
| #define NV_SCANOUT_INTENSITY_DATA_VER1 MAKE_NVAPI_VERSION(NV_SCANOUT_INTENSITY_DATA_V1, 1) |
| #define NV_SCANOUT_INTENSITY_STATE_VER MAKE_NVAPI_VERSION(NV_SCANOUT_INTENSITY_STATE_DATA, 1) |
| #define NV_SCANOUT_WARPING_STATE_VER MAKE_NVAPI_VERSION(NV_SCANOUT_WARPING_STATE_DATA, 1) |
| #define NV_SCANOUT_WARPING_VER MAKE_NVAPI_VERSION(NV_SCANOUT_WARPING_DATA, 1) |
| #define NVAPI_DISPLAY_DEVICE_MASK_MAX 24 |
| #define NVAPI_GPU_MAX_BUILD_VERSION_LENGTH (0x0000040) |
| #define NVAPI_I2C_SPEED_DEPRECATED 0xFFFF |
| #define NVAPI_MAX_SIZEOF_I2C_REG_ADDRESS 4 |
| typedef NV_BOARD_INFO_V1 NV_BOARD_INFO |
| typedef struct _NV_BOARD_INFO NV_BOARD_INFO_V1 |
| typedef struct _NV_COMPUTE_GPU NV_COMPUTE_GPU |
| typedef struct _NV_COMPUTE_GPU_TOPOLOGY_V2 NV_COMPUTE_GPU_TOPOLOGY_V2 |
| typedef NV_EDID_V3 NV_EDID |
NV_GPU_ARCH_INFO() values to identify GPU Architecture Implementation.
| typedef NV_GPU_ARCH_INFO_V2 NV_GPU_ARCH_INFO |
| typedef enum _NV_GPU_ARCHITECTURE_ID NV_GPU_ARCHITECTURE_ID |
NV_GPU_ARCH_INFO() values to identify Architecture level for the GPU.
| typedef enum _NV_GPU_BUS_TYPE NV_GPU_BUS_TYPE |
Used in NvAPI_GPU_GetBusType()
| typedef enum _NV_GPU_CHIP_REVISION NV_GPU_CHIP_REVISION |
| typedef enum _NV_GPU_CONNECTOR_TYPE NV_GPU_CONNECTOR_TYPE |
Used in NV_GPU_CONNECTOR_DATA
| typedef struct _NV_GPU_DISPLAYIDS NV_GPU_DISPLAYIDS |
| typedef struct _NV_GPU_GET_ILLUMINATION_PARM_V1 NV_GPU_GET_ILLUMINATION_PARM_V1 |
| typedef struct _NV_GPU_GSP_INFO_V1 NV_GPU_GSP_INFO_V1 |
Used in NvAPI_GPU_GetGspFeatures().
| typedef enum _NV_GPU_HDCP_FUSE_STATE NV_GPU_HDCP_FUSE_STATE |
HDCP fuse states - used in NV_GPU_GET_HDCP_SUPPORT_STATUS.
| typedef enum _NV_GPU_HDCP_KEY_SOURCE NV_GPU_HDCP_KEY_SOURCE |
HDCP key sources - used in NV_GPU_GET_HDCP_SUPPORT_STATUS.
HDCP key source states - used in NV_GPU_GET_HDCP_SUPPORT_STATUS.
| typedef enum _NV_GPU_ILLUMINATION_ATTRIB NV_GPU_ILLUMINATION_ATTRIB |
| typedef enum _NV_GPU_OUTPUT_TYPE NV_GPU_OUTPUT_TYPE |
used in NvAPI_GPU_GetOutputType()
| typedef struct _NV_GPU_SET_ILLUMINATION_PARM_V1 NV_GPU_SET_ILLUMINATION_PARM_V1 |
| typedef enum _NV_GPU_TYPE NV_GPU_TYPE |
Used in NvAPI_GPU_GetGPUType().
| typedef struct _NV_GPU_VIRTUALIZATION_INFO NV_GPU_VIRTUALIZATION_INFO_V1 |
| typedef NV_I2C_INFO_V3 NV_I2C_INFO |
| typedef struct _NV_LOGICAL_GPU_DATA_V1 NV_LOGICAL_GPU_DATA_V1 |
| typedef struct _NV_SCANOUT_INFORMATION NV_SCANOUT_INFORMATION |
| typedef struct _NV_SCANOUT_INTENSITY_STATE_DATA NV_SCANOUT_INTENSITY_STATE_DATA |
| typedef struct _NV_SCANOUT_WARPING_STATE_DATA NV_SCANOUT_WARPING_STATE_DATA |
| typedef enum _NV_VIRTUALIZATION_MODE NV_VIRTUALIZATION_MODE |
NV_GPU_ARCH_INFO() values to identify GPU Architecture Implementation.
NV_GPU_ARCH_INFO() values to identify Architecture level for the GPU.
| enum _NV_GPU_BUS_TYPE |
Used in NvAPI_GPU_GetBusType()
| Enumerator | |
|---|---|
| NVAPI_GPU_BUS_TYPE_UNDEFINED | |
| NVAPI_GPU_BUS_TYPE_PCI | |
| NVAPI_GPU_BUS_TYPE_AGP | |
| NVAPI_GPU_BUS_TYPE_PCI_EXPRESS | |
| NVAPI_GPU_BUS_TYPE_FPCI | |
| NVAPI_GPU_BUS_TYPE_AXI | |
Used in NV_GPU_CONNECTOR_DATA
HDCP fuse states - used in NV_GPU_GET_HDCP_SUPPORT_STATUS.
| Enumerator | |
|---|---|
| NV_GPU_HDCP_FUSE_STATE_UNKNOWN | |
| NV_GPU_HDCP_FUSE_STATE_DISABLED | |
| NV_GPU_HDCP_FUSE_STATE_ENABLED | |
HDCP key sources - used in NV_GPU_GET_HDCP_SUPPORT_STATUS.
| Enumerator | |
|---|---|
| NV_GPU_HDCP_KEY_SOURCE_UNKNOWN | |
| NV_GPU_HDCP_KEY_SOURCE_NONE | |
| NV_GPU_HDCP_KEY_SOURCE_CRYPTO_ROM | |
| NV_GPU_HDCP_KEY_SOURCE_SBIOS | |
| NV_GPU_HDCP_KEY_SOURCE_I2C_ROM | |
| NV_GPU_HDCP_KEY_SOURCE_FUSES | |
HDCP key source states - used in NV_GPU_GET_HDCP_SUPPORT_STATUS.
| Enumerator | |
|---|---|
| NV_GPU_HDCP_KEY_SOURCE_STATE_UNKNOWN | |
| NV_GPU_HDCP_KEY_SOURCE_STATE_ABSENT | |
| NV_GPU_HDCP_KEY_SOURCE_STATE_PRESENT | |
| enum _NV_GPU_OUTPUT_TYPE |
used in NvAPI_GPU_GetOutputType()
| Enumerator | |
|---|---|
| NVAPI_GPU_OUTPUT_UNKNOWN | |
| NVAPI_GPU_OUTPUT_CRT | CRT display device. |
| NVAPI_GPU_OUTPUT_DFP | Digital Flat Panel display device. |
| NVAPI_GPU_OUTPUT_TV | TV display device. |
| enum _NV_GPU_TYPE |
Used in NvAPI_GPU_GetGPUType().
| Enumerator | |
|---|---|
| NV_SYSTEM_TYPE_GPU_UNKNOWN | |
| NV_SYSTEM_TYPE_IGPU | Integrated GPU. |
| NV_SYSTEM_TYPE_DGPU | Discrete GPU. |
| enum NV_I2C_SPEED |
| enum NV_MONITOR_CONN_TYPE |
Get uncached connected devices.
| enum NV_SYSTEM_TYPE |
Used in NvAPI_GPU_GetSystemType()
| Enumerator | |
|---|---|
| NV_SYSTEM_TYPE_UNKNOWN | |
| NV_SYSTEM_TYPE_LAPTOP | |
| NV_SYSTEM_TYPE_DESKTOP | |
| __nvapi_deprecated_function | ( | "Do not use this function - it is deprecated in release 290. | Instead, |
| use NvAPI_GPU_GetAllDisplayIds." | |||
| ) |
This function returns set of all GPU-output identifiers as a bitmask.
| 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. |
| __nvapi_deprecated_function | ( | "Do not use this function - it is deprecated in release 290. | Instead, |
| use NvAPI_GPU_GetConnectedDisplayIds." | |||
| ) |
This function is the same as NvAPI_GPU_GetAllOutputs() but returns only the set of GPU output identifiers that are connected to display devices.
| 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. NOTE: This function matches NvAPI_GPU_GetConnectedOutputs()
| 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.
| 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().
| 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 |
| __nvapi_deprecated_function | ( | "Do not use this function - it is deprecated in release 455." | ) |
This function returns the AGP aperture in megabytes.
TCC_SUPPORTED
| NVAPI_NOT_SUPPORTED |
This function returns the current AGP Rate (0 = AGP not present, 1 = 1x, 2 = 2x, etc.).
TCC_SUPPORTED
| NVAPI_NOT_SUPPORTED |
| __nvapi_deprecated_function | ( | "Do not use this function - it is deprecated in release 460." | ) |
This function retrieves the Quadro status for the GPU (1 if Quadro, 0 if GeForce)
This API is deprecated and it is recommended to instead query NV_GPU_WORKSTATION_FEATURE_TYPE_PROVIZ support from the API NvAPI_GPU_QueryWorkstationFeatureSupport.
| __nvapi_deprecated_function | ( | "Do not use this function - it is deprecated in release 520. | Instead, |
| use NvAPI_GPU_GetLogicalGpuInfo." | |||
| ) |
DESCRIPTION: This API returns the OS-AdapterID from physicalGpu Handle. OS-AdapterID is the Adapter ID that is used by Win7 CCD APIs. This API is deprecated. Please use NvAPI_GPU_GetLogicalGpuInfo to get the OS-AdapterID. NvAPI_GetLogicalGPUFromPhysicalGPU can be used to get the logical GPU handle associated with specified physical GPU handle.
| [in] | hPhysicalGpu | PhysicalGpu Handle |
| [out] | pOSAdapterId | Returns OS-AdapterId, it is typed as void * to avoid dependency with windows.h. User must type cast it to LUID. |
| NVAPI_INVALID_ARGUMENT | pOSAdapterId is NULL; hPhysicalGpu is invalid |
| NVAPI_OK | *pOSAdapterId contains valid data. |
| NVAPI_NOT_SUPPORTED | This API is not supported on the system. |
| NVAPI_INTERFACE NvAPI_DestroyPresentBarrierClient | ( | __in NvPresentBarrierClientHandle | presentBarrierClient | ) |
SUPPORTED OS: Windows 10 and higher DESCRIPTION: This API destroys a presentBarrier client, and must be called after client leaves presentBarrier to avoid memory leak.
| [in] | presentBarrierClient | An NvPresentBarrierClientHandle handle created by NvAPI_xxxx_CreatedPresentBarrierClient |
| NVAPI_API_NOT_INITIALIZED | NvAPI not initialized |
| NVAPI_INTERFACE NvAPI_DISP_GetNvManagedDedicatedDisplayMetadata | ( | __inout NV_MANAGED_DEDICATED_DISPLAY_METADATA * | pDedicatedDisplayMetadata | ) |
DESCRIPTION: This API returns metadata which has been set for the display connector in question. Main use case would be to query the data for an Nvidia managed dedicated display. The function will work for any valid displayId though.
| [in/out] | pDedicatedDisplayMetadata Data structure containing input and output data. |
| NVAPI_OK | The call succeeded. |
| NVAPI_ERROR | The call failed. |
| NVAPI_NO_IMPLEMENTATION | The API is not implemented in current driver. |
| NVAPI_NOT_SUPPORTED | The API is not supported on the current operating system or gpu. |
| NVAPI_OUT_OF_MEMORY | There wasn't sufficient memory to complete the call. |
| NVAPI_INVALID_POINTER | An invalid pointer was passed as an argument. |
| NVAPI_API_NOT_INITIALIZED | NvAPI was not initialized. |
| NVAPI_INCOMPATIBLE_STRUCT_VERSION | The version of the NV_MANAGED_DEDICATED_DISPLAY_METADATA structure is invalid. |
| NVAPI_INTERFACE NvAPI_DISP_GetNvManagedDedicatedDisplays | ( | __inout NvU32 * | pDedicatedDisplayCount, |
| __inout NV_MANAGED_DEDICATED_DISPLAY_INFO * | pDedicatedDisplays | ||
| ) |
DESCRIPTION: This API returns the count of dedicated displays managed by the Nvidia driver, and specific driver info of each display. This API does not return VR displays.
HOW TO USE: 1) First make a call NvAPI_DISP_GetNvManagedDedicatedDisplays to get the number of dedicated displays managed by the Nvidia driver by passing pDedicatedDisplays as NULL. On call success: 2) Allocate memory based on pDisplayCount, then call NvAPI_DISP_GetNvManagedDedicatedDisplays to populate pDedicatedDisplays.
| [in/out] | pDedicatedDisplayCount The count of dedicated displays managed by the Nvidia driver. |
| [in/out] | pDedicatedDisplays Pointer to an array of NV_MANAGED_DEDICATED_DISPLAY_INFO data structure. |
| NVAPI_OK | The call succeeded. |
| NVAPI_ERROR | The call failed. |
| NVAPI_NO_IMPLEMENTATION | The API is not implemented in current driver. |
| NVAPI_OUT_OF_MEMORY | Could not allocate sufficient memory to complete the call. |
| NVAPI_INVALID_POINTER | An invalid pointer was passed as an argument. |
| NVAPI_API_NOT_INITIALIZED | NvAPI was not initialized. |
| NVAPI_INCOMPATIBLE_STRUCT_VERSION | The version of NV_MANAGED_DEDICATED_DISPLAY_INFO structure is invalid. |
| NVAPI_INTERFACE NvAPI_DISP_SetNvManagedDedicatedDisplayMetadata | ( | __inout NV_MANAGED_DEDICATED_DISPLAY_METADATA * | pDedicatedDisplayMetadata | ) |
SUPPORTED OS: Windows 11 and higher DESCRIPTION: This API allows to set metadata for the display connector in question. Main use case would be to set the data for an Nvidia managed dedicated display. The function will work for any valid displayId though.
| [in/out] | pDedicatedDisplayMetadata Data structure containing input and output data. |
| NVAPI_OK | The call succeeded. |
| NVAPI_ERROR | The call failed. |
| NVAPI_NO_IMPLEMENTATION | The API is not implemented in current driver. |
| NVAPI_NOT_SUPPORTED | The API is not supported on the current operating system or gpu. |
| NVAPI_OUT_OF_MEMORY | There wasn't sufficient memory to complete the call. |
| NVAPI_INVALID_POINTER | An invalid pointer was passed as an argument. |
| NVAPI_API_NOT_INITIALIZED | NvAPI was not initialized. |
| NVAPI_INCOMPATIBLE_STRUCT_VERSION | The version of the NV_MANAGED_DEDICATED_DISPLAY_METADATA structure is invalid. |
| NVAPI_INVALID_USER_PRIVILEGE | The caller doesn't have the required administrator privileges to access this API. |
| NVAPI_INVALID_ARGUMENT | Characters in pDedicatedDisplayMetadata->name are out of the allowed range. |
| NVAPI_INTERFACE NvAPI_EnumLogicalGPUs | ( | NvLogicalGpuHandle | nvGPUHandle[NVAPI_MAX_LOGICAL_GPUS], |
| NvU32 * | pGpuCount | ||
| ) |
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.
To detect if SLI rendering is enabled, use NvAPI_D3D_GetCurrentSLIState().
SUPPORTED OS: Windows 7 and higher
| 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 |
| NVAPI_INTERFACE NvAPI_EnumPhysicalGPUs | ( | NvPhysicalGpuHandle | nvGPUHandle[NVAPI_MAX_PHYSICAL_GPUS], |
| NvU32 * | pGpuCount | ||
| ) |
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.
For GPU handles in TCC MODE please use NvAPI_EnumTCCPhysicalGPUs()
SUPPORTED OS: Windows 7 and higher
| 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 |
| NVAPI_INTERFACE NvAPI_EnumTCCPhysicalGPUs | ( | NvPhysicalGpuHandle | nvGPUHandle[NVAPI_MAX_PHYSICAL_GPUS], |
| NvU32 * | pGpuCount | ||
| ) |
This function returns an array of physical GPU handles that are in TCC Mode. Each handle represents a physical GPU present in the system in TCC Mode. That GPU may not be visible to the OS directly.
The array nvGPUHandle will be filled with physical GPU handle values. The returned gpuCount determines how many entries in the array are valid.
NOTE: Handles enumerated by this API are only valid for NvAPIs that are tagged as TCC_SUPPORTED If handle is passed to any other API, it will fail with NVAPI_INVALID_HANDLE
For WDDM GPU handles please use NvAPI_EnumPhysicalGPUs()
SUPPORTED OS: Windows 7 and higher
| [out] | nvGPUHandle | Physical GPU array that will contain all TCC Physical GPUs |
| [out] | pGpuCount | count represent the number of valid entries in nvGPUHandle |
| NVAPI_INVALID_ARGUMENT | nvGPUHandle or pGpuCount is NULL |
| NVAPI_INTERFACE NvAPI_Event_RegisterCallback | ( | PNV_EVENT_REGISTER_CALLBACK | eventCallback, |
| NvEventHandle * | phClient | ||
| ) |
DESCRIPTION: This API registers the process for events. This API should be called for each eventcallback. The handle returned to the client will be common across all eventCallbacks.
SUPPORTED OS: Windows 7 and higher
| [in] | eventCallback | Pointer to NV_EVENT_REGISTER_CALLBACK structure to call on new events |
| [out] | phClient | Handle to client for use with unregister function |
| NVAPI_OK | - completed request |
| NVAPI_API_NOT_INTIALIZED | - NvAPI not initialized |
| NVAPI_INVALID_ARGUMENT | - Invalid argument |
| NVAPI_ERROR | - miscellaneous error occurred |
| NVAPI_INTERFACE NvAPI_Event_UnregisterCallback | ( | NvEventHandle | hClient | ) |
DESCRIPTION: This API unregister an event handle. This API should be called only once per process(irrespective of the number of callbacks registered).
SUPPORTED OS: Windows 7 and higher
| [in] | hClient | Handle associated with this listeners event queue. Same as returned from NvAPI_Event_RegisterCallback(). |
| NVAPI_OK | - completed request |
| NVAPI_API_NOT_INTIALIZED | - NvAPI not initialized |
| NVAPI_INVALID_ARGUMENT | - Invalid argument |
| NVAPI_ERROR | - miscellaneous error occurred |
| NVAPI_INTERFACE NvAPI_GetGPUIDfromPhysicalGPU | ( | NvPhysicalGpuHandle | hPhysicalGpu, |
| NvU32 * | pGpuId | ||
| ) |
Do not use this function for new software development.
SUPPORTED OS: Windows 10 and higher
TCC_SUPPORTED
MCDM_SUPPORTED
| NVAPI_INVALID_ARGUMENT | hPhysicalGpu is NULL or invalid. Re-enumerate the GPU handles. |
| NVAPI_OK | Handle was returned |
| NVAPI_NVIDIA_DEVICE_NOT_FOUND | No NVIDIA GPU driving a display was found |
| NVAPI_INTERFACE NvAPI_GetLogicalGPUFromDisplay | ( | NvDisplayHandle | hNvDisp, |
| NvLogicalGpuHandle * | pLogicalGPU | ||
| ) |
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. hNvDisp can be NVAPI_DEFAULT_HANDLE or a handle enumerated from NvAPI_EnumNVidiaDisplayHandle().
SUPPORTED OS: Windows 7 and higher
| 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 |
| NVAPI_INTERFACE NvAPI_GetLogicalGPUFromPhysicalGPU | ( | NvPhysicalGpuHandle | hPhysicalGPU, |
| NvLogicalGpuHandle * | pLogicalGPU | ||
| ) |
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: Windows 7 and higher
| 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 |
| NVAPI_INTERFACE NvAPI_GetPhysicalGPUFromGPUID | ( | NvU32 | gpuId, |
| NvPhysicalGpuHandle * | pPhysicalGPU | ||
| ) |
Do not use this function for new software development.
SUPPORTED OS: Windows 10 and higher
TCC_SUPPORTED
MCDM_SUPPORTED
| NVAPI_INVALID_ARGUMENT | gpuId is zero or pPhysicalGPU is NULL |
| NVAPI_OK | Handle was returned |
| NVAPI_NVIDIA_DEVICE_NOT_FOUND | No NVIDIA GPU driving a display was found |
| NVAPI_INTERFACE NvAPI_GetPhysicalGPUFromUnAttachedDisplay | ( | NvUnAttachedDisplayHandle | hNvUnAttachedDisp, |
| NvPhysicalGpuHandle * | pPhysicalGpu | ||
| ) |
This function returns a physical GPU handle associated with the specified unattached display. The source GPU is a physical render GPU which renders the frame buffer but may or may not drive the scan out.
At least one GPU must be present in the system and running an NVIDIA display driver.
SUPPORTED OS: Windows 7 and higher
| 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 |
| NVAPI_INTERFACE NvAPI_GetPhysicalGPUsFromDisplay | ( | NvDisplayHandle | hNvDisp, |
| NvPhysicalGpuHandle | nvGPUHandle[NVAPI_MAX_PHYSICAL_GPUS], | ||
| NvU32 * | pGpuCount | ||
| ) |
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.
If the display corresponds to more than one physical GPU, the first GPU returned is the one with the attached active output.
SUPPORTED OS: Windows 7 and higher
| 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 |
| NVAPI_INTERFACE NvAPI_GetPhysicalGPUsFromLogicalGPU | ( | NvLogicalGpuHandle | hLogicalGPU, |
| NvPhysicalGpuHandle | hPhysicalGPU[NVAPI_MAX_PHYSICAL_GPUS], | ||
| NvU32 * | pGpuCount | ||
| ) |
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: Windows 7 and higher
| 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 |
| NVAPI_INTERFACE NvAPI_GPU_GetActiveOutputs | ( | NvPhysicalGpuHandle | hPhysicalGpu, |
| NvU32 * | pOutputsMask | ||
| ) |
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 7 and higher
| 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. |
| NVAPI_INTERFACE NvAPI_GPU_GetAllDisplayIds | ( | __in NvPhysicalGpuHandle | hPhysicalGpu, |
| __inout_ecount_part_opt *, *pDisplayIdCount NV_GPU_DISPLAYIDS * | pDisplayIds, | ||
| __inout NvU32 * | pDisplayIdCount | ||
| ) |
DESCRIPTION: This API returns display IDs for all possible outputs on the GPU. For DPMST connector, it will return display IDs for all the video sinks in the topology.
HOW TO USE: 1. The first call should be made to get the all display ID count. To get the display ID count, send in
a) hPhysicalGpu - a valid WDDM type GPU handle(enumerated using NvAPI_SYS_GetPhysicalGPUs()) as input,
b) pDisplayIds - NULL, as we just want to get the display ID count.
c) pDisplayIdCount - a valid pointer to NvU32, whose value is set to ZERO.
If all parameters are correct and this call is successful, this call will return the display ID's count.
SUPPORTED OS: Windows 7 and higher
| [in] | hPhysicalGpu | GPU selection. |
| [in,out] | DisplayIds | Pointer to an array of NV_GPU_DISPLAYIDS structures, each entry represents one displayID and its attributes. |
| [in,out] | pDisplayIdCount | As input, this parameter indicates the number of display's id's for which caller has allocated the memory. As output, it will return the actual number of display IDs. |
| NVAPI_INSUFFICIENT_BUFFER | When the input buffer(pDisplayIds) is less than the actual number of display IDs, this API will return NVAPI_INSUFFICIENT_BUFFER. |
| NvAPI_GPU_GetArchInfo | ( | NvPhysicalGpuHandle | hPhysicalGpu, |
| NV_GPU_ARCH_INFO * | pGpuArchInfo | ||
| ) |
This function retrieves the architecture, implementation and chip revision for the specified GPU .
SUPPORTED OS: Windows 7 and higher
TCC_SUPPORTED
MCDM_SUPPORTED
| NVAPI_INTERFACE NvAPI_GPU_GetBoardInfo | ( | NvPhysicalGpuHandle | hPhysicalGpu, |
| NV_BOARD_INFO * | pBoardInfo | ||
| ) |
SUPPORTED OS: Windows 7 and higher DESCRIPTION: This API Retrieves the Board information (a unique GPU Board Serial Number) stored in the InfoROM.
| [in] | hPhysicalGpu | Physical GPU Handle. |
| [in,out] | NV_BOARD_INFO | Board Information. |
TCC_SUPPORTED
MCDM_SUPPORTED
| NVAPI_OK | completed request |
| NVAPI_ERROR | miscellaneous error occurred |
| NVAPI_EXPECTED_PHYSICAL_GPU_HANDLE | handle passed is not a physical GPU handle |
| NVAPI_API_NOT_INTIALIZED | NVAPI not initialized |
| NVAPI_INVALID_POINTER | pBoardInfo is NULL |
| NVAPI_INCOMPATIBLE_STRUCT_VERSION | the version of the INFO struct is not supported |
| NVAPI_INTERFACE NvAPI_GPU_GetBusId | ( | NvPhysicalGpuHandle | hPhysicalGpu, |
| NvU32 * | pBusId | ||
| ) |
DESCRIPTION: Returns the ID of the bus associated with this GPU.
SUPPORTED OS: Windows 7 and higher
TCC_SUPPORTED
MCDM_SUPPORTED
| 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. |
| NVAPI_INTERFACE NvAPI_GPU_GetBusSlotId | ( | NvPhysicalGpuHandle | hPhysicalGpu, |
| NvU32 * | pBusSlotId | ||
| ) |
DESCRIPTION: Returns the ID of the bus slot associated with this GPU.
SUPPORTED OS: Windows 7 and higher
TCC_SUPPORTED
MCDM_SUPPORTED
| 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. |
| NVAPI_INTERFACE NvAPI_GPU_GetBusType | ( | NvPhysicalGpuHandle | hPhysicalGpu, |
| NV_GPU_BUS_TYPE * | pBusType | ||
| ) |
This function returns the type of bus associated with this GPU.
SUPPORTED OS: Windows 7 and higher
TCC_SUPPORTED
MCDM_SUPPORTED
| NVAPI_INVALID_ARGUMENT | hPhysicalGpu or pBusType is NULL. |
| NVAPI_OK | *pBusType contains bus identifier. |
| NVAPI_INTERFACE NvAPI_GPU_GetConnectedDisplayIds | ( | __in NvPhysicalGpuHandle | hPhysicalGpu, |
| __inout_ecount_part_opt *, *pDisplayIdCount NV_GPU_DISPLAYIDS * | pDisplayIds, | ||
| __inout NvU32 * | pDisplayIdCount, | ||
| __in NvU32 | flags | ||
| ) |
DESCRIPTION: Due to space limitation NvAPI_GPU_GetConnectedOutputs can return maximum 32 devices, but this is no longer true for DPMST. NvAPI_GPU_GetConnectedDisplayIds will return all the connected display devices in the form of displayIds for the associated hPhysicalGpu. This function can accept set of flags to request cached, uncached, sli and lid to get the connected devices. Default value for flags will be cached .
HOW TO USE: 1) for each PhysicalGpu, make a call to get the number of connected displayId's using NvAPI_GPU_GetConnectedDisplayIds by passing the pDisplayIds as NULL On call success:
2) If pDisplayIdCount is greater than 0, allocate memory based on pDisplayIdCount. Then make a call NvAPI_GPU_GetConnectedDisplayIds to populate DisplayIds. However, if pDisplayIdCount is 0, do not make this call. SUPPORTED OS: Windows 7 and higher
| [in] | hPhysicalGpu | - GPU selection |
| [in] | flags | - One or more defines from NV_GPU_CONNECTED_IDS_FLAG_* as valid flags. |
| [in,out] | pDisplayIds | - Pointer to an NV_GPU_DISPLAYIDS struct, each entry represents a one displayID and its attributes |
| [in] | pDisplayIdCount | - Number of displayId's. |
| NVAPI_INVALID_ARGUMENT | hPhysicalGpu or pDisplayIds or pDisplayIdCount is NULL |
| NVAPI_OK | *pDisplayIds 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 |
| NVAPI_INTERFACE NvAPI_GPU_GetCurrentPCIEDownstreamWidth | ( | NvPhysicalGpuHandle | hPhysicalGpu, |
| NvU32 * | pWidth | ||
| ) |
This function returns the number of PCIE lanes being used for the PCIE interface downstream from the GPU.
SUPPORTED OS: Windows 7 and higher
TCC_SUPPORTED
MCDM_SUPPORTED
| 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 7 and higher
| 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. |
| NVAPI_INTERFACE NvAPI_GPU_GetFullName | ( | NvPhysicalGpuHandle | hPhysicalGpu, |
| NvAPI_ShortString | szName | ||
| ) |
This function retrieves the full GPU name as an ASCII string - for example, "Quadro FX 1400".
SUPPORTED OS: Windows 7 and higher
TCC_SUPPORTED
MCDM_SUPPORTED
| NVAPI_INTERFACE NvAPI_GPU_GetGpuCoreCount | ( | NvPhysicalGpuHandle | hPhysicalGpu, |
| NvU32 * | pCount | ||
| ) |
DESCRIPTION: Retrieves the total number of cores defined for a GPU. Returns 0 on architectures that don't define GPU cores.
SUPPORTED OS: Windows 7 and higher
TCC_SUPPORTED
MCDM_SUPPORTED
| NVAPI_INVALID_ARGUMENT | pCount is NULL |
| NVAPI_OK | *pCount is set |
| 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_NOT_SUPPORTED | API call is not supported on current architecture |
| NVAPI_INTERFACE NvAPI_GPU_GetGPUInfo | ( | __in NvPhysicalGpuHandle | hPhysicalGpu, |
| __inout NV_GPU_INFO * | pGpuInfo | ||
| ) |
DESCRIPTION: This API will return NVIDIA GPU related information.
SUPPORTED OS: Windows 7 and higher
TCC_SUPPORTED
MCDM_SUPPORTED
| [in,out] | pGpuInfo | - This structure will be filled with required information. |
| NVAPI_INTERFACE NvAPI_GPU_GetGPUType | ( | __in NvPhysicalGpuHandle | hPhysicalGpu, |
| __inout NV_GPU_TYPE * | pGpuType | ||
| ) |
DESCRIPTION: This function returns the GPU type (integrated or discrete). See NV_GPU_TYPE.
SUPPORTED OS: Windows 7 and higher
TCC_SUPPORTED
MCDM_SUPPORTED
| 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 |
| NVAPI_INTERFACE NvAPI_GPU_GetGspFeatures | ( | __in NvPhysicalGpuHandle | hPhysicalGpu, |
| __inout NV_GPU_GSP_INFO * | pGspInfo | ||
| ) |
DESCRIPTION: If the device has GSP running, this function populates firmwareVersion field with GSP firmware version and returns NVAPI_OK Otherwise returns NVAPI_NOT_SUPPORTED
SUPPORTED OS: Windows 10 and higher
TCC_SUPPORTED
MCDM_SUPPORTED
| [in] | hPhysicalGpu | GPU selection |
| [out] | pGspInfo | GSP firmware version |
| NVAPI_INVALID_ARGUMENT | pMemoryInfo is NULL |
| NVAPI_OK | call successful |
| NVAPI_API_NOT_INTIALIZED | nvapi not initialized |
| NVAPI_EXPECTED_PHYSICAL_GPU_HANDLE | hPhysicalGpu was not a physical GPU handle |
| NVAPI_INCOMPATIBLE_STRUCT_VERSION | NV_GPU_GSP_INFO structure version mismatch |
| NVAPI_NOT_SUPPORTED | GSP is not running/supported on this device |
| NvAPI_GPU_GetHDCPSupportStatus | ( | NvPhysicalGpuHandle | hPhysicalGpu, |
| NV_GPU_GET_HDCP_SUPPORT_STATUS * | pGetHDCPSupportStatus | ||
| ) |
DESCRIPTION: This function returns a GPU's HDCP support status.
SUPPORTED OS: Windows 7 and higher
TCC_SUPPORTED
MCDM_SUPPORTED
| NVAPI_INTERFACE NvAPI_GPU_GetIllumination | ( | NV_GPU_GET_ILLUMINATION_PARM * | pIlluminationInfo | ) |
| NVAPI_INTERFACE NvAPI_GPU_GetIRQ | ( | NvPhysicalGpuHandle | hPhysicalGpu, |
| NvU32 * | pIRQ | ||
| ) |
This function returns the interrupt number associated with this GPU.
SUPPORTED OS: Windows 7 and higher
TCC_SUPPORTED
MCDM_SUPPORTED
| 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. |
| NVAPI_INTERFACE NvAPI_GPU_GetLogicalGpuInfo | ( | __in NvLogicalGpuHandle | hLogicalGpu, |
| __inout NV_LOGICAL_GPU_DATA * | pLogicalGpuData | ||
| ) |
This function is used to query Logical GPU information.
SUPPORTED OS: Windows 7 and higher
| [in] | hLogicalGpu | logical GPU Handle. |
| [in,out] | pLogicalGpuData | Pointer to NV_LOGICAL_GPU_DATA structure. |
| NvAPI_GPU_GetOutputType | ( | NvPhysicalGpuHandle | hPhysicalGpu, |
| NvU32 | outputId, | ||
| NV_GPU_OUTPUT_TYPE * | pOutputType | ||
| ) |
This function returns the output type. User can either specify both 'physical GPU handle and outputId (exactly 1 bit set - see NvAPI Handles)' or a valid displayId in the outputId parameter.
SUPPORTED OS: Windows 7 and higher
\Version Earliest supported ForceWare version: 82.61
| NVAPI_INVALID_ARGUMENT | outputId, pOutputType is NULL; or if outputId parameter is not displayId and either it has > 1 bit set or hPhysicalGpu is NULL. |
| 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 |
| NVAPI_INTERFACE NvAPI_GPU_GetPCIIdentifiers | ( | NvPhysicalGpuHandle | hPhysicalGpu, |
| NvU32 * | pDeviceId, | ||
| NvU32 * | pSubSystemId, | ||
| NvU32 * | pRevisionId, | ||
| NvU32 * | pExtDeviceId | ||
| ) |
This function returns the PCI identifiers associated with this GPU.
SUPPORTED OS: Windows 7 and higher
TCC_SUPPORTED
MCDM_SUPPORTED
| 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. |
| 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 |
| NVAPI_INTERFACE NvAPI_GPU_GetPhysicalFrameBufferSize | ( | NvPhysicalGpuHandle | hPhysicalGpu, |
| NvU32 * | pSize | ||
| ) |
This function 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: Windows 7 and higher
TCC_SUPPORTED
MCDM_SUPPORTED
| 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 |
| NVAPI_INTERFACE NvAPI_GPU_GetRamBusWidth | ( | NvPhysicalGpuHandle | hPhysicalGpu, |
| NvU32 * | pBusWidth | ||
| ) |
This function returns the width of the GPU's RAM memory bus.
SUPPORTED OS: Windows 7 and higher
TCC_SUPPORTED
MCDM_SUPPORTED
| NVAPI_INTERFACE NvAPI_GPU_GetScanoutCompositionParameter | ( | __in NvU32 | displayId, |
| __in NV_GPU_SCANOUT_COMPOSITION_PARAMETER | parameter, | ||
| __out NV_GPU_SCANOUT_COMPOSITION_PARAMETER_VALUE * | parameterData, | ||
| __out float * | pContainer | ||
| ) |
DESCRIPTION: This API queries current state of one of the various scanout composition parameters on the specified display.
SUPPORTED OS: Windows 7 and higher
| [in] | displayId | combined physical display and GPU identifier of the display to query the configuration. |
| [in] | parameter | scanout composition parameter to by queried. |
| [out] | parameterData | scanout composition parameter data. |
| [out] | pContainer | Additional container for returning data associated with the specified parameter |
| NVAPI_INVALID_ARGUMENT | Invalid input parameters. |
| NVAPI_API_NOT_INITIALIZED | NvAPI not initialized. |
| NVAPI_NOT_SUPPORTED | Interface not supported by the driver used, or only supported on selected GPUs. |
| NVAPI_OK | Feature enabled. |
| NVAPI_ERROR | Miscellaneous error occurred. |
| NVAPI_INTERFACE NvAPI_GPU_GetScanoutConfiguration | ( | NvU32 | displayId, |
| NvSBox * | desktopRect, | ||
| NvSBox * | scanoutRect | ||
| ) |
DESCRIPTION: This API queries the desktop and scanout portion of the specified display.
SUPPORTED OS: Windows 7 and higher
| [in] | displayId | combined physical display and GPU identifier of the display to query the configuration. |
| [in,out] | desktopRect | desktop area of the display in desktop coordinates. |
| [in,out] | scanoutRect | scanout area of the display relative to desktopRect. |
| NVAPI_INVALID_ARGUMENT | Invalid input parameters. |
| NVAPI_API_NOT_INITIALIZED | NvAPI not initialized. |
| NVAPI_NOT_SUPPORTED | Interface not supported by the driver used, or only supported on selected GPUs. |
| NVAPI_OK | Feature enabled. |
| NVAPI_ERROR | Miscellaneous error occurred. |
| NVAPI_INTERFACE NvAPI_GPU_GetScanoutConfigurationEx | ( | __in NvU32 | displayId, |
| __inout NV_SCANOUT_INFORMATION * | pScanoutInformation | ||
| ) |
DESCRIPTION: This API queries the desktop and scanout portion of the specified display.
SUPPORTED OS: Windows 7 and higher
| [in] | displayId | combined physical display and GPU identifier of the display to query the configuration. |
| [in,out] | pScanoutInformation | desktop area to displayId mapping information. |
| NVAPI_INTERFACE NvAPI_GPU_GetScanoutIntensityState | ( | __in NvU32 | displayId, |
| __inout NV_SCANOUT_INTENSITY_STATE_DATA * | scanoutIntensityStateData | ||
| ) |
DESCRIPTION: This API queries current state of the intensity feature on the specified display.
SUPPORTED OS: Windows 7 and higher
| [in] | displayId | combined physical display and GPU identifier of the display to query the configuration. |
| [in,out] | scanoutIntensityStateData | intensity state data. |
| NVAPI_INVALID_ARGUMENT | Invalid input parameters. |
| NVAPI_API_NOT_INITIALIZED | NvAPI not initialized. |
| NVAPI_NOT_SUPPORTED | Interface not supported by the driver used, or only supported on selected GPUs. |
| NVAPI_OK | Feature enabled. |
| NVAPI_ERROR | Miscellaneous error occurred. |
| NVAPI_INTERFACE NvAPI_GPU_GetScanoutWarpingState | ( | __in NvU32 | displayId, |
| __inout NV_SCANOUT_WARPING_STATE_DATA * | scanoutWarpingStateData | ||
| ) |
DESCRIPTION: This API queries current state of the warping feature on the specified display.
SUPPORTED OS: Windows 7 and higher
| [in] | displayId | combined physical display and GPU identifier of the display to query the configuration. |
| [in,out] | scanoutWarpingStateData | warping state data. |
| NVAPI_INVALID_ARGUMENT | Invalid input parameters. |
| NVAPI_API_NOT_INITIALIZED | NvAPI not initialized. |
| NVAPI_NOT_SUPPORTED | Interface not supported by the driver used, or only supported on selected GPUs. |
| NVAPI_OK | Feature enabled. |
| NVAPI_ERROR | Miscellaneous error occurred. |
| NVAPI_INTERFACE NvAPI_GPU_GetShaderSubPipeCount | ( | NvPhysicalGpuHandle | hPhysicalGpu, |
| NvU32 * | pCount | ||
| ) |
DESCRIPTION: This function retrieves the number of Shader SubPipes on the GPU On newer architectures, this corresponds to the number of SM units
SUPPORTED OS: Windows 7 and higher
TCC_SUPPORTED
MCDM_SUPPORTED
| NVAPI_INVALID_ARGUMENT | pCount is NULL |
| NVAPI_OK | *pCount is set |
| 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_GPU_GetSystemType | ( | NvPhysicalGpuHandle | hPhysicalGpu, |
| NV_SYSTEM_TYPE * | pSystemType | ||
| ) |
This function identifies whether the GPU is a notebook GPU or a desktop GPU.
SUPPORTED OS: Windows 7 and higher
TCC_SUPPORTED
MCDM_SUPPORTED
| 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 |
| NVAPI_INTERFACE NvAPI_GPU_GetVbiosOEMRevision | ( | NvPhysicalGpuHandle | hPhysicalGpu, |
| NvU32 * | pBiosRevision | ||
| ) |
This function returns the OEM revision of the video BIOS associated with this GPU.
SUPPORTED OS: Windows 7 and higher
TCC_SUPPORTED
MCDM_SUPPORTED
| 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 |
| NVAPI_INTERFACE NvAPI_GPU_GetVbiosRevision | ( | NvPhysicalGpuHandle | hPhysicalGpu, |
| NvU32 * | pBiosRevision | ||
| ) |
This function returns the revision of the video BIOS associated with this GPU.
SUPPORTED OS: Windows 7 and higher
TCC_SUPPORTED
MCDM_SUPPORTED
| 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. |
| NVAPI_INTERFACE NvAPI_GPU_GetVbiosVersionString | ( | NvPhysicalGpuHandle | hPhysicalGpu, |
| NvAPI_ShortString | szBiosRevision | ||
| ) |
This function returns the full video BIOS version string in the form of xx.xx.xx.xx.yy where
SUPPORTED OS: Windows 7 and higher
TCC_SUPPORTED
MCDM_SUPPORTED
| 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. |
| NVAPI_INTERFACE NvAPI_GPU_GetVirtualFrameBufferSize | ( | NvPhysicalGpuHandle | hPhysicalGpu, |
| NvU32 * | pSize | ||
| ) |
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: Windows 7 and higher
TCC_SUPPORTED
MCDM_SUPPORTED
| 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. |
| NVAPI_INTERFACE NvAPI_GPU_GetVirtualizationInfo | ( | __in NvPhysicalGpuHandle | hPhysicalGpu, |
| __inout NV_GPU_VIRTUALIZATION_INFO * | pVirtualizationInfo | ||
| ) |
FUNCTION NAME: NvAPI_GPU_GetVirtualizationInfo
DESCRIPTION: This API returns virtualization information of the GPU
SUPPORTED OS: Windows 7 and higher
TCC_SUPPORTED
MCDM_SUPPORTED
| [in,out] | pVirtualizationInfo | Pointer to NV_GPU_VIRTUALIZATION_INFO structure. |
| NVAPI_INTERFACE NvAPI_GPU_GetVRReadyData | ( | __in NvPhysicalGpuHandle | hPhysicalGpu, |
| __inout NV_GPU_VR_READY * | pGpuVrReadyData | ||
| ) |
DESCRIPTION: This API will return NVIDIA GPU VR Ready state.
SUPPORTED OS: Windows 10 and higher
TCC_SUPPORTED
MCDM_SUPPORTED
| [in,out] | pGpuVrReadyData | - This structure will be filled with required information. |
| NVAPI_INTERFACE NvAPI_GPU_QueryIlluminationSupport | ( | __inout NV_GPU_QUERY_ILLUMINATION_SUPPORT_PARM * | pIlluminationSupportInfo | ) |
| NvAPI_GPU_QueryWorkstationFeatureSupport | ( | NvPhysicalGpuHandle | physicalGpu, |
| NV_GPU_WORKSTATION_FEATURE_TYPE | gpuWorkstationFeature | ||
| ) |
| NVAPI_INTERFACE NvAPI_GPU_SetEDID | ( | NvPhysicalGpuHandle | hPhysicalGpu, |
| NvU32 | displayOutputId, | ||
| NV_EDID * | pEDID | ||
| ) |
Thus function sets the EDID data for the specified GPU handle and connection bit mask. User can either send (Gpu handle & output id) or only display Id in variable displayOutputId parameter & hPhysicalGpu parameter can be default handle (0).
This feature will NOT be supported on the following boards:
- GeForce
- Quadro VX
- Tesla
SUPPORTED OS: Windows 7 and higher| NVAPI_INVALID_ARGUMENT | pEDID is NULL; displayOutputId has 0 or > 1 bits set |
| NVAPI_OK | *pEDID data was applied to the requested displayOutputId. |
| 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_NOT_SUPPORTED | For the above mentioned GPUs |
| NVAPI_INVALID_USER_PRIVILEGE | The application will require Administrator privileges to access this API. The application can be elevated to a higher permission level by selecting "Run as Administrator". |
| NVAPI_INTERFACE NvAPI_GPU_SetIllumination | ( | NV_GPU_SET_ILLUMINATION_PARM * | pIlluminationInfo | ) |
| NVAPI_INTERFACE NvAPI_GPU_SetScanoutCompositionParameter | ( | NvU32 | displayId, |
| NV_GPU_SCANOUT_COMPOSITION_PARAMETER | parameter, | ||
| NV_GPU_SCANOUT_COMPOSITION_PARAMETER_VALUE | parameterValue, | ||
| float * | pContainer | ||
| ) |
DESCRIPTION: This API sets various parameters that configure the scanout composition feature on the specified display. (currently there is only one configurable parameter defined: WARPING_RESAMPLING_METHOD, but this function is designed to support the addition of parameters as needed.)
SUPPORTED OS: Windows 7 and higher
| [in] | displayId | Combined physical display and GPU identifier of the display to apply the intensity control |
| [in] | parameter | The scanout composition parameter to be set |
| [in] | parameterValue | The data to be set for the specified parameter |
| [in] | pContainer | Additional container for data associated with the specified parameter |
| NVAPI_INVALID_ARGUMENT | Invalid input parameters. |
| NVAPI_API_NOT_INITIALIZED | NvAPI not initialized. |
| NVAPI_NOT_SUPPORTED | Interface not supported by the driver used, or only supported on selected GPUs |
| NVAPI_INVALID_ARGUMENT | Invalid input data. |
| NVAPI_OK | Feature enabled. |
| NVAPI_ERROR | Miscellaneous error occurred. |
| NVAPI_INTERFACE NvAPI_GPU_SetScanoutIntensity | ( | NvU32 | displayId, |
| NV_SCANOUT_INTENSITY_DATA * | scanoutIntensityData, | ||
| int * | pbSticky | ||
| ) |
DESCRIPTION: This API enables and sets up per-pixel intensity feature on the specified display.
SUPPORTED OS: Windows 7 and higher
| [in] | displayId | combined physical display and GPU identifier of the display to apply the intensity control. |
| [in] | scanoutIntensityData | the intensity texture info. |
| [out] | pbSticky(OUT) | indicates whether the settings will be kept over a reboot. |
| NVAPI_INVALID_ARGUMENT | Invalid input parameters. |
| NVAPI_API_NOT_INITIALIZED | NvAPI not initialized. |
| NVAPI_NOT_SUPPORTED | Interface not supported by the driver used, or only supported on selected GPUs |
| NVAPI_INVALID_ARGUMENT | Invalid input data. |
| NVAPI_INCOMPATIBLE_STRUCT_VERSION | NV_SCANOUT_INTENSITY_DATA structure version mismatch. |
| NVAPI_OK | Feature enabled. |
| NVAPI_ERROR | Miscellaneous error occurred. |
| NVAPI_INTERFACE NvAPI_GPU_SetScanoutWarping | ( | NvU32 | displayId, |
| NV_SCANOUT_WARPING_DATA * | scanoutWarpingData, | ||
| int * | piMaxNumVertices, | ||
| int * | pbSticky | ||
| ) |
DESCRIPTION: This API enables and sets up the warping feature on the specified display.
SUPPORTED OS: Windows 7 and higher
| [in] | displayId | Combined physical display and GPU identifier of the display to apply the intensity control |
| [in] | scanoutWarpingData | The warping data info |
| [out] | pbSticky | Indicates whether the settings will be kept over a reboot. |
| NVAPI_INVALID_ARGUMENT | Invalid input parameters. |
| NVAPI_API_NOT_INITIALIZED | NvAPI not initialized. |
| NVAPI_NOT_SUPPORTED | Interface not supported by the driver used, or only supported on selected GPUs |
| NVAPI_INVALID_ARGUMENT | Invalid input data. |
| NVAPI_INCOMPATIBLE_STRUCT_VERSION | NV_SCANOUT_WARPING_DATA structure version mismatch. |
| NVAPI_OK | Feature enabled. |
| NVAPI_ERROR | Miscellaneous error occurred. |
| NVAPI_INTERFACE NvAPI_GPU_ValidateOutputCombination | ( | NvPhysicalGpuHandle | hPhysicalGpu, |
| NvU32 | outputsMask | ||
| ) |
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 7 and higher
| 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. |
| NVAPI_INTERFACE NvAPI_GPU_WorkstationFeatureQuery | ( | __in NvPhysicalGpuHandle | hPhysicalGpu, |
| __out_opt NvU32 * | pConfiguredFeatureMask, | ||
| __out_opt NvU32 * | pConsistentFeatureMask | ||
| ) |
DESCRIPTION: This API queries the current set of workstation features.
SUPPORTED OS: Windows 7
| [in] | hPhysicalGpu | Physical GPU Handle of the display adapter to be configured. GPU handles may be retrieved using NvAPI_EnumPhysicalGPUs. |
| [out] | pConfiguredFeatureMask | Mask of features requested for use by client drivers |
| [out] | pConsistentFeatureMask | Mask of features that have all resources allocated for completeness. |
| NVAPI_OK | configuration request succeeded |
| NVAPI_ERROR | configuration request failed |
| NVAPI_EXPECTED_PHYSICAL_GPU_HANDLE | hPhysicalGpu is not a physical GPU handle. |
| NVAPI_NO_IMPLEMENTATION | OS below Win7, implemented only for Win7 but returns NVAPI_OK on OS above Win7 to keep compatibility with apps written against Win7. |
| NVAPI_INTERFACE NvAPI_GPU_WorkstationFeatureSetup | ( | __in NvPhysicalGpuHandle | hPhysicalGpu, |
| __in NvU32 | featureEnableMask, | ||
| __in NvU32 | featureDisableMask | ||
| ) |
| NVAPI_INTERFACE NvAPI_JoinPresentBarrier | ( | __in NvPresentBarrierClientHandle | presentBarrierClient, |
| __in NV_JOIN_PRESENT_BARRIER_PARAMS * | pParams | ||
| ) |
DESCRIPTION: This API adds a registered PresentBarrier client to the presentBarrier. If the call suceeds, image present of the registered scanout resources from this client is under the synchronization of presentBarrier.
| [in] | presentBarrierClient | An NvPresentBarrierClientHandle handle created by NvAPI_xxxx_CreatedPresentBarrierClient |
| [in] | pParams | Parameters to joining presentBarrier. |
| NVAPI_OK | the call succeeded |
| NVAPI_ERROR | the call failed |
| NVAPI_NO_IMPLEMENTATION | the interface is not implemented |
| NVAPI_INCOMPATIBLE_STRUCT_VERSION | the version of data structure is not correct |
| NVAPI_INVALID_HANDLE | an invalid NvPresentBarrierClientHandle was passed as an argument |
| NVAPI_INVALID_POINTER | an invalid pointer was passed as an argument (probably NULL) |
| NVAPI_API_NOT_INITIALIZED | NvAPI not initialized |
| NVAPI_INTERFACE NvAPI_LeavePresentBarrier | ( | __in NvPresentBarrierClientHandle | presentBarrierClient | ) |
SUPPORTED OS: Windows 10 and higher DESCRIPTION: This API removes a registered client from presentBarrier. If this client does not join presentBarrier, this function does nothing.
| [in] | presentBarrierClient | An NvPresentBarrierClientHandle handle created by NvAPI_xxxxx_CreatePresentBarrierClient. |
| NVAPI_OK | the call succeeded |
| NVAPI_ERROR | the call failed |
| NVAPI_NO_IMPLEMENTATION | the interface is not implemented |
| NVAPI_INVALID_HANDLE | an invalid NvPresentBarrierClientHandle was passed as an argument |
| NVAPI_API_NOT_INITIALIZED | NvAPI not initialized |
| NVAPI_INTERFACE NvAPI_OGL_ExpertModeDefaultsGet | ( | NvU32 * | pExpertDetailLevel, |
| NvU32 * | pExpertReportMask, | ||
| NvU32 * | pExpertOutputMask | ||
| ) |
Get uncached connected devices.
| NVAPI_INTERFACE NvAPI_OGL_ExpertModeDefaultsSet | ( | NvU32 | expertDetailLevel, |
| NvU32 | expertReportMask, | ||
| NvU32 | expertOutputMask | ||
| ) |
This function configures OpenGL Expert Mode global defaults. These settings apply to any OpenGL application which starts up after these values are applied (i.e. these settings do not apply to currently running applications).
SUPPORTED OS: Windows 7 and higher
| expertDetailLevel | Value which specifies the detail level in the feedback stream. This is a mask made up of NVAPI_OGLEXPERT_LEVEL bits. |
| expertReportMask | Mask made up of NVAPI_OGLEXPERT_REPORT bits, this parameter specifies the areas of functional interest. |
| expertOutputMask | Mask made up of NVAPI_OGLEXPERT_OUTPUT bits, this parameter specifies the feedback output location. Note that using OUTPUT_TO_CALLBACK here is meaningless and has no effect, but using it will not cause an error. |
SUPPORTED OS: Windows 7 and higher
| NVAPI_INTERFACE NvAPI_QueryPresentBarrierFrameStatistics | ( | __in NvPresentBarrierClientHandle | presentBarrierClient, |
| __out NV_PRESENT_BARRIER_FRAME_STATISTICS * | pFrameStats | ||
| ) |
DESCRIPTION: This API returns the presentBarrier frame statistics of last present call from this client. If the client did not join presentBarrier, the SyncMode is returned as PRESENT_BARRIER_NOT_JOINED, and all other fields are reset. Driver does not retain any presentBarrier info of the client once it leaves presentBarrier.
| [in] | presentBarrierClient | An NvPresentBarrierClientHandle handle created by NvAPI_xxxxx_CreatePresentBarrierClient. |
| [out] | pFrameStats | Pointer to NV_PRESENT_BARRIER_FRAME_STATISTICS structure about presentBarrier statistics. |
| NVAPI_OK | the call succeeded |
| NVAPI_ERROR | the call failed |
| NVAPI_NO_IMPLEMENTATION | the interface is not implemented |
| NVAPI_INVALID_HANDLE | an invalid NvPresentBarrierClientHandle was passed as an argument |
| NVAPI_INVALID_POINTER | an invalid pointer was passed as an argument (probably NULL) |
| NVAPI_INCOMPATIBLE_STRUCT_VERSION | invalid version of frameStatistics params |
| NVAPI_API_NOT_INITIALIZED | NvAPI not initialized |
| NVAPI_INTERFACE NvAPI_SYS_GetDisplayDriverInfo | ( | __inout NV_DISPLAY_DRIVER_INFO * | pDriverInfo | ) |
DESCRIPTION: This API will return information related to the NVIDIA Display Driver. Note that out of the driver types - Studio, Game Ready, RTX Production Branch, RTX New Feature Branch - only one driver type can be available in system. If NVAPI is unable to get the information of particular driver type, we report all flags as 0 (Unknown).
SUPPORTED OS: Windows 7 and higher
| [in,out] | pDriverInfo | - This structure will be filled with required information. |
| NvU32 * pOutputsMask |
Get uncached connected devices.
| NvU32* pRate |
| NvU32* pSize |
| NVVIOSTATUS* pStatus |
