SLI Zone
NVIDIA.com Developer Home

NVAPI Reference: group__gputhermalfunctions

GPU Thermal Control Functions
[GPU Thermal Control Interface]


Functions

NVAPI_INTERFACE NvAPI_GPU_GetThermalSettings (NvPhysicalGpuHandle hPhysicalGpu, NvU32 sensorIndex, NV_GPU_THERMAL_SETTINGS *pThermalSettings)

Function Documentation

NVAPI_INTERFACE NvAPI_GPU_GetThermalSettings ( NvPhysicalGpuHandle  hPhysicalGpu,
NvU32  sensorIndex,
NV_GPU_THERMAL_SETTINGS pThermalSettings 
)

This function retrieves the thermal information of all thermal sensors or specific thermal sensor associated with the selected GPU. Thermal sensors are indexed 0 to NVAPI_MAX_THERMAL_SENSORS_PER_GPU-1.

  • To retrieve specific thermal sensor info, set the sensorIndex to the required thermal sensor index.
  • To retrieve info for all sensors, set sensorIndex to NVAPI_THERMAL_TARGET_ALL.

SUPPORTED OS: Mac OS X, Windows XP and higher
Since:
Version: 87.60 (Rel85), 92.40 (Rel90)
Parameters:
[in] hPhysicalGPU GPU selection.
[in] sensorIndex Explicit thermal sensor index selection.
[out] pThermalSettings Array of thermal settings.
Return values:
NVAPI_OK Completed request
NVAPI_ERROR Miscellaneous error occurred.
NVAPI_INVALID_ARGUMENT pThermalInfo is NULL.
NVAPI_HANDLE_INVALIDATED Handle passed has been invalidated (see user guide).
NVAPI_EXPECTED_PHYSICAL_GPU_HANDLE Handle passed is not a physical GPU handle.
NVAPI_INCOMPATIBLE_STRUCT_VERSION The version of the INFO struct is not supported.


Copyright (c) 2007, 2008 NVIDIA Corporation. All rights reserved.