OGRE  2.0
Object-Oriented Graphics Rendering Engine
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Ogre::PlatformInformation Class Reference

Class which provides the run-time platform information Ogre runs on. More...

#include <OgrePlatformInformation.h>

Public Types

enum  CpuFeatures { CPU_FEATURE_NONE = 0 }
 Enum describing the different CPU features we want to check for, platform-dependent. More...
 

Static Public Member Functions

static uint getCpuFeatures (void)
 Gets a or-masked of enum CpuFeatures that are supported by the CPU. More...
 
static const StringgetCpuIdentifier (void)
 Gets a string of the CPU identifier. More...
 
static uint32 getNumLogicalCores (void)
 Returns the number of logical cores. More...
 
static bool hasCpuFeature (CpuFeatures feature)
 Gets whether a specific feature is supported by the CPU. More...
 
static void log (Log *pLog)
 Write the CPU information to the passed in Log. More...
 

Detailed Description

Class which provides the run-time platform information Ogre runs on.

Remarks
Ogre is designed to be platform-independent, but some platform and run-time environment specific optimised functions are built-in to maximise performance, and those special optimised routines are need to determine run-time environment for select variant executing path.
This class manages that provides a couple of functions to determine platform information of the run-time environment.
Note
This class is supposed to use by advanced user only.

Definition at line 142 of file OgrePlatformInformation.h.

Member Enumeration Documentation

Enum describing the different CPU features we want to check for, platform-dependent.

Enumerator
CPU_FEATURE_NONE 

Definition at line 147 of file OgrePlatformInformation.h.

Member Function Documentation

static uint Ogre::PlatformInformation::getCpuFeatures ( void  )
static

Gets a or-masked of enum CpuFeatures that are supported by the CPU.

Note
Actual detecting are performs in the first time call to this function, and then all future calls with return internal cached value.
static const String& Ogre::PlatformInformation::getCpuIdentifier ( void  )
static

Gets a string of the CPU identifier.

Note
Actual detecting are performs in the first time call to this function, and then all future calls with return internal cached value.
static uint32 Ogre::PlatformInformation::getNumLogicalCores ( void  )
static

Returns the number of logical cores.

Hyper Threaded cores do not count

Note
Returns 0 if couldn't detect.
static bool Ogre::PlatformInformation::hasCpuFeature ( CpuFeatures  feature)
static

Gets whether a specific feature is supported by the CPU.

Note
Actual detecting are performs in the first time call to this function, and then all future calls with return internal cached value.
static void Ogre::PlatformInformation::log ( Log pLog)
static

Write the CPU information to the passed in Log.


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