OGRE: OgreConfig.h File Reference - OGRE Documentation

Defines

# OgreConfig.h File Reference

`#include "OgreBuildSettings.h"`

Go to the source code of this file.

## Defines
#define | OGRE_PROFILING 0
| If set to 1, profiling code will be included in the application.
#define | OGRE_ASSERT_MODE 0
| There are three modes for handling asserts in OGRE: 0 - STANDARD - Standard asserts in debug builds, nothing in release builds 1 - RELEASE_EXCEPTIONS - Standard asserts in debug builds, exceptions in release builds 2 - EXCEPTIONS - Exceptions in debug builds, exceptions in release builds.
#define | OGRE_PRETEND_TEXTURE_UNITS 0
| If set to >0, OGRE will always 'think' that the graphics card only has the number of texture units specified.
#define | OGRE_DOUBLE_PRECISION 0
| If set to 1, Real is typedef'ed to double.
#define | OGRE_MAX_TEXTURE_COORD_SETS 6
| Define number of texture coordinate sets allowed per vertex.
#define | OGRE_MAX_TEXTURE_LAYERS 16
| Define max number of texture layers allowed per pass on any card.
#define | OGRE_MAX_SIMULTANEOUS_LIGHTS 8
| Define max number of lights allowed per pass.
#define | OGRE_MAX_BLEND_WEIGHTS 4
| Define max number of blending weights allowed per vertex.
#define | OGRE_MEMORY_ALLOCATOR_STD 1
| Define this if you want to link OGRE as a static lib (preferably as a project file).
#define | OGRE_MEMORY_ALLOCATOR_NED 2
#define | OGRE_MEMORY_ALLOCATOR_USER 3
#define | OGRE_MEMORY_ALLOCATOR_NEDPOOLING 4
#define | OGRE_MEMORY_ALLOCATOR OGRE_MEMORY_ALLOCATOR_NEDPOOLING
#define | OGRE_CONTAINERS_USE_CUSTOM_MEMORY_ALLOCATOR 1
#define | OGRE_STRING_USE_CUSTOM_MEMORY_ALLOCATOR 0
#define | OGRE_MEMORY_TRACKER_DEBUG_MODE 0
#define | OGRE_MEMORY_TRACKER_RELEASE_MODE 0
#define | OGRE_MAX_MULTIPLE_RENDER_TARGETS 8
| Define max number of multiple render targets (MRTs) to render to at once.
#define | OGRE_THREAD_SUPPORT 0
| Support for multithreading, there are 3 options.
#define | OGRE_THREAD_PROVIDER 0
| Provider for threading functionality, there are 4 options.
#define | OGRE_NO_FREEIMAGE 0
| Disables use of the FreeImage image library for loading images.
#define | OGRE_NO_DEVIL 1
| Disables use of the DevIL image library for loading images.
#define | OGRE_NO_DDS_CODEC 0
| Disables use of the internal image codec for loading DDS files.
#define | OGRE_NO_ZIP_ARCHIVE 0
| Disables use of the ZIP archive support.
#define | OGRE_USE_NEW_COMPILERS 1
| Enables the use of the new script compilers when Ogre compiles resource scripts.

## Define Documentation

#define OGRE_ASSERT_MODE 0

There are three modes for handling asserts in OGRE: 0 - STANDARD - Standard asserts in debug builds, nothing in release builds 1 - RELEASE_EXCEPTIONS - Standard asserts in debug builds, exceptions in release builds 2 - EXCEPTIONS - Exceptions in debug builds, exceptions in release builds.

Definition at line 48 of file OgreConfig.h.

#define OGRE_CONTAINERS_USE_CUSTOM_MEMORY_ALLOCATOR 1

Definition at line 97 of file OgreConfig.h.

#define OGRE_DOUBLE_PRECISION 0

If set to 1, Real is typedef'ed to double.

Otherwise, Real is typedef'ed to float. Setting this allows you to perform mathematical operations in the CPU (Quaternion, Vector3 etc) with more precision, but bear in mind that the GPU still operates in single-precision mode.

Definition at line 61 of file OgreConfig.h.

#define OGRE_MAX_BLEND_WEIGHTS 4

Define max number of blending weights allowed per vertex.

Definition at line 78 of file OgreConfig.h.

#define OGRE_MAX_MULTIPLE_RENDER_TARGETS 8

Define max number of multiple render targets (MRTs) to render to at once.

Definition at line 119 of file OgreConfig.h.

#define OGRE_MAX_SIMULTANEOUS_LIGHTS 8

Define max number of lights allowed per pass.

Definition at line 74 of file OgreConfig.h.

#define OGRE_MAX_TEXTURE_COORD_SETS 6

Define number of texture coordinate sets allowed per vertex.

Definition at line 66 of file OgreConfig.h.

#define OGRE_MAX_TEXTURE_LAYERS 16

Define max number of texture layers allowed per pass on any card.

Definition at line 70 of file OgreConfig.h.

#define OGRE_MEMORY_ALLOCATOR OGRE_MEMORY_ALLOCATOR_NEDPOOLING

Definition at line 92 of file OgreConfig.h.

#define OGRE_MEMORY_ALLOCATOR_NED 2

Definition at line 87 of file OgreConfig.h.

#define OGRE_MEMORY_ALLOCATOR_NEDPOOLING 4

Definition at line 89 of file OgreConfig.h.

#define OGRE_MEMORY_ALLOCATOR_STD 1

Define this if you want to link OGRE as a static lib (preferably as a project file).

Definition at line 86 of file OgreConfig.h.

#define OGRE_MEMORY_ALLOCATOR_USER 3

Definition at line 88 of file OgreConfig.h.

#define OGRE_MEMORY_TRACKER_DEBUG_MODE 0

Definition at line 111 of file OgreConfig.h.

#define OGRE_MEMORY_TRACKER_RELEASE_MODE 0

Definition at line 115 of file OgreConfig.h.

#define OGRE_NO_DDS_CODEC 0

Disables use of the internal image codec for loading DDS files.

WARNING: Use only when you want to provide your own image loading code via codecs.

Definition at line 181 of file OgreConfig.h.

#define OGRE_NO_DEVIL 1

Disables use of the DevIL image library for loading images.

By default DevIL is disabled in Eihort in favour of FreeImage, but you may re-enable it if you choose

Definition at line 174 of file OgreConfig.h.

#define OGRE_NO_FREEIMAGE 0

Disables use of the FreeImage image library for loading images.

WARNING: Use only when you want to provide your own image loading code via codecs.

Definition at line 166 of file OgreConfig.h.

#define OGRE_NO_ZIP_ARCHIVE 0

Disables use of the ZIP archive support.

WARNING: Disabling this will make the samples unusable.

Definition at line 188 of file OgreConfig.h.

#define OGRE_PRETEND_TEXTURE_UNITS 0

If set to >0, OGRE will always 'think' that the graphics card only has the number of texture units specified.

Very useful for testing multipass fallback.

Definition at line 53 of file OgreConfig.h.

#define OGRE_PROFILING 0

If set to 1, profiling code will be included in the application.

When you are deploying your application you will probably want to set this to 0

Definition at line 40 of file OgreConfig.h.

#define OGRE_STRING_USE_CUSTOM_MEMORY_ALLOCATOR 0

Definition at line 104 of file OgreConfig.h.

#define OGRE_THREAD_PROVIDER 0

Provider for threading functionality, there are 4 options.

OGRE_THREAD_PROVIDER = 0 No support for threading. OGRE_THREAD_PROVIDER = 1 Boost libraries provide threading functionality. OGRE_THREAD_PROVIDER = 2 Poco libraries provide threading functionality. OGRE_THREAD_PROVIDER = 3 TBB library provides threading functionality.

Definition at line 159 of file OgreConfig.h.

#define OGRE_THREAD_SUPPORT 0

Support for multithreading, there are 3 options.

OGRE_THREAD_SUPPORT = 0 No support for threading. OGRE_THREAD_SUPPORT = 1 Thread support for background loading, by both loading and constructing resources in a background thread. Resource management and SharedPtr handling becomes thread-safe, and resources may be completely loaded in the background. The places where threading is available are clearly marked, you should assume state is NOT thread safe unless otherwise stated in relation to this flag. OGRE_THREAD_SUPPORT = 2 Thread support for background resource preparation. This means that resource data can streamed into memory in the background, but the final resource construction (including RenderSystem dependencies) is still done in the primary thread. Has a lower synchronisation primitive overhead than full threading while still allowing the major blocking aspects of resource management (I/O) to be done in the background.

Definition at line 141 of file OgreConfig.h.

#define OGRE_USE_NEW_COMPILERS 1

Enables the use of the new script compilers when Ogre compiles resource scripts.

Definition at line 194 of file OgreConfig.h.

Copyright © 2008 Torus Knot Software Ltd
This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.
Last modified Wed Nov 3 2010 19:24:52