# OgrePrerequisites.h File Reference

`#include "OgrePlatform.h"`
`#include "OgreStdHeaders.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 2
#define | OGRE_VERSION_PATCH 3
#define | OGRE_VERSION_NAME "Dagon"
#define | OGRE_VERSION ((OGRE_VERSION_MAJOR << 16) | (OGRE_VERSION_MINOR << 8) | OGRE_VERSION_PATCH)
#define | OgreChar char
#define | _TO_CHAR(x) x
#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_LOCK_MUTEX(name)
#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)

## 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 _TO_CHAR | ( | x |  | ) | x

| Definition at line 113 of file OgrePrerequisites.h.

#define HashMap ::std::hash_map

| Definition at line 126 of file OgrePrerequisites.h.

#define OGRE_AUTO_MUTEX

| Definition at line 166 of file OgrePrerequisites.h.

#define OGRE_AUTO_MUTEX_NAME mutex

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

#define OGRE_AUTO_SHARED_MUTEX

| Definition at line 170 of file OgrePrerequisites.h.

#define OGRE_COPY_AUTO_SHARED_MUTEX | ( | from |  | ) |

Definition at line 174 of file OgrePrerequisites.h.

Referenced by Ogre::BspLevelPtr::BspLevelPtr(), Ogre::CompositorPtr::CompositorPtr(), Ogre::D3D9GpuProgramPtr::D3D9GpuProgramPtr(), Ogre::D3D9TexturePtr::D3D9TexturePtr(), Ogre::FontPtr::FontPtr(), Ogre::GLTexturePtr::GLTexturePtr(), Ogre::HighLevelGpuProgramPtr::HighLevelGpuProgramPtr(), Ogre::MaterialPtr::MaterialPtr(), Ogre::TexturePtr::operator=(), Ogre::SkeletonPtr::operator=(), Ogre::SharedPtr< Skeleton >::operator=(), Ogre::PatchMeshPtr::operator=(), Ogre::MaterialPtr::operator=(), Ogre::HighLevelGpuProgramPtr::operator=(), Ogre::GpuProgramPtr::operator=(), Ogre::GLTexturePtr::operator=(), Ogre::FontPtr::operator=(), Ogre::D3D9TexturePtr::operator=(), Ogre::D3D9GpuProgramPtr::operator=(), Ogre::CompositorPtr::operator=(), Ogre::BspLevelPtr::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 138 of file OgrePrerequisites.h.

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

| Definition at line 139 of file OgrePrerequisites.h.

#define OGRE_DELETE_AUTO_SHARED_MUTEX

| Definition at line 173 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 167 of file OgrePrerequisites.h. Referenced by Ogre::Resource::isLoaded().

#define OGRE_LOCK_AUTO_SHARED_MUTEX

| Definition at line 171 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 169 of file OgrePrerequisites.h.

Referenced by Ogre::BspLevelPtr::BspLevelPtr(), Ogre::CompositorPtr::CompositorPtr(), Ogre::D3D9GpuProgramPtr::D3D9GpuProgramPtr(), Ogre::D3D9TexturePtr::D3D9TexturePtr(), Ogre::FontPtr::FontPtr(), Ogre::GLTexturePtr::GLTexturePtr(), Ogre::HighLevelGpuProgramPtr::HighLevelGpuProgramPtr(), Ogre::MaterialPtr::MaterialPtr(), Ogre::TexturePtr::operator=(), Ogre::SkeletonPtr::operator=(), Ogre::SharedPtr< Skeleton >::operator=(), Ogre::PatchMeshPtr::operator=(), Ogre::MaterialPtr::operator=(), Ogre::HighLevelGpuProgramPtr::operator=(), Ogre::GpuProgramPtr::operator=(), Ogre::GLTexturePtr::operator=(), Ogre::FontPtr::operator=(), Ogre::D3D9TexturePtr::operator=(), Ogre::D3D9GpuProgramPtr::operator=(), Ogre::CompositorPtr::operator=(), Ogre::BspLevelPtr::operator=(), Ogre::PatchMeshPtr::PatchMeshPtr(), Ogre::SharedPtr< Skeleton >::SharedPtr(), Ogre::SkeletonPtr::SkeletonPtr(), and Ogre::TexturePtr::TexturePtr().

#define OGRE_MUTEX | ( | name |  | ) |

| Definition at line 168 of file OgrePrerequisites.h.

#define OGRE_MUTEX_CONDITIONAL | ( | name |  | ) |

Definition at line 176 of file OgrePrerequisites.h.

Referenced by Ogre::CompositorPtr::CompositorPtr(), Ogre::D3D9TexturePtr::D3D9TexturePtr(), Ogre::FontPtr::FontPtr(), Ogre::GLTexturePtr::GLTexturePtr(), Ogre::HighLevelGpuProgramPtr::HighLevelGpuProgramPtr(), Ogre::MaterialPtr::MaterialPtr(), Ogre::TexturePtr::operator=(), Ogre::SkeletonPtr::operator=(), Ogre::SharedPtr< Skeleton >::operator=(), Ogre::PatchMeshPtr::operator=(), Ogre::MaterialPtr::operator=(), Ogre::HighLevelGpuProgramPtr::operator=(), Ogre::GpuProgramPtr::operator=(), Ogre::GLTexturePtr::operator=(), Ogre::FontPtr::operator=(), Ogre::D3D9TexturePtr::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 172 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 175 of file OgrePrerequisites.h. Referenced by Ogre::SharedPtr< Skeleton >::release(), and Ogre::SharedPtr< Skeleton >::SharedPtr().

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

| Definition at line 91 of file OgrePrerequisites.h.

#define OGRE_VERSION_MAJOR 1

| Definition at line 86 of file OgrePrerequisites.h.

#define OGRE_VERSION_MINOR 2

| Definition at line 87 of file OgrePrerequisites.h.

#define OGRE_VERSION_NAME "Dagon"

| Definition at line 89 of file OgrePrerequisites.h.

#define OGRE_VERSION_PATCH 3

| Definition at line 88 of file OgrePrerequisites.h.

#define OgreChar char

| Definition at line 112 of file OgrePrerequisites.h. Referenced by Ogre::Font::getGlyphAspectRatio(), Ogre::Font::getGlyphTexCoords(), Ogre::Font::setGlyphAspectRatio(), and Ogre::Font::setGlyphTexCoords().

## Typedef Documentation

typedef std::string Ogre::_StringBase

| Definition at line 144 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 104 of file OgrePrerequisites.h.

typedef _StringBase Ogre::String

| Definition at line 147 of file OgrePrerequisites.h.

typedef unsigned char Ogre::uchar

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

typedef unsigned int Ogre::uint

| Definition at line 134 of file OgrePrerequisites.h.

typedef unsigned long Ogre::ulong

| Definition at line 135 of file OgrePrerequisites.h.

typedef unsigned short Ogre::ushort

| Definition at line 133 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 Sun Sep 17 15:39:13 2006