Ogre::PlatformInformation Class Reference
[General]

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

#include <OgrePlatformInformation.h>

List of all members.

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 const StringgetCpuIdentifier (void)
 Gets a string of the CPU identifier.
static uint getCpuFeatures (void)
 Gets a or-masked of enum CpuFeatures that are supported by the CPU.
static bool hasCpuFeature (CpuFeatures feature)
 Gets whether a specific feature is supported by the CPU.
static void log (Log *pLog)
 Write the CPU information to the passed in Log.

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 143 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 148 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 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:

Copyright © 2012 Torus Knot Software Ltd
Creative Commons License
This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.
Last modified Fri May 25 23:38:57 2012