This page has been translated automatically.
Video Tutorials
Interface
Essentials
Advanced
How To
UnigineEditor
Interface Overview
Assets Workflow
Settings and Preferences
Working With Projects
Adjusting Node Parameters
Setting Up Materials
Setting Up Properties
Lighting
Landscape Tool
Sandworm
Using Editor Tools for Specific Tasks
Extending Editor Functionality
Built-in Node Types
Nodes
Objects
Effects
Decals
Light Sources
Geodetics
World Nodes
Sound Objects
Pathfinding Objects
Players
Programming
Fundamentals
Setting Up Development Environment
Usage Examples
C++
C#
UnigineScript
UUSL (Unified UNIGINE Shader Language)
Plugins
File Formats
Rebuilding the Engine Tools
GUI
Double Precision Coordinates
API
Containers
Common Functionality
Controls-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
Content Creation
Content Optimization
Materials
Material Nodes Library
Miscellaneous
Input
Math
Matrix
Textures
Art Samples
Tutorials
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.

SystemInfo 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 UnigineScript (beyond its scope of applications) is not guaranteed, as the current level of support assumes only fixing critical issues.

This class is used to obtain system information.

SystemInfo Class

Members


string getBinaryInfo ( ) #

Returns information on the Engine binary.

Return value

Information on the Engine binary.

string getRevisionInfo ( ) #

Returns information on the Engine version.

Return value

Information on the Engine version, date.

string getSystemInfo ( ) #

Returns operating system information.

Return value

Operating system information.

string getCPUInfo ( ) #

Console: cpu_info
Returns information on the CPU.

Return value

CPU information.

int getSystemMemory ( ) #

Returns the current system memory amount.

Return value

Current system memory amount, in Mbytes.

int getCPUFrequency ( ) #

Console: cpu_frequency
Returns the current CPU frequency.

Return value

Current CPU frequency, in MHz.

int getCPUCount ( ) #

Console: cpu_count
Returns the number of available CPUs.

Return value

Number of available CPUs.

int getCPUThreads ( ) #

Console: cpu_threads
Returns the number of available CPU threads.

Return value

Number of available CPU threads.

int hasMMX ( ) #

Returns a value indicating if the system supports MMX (Multi-Media Extensions).

Return value

1 if the system supports MMX extension; otherwise, 0.

int hasSSE ( ) #

Returns a value indicating if the system supports SSE (Streaming SIMD Extensions).

Return value

1 if the system supports SSE extension; otherwise, 0.

int hasSSE2 ( ) #

Returns a value indicating if the system supports SSE2 (Streaming SIMD Extensions).

Return value

1 if the system supports SSE2 extension; otherwise, 0.

int hasSSE3 ( ) #

Returns a value indicating if the system supports SSE3 (Streaming SIMD Extensions).

Return value

1 if the system supports SSE3 extension; otherwise, 0.

int hasSSE4 ( ) #

Returns a value indicating if the system supports SSE4 (Streaming SIMD Extensions).

Return value

1 if the system supports SSE4 extension; otherwise, 0.

int hasSSE5 ( ) #

Returns a value indicating if the system supports SSE5 (Streaming SIMD Extensions).

Return value

1 if the system supports SSE5 extension; otherwise, 0.

int hasAVX ( ) #

Returns a value indicating if the system supports AVX (Advanced Vector Extensions).

Return value

1 if the system supports AVX extension; otherwise, 0.

int hasAVX2 ( ) #

Returns a value indicating if the system supports AVX2 (Advanced Vector Extensions).

Return value

1 if the system supports AVX2 extension; otherwise, 0.

int hasNeon ( ) #

Returns a value indicating if the system supports Neon (Advanced Vector Extensions).

Return value

1 if the system supports Neon extension; otherwise, 0.

int hasHyperThreading ( ) #

Console: cpu_hyper_threading
Returns a value indicating if the system supports hyper-threading.

Return value

1 if the system supports hyper-threading; otherwise, 0.

int getGPUCount ( ) #

Returns the number of available GPUs.

Return value

Number of available GPUs.

string getGPUInfo ( int video_adapter_num = 0 ) #

Returns information on the video adapter with the specified number (video card, driver versions).

Arguments

  • int video_adapter_num - Number of the video adapter.

Return value

Information on the video adapter.

int getGPUMemory ( int video_adapter_num = 0 ) #

Returns the video memory size for the video adapter with the specified number.

Arguments

  • int video_adapter_num - Number of the video adapter.

Return value

Video memory size, in Mbytes.

int getGPUID ( int video_adapter_num = 0 ) #

Returns the GPU ID for the video adapter with the specified number in the list of detected ones.

Arguments

  • int video_adapter_num - Number of the graphics adapter (GPU) in the list of detected ones.

Return value

GPU ID for the video adapter with the specified number.

int getGPUName ( string str ) #

Returns the type of the GPU win the specified name.

Arguments

  • string str - GPU name (e.g. GeForce GTX 770).

Return value

GPU type identifier, one of the GPU_* values.

int getGPUName ( int video_adapter_num = 0 ) #

Returns the GPU type for the video adapter with the specified number in the list of detected ones.

Arguments

  • int video_adapter_num - Number of the graphics adapter (GPU) in the list of detected ones.

Return value

GPU type identifier, one of the GPU_* values.
Last update: 2021-12-13
Build: ()