GPUMonitor Class
Warning
UnigineScript is deprecated and will be removed in future releases. Please consider using C#/C++ instead, as these APIs are the preferred ones. Availability of new Engine features in UnigineScipt is not guaranteed, as the current level of support assumes only fixing critical issues.
Warning
The functionality described in this article is not available in the Community SDK edition.
You should upgrade to- Sim
SDK edition to use it.
You should upgrade to
GPUMonitor Class
Members
string getName ( ) #
Returns the name of the currently used GPU.Return value
Name of the currently used GPUint getNumAdapters ( ) #
Returns the number of adapters on the system.Return value
Number of adaptersstring getAdapterName ( int num ) #
Returns the display adapter name based on its ordinal number.Arguments
- int num - Ordinal number that denotes the display adapter. The minimum value for this parameter is 0, and the maximum value for this parameter is one less than the value returned by getNumAdapters().
Return value
Display adapter namefloat getCoreClock ( int num ) #
Returns core clock of the selected adapter.Arguments
- int num - Ordinal number that denotes the display adapter. The minimum value for this parameter is 0, and the maximum value for this parameter is one less than the value returned by getNumAdapters().
Return value
Core clock, i.e. frequency, at which the GPU is running.float getMemoryClock ( int num ) #
Returns memory clock of the selected adapter.Arguments
- int num - Ordinal number that denotes the display adapter. The minimum value for this parameter is 0, and the maximum value for this parameter is one less than the value returned by getNumAdapters().
Return value
Memory clock, i.e. how fast the GPU memory is runningfloat getShaderClock ( int num ) #
Returns shader clock of the selected adapter.Arguments
- int num - Ordinal number that denotes the display adapter. The minimum value for this parameter is 0, and the maximum value for this parameter is one less than the value returned by getNumAdapters().
Return value
Shader clock, i.e. frequency, at which shader processing units operatefloat getTemperature ( int num ) #
Returns the GPU temperature of the selected adapter.Arguments
- int num - Ordinal number that denotes the display adapter. The minimum value for this parameter is 0, and the maximum value for this parameter is one less than the value returned by getNumAdapters().
Return value
GPU temperaturefloat getUtilization ( int num ) #
Returns the rate of GPU utilization, in percent, of the selected adapter.Arguments
- int num - Ordinal number that denotes the display adapter. The minimum value for this parameter is 0, and the maximum value for this parameter is one less than the value returned by getNumAdapters().
Return value
GPU utilization rate, in percentfloat getMaxTemperature ( ) #
Returns maximum GPU temperature.Return value
Maximum GPU temperatureLast update:
2020-04-10
Help improve this article
Was this article helpful?
(or select a word/phrase and press Ctrl+Enter)