This page has been translated automatically.
UnigineEditor
Interface Overview
Assets Workflow
Settings and Preferences
Working With Projects
Adjusting Node Parameters
Setting Up Materials
Setting Up Properties
Landscape Tool
Using Editor Tools for Specific Tasks
Extending Editor Functionality
Programming
Fundamentals
Setting Up Development Environment
Usage Examples
UnigineScript
C++
C#
UUSL (Unified UNIGINE Shader Language)
File Formats
Rebuilding the Engine Tools
GUI
Double Precision Coordinates
API
Containers
Common Functionality
Controls-Related Classes
Engine-Related Classes
Filesystem Functionality
GUI-Related Classes
Math Functionality
Node-Related Classes
Objects-Related Classes
Networking Functionality
Pathfinding-Related Classes
Physics-Related Classes
Plugins-Related Classes
IG Plugin
CIGIConnector Plugin
Rendering-Related Classes
Warning! This version of documentation is OUTDATED, as it describes an older SDK version! Please switch to the documentation for the latest SDK version.
Warning! This version of documentation describes an old SDK version which is no longer supported! Please upgrade to the latest SDK version.

GPUMonitor Class

Warning
The scope of applications for UnigineScript is limited to implementing materials-related logic (material expressions, scriptable materials, brush materials). Do not use UnigineScript as a language for application logic, please consider C#/C++ instead, as these APIs are the preferred ones. Availability of new Engine features in UnigineScipt (beyond its scope of applications) 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.

GPUMonitor Class

Members


string getName ( ) #

Returns the name of the currently used GPU.

Return value

Name of the currently used GPU

int getNumAdapters ( ) #

Returns the number of adapters on the system.

Return value

Number of adapters

string 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 name

float 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 running

float 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 operate

float 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 temperature

float 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 percent

float getMaxTemperature ( ) #

Returns maximum GPU temperature.

Return value

Maximum GPU temperature
Last update: 2020-07-31
Build: ()