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.
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.string getCPUInfo ( ) #
Console: cpu_info
Returns information on the CPU.Return value
CPU information.int getCPUFrequency ( ) #
Console: cpu_frequency
Returns the current CPU frequency.Return value
Current CPU frequency, in MHz.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.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.string getOSInfo ( ) #
Returns the operating system information: its name, edition, and build.Return value
Operating system information.string getEngineInfo ( ) #
Returns the complete information on the engine: version number, release/debug, revision, date.Return value
Complete engine information.long getMemoryFree ( ) #
Returns the total amount of unused memory, in Mbytes.Return value
The total amount of unused memory.long getMemoryFreeCommitted ( ) #
Returns the amount of unused committed memory, in Mbytes.Return value
The amount of unused committed memory.long getMemoryTotal ( ) #
Returns the total amount of memory, in Mbytes.Return value
The total amount of memory.long getMemoryTotalCommitted ( ) #
Returns the total amount of committed memory, in Mbytes.Return value
The total amount of committed memory.long getMemoryUsage ( ) #
Returns the total amount of memory in use, in Mbytes.Return value
The total amount of used memory.long getMemoryUsageCommitted ( ) #
Returns the amount of the committed memory currently in use, in Mbytes.Return value
The amount of the committed memory currently in use, in Mbytes.int getCPUCores ( ) #
Returns the number of CPU cores.Return value
The number of CPU cores.void logInfo ( ) #
Returns the infromation on the Engine, OS, CPU and GPU.int getGPUActive ( ) #
Returns the index of the active GPU.Return value
The index of the active GPU.int findGPUByLuid ( long luid ) #
Returns the GPU index by its locally unique identifier.Arguments
- long luid - The locally unique identifier of the GPU.
Return value
The GPU index, or -1 if no GPU is found.int findGPUByDeviceID ( unsigned int device_id ) #
Returns the GPU index by the device identifier.Arguments
- unsigned int device_id - The GPU device ID.
Return value
The GPU index, or -1 if no GPU is found.int getGPUType ( int video_adapter_num = -1 ) #
Returns the GPU type by the video adapter index.Arguments
- int video_adapter_num - The video adapter index.
Return value
The GPU type.int getGPUVendor ( int video_adapter_num = -1 ) #
Returns the GPU vendor name by the video adapter index.Arguments
- int video_adapter_num - The video adapter index.
Return value
The GPU vendor name.unsigned int getGPUDeviceID ( int video_adapter_num = -1 ) #
Returns the GPU device ID by the video adapter index.Arguments
- int video_adapter_num - The video adapter index.
Return value
The GPU device ID.long getGPULuid ( int video_adapter_num = -1 ) #
Returns the GPU locally unique identifier by the video adapter index.Arguments
- int video_adapter_num - The video adapter index.
Return value
The locally unique identifier of the GPU.string getGPUDescription ( int video_adapter_num = -1 ) #
Returns the graphics card model by the video adapter index.Arguments
- int video_adapter_num - The video adapter index.
Return value
The GPU model.string getGPUVendorName ( int video_adapter_num = -1 ) #
Returns the graphics card vendor name by the video adapter index.Arguments
- int video_adapter_num - The video adapter index.
Return value
The GPU vendor name.string getGPUDriver ( int video_adapter_num = -1 ) #
Returns the graphics card driver version by the video adapter index.Arguments
- int video_adapter_num - The video adapter index.
Return value
The GPU driver version.long getGPUMemoryFree ( ) #
Returns the amount of unused GPU memory, in Mbytes.Return value
The amount of unused GPU memory, in Mbytes.int getPlatformType ( ) #
Returns the platform type.Return value
The platform type.The information on this page is valid for UNIGINE 2.20 SDK.
Last update:
2024-07-12
Help improve this article
Was this article helpful?
(or select a word/phrase and press Ctrl+Enter)