Unigine.SystemInfo Class
SystemInfo Class
Enums
PLATFORM_TYPE#
GPU_TYPE#
GPU_VENDOR#
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.bool HasMMX ( ) #
Returns a value indicating if the system supports MMX (Multi-Media Extensions).Return value
true if the system supports MMX extension; otherwise, false.bool HasSSE ( ) #
Returns a value indicating if the system supports SSE (Streaming SIMD Extensions).Return value
true if the system supports SSE extension; otherwise, false.bool HasSSE2 ( ) #
Returns a value indicating if the system supports SSE2 (Streaming SIMD Extensions).Return value
true if the system supports SSE2 extension; otherwise, false.bool HasSSE3 ( ) #
Returns a value indicating if the system supports SSE3 (Streaming SIMD Extensions).Return value
true if the system supports SSE3 extension; otherwise, false.bool HasSSE4 ( ) #
Returns a value indicating if the system supports SSE4 (Streaming SIMD Extensions).Return value
true if the system supports SSE4 extension; otherwise, false.bool HasSSE5 ( ) #
Returns a value indicating if the system supports SSE5 (Streaming SIMD Extensions).Return value
true if the system supports SSE5 extension; otherwise, false.bool HasAVX ( ) #
Returns a value indicating if the system supports AVX (Advanced Vector Extensions).Return value
true if the system supports AVX extension; otherwise, false.bool HasAVX2 ( ) #
Returns a value indicating if the system supports AVX2 (Advanced Vector Extensions).Return value
true if the system supports AVX2 extension; otherwise, false.bool HasNeon ( ) #
Returns a value indicating if the system supports Neon (Advanced Vector Extensions).Return value
true if the system supports Neon extension; otherwise, false.bool HasHyperThreading ( ) #
Console: cpu_hyper_threading
Returns a value indicating if the system supports hyper-threading.Return value
true if the system supports hyper-threading; otherwise, false.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 ( ulong luid ) #
Returns the GPU index by its locally unique identifier.Arguments
- ulong luid - The locally unique identifier of the GPU.
Return value
The GPU index, or -1 if no GPU is found.int FindGPUByDeviceID ( uint device_id ) #
Returns the GPU index by the device identifier.Arguments
- uint device_id - The GPU device ID.
Return value
The GPU index, or -1 if no GPU is found.SystemInfo.GPU_TYPE 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.SystemInfo.GPU_VENDOR 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.uint 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.ulong 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.SystemInfo.PLATFORM_TYPE GetPlatformType ( ) #
Returns the platform type.Return value
The platform type.Last update:
2024-12-13
Help improve this article
Was this article helpful?
(or select a word/phrase and press Ctrl+Enter)