Ocular Engine
Ocular::Core::SystemInfo Class Reference

#include <SystemInfo.hpp>

Static Public Member Functions

static void initialize ()
 
static void refresh ()
 
static void logSystemInfo ()
 
static OperatingSystems getOperatingSystem ()
 
static ProcessorArchitectures getProcessorArchitecture ()
 
static Endianness getEndianness ()
 
static OpenGLLevels getOpenGLSupportLevel ()
 
static DirectXLevels getDirectXSupportLevel ()
 
static uint64_t getTotalRAM ()
 
static uint64_t getFreeRAM ()
 
static uint64_t getTotalGPUMemory ()
 
static uint64_t getFreeGPUMemory ()
 
static uint32_t getNumberOfChannels ()
 
static uint32_t getNumberOfThreads ()
 
static Core::Directory getWorkingDirectory ()
 

Static Protected Member Functions

static void discoverOperatingSystem ()
 
static void discoverProcessorArchitecture ()
 
static void discoverEndianness ()
 
static void discoverOpenGLLevel ()
 
static void discoverDirectXLevel ()
 
static void discoverInstalledRAM ()
 
static void discoverInstalledGPUMemory ()
 
static void discoverNumberOfThreads ()
 
static void discoverAvailableGPUMemory ()
 
static void discoverAvailableRAM ()
 
static void discoverChannels ()
 

Detailed Description

Static class that collects many pieces of useful system information such as OS, architecture, supported graphics APIs, etc.

Member Function Documentation

DirectXLevels Ocular::Core::SystemInfo::getDirectXSupportLevel ( )
static

Returns the level of DirectX support on this system.

Endianness Ocular::Core::SystemInfo::getEndianness ( )
static

Returns the endianness of the system.

uint64_t Ocular::Core::SystemInfo::getFreeGPUMemory ( )
static

Returns the total amount of memory that is free and not in use on the GPUs (in bytes).

Note
A return value of 0 indicates unknown. Either Ocular failed to retrieve the data, or refresh needs to be called.
uint64_t Ocular::Core::SystemInfo::getFreeRAM ( )
static

Returns the total amount of physical RAM that is available on the system (in bytes).

Note
A return value of 0 indicates unknown. Either Ocular failed to retrieve the data, or refresh needs to be called.
uint32_t Ocular::Core::SystemInfo::getNumberOfChannels ( )
static

Returns number of output channels (monitors, etc.) on the system.

Note
A return value of 0 indicates unknown. Either Ocular failed to retrieve the data, or refresh needs to be called.
uint32_t Ocular::Core::SystemInfo::getNumberOfThreads ( )
static

Returns the number of supported concurrent threads.

OpenGLLevels Ocular::Core::SystemInfo::getOpenGLSupportLevel ( )
static

Returns the level of OpenGL support on this system.

OperatingSystems Ocular::Core::SystemInfo::getOperatingSystem ( )
static

Returns the current running Operating System.

ProcessorArchitectures Ocular::Core::SystemInfo::getProcessorArchitecture ( )
static

Returns the processor architecture for the system.

uint64_t Ocular::Core::SystemInfo::getTotalGPUMemory ( )
static

Returns the total amount of memory on the GPUs (both used and unused) (in bytes).

Note
A return value of 0 indicates unknown. Either Ocular failed to retrieve the data, or refresh needs to be called.
uint64_t Ocular::Core::SystemInfo::getTotalRAM ( )
static

Returns the total amount of physical RAM on this system (in bytes).

Note
A return value of 0 indicates unknown. Either Ocular failed to retrieve the data, or refresh needs to be called.
Core::Directory Ocular::Core::SystemInfo::getWorkingDirectory ( )
static

Returns the directory that the executable is running from.

void Ocular::Core::SystemInfo::initialize ( )
static

Populates with all available system info.

void Ocular::Core::SystemInfo::logSystemInfo ( )
static

Helper method that logs all current system information.

void Ocular::Core::SystemInfo::refresh ( )
static

Forces a refresh of variables that can change during program lifetime. These include:

- Available RAM
- Available GPU Memory
- Available Channels

This method is called automatically at the start of each frame.


The documentation for this class was generated from the following files: