OGRE: OgreConfig.h File Reference

| OGRE 2.2.4 Object-Oriented Graphics Rendering Engine

Macros
OgreConfig.h File Reference
`#include "OgreBuildSettings.h"`

## Macros
#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. More...
#define | OGRE_CONTAINERS_USE_CUSTOM_MEMORY_ALLOCATOR 1
#define | OGRE_DOUBLE_PRECISION 0
| If set to 1, Real is typedef'ed to double. More...
#define | OGRE_MAX_BLEND_WEIGHTS 4
| Define max number of blending weights allowed per vertex. More...
#define | OGRE_MAX_MULTIPLE_RENDER_TARGETS 8
| Define max number of multiple render targets (MRTs) to render to at once. More...
#define | OGRE_MAX_POSES 16
| Define max number of poses per item. More...
#define | OGRE_MAX_SIMULTANEOUS_LIGHTS 8
| Define max number of lights allowed per pass. More...
#define | OGRE_MAX_TEXTURE_COORD_SETS 8
| Define number of texture coordinate sets allowed per vertex. More...
#define | OGRE_MAX_TEXTURE_LAYERS 128
| Define max number of texture layers allowed per pass on any card. More...
#define | OGRE_MEMORY_ALLOCATOR_NED 2
#define | OGRE_MEMORY_ALLOCATOR_NEDPOOLING 4
#define | OGRE_MEMORY_ALLOCATOR_STD 1
#define | OGRE_MEMORY_ALLOCATOR_TRACK 5
#define | OGRE_MEMORY_ALLOCATOR_USER 3
#define | OGRE_MEMORY_TRACKER_DEBUG_MODE 0
#define | OGRE_MEMORY_TRACKER_RELEASE_MODE 0
#define | OGRE_NO_DDS_CODEC 0
| Disables use of the internal image codec for loading DDS files. More...
#define | OGRE_NO_ETC_CODEC 1
| Disables use of the internal image codec for loading ETC files. More...
#define | OGRE_NO_FREEIMAGE 0
| Disables use of the FreeImage image library for loading images. More...
#define | OGRE_NO_STBI_CODEC 1
| Disables use of the internal image codec for loading image files. More...
#define | OGRE_NO_ZIP_ARCHIVE 0
| Disables use of the ZIP archive support. More...
#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. More...
#define | OGRE_PROFILING 0
| If set to 1, profiling code will be included in the application. More...
#define | OGRE_PROFILING_INTERNAL 1
#define | OGRE_PROFILING_INTERNAL_OFFLINE 3
#define | OGRE_PROFILING_NONE 0
#define | OGRE_PROFILING_REMOTERY 2
#define | OGRE_STRING_USE_CUSTOM_MEMORY_ALLOCATOR 0
#define | OGRE_THREAD_PROVIDER 0
| Provider for threading functionality, there are 4 options. More...
#define | OGRE_THREAD_SUPPORT 0
| Support for multithreading, there are 3 options. More...

## Macro Definition Documentation

## ◆ OGRE_ASSERT_MODE

#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.

## ◆ OGRE_CONTAINERS_USE_CUSTOM_MEMORY_ALLOCATOR

#define OGRE_CONTAINERS_USE_CUSTOM_MEMORY_ALLOCATOR 1

## ◆ OGRE_DOUBLE_PRECISION

#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.

## ◆ OGRE_MAX_BLEND_WEIGHTS

#define OGRE_MAX_BLEND_WEIGHTS 4

Define max number of blending weights allowed per vertex.

## ◆ OGRE_MAX_MULTIPLE_RENDER_TARGETS

#define OGRE_MAX_MULTIPLE_RENDER_TARGETS 8

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

## ◆ OGRE_MAX_POSES

#define OGRE_MAX_POSES 16

Define max number of poses per item.

## ◆ OGRE_MAX_SIMULTANEOUS_LIGHTS

#define OGRE_MAX_SIMULTANEOUS_LIGHTS 8

Define max number of lights allowed per pass.

## ◆ OGRE_MAX_TEXTURE_COORD_SETS

#define OGRE_MAX_TEXTURE_COORD_SETS 8

Define number of texture coordinate sets allowed per vertex.

## ◆ OGRE_MAX_TEXTURE_LAYERS

#define OGRE_MAX_TEXTURE_LAYERS 128

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

## ◆ OGRE_MEMORY_ALLOCATOR_NED

#define OGRE_MEMORY_ALLOCATOR_NED 2

## ◆ OGRE_MEMORY_ALLOCATOR_NEDPOOLING

#define OGRE_MEMORY_ALLOCATOR_NEDPOOLING 4

## ◆ OGRE_MEMORY_ALLOCATOR_STD

#define OGRE_MEMORY_ALLOCATOR_STD 1

## ◆ OGRE_MEMORY_ALLOCATOR_TRACK

#define OGRE_MEMORY_ALLOCATOR_TRACK 5

## ◆ OGRE_MEMORY_ALLOCATOR_USER

#define OGRE_MEMORY_ALLOCATOR_USER 3

## ◆ OGRE_MEMORY_TRACKER_DEBUG_MODE

#define OGRE_MEMORY_TRACKER_DEBUG_MODE 0

## ◆ OGRE_MEMORY_TRACKER_RELEASE_MODE

#define OGRE_MEMORY_TRACKER_RELEASE_MODE 0

## ◆ OGRE_NO_DDS_CODEC

#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.

## ◆ OGRE_NO_ETC_CODEC

#define OGRE_NO_ETC_CODEC 1

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

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

## ◆ OGRE_NO_FREEIMAGE

#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.

## ◆ OGRE_NO_STBI_CODEC

#define OGRE_NO_STBI_CODEC 1

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

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

## ◆ OGRE_NO_ZIP_ARCHIVE

#define OGRE_NO_ZIP_ARCHIVE 0

Disables use of the ZIP archive support.

WARNING: Disabling this will make the samples unusable.

## ◆ OGRE_PRETEND_TEXTURE_UNITS

#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.

## ◆ OGRE_PROFILING

#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

## ◆ OGRE_PROFILING_INTERNAL

#define OGRE_PROFILING_INTERNAL 1

## ◆ OGRE_PROFILING_INTERNAL_OFFLINE

#define OGRE_PROFILING_INTERNAL_OFFLINE 3

## ◆ OGRE_PROFILING_NONE

#define OGRE_PROFILING_NONE 0

## ◆ OGRE_PROFILING_REMOTERY

#define OGRE_PROFILING_REMOTERY 2

## ◆ OGRE_STRING_USE_CUSTOM_MEMORY_ALLOCATOR

#define OGRE_STRING_USE_CUSTOM_MEMORY_ALLOCATOR 0

## ◆ OGRE_THREAD_PROVIDER

#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. OGRE_THREAD_PROVIDER = 4 Standard library provides threading functionality. (requires compiler support)

## ◆ OGRE_THREAD_SUPPORT

#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.