OGRE: OgrePrerequisites.h File Reference - OGRE Documentation

Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages

# OgrePrerequisites.h File Reference

`#include "OgrePlatform.h"`
`#include "OgreMemoryManager.h"`

Go to the source code of this file.

## Namespaces

namespace | Ogre

## Defines

#define | OGRE_FORCE_ANGLE_TYPES
#define | OGRE_VERSION_MAJOR 1
#define | OGRE_VERSION_MINOR 4
#define | OGRE_VERSION_PATCH 7
#define | OGRE_VERSION_SUFFIX ""
#define | OGRE_VERSION_NAME "Eihort"
#define | OGRE_VERSION ((OGRE_VERSION_MAJOR << 16) | (OGRE_VERSION_MINOR << 8) | OGRE_VERSION_PATCH)
#define | HashMap ::std::hash_map
#define | OGRE_DELETE(p) { if(p) { delete (p); (p)=NULL; } }
| Useful macros.
#define | OGRE_DELETE_ARRAY(p) { if(p) { delete[] (p); (p)=NULL; } }
#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) delete var; var = 0
#define | OGRE_THREAD_POINTER_GET(var) var

## Typedefs

typedef float | Real
| Software floating point type.
typedef unsigned char | uchar
| In order to avoid finger-aches :).
typedef unsigned short | ushort
typedef unsigned int | uint
typedef unsigned long | ulong
typedef std::string | _StringBase
typedef _StringBase | String

## Define Documentation

#define HashMap ::std::hash_map

| Definition at line 123 of file OgrePrerequisites.h.

#define OGRE_AUTO_MUTEX

| Definition at line 174 of file OgrePrerequisites.h.

#define OGRE_AUTO_MUTEX_NAME mutex

| Definition at line 147 of file OgrePrerequisites.h. Referenced by Ogre::SharedPtr< Skeleton >::release(), and Ogre::SharedPtr< Skeleton >::swap().

#define OGRE_AUTO_SHARED_MUTEX

| Definition at line 181 of file OgrePrerequisites.h.

#define OGRE_COPY_AUTO_SHARED_MUTEX | ( | from |  | ) |

| Definition at line 185 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< Skeleton >::SharedPtr(), Ogre::SkeletonPtr::SkeletonPtr(), and Ogre::TexturePtr::TexturePtr().

#define OGRE_DELETE | ( | p |  | ) | { if(p) { delete (p); (p)=NULL; } }

| Useful macros. Definition at line 135 of file OgrePrerequisites.h.

#define OGRE_DELETE_ARRAY | ( | p |  | ) | { if(p) { delete[] (p); (p)=NULL; } }

| Definition at line 136 of file OgrePrerequisites.h.

#define OGRE_DELETE_AUTO_SHARED_MUTEX

| Definition at line 184 of file OgrePrerequisites.h. Referenced by Ogre::SharedPtr< Skeleton >::destroy().

#define OGRE_FORCE_ANGLE_TYPES

| Definition at line 29 of file OgrePrerequisites.h.

#define OGRE_LOCK_AUTO_MUTEX

| Definition at line 175 of file OgrePrerequisites.h.

#define OGRE_LOCK_AUTO_SHARED_MUTEX

| Definition at line 182 of file OgrePrerequisites.h. Referenced by Ogre::SharedPtr< Skeleton >::bind(), Ogre::SharedPtr< Skeleton >::release(), Ogre::SharedPtr< Skeleton >::unique(), and Ogre::SharedPtr< Skeleton >::useCount().

#define OGRE_LOCK_MUTEX | ( | name |  | ) |

| Definition at line 179 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< Skeleton >::SharedPtr(), Ogre::SkeletonPtr::SkeletonPtr(), and Ogre::TexturePtr::TexturePtr().

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

| Definition at line 180 of file OgrePrerequisites.h.

#define OGRE_MUTEX | ( | name |  | ) |

| Definition at line 176 of file OgrePrerequisites.h.

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

| Definition at line 187 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< Skeleton >::release(), Ogre::SharedPtr< Skeleton >::SharedPtr(), Ogre::SkeletonPtr::SkeletonPtr(), and Ogre::TexturePtr::TexturePtr().

#define OGRE_NEW_AUTO_SHARED_MUTEX

| Definition at line 183 of file OgrePrerequisites.h. Referenced by Ogre::SharedPtr< Skeleton >::bind(), and Ogre::SharedPtr< Skeleton >::SharedPtr().

#define OGRE_SET_AUTO_SHARED_MUTEX_NULL

| Definition at line 186 of file OgrePrerequisites.h. Referenced by Ogre::SharedPtr< Skeleton >::release(), and Ogre::SharedPtr< Skeleton >::SharedPtr().

#define OGRE_STATIC_MUTEX | ( | name |  | ) |

| Definition at line 177 of file OgrePrerequisites.h.

#define OGRE_STATIC_MUTEX_INSTANCE | ( | name |  | ) |

| Definition at line 178 of file OgrePrerequisites.h.

#define OGRE_THREAD_NOTIFY_ALL | ( | sync |  | ) |

| Definition at line 191 of file OgrePrerequisites.h.

#define OGRE_THREAD_NOTIFY_ONE | ( | sync |  | ) |

| Definition at line 190 of file OgrePrerequisites.h.

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

| Definition at line 192 of file OgrePrerequisites.h.

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

| Definition at line 194 of file OgrePrerequisites.h.

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

| Definition at line 195 of file OgrePrerequisites.h.

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

| Definition at line 193 of file OgrePrerequisites.h.

#define OGRE_THREAD_SYNCHRONISER | ( | sync |  | ) |

| Definition at line 188 of file OgrePrerequisites.h.

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

| Definition at line 189 of file OgrePrerequisites.h.

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

| Definition at line 97 of file OgrePrerequisites.h.

#define OGRE_VERSION_MAJOR 1

| Definition at line 91 of file OgrePrerequisites.h.

#define OGRE_VERSION_MINOR 4

| Definition at line 92 of file OgrePrerequisites.h.

#define OGRE_VERSION_NAME "Eihort"

| Definition at line 95 of file OgrePrerequisites.h.

#define OGRE_VERSION_PATCH 7

| Definition at line 93 of file OgrePrerequisites.h.

#define OGRE_VERSION_SUFFIX ""

| Definition at line 94 of file OgrePrerequisites.h.

## Typedef Documentation

typedef std::string Ogre::_StringBase

| Definition at line 141 of file OgrePrerequisites.h.

typedef float Ogre::Real

Software floating point type.

Note:
  Not valid as a pointer to GPU buffers / parameters

Definition at line 110 of file OgrePrerequisites.h.

typedef _StringBase Ogre::String

| Definition at line 144 of file OgrePrerequisites.h.

typedef unsigned char Ogre::uchar

| In order to avoid finger-aches :). Definition at line 129 of file OgrePrerequisites.h.

typedef unsigned int Ogre::uint

| Definition at line 131 of file OgrePrerequisites.h.

typedef unsigned long Ogre::ulong

| Definition at line 132 of file OgrePrerequisites.h.

typedef unsigned short Ogre::ushort

| Definition at line 130 of file OgrePrerequisites.h.

Copyright © 2000-2005 by The OGRE Team
This work is licensed under a Creative Commons Attribution-ShareAlike 2.5 License.
Last modified Thu Mar 6 09:46:27 2008