OGRE: OgrePrerequisites.h File Reference - OGRE Documentation

# OgrePrerequisites.h File Reference

`#include "OgrePlatform.h"`
`#include <string>`
`#include "OgreStdHeaders.h"`
`#include "OgreMemoryAllocatorConfig.h"`

Go to the source code of this file.

## Namespaces
namespace | Ogre
## Defines
#define | OGRE_MEMORY_TRACKER 0
#define | OGRE_VERSION_MAJOR 1
#define | OGRE_VERSION_MINOR 6
#define | OGRE_VERSION_PATCH 3
#define | OGRE_VERSION_SUFFIX ""
#define | OGRE_VERSION_NAME "Shoggoth"
#define | OGRE_VERSION ((OGRE_VERSION_MAJOR << 16) | (OGRE_VERSION_MINOR << 8) | OGRE_VERSION_PATCH)
#define | HashMap ::std::hash_map
#define | HashSet ::std::hash_set
#define | OGRE_AUTO_MUTEX_NAME mutex
#define | OGRE_AUTO_MUTEX
#define | OGRE_LOCK_AUTO_MUTEX
#define | OGRE_MUTEX(name)
#define | OGRE_STATIC_MUTEX(name)
#define | OGRE_STATIC_MUTEX_INSTANCE(name)
#define | OGRE_LOCK_MUTEX(name)
#define | OGRE_LOCK_MUTEX_NAMED(mutexName, lockName)
#define | OGRE_AUTO_SHARED_MUTEX
#define | OGRE_LOCK_AUTO_SHARED_MUTEX
#define | OGRE_NEW_AUTO_SHARED_MUTEX
#define | OGRE_DELETE_AUTO_SHARED_MUTEX
#define | OGRE_COPY_AUTO_SHARED_MUTEX(from)
#define | OGRE_SET_AUTO_SHARED_MUTEX_NULL
#define | OGRE_MUTEX_CONDITIONAL(name) if(true)
#define | OGRE_THREAD_SYNCHRONISER(sync)
#define | OGRE_THREAD_WAIT(sync, lock)
#define | OGRE_THREAD_NOTIFY_ONE(sync)
#define | OGRE_THREAD_NOTIFY_ALL(sync)
#define | OGRE_THREAD_POINTER(T, var) T* var
#define | OGRE_THREAD_POINTER_SET(var, expr) var = expr
#define | OGRE_THREAD_POINTER_DELETE(var) OGRE_DELETE var; var = 0
#define | OGRE_THREAD_POINTER_GET(var) var
## Typedefs
typedef float | Ogre::Real
| Software floating point type.
typedef unsigned char | Ogre::uchar
| In order to avoid finger-aches :).
typedef unsigned short | Ogre::ushort
typedef unsigned int | Ogre::uint
typedef unsigned long | Ogre::ulong
typedef std::string | Ogre::_StringBase
typedef _StringBase | Ogre::String

## Define Documentation

#define HashMap ::std::hash_map

Definition at line 144 of file OgrePrerequisites.h.

#define HashSet ::std::hash_set

Definition at line 145 of file OgrePrerequisites.h.

#define OGRE_AUTO_MUTEX

Definition at line 192 of file OgrePrerequisites.h.

#define OGRE_AUTO_MUTEX_NAME mutex

Definition at line 165 of file OgrePrerequisites.h.

Referenced by Ogre::SharedPtr< Ogre::AnimableValue >::release(), and Ogre::SharedPtr< Ogre::AnimableValue >::swap().

#define OGRE_AUTO_SHARED_MUTEX

Definition at line 199 of file OgrePrerequisites.h.

#define OGRE_COPY_AUTO_SHARED_MUTEX | ( | from |  | ) |

Definition at line 203 of file OgrePrerequisites.h.

Referenced by Ogre::CompositorPtr::CompositorPtr(), Ogre::FontPtr::FontPtr(), Ogre::GpuProgramPtr::GpuProgramPtr(), Ogre::HighLevelGpuProgramPtr::HighLevelGpuProgramPtr(), Ogre::MaterialPtr::MaterialPtr(), Ogre::TexturePtr::operator=(), Ogre::SkeletonPtr::operator=(), Ogre::PatchMeshPtr::operator=(), Ogre::MaterialPtr::operator=(), Ogre::HighLevelGpuProgramPtr::operator=(), Ogre::GpuProgramPtr::operator=(), Ogre::FontPtr::operator=(), Ogre::CompositorPtr::operator=(), Ogre::PatchMeshPtr::PatchMeshPtr(), Ogre::SharedPtr< Ogre::AnimableValue >::SharedPtr(), Ogre::SkeletonPtr::SkeletonPtr(), and Ogre::TexturePtr::TexturePtr().

#define OGRE_DELETE_AUTO_SHARED_MUTEX

Definition at line 202 of file OgrePrerequisites.h.

Referenced by Ogre::SharedPtr< Ogre::AnimableValue >::destroy().

#define OGRE_LOCK_AUTO_MUTEX

Definition at line 193 of file OgrePrerequisites.h.

Referenced by Ogre::AtomicScalar< Ogre::Resource::LoadingState >::cas(), Ogre::AtomicObject< T >::cas(), Ogre::AtomicObject< T >::get(), Ogre::AtomicScalar< Ogre::Resource::LoadingState >::operator++(), Ogre::AtomicObject< T >::operator++(), Ogre::AtomicScalar< Ogre::Resource::LoadingState >::operator--(), Ogre::AtomicObject< T >::operator--(), Ogre::AtomicScalar< Ogre::Resource::LoadingState >::operator=(), Ogre::AtomicScalar< Ogre::Resource::LoadingState >::set(), and Ogre::AtomicObject< T >::set().

#define OGRE_LOCK_AUTO_SHARED_MUTEX

Definition at line 200 of file OgrePrerequisites.h.

Referenced by Ogre::SharedPtr< Ogre::AnimableValue >::bind(), Ogre::SharedPtr< Ogre::AnimableValue >::release(), Ogre::SharedPtr< Ogre::AnimableValue >::unique(), and Ogre::SharedPtr< Ogre::AnimableValue >::useCount().

#define OGRE_LOCK_MUTEX | ( | name |  | ) |

Definition at line 197 of file OgrePrerequisites.h.

Referenced by Ogre::CompositorPtr::CompositorPtr(), Ogre::FontPtr::FontPtr(), Ogre::GpuProgramPtr::GpuProgramPtr(), Ogre::HighLevelGpuProgramPtr::HighLevelGpuProgramPtr(), Ogre::MaterialPtr::MaterialPtr(), Ogre::TexturePtr::operator=(), Ogre::SkeletonPtr::operator=(), Ogre::PatchMeshPtr::operator=(), Ogre::MaterialPtr::operator=(), Ogre::HighLevelGpuProgramPtr::operator=(), Ogre::GpuProgramPtr::operator=(), Ogre::FontPtr::operator=(), Ogre::CompositorPtr::operator=(), Ogre::PatchMeshPtr::PatchMeshPtr(), Ogre::SharedPtr< Ogre::AnimableValue >::SharedPtr(), Ogre::SkeletonPtr::SkeletonPtr(), and Ogre::TexturePtr::TexturePtr().

#define OGRE_LOCK_MUTEX_NAMED | ( | mutexName,
|  | lockName |  | ) |

Definition at line 198 of file OgrePrerequisites.h.

#define OGRE_MEMORY_TRACKER 0

Definition at line 92 of file OgrePrerequisites.h.

#define OGRE_MUTEX | ( | name |  | ) |

Definition at line 194 of file OgrePrerequisites.h.

#define OGRE_MUTEX_CONDITIONAL | ( | name |  | ) | if(true)

Definition at line 205 of file OgrePrerequisites.h.

Referenced by Ogre::CompositorPtr::CompositorPtr(), Ogre::FontPtr::FontPtr(), Ogre::GpuProgramPtr::GpuProgramPtr(), Ogre::HighLevelGpuProgramPtr::HighLevelGpuProgramPtr(), Ogre::MaterialPtr::MaterialPtr(), Ogre::TexturePtr::operator=(), Ogre::SkeletonPtr::operator=(), Ogre::PatchMeshPtr::operator=(), Ogre::MaterialPtr::operator=(), Ogre::HighLevelGpuProgramPtr::operator=(), Ogre::GpuProgramPtr::operator=(), Ogre::FontPtr::operator=(), Ogre::CompositorPtr::operator=(), Ogre::PatchMeshPtr::PatchMeshPtr(), Ogre::SharedPtr< Ogre::AnimableValue >::release(), Ogre::SharedPtr< Ogre::AnimableValue >::SharedPtr(), Ogre::SkeletonPtr::SkeletonPtr(), and Ogre::TexturePtr::TexturePtr().

#define OGRE_NEW_AUTO_SHARED_MUTEX

Definition at line 201 of file OgrePrerequisites.h.

Referenced by Ogre::SharedPtr< Ogre::AnimableValue >::bind(), and Ogre::SharedPtr< Ogre::AnimableValue >::SharedPtr().

#define OGRE_SET_AUTO_SHARED_MUTEX_NULL

Definition at line 204 of file OgrePrerequisites.h.

Referenced by Ogre::SharedPtr< Ogre::AnimableValue >::release(), and Ogre::SharedPtr< Ogre::AnimableValue >::SharedPtr().

#define OGRE_STATIC_MUTEX | ( | name |  | ) |

Definition at line 195 of file OgrePrerequisites.h.

#define OGRE_STATIC_MUTEX_INSTANCE | ( | name |  | ) |

Definition at line 196 of file OgrePrerequisites.h.

#define OGRE_THREAD_NOTIFY_ALL | ( | sync |  | ) |

Definition at line 209 of file OgrePrerequisites.h.

#define OGRE_THREAD_NOTIFY_ONE | ( | sync |  | ) |

Definition at line 208 of file OgrePrerequisites.h.

#define OGRE_THREAD_POINTER | ( | T,
|  | var |  | ) | T* var

Definition at line 210 of file OgrePrerequisites.h.

#define OGRE_THREAD_POINTER_DELETE | ( | var |  | ) | OGRE_DELETE var; var = 0

Definition at line 212 of file OgrePrerequisites.h.

#define OGRE_THREAD_POINTER_GET | ( | var |  | ) | var

Definition at line 213 of file OgrePrerequisites.h.

#define OGRE_THREAD_POINTER_SET | ( | var,
|  | expr |  | ) | var = expr

Definition at line 211 of file OgrePrerequisites.h.

#define OGRE_THREAD_SYNCHRONISER | ( | sync |  | ) |

Definition at line 206 of file OgrePrerequisites.h.

#define OGRE_THREAD_WAIT | ( | sync,
|  | lock |  | ) |

Definition at line 207 of file OgrePrerequisites.h.

#define OGRE_VERSION ((OGRE_VERSION_MAJOR << 16) | (OGRE_VERSION_MINOR << 8) | OGRE_VERSION_PATCH)

Definition at line 107 of file OgrePrerequisites.h.

#define OGRE_VERSION_MAJOR 1

Definition at line 101 of file OgrePrerequisites.h.

#define OGRE_VERSION_MINOR 6

Definition at line 102 of file OgrePrerequisites.h.

#define OGRE_VERSION_NAME "Shoggoth"

Definition at line 105 of file OgrePrerequisites.h.

#define OGRE_VERSION_PATCH 3

Definition at line 103 of file OgrePrerequisites.h.

#define OGRE_VERSION_SUFFIX ""

Definition at line 104 of file OgrePrerequisites.h.

Copyright © 2008 Torus Knot Software Ltd
This work is licensed under a Creative Commons Attribution-ShareAlike 2.5 License.
Last modified Sun Jul 26 11:32:21 2009