# General
[Core]

Collaboration diagram for General:

## Classes

class | Ogre::Any
| Variant type that can hold Any other type. More...
class | Ogre::AnyNumeric
| Specialised Any class which has built in arithmetic operators, but can hold only types which support operator +,-,* and / . More...
class | Ogre::AtomicObject< T >
class | Ogre::AtomicScalar< T >
class | Ogre::Codec
| Abstract class that defines a 'codec'. More...
class | Ogre::ColourValue
| Class representing colour. More...
class | Ogre::HashedVector< T >
| A hashed vector. More...
struct | Ogre::TRect< T >
struct | Ogre::Box
| Structure used to define a box in a 3-D integer space. More...
struct | Ogre::RenderWindowDescription
| Render window creation parameters. More...
class | Ogre::NameGenerator
| Utility class to generate a sequentially numbered series of names. More...
class | Ogre::Pool< T >
| Template class describing a simple pool of items. More...
class | Ogre::ConfigFile
| Class for quickly loading settings from a text file. More...
struct | Ogre::_ConfigOption
| Packages the details of a configuration option. More...
class | Ogre::ControllerFunction< T >
| Subclasses of this class are responsible for performing a function on an input value for a Controller. More...
class | Ogre::ControllerValue< T >
| Can either be used as an input or output value. More...
class | Ogre::Controller< T >
| Instances of this class 'control' the value of another object in the system. More...
class | Ogre::ControllerManager
| Class for managing Controller instances. More...
class | Ogre::DynLib
| Resource holding data about a dynamic library. More...
class | Ogre::DynLibManager
| Manager for Dynamic-loading Libraries. More...
class | Ogre::Exception
| When thrown, provides information about an error that has occurred inside the engine. More...
struct | Ogre::ExceptionCodeType< num >
| Template struct which creates a distinct type for each exception code. More...
class | Ogre::UnimplementedException
class | Ogre::FileNotFoundException
class | Ogre::IOException
class | Ogre::InvalidStateException
class | Ogre::InvalidParametersException
class | Ogre::ItemIdentityException
class | Ogre::InternalErrorException
class | Ogre::RenderingAPIException
class | Ogre::RuntimeAssertionException
class | Ogre::ExceptionFactory
| Class implementing dispatch methods in order to construct by-value exceptions of a derived type based just on an exception code. More...
class | Ogre::FactoryObj< T >
| Abstract factory class. More...
struct | Ogre::FrameEvent
| Struct containing information about a frame event. More...
class | Ogre::FrameListener
| A interface class defining a listener which can be used to receive notifications of frame events. More...
class | Ogre::LogListener
class | Ogre::Log
class | Ogre::LogManager
| The log manager handles the creation and retrieval of logs for the application. More...
class | Ogre::PlatformInformation
| Class which provides the run-time platform information Ogre runs on. More...
class | Ogre::Plugin
| Class defining a generic OGRE plugin. More...
class | Ogre::FrameTimeControllerValue
| Predefined controller value for getting the latest frame time. More...
class | Ogre::TextureFrameControllerValue
| Predefined controller value for getting / setting the frame number of a texture layer. More...
class | Ogre::TexCoordModifierControllerValue
| Predefined controller value for getting / setting a texture coordinate modifications (scales and translates). More...
class | Ogre::FloatGpuParameterControllerValue
| Predefined controller value for setting a single floating- point value in a constant parameter of a vertex or fragment program. More...
class | Ogre::PassthroughControllerFunction
| Predefined controller function which just passes through the original source directly to dest. More...
class | Ogre::AnimationControllerFunction
| Predefined controller function for dealing with animation. More...
class | Ogre::ScaleControllerFunction
| Predefined controller function which simply scales an input to an output value. More...
class | Ogre::WaveformControllerFunction
| Predefined controller function based on a waveform. More...
class | Ogre::Profile
| An individual profile that will be processed by the Profiler. More...
class | Ogre::Profiler
| The profiler allows you to measure the performance of your code. More...
class | Ogre::RadixSort< TContainer, TContainerValueType, TCompValueType >
| Class for performing a radix sort (fast comparison-less sort based on byte value) on various standard STL containers. More...
struct | Ogre::Rectangle
class | Ogre::Root
| The root class of the Ogre system. More...
struct | Ogre::ConcreteNode
class | Ogre::AbstractNode
class | Ogre::AtomAbstractNode
| This is an abstract node which cannot be broken down further. More...
class | Ogre::ObjectAbstractNode
| This specific abstract node represents a script object. More...
class | Ogre::PropertyAbstractNode
| This abstract node represents a script property. More...
class | Ogre::ImportAbstractNode
| This abstract node represents an import statement. More...
class | Ogre::VariableAccessAbstractNode
| This abstract node represents a variable assignment. More...
class | Ogre::ScriptCompiler
| This is the main class for the compiler. More...
class | Ogre::ScriptCompilerEvent
| This struct is a base class for events which can be thrown by the compilers and caught by subscribers. More...
class | Ogre::ScriptCompilerListener
| This is a listener for the compiler. More...
class | Ogre::ScriptCompilerManager
| Manages threaded compilation of scripts. More...
class | Ogre::PreApplyTextureAliasesScriptCompilerEvent
class | Ogre::ProcessResourceNameScriptCompilerEvent
class | Ogre::ProcessNameExclusionScriptCompilerEvent
class | Ogre::CreateMaterialScriptCompilerEvent
class | Ogre::CreateGpuProgramScriptCompilerEvent
class | Ogre::CreateHighLevelGpuProgramScriptCompilerEvent
class | Ogre::CreateGpuSharedParametersScriptCompilerEvent
class | Ogre::CreateParticleSystemScriptCompilerEvent
class | Ogre::CreateCompositorScriptCompilerEvent
struct | Ogre::ScriptToken
| This struct represents a token, which is an ID'd lexeme from the parsing input stream. More...
class | Ogre::ScriptLexer
class | Ogre::ScriptLoader
| Abstract class defining the interface used by classes which wish to perform script loading to define instances of whatever they manage. More...
class | Ogre::ScriptParser
class | Ogre::ScriptTranslator
| This class translates script AST (abstract syntax tree) into Ogre resources. More...
class | Ogre::ScriptTranslatorManager
| The ScriptTranslatorManager manages the lifetime and access to script translators. More...
class | Ogre::MaterialTranslator
class | Ogre::TechniqueTranslator
class | Ogre::PassTranslator
class | Ogre::TextureUnitTranslator
class | Ogre::TextureSourceTranslator
class | Ogre::GpuProgramTranslator
class | Ogre::SharedParamsTranslator
class | Ogre::ParticleSystemTranslator
class | Ogre::ParticleEmitterTranslator
class | Ogre::ParticleAffectorTranslator
class | Ogre::CompositorTranslator
class | Ogre::CompositionTechniqueTranslator
class | Ogre::CompositionTargetPassTranslator
class | Ogre::CompositionPassTranslator
class | Ogre::CompositionPassClearTranslator
class | Ogre::CompositionPassStencilTranslator
class | Ogre::BuiltinScriptTranslatorManager
| This class manages the builtin translators. More...
class | Ogre::Serializer
| Generic class for serialising data to / from binary stream-based files. More...
class | Ogre::SharedPtr< T >
| Reference-counted shared pointer, used for objects where implicit destruction is required. More...
class | Ogre::Singleton< T >
| Template class for creating single-instance global classes. More...
class | Ogre::StringUtil
| Utility class for manipulating Strings. More...
class | Ogre::StringConverter
| Class for converting the core Ogre data types to/from Strings. More...
class | Ogre::ParameterDef
| Definition of a parameter supported by a StringInterface class, for introspection. More...
class | Ogre::ParamCommand
| Abstract class which is command object which gets/sets parameters. More...
class | Ogre::ParamDictionary
| Class to hold a dictionary of parameters for a single class. More...
class | Ogre::StringInterface
| Class defining the common interface which classes can use to present a reflection-style, self-defining parameter set to callers. More...
class | Ogre::WorkQueue
| Interface to a general purpose request / response style background work queue. More...
class | Ogre::DefaultWorkQueueBase
| Base for a general purpose request / response style background work queue. More...
class | Ogre::ConfigDialog
| Defines the behaviour of an automatic renderer configuration dialog. More...
class | Ogre::ErrorDialog
| Class for displaying the error dialog if Ogre fails badly. More...
class | Ogre::Timer
| Timer class. More...

## Defines

#define | OGRE_EXCEPT(num, desc, src)
#define | OGRE_LOG_THRESHOLD 4

## Typedefs

typedef uint32 | Ogre::RGBA
typedef uint32 | Ogre::ARGB
typedef uint32 | Ogre::ABGR
typedef uint32 | Ogre::BGRA
typedef int | Ogre::TrackVertexColourType
| An enumeration describing which material properties should track the vertex colours.
typedef HashedVector< Light * > | Ogre::LightList
typedef map< String, bool >::type | Ogre::UnaryOptionList
typedef map< String, String >::type | Ogre::BinaryOptionList
typedef map< String, String >::type | Ogre::NameValuePairList
| Name / value parameter pair (first = name, second = value).
typedef map< String, String >::type | Ogre::AliasTextureNamePairList
| Alias / Texture name pair (first = alias, second = texture name).
typedef TRect< float > | Ogre::FloatRect
| Structure used to define a rectangle in a 2-D floating point space.
typedef TRect< Real > | Ogre::RealRect
| Structure used to define a rectangle in a 2-D floating point space, subject to double / single floating point settings.
typedef TRect< long > | Ogre::Rect
| Structure used to define a rectangle in a 2-D integer space.
typedef vector < RenderWindowDescription > ::type | Ogre::RenderWindowDescriptionList
| Render window creation parameters container.
typedef vector< RenderWindow * > ::type | Ogre::RenderWindowList
| Render window container.
typedef struct Ogre::_ConfigOption | Ogre::ConfigOption
| Packages the details of a configuration option.
typedef map< String, ConfigOption >::type | Ogre::ConfigOptionMap
typedef SharedPtr < ControllerValue< Real > > | Ogre::ControllerValueRealPtr
typedef SharedPtr < ControllerFunction< Real > > | Ogre::ControllerFunctionRealPtr
typedef vector< RenderSystem * > ::type | Ogre::RenderSystemList
typedef SharedPtr< ConcreteNode > | Ogre::ConcreteNodePtr
typedef list< ConcreteNodePtr > ::type | Ogre::ConcreteNodeList
typedef SharedPtr < ConcreteNodeList > | Ogre::ConcreteNodeListPtr
typedef SharedPtr< AbstractNode > | Ogre::AbstractNodePtr
typedef list< AbstractNodePtr > ::type | Ogre::AbstractNodeList
typedef SharedPtr < AbstractNodeList > | Ogre::AbstractNodeListPtr
typedef SharedPtr< ScriptToken > | Ogre::ScriptTokenPtr
typedef vector< ScriptTokenPtr > ::type | Ogre::ScriptTokenList
typedef SharedPtr < ScriptTokenList > | Ogre::ScriptTokenListPtr
typedef stdext::hash_compare < _StringBase, std::less < _StringBase > > | Ogre::_StringHash
typedef vector< ParameterDef > ::type | Ogre::ParameterList
typedef map< String, ParamCommand * >::type | Ogre::ParamCommandMap
typedef map< String, ParamDictionary >::type | Ogre::ParamDictionaryMap
typedef vector< String >::type | Ogre::StringVector
typedef SharedPtr< StringVector > | Ogre::StringVectorPtr

## Enumerations

enum | Ogre::CompareFunction { Ogre::CMPF_ALWAYS_FAIL, Ogre::CMPF_ALWAYS_PASS, Ogre::CMPF_LESS, Ogre::CMPF_LESS_EQUAL, Ogre::CMPF_EQUAL, Ogre::CMPF_NOT_EQUAL, Ogre::CMPF_GREATER_EQUAL, Ogre::CMPF_GREATER }
| Comparison functions used for the depth/stencil buffer operations and others. More...
enum | Ogre::TextureFilterOptions { Ogre::TFO_NONE, Ogre::TFO_BILINEAR, Ogre::TFO_TRILINEAR, Ogre::TFO_ANISOTROPIC }
| High-level filtering options providing shortcuts to settings the minification, magnification and mip filters. More...
enum | Ogre::FilterType { Ogre::FT_MIN, Ogre::FT_MAG, Ogre::FT_MIP }
enum | Ogre::FilterOptions { Ogre::FO_NONE, Ogre::FO_POINT, Ogre::FO_LINEAR, Ogre::FO_ANISOTROPIC }
| Filtering options for textures / mipmaps. More...
enum | Ogre::ShadeOptions { Ogre::SO_FLAT, Ogre::SO_GOURAUD, Ogre::SO_PHONG }
| Light shading modes. More...
enum | Ogre::FogMode { Ogre::FOG_NONE, Ogre::FOG_EXP, Ogre::FOG_EXP2, Ogre::FOG_LINEAR }
| Fog modes. More...
enum | Ogre::CullingMode { Ogre::CULL_NONE = 1, Ogre::CULL_CLOCKWISE = 2, Ogre::CULL_ANTICLOCKWISE = 3 }
| Hardware culling modes based on vertex winding. More...
enum | Ogre::ManualCullingMode { Ogre::MANUAL_CULL_NONE = 1, Ogre::MANUAL_CULL_BACK = 2, Ogre::MANUAL_CULL_FRONT = 3 }
| Manual culling modes based on vertex normals. More...
enum | Ogre::WaveformType { Ogre::WFT_SINE, Ogre::WFT_TRIANGLE, Ogre::WFT_SQUARE, Ogre::WFT_SAWTOOTH, Ogre::WFT_INVERSE_SAWTOOTH, Ogre::WFT_PWM }
| Enumerates the wave types usable with the Ogre engine. More...
enum | Ogre::PolygonMode { Ogre::PM_POINTS = 1, Ogre::PM_WIREFRAME = 2, Ogre::PM_SOLID = 3 }
| The polygon mode to use when rasterising. More...

enum

Ogre::ShadowTechnique {
Ogre::SHADOWTYPE_NONE = 0x00, Ogre::SHADOWDETAILTYPE_ADDITIVE = 0x01, Ogre::SHADOWDETAILTYPE_MODULATIVE = 0x02, Ogre::SHADOWDETAILTYPE_INTEGRATED = 0x04,
Ogre::SHADOWDETAILTYPE_STENCIL = 0x10, Ogre::SHADOWDETAILTYPE_TEXTURE = 0x20, Ogre::SHADOWTYPE_STENCIL_MODULATIVE = 0x12, Ogre::SHADOWTYPE_STENCIL_ADDITIVE = 0x11,
Ogre::SHADOWTYPE_TEXTURE_MODULATIVE = 0x22, Ogre::SHADOWTYPE_TEXTURE_ADDITIVE = 0x21, Ogre::SHADOWTYPE_TEXTURE_ADDITIVE_INTEGRATED = 0x25, Ogre::SHADOWTYPE_TEXTURE_MODULATIVE_INTEGRATED = 0x26
}

| An enumeration of broad shadow techniques. More...
enum | Ogre::TrackVertexColourEnum { Ogre::TVC_NONE = 0x0, Ogre::TVC_AMBIENT = 0x1, Ogre::TVC_DIFFUSE = 0x2, Ogre::TVC_SPECULAR = 0x4, Ogre::TVC_EMISSIVE = 0x8 }
enum | Ogre::SortMode { Ogre::SM_DIRECTION, Ogre::SM_DISTANCE }
| Sort mode for billboard-set and particle-system. More...
enum | Ogre::FrameBufferType { Ogre::FBT_COLOUR = 0x1, Ogre::FBT_DEPTH = 0x2, Ogre::FBT_STENCIL = 0x4 }
| Defines the frame buffer types. More...
enum | Ogre::ClipResult { Ogre::CLIPPED_NONE = 0, Ogre::CLIPPED_SOME = 1, Ogre::CLIPPED_ALL = 2 }
| Generic result of clipping. More...
enum | Ogre::LoggingLevel { Ogre::LL_LOW = 1, Ogre::LL_NORMAL = 2, Ogre::LL_BOREME = 3 }
| The level of detail to which the log will go into. More...
enum | Ogre::LogMessageLevel { Ogre::LML_TRIVIAL = 1, Ogre::LML_NORMAL = 2, Ogre::LML_CRITICAL = 3 }
| The importance of a logged message. More...
enum | Ogre::ProfileGroupMask { Ogre::OGREPROF_USER_DEFAULT = 0x00000001, Ogre::OGREPROF_ALL = 0xFF000000, Ogre::OGREPROF_GENERAL = 0x80000000, Ogre::OGREPROF_CULLING = 0x40000000, Ogre::OGREPROF_RENDERING = 0x20000000 }
| List of reserved profiling masks. More...
enum | Ogre::ConcreteNodeType { Ogre::CNT_VARIABLE, Ogre::CNT_VARIABLE_ASSIGN, Ogre::CNT_WORD, Ogre::CNT_IMPORT, Ogre::CNT_QUOTE, Ogre::CNT_LBRACE, Ogre::CNT_RBRACE, Ogre::CNT_COLON }
| These enums hold the types of the concrete parsed nodes. More...
enum | Ogre::AbstractNodeType { Ogre::ANT_UNKNOWN, Ogre::ANT_ATOM, Ogre::ANT_OBJECT, Ogre::ANT_PROPERTY, Ogre::ANT_IMPORT, Ogre::ANT_VARIABLE_SET, Ogre::ANT_VARIABLE_ACCESS }
| This enum holds the types of the possible abstract nodes. More...

enum

{
Ogre::ID_MATERIAL = 3, Ogre::ID_VERTEX_PROGRAM, Ogre::ID_GEOMETRY_PROGRAM, Ogre::ID_FRAGMENT_PROGRAM,
Ogre::ID_TECHNIQUE, Ogre::ID_PASS, Ogre::ID_TEXTURE_UNIT, Ogre::ID_VERTEX_PROGRAM_REF,
Ogre::ID_GEOMETRY_PROGRAM_REF, Ogre::ID_FRAGMENT_PROGRAM_REF, Ogre::ID_SHADOW_CASTER_VERTEX_PROGRAM_REF, Ogre::ID_SHADOW_RECEIVER_VERTEX_PROGRAM_REF,
Ogre::ID_SHADOW_RECEIVER_FRAGMENT_PROGRAM_REF, Ogre::ID_SHADOW_CASTER_MATERIAL, Ogre::ID_SHADOW_RECEIVER_MATERIAL, Ogre::ID_LOD_VALUES,
Ogre::ID_LOD_STRATEGY, Ogre::ID_LOD_DISTANCES, Ogre::ID_RECEIVE_SHADOWS, Ogre::ID_TRANSPARENCY_CASTS_SHADOWS,
Ogre::ID_SET_TEXTURE_ALIAS, Ogre::ID_SOURCE, Ogre::ID_SYNTAX, Ogre::ID_DEFAULT_PARAMS,
Ogre::ID_PARAM_INDEXED, Ogre::ID_PARAM_NAMED, Ogre::ID_PARAM_INDEXED_AUTO, Ogre::ID_PARAM_NAMED_AUTO,
Ogre::ID_SCHEME, Ogre::ID_LOD_INDEX, Ogre::ID_GPU_VENDOR_RULE, Ogre::ID_GPU_DEVICE_RULE,
Ogre::ID_INCLUDE, Ogre::ID_EXCLUDE, Ogre::ID_AMBIENT, Ogre::ID_DIFFUSE,
Ogre::ID_SPECULAR, Ogre::ID_EMISSIVE, Ogre::ID_VERTEXCOLOUR, Ogre::ID_SCENE_BLEND,
Ogre::ID_COLOUR_BLEND, Ogre::ID_ONE, Ogre::ID_ZERO, Ogre::ID_DEST_COLOUR,
Ogre::ID_SRC_COLOUR, Ogre::ID_ONE_MINUS_DEST_COLOUR, Ogre::ID_ONE_MINUS_SRC_COLOUR, Ogre::ID_DEST_ALPHA,
Ogre::ID_SRC_ALPHA, Ogre::ID_ONE_MINUS_DEST_ALPHA, Ogre::ID_ONE_MINUS_SRC_ALPHA, Ogre::ID_SEPARATE_SCENE_BLEND,
Ogre::ID_SCENE_BLEND_OP, Ogre::ID_REVERSE_SUBTRACT, Ogre::ID_MIN, Ogre::ID_MAX,
Ogre::ID_SEPARATE_SCENE_BLEND_OP, Ogre::ID_DEPTH_CHECK, Ogre::ID_DEPTH_WRITE, Ogre::ID_DEPTH_FUNC,
Ogre::ID_DEPTH_BIAS, Ogre::ID_ITERATION_DEPTH_BIAS, Ogre::ID_ALWAYS_FAIL, Ogre::ID_ALWAYS_PASS,
Ogre::ID_LESS_EQUAL, Ogre::ID_LESS, Ogre::ID_EQUAL, Ogre::ID_NOT_EQUAL,
Ogre::ID_GREATER_EQUAL, Ogre::ID_GREATER, Ogre::ID_ALPHA_REJECTION, Ogre::ID_ALPHA_TO_COVERAGE,
Ogre::ID_LIGHT_SCISSOR, Ogre::ID_LIGHT_CLIP_PLANES, Ogre::ID_TRANSPARENT_SORTING, Ogre::ID_ILLUMINATION_STAGE,
Ogre::ID_DECAL, Ogre::ID_CULL_HARDWARE, Ogre::ID_CLOCKWISE, Ogre::ID_ANTICLOCKWISE,
Ogre::ID_CULL_SOFTWARE, Ogre::ID_BACK, Ogre::ID_FRONT, Ogre::ID_NORMALISE_NORMALS,
Ogre::ID_LIGHTING, Ogre::ID_SHADING, Ogre::ID_FLAT, Ogre::ID_GOURAUD,
Ogre::ID_PHONG, Ogre::ID_POLYGON_MODE, Ogre::ID_SOLID, Ogre::ID_WIREFRAME,
Ogre::ID_POINTS, Ogre::ID_POLYGON_MODE_OVERRIDEABLE, Ogre::ID_FOG_OVERRIDE, Ogre::ID_NONE,
Ogre::ID_LINEAR, Ogre::ID_EXP, Ogre::ID_EXP2, Ogre::ID_COLOUR_WRITE,
Ogre::ID_MAX_LIGHTS, Ogre::ID_START_LIGHT, Ogre::ID_ITERATION, Ogre::ID_ONCE,
Ogre::ID_ONCE_PER_LIGHT, Ogre::ID_PER_LIGHT, Ogre::ID_PER_N_LIGHTS, Ogre::ID_POINT,
Ogre::ID_SPOT, Ogre::ID_DIRECTIONAL, Ogre::ID_POINT_SIZE, Ogre::ID_POINT_SPRITES,
Ogre::ID_POINT_SIZE_ATTENUATION, Ogre::ID_POINT_SIZE_MIN, Ogre::ID_POINT_SIZE_MAX, Ogre::ID_TEXTURE_ALIAS,
Ogre::ID_TEXTURE, Ogre::ID_1D, Ogre::ID_2D, Ogre::ID_3D,
Ogre::ID_CUBIC, Ogre::ID_UNLIMITED, Ogre::ID_ALPHA, Ogre::ID_GAMMA,
Ogre::ID_ANIM_TEXTURE, Ogre::ID_CUBIC_TEXTURE, Ogre::ID_SEPARATE_UV, Ogre::ID_COMBINED_UVW,
Ogre::ID_TEX_COORD_SET, Ogre::ID_TEX_ADDRESS_MODE, Ogre::ID_WRAP, Ogre::ID_CLAMP,
Ogre::ID_BORDER, Ogre::ID_MIRROR, Ogre::ID_TEX_BORDER_COLOUR, Ogre::ID_FILTERING,
Ogre::ID_BILINEAR, Ogre::ID_TRILINEAR, Ogre::ID_ANISOTROPIC, Ogre::ID_MAX_ANISOTROPY,
Ogre::ID_MIPMAP_BIAS, Ogre::ID_COLOUR_OP, Ogre::ID_REPLACE, Ogre::ID_ADD,
Ogre::ID_MODULATE, Ogre::ID_ALPHA_BLEND, Ogre::ID_COLOUR_OP_EX, Ogre::ID_SOURCE1,
Ogre::ID_SOURCE2, Ogre::ID_MODULATE_X2, Ogre::ID_MODULATE_X4, Ogre::ID_ADD_SIGNED,
Ogre::ID_ADD_SMOOTH, Ogre::ID_SUBTRACT, Ogre::ID_BLEND_DIFFUSE_COLOUR, Ogre::ID_BLEND_DIFFUSE_ALPHA,
Ogre::ID_BLEND_TEXTURE_ALPHA, Ogre::ID_BLEND_CURRENT_ALPHA, Ogre::ID_BLEND_MANUAL, Ogre::ID_DOT_PRODUCT,
Ogre::ID_SRC_CURRENT, Ogre::ID_SRC_TEXTURE, Ogre::ID_SRC_DIFFUSE, Ogre::ID_SRC_SPECULAR,
Ogre::ID_SRC_MANUAL, Ogre::ID_COLOUR_OP_MULTIPASS_FALLBACK, Ogre::ID_ALPHA_OP_EX, Ogre::ID_ENV_MAP,
Ogre::ID_SPHERICAL, Ogre::ID_PLANAR, Ogre::ID_CUBIC_REFLECTION, Ogre::ID_CUBIC_NORMAL,
Ogre::ID_SCROLL, Ogre::ID_SCROLL_ANIM, Ogre::ID_ROTATE, Ogre::ID_ROTATE_ANIM,
Ogre::ID_SCALE, Ogre::ID_WAVE_XFORM, Ogre::ID_SCROLL_X, Ogre::ID_SCROLL_Y,
Ogre::ID_SCALE_X, Ogre::ID_SCALE_Y, Ogre::ID_SINE, Ogre::ID_TRIANGLE,
Ogre::ID_SQUARE, Ogre::ID_SAWTOOTH, Ogre::ID_INVERSE_SAWTOOTH, Ogre::ID_TRANSFORM,
Ogre::ID_BINDING_TYPE, Ogre::ID_VERTEX, Ogre::ID_FRAGMENT, Ogre::ID_CONTENT_TYPE,
Ogre::ID_NAMED, Ogre::ID_SHADOW, Ogre::ID_TEXTURE_SOURCE, Ogre::ID_SHARED_PARAMS,
Ogre::ID_SHARED_PARAM_NAMED, Ogre::ID_SHARED_PARAMS_REF, Ogre::ID_PARTICLE_SYSTEM, Ogre::ID_EMITTER,
Ogre::ID_AFFECTOR, Ogre::ID_COMPOSITOR, Ogre::ID_TARGET, Ogre::ID_TARGET_OUTPUT,
Ogre::ID_INPUT, Ogre::ID_PREVIOUS, Ogre::ID_TARGET_WIDTH, Ogre::ID_TARGET_HEIGHT,
Ogre::ID_TARGET_WIDTH_SCALED, Ogre::ID_TARGET_HEIGHT_SCALED, Ogre::ID_COMPOSITOR_LOGIC, Ogre::ID_TEXTURE_REF,
Ogre::ID_SCOPE_LOCAL, Ogre::ID_SCOPE_CHAIN, Ogre::ID_SCOPE_GLOBAL, Ogre::ID_POOLED,
Ogre::ID_NO_FSAA, Ogre::ID_ONLY_INITIAL, Ogre::ID_VISIBILITY_MASK, Ogre::ID_LOD_BIAS,
Ogre::ID_MATERIAL_SCHEME, Ogre::ID_SHADOWS_ENABLED, Ogre::ID_CLEAR, Ogre::ID_STENCIL,
Ogre::ID_RENDER_SCENE, Ogre::ID_RENDER_QUAD, Ogre::ID_IDENTIFIER, Ogre::ID_FIRST_RENDER_QUEUE,
Ogre::ID_LAST_RENDER_QUEUE, Ogre::ID_QUAD_NORMALS, Ogre::ID_CAMERA_FAR_CORNERS_VIEW_SPACE, Ogre::ID_CAMERA_FAR_CORNERS_WORLD_SPACE,
Ogre::ID_BUFFERS, Ogre::ID_COLOUR, Ogre::ID_DEPTH, Ogre::ID_COLOUR_VALUE,
Ogre::ID_DEPTH_VALUE, Ogre::ID_STENCIL_VALUE, Ogre::ID_CHECK, Ogre::ID_COMP_FUNC,
Ogre::ID_REF_VALUE, Ogre::ID_MASK, Ogre::ID_FAIL_OP, Ogre::ID_KEEP,
Ogre::ID_INCREMENT, Ogre::ID_DECREMENT, Ogre::ID_INCREMENT_WRAP, Ogre::ID_DECREMENT_WRAP,
Ogre::ID_INVERT, Ogre::ID_DEPTH_FAIL_OP, Ogre::ID_PASS_OP, Ogre::ID_TWO_SIDED,
Ogre::ID_END_BUILTIN_IDS
}

| This enum defines the integer ids for keywords this compiler handles. More...
enum | { Ogre::TID_LBRACKET = 0, Ogre::TID_RBRACKET, Ogre::TID_COLON, Ogre::TID_VARIABLE, Ogre::TID_WORD, Ogre::TID_QUOTE, Ogre::TID_NEWLINE, Ogre::TID_UNKNOWN, Ogre::TID_END }
| These codes represent token IDs which are numerical translations of specific lexemes. More...
enum | Ogre::SharedPtrFreeMethod { Ogre::SPFM_DELETE, Ogre::SPFM_DELETE_T, Ogre::SPFM_FREE }
| The method to use to free memory on destruction. More...
enum | Ogre::ParameterType { Ogre::PT_BOOL, Ogre::PT_REAL, Ogre::PT_INT, Ogre::PT_UNSIGNED_INT, Ogre::PT_SHORT, Ogre::PT_UNSIGNED_SHORT, Ogre::PT_LONG, Ogre::PT_UNSIGNED_LONG, Ogre::PT_STRING, Ogre::PT_VECTOR3, Ogre::PT_MATRIX3, Ogre::PT_MATRIX4, Ogre::PT_QUATERNION, Ogre::PT_COLOURVALUE }
| List of parameter types available. More...

## Functions

template<typename ValueType >
ValueType * | Ogre::any_cast (Any *operand)
template<typename ValueType >
const ValueType * | Ogre::any_cast (const Any *operand)
template<typename ValueType >
ValueType | Ogre::any_cast (const Any &operand)
uint32 _OgreExport | Ogre::FastHash (const char *data, int len, uint32 hashSoFar=0)
| Fast general hashing algorithm.
template<typename T >
uint32 | Ogre::HashCombine (uint32 hashSoFar, const T &data)
| Combine hashes with same style as boost::hash_combine.
template<typename T >
std::ostream & | Ogre::operator<< (std::ostream &o, const TRect< T > &r)
int _OgreExport | Ogre::findCommandLineOpts (int numargs, char **argv, UnaryOptionList &unaryOptList, BinaryOptionList &binOptList)
| Locate command-line options of the unary form '-blah' and of the binary form '-blah foo', passing back the index of the next non-option.
Rectangle | Ogre::intersect (const Rectangle &lhs, const Rectangle &rhs)
| Geometric intersection of two rectanglar regions.
template<class T , class U >
bool | Ogre::operator== (SharedPtr< T > const &a, SharedPtr< U > const &b)
template<class T , class U >
bool | Ogre::operator!= (SharedPtr< T > const &a, SharedPtr< U > const &b)
template<class T , class U >
bool | Ogre::operator< (SharedPtr< T > const &a, SharedPtr< U > const &b)

## Define Documentation

#define OGRE_EXCEPT | ( |  | num,
|  |  | desc,
|  |  | src |
| ) |  |  |

Value:

    throw Ogre::ExceptionFactory::create( \
        Ogre::ExceptionCodeType<num>(), desc, src, __FILE__, __LINE__ );

Definition at line 342 of file OgreException.h.

Referenced by Ogre::AnimableObject::_getAnimableValueNames(), Ogre::any_cast(), Ogre::AnimableValue::applyDeltaValue(), Ogre::Archive::create(), Ogre::AnimableObject::createAnimableValue(), Ogre::AnimableObject::getAnimableValueNames(), Ogre::Renderable::getCustomParameter(), Ogre::PropertySet::getPropertyImpl(), Ogre::Any::operator()(), Ogre::Codec::registerCodec(), Ogre::Archive::remove(), Ogre::PropertySet::setPropertyImpl(), and Ogre::AnimableValue::setValue().

#define OGRE_LOG_THRESHOLD 4

Definition at line 44 of file OgreLog.h.

## Typedef Documentation

typedef stdext::hash_compare< _StringBase, std::less< _StringBase > > Ogre::_StringHash

Definition at line 193 of file OgreString.h.

typedef uint32 Ogre::ABGR

Definition at line 43 of file OgreColourValue.h.

typedef list<AbstractNodePtr>::type Ogre::AbstractNodeList

Definition at line 87 of file OgreScriptCompiler.h.

typedef SharedPtr<AbstractNodeList> Ogre::AbstractNodeListPtr

Definition at line 88 of file OgreScriptCompiler.h.

typedef SharedPtr<AbstractNode> Ogre::AbstractNodePtr

Definition at line 85 of file OgreScriptCompiler.h.

typedef map<String, String>::type Ogre::AliasTextureNamePairList

Alias / Texture name pair (first = alias, second = texture name).

Definition at line 527 of file OgreCommon.h.

typedef uint32 Ogre::ARGB

Definition at line 42 of file OgreColourValue.h.

typedef uint32 Ogre::BGRA

Definition at line 44 of file OgreColourValue.h.

typedef map<String, String>::type Ogre::BinaryOptionList

Definition at line 521 of file OgreCommon.h.

typedef list<ConcreteNodePtr>::type Ogre::ConcreteNodeList

Definition at line 63 of file OgreScriptCompiler.h.

typedef SharedPtr<ConcreteNodeList> Ogre::ConcreteNodeListPtr

Definition at line 64 of file OgreScriptCompiler.h.

typedef SharedPtr<ConcreteNode> Ogre::ConcreteNodePtr

Definition at line 61 of file OgreScriptCompiler.h.

typedef struct Ogre::_ConfigOption Ogre::ConfigOption

Packages the details of a configuration option.

Remarks:
  Used for RenderSystem::getConfigOptions. If immutable is true, this option must be disabled for modifying.

typedef map< String, ConfigOption >::type Ogre::ConfigOptionMap

Definition at line 58 of file OgreConfigOptionMap.h.

typedef SharedPtr< ControllerFunction<Real> > Ogre::ControllerFunctionRealPtr

Definition at line 49 of file OgreControllerManager.h.

typedef SharedPtr< ControllerValue<Real> > Ogre::ControllerValueRealPtr

Definition at line 48 of file OgreControllerManager.h.

typedef TRect<float> Ogre::FloatRect

Structure used to define a rectangle in a 2-D floating point space.

Definition at line 618 of file OgreCommon.h.

typedef HashedVector<Light*> Ogre::LightList

Definition at line 515 of file OgreCommon.h.

typedef map<String, String>::type Ogre::NameValuePairList

Name / value parameter pair (first = name, second = value).

Definition at line 524 of file OgreCommon.h.

typedef map<String, ParamCommand* >::type Ogre::ParamCommandMap

Definition at line 85 of file OgreStringInterface.h.

typedef map<String, ParamDictionary>::type Ogre::ParamDictionaryMap

Definition at line 150 of file OgreStringInterface.h.

typedef vector<ParameterDef>::type Ogre::ParameterList

Definition at line 74 of file OgreStringInterface.h.

typedef TRect<Real> Ogre::RealRect

Structure used to define a rectangle in a 2-D floating point space, subject to double / single floating point settings.

Definition at line 623 of file OgreCommon.h.

typedef TRect< long > Ogre::Rect

Structure used to define a rectangle in a 2-D integer space.

Definition at line 627 of file OgreCommon.h.

typedef vector<RenderSystem*>::type Ogre::RenderSystemList

Definition at line 52 of file OgreRoot.h.

typedef vector<RenderWindowDescription>::type Ogre::RenderWindowDescriptionList

Render window creation parameters container.

Definition at line 735 of file OgreCommon.h.

typedef vector<RenderWindow*>::type Ogre::RenderWindowList

Render window container.

Definition at line 738 of file OgreCommon.h.

typedef uint32 Ogre::RGBA

Definition at line 41 of file OgreColourValue.h.

typedef vector<ScriptTokenPtr>::type Ogre::ScriptTokenList

Definition at line 75 of file OgreScriptLexer.h.

typedef SharedPtr<ScriptTokenList> Ogre::ScriptTokenListPtr

Definition at line 76 of file OgreScriptLexer.h.

typedef SharedPtr<ScriptToken> Ogre::ScriptTokenPtr

Definition at line 74 of file OgreScriptLexer.h.

typedef vector<String>::type Ogre::StringVector

Definition at line 45 of file OgreStringVector.h.

typedef SharedPtr<StringVector> Ogre::StringVectorPtr

Definition at line 46 of file OgreStringVector.h.

typedef int Ogre::TrackVertexColourType

An enumeration describing which material properties should track the vertex colours.

Definition at line 277 of file OgreCommon.h.

typedef map<String, bool>::type Ogre::UnaryOptionList

Definition at line 520 of file OgreCommon.h.

## Enumeration Type Documentation

anonymous enum

These codes represent token IDs which are numerical translations of specific lexemes.

Specific compilers using the lexer can register their own token IDs which are given precedence over these built-in ones.

Enumerator:

  TID_LBRACKET |
  TID_RBRACKET |
  TID_COLON |
  TID_VARIABLE |
  TID_WORD |
  TID_QUOTE |
  TID_NEWLINE |
  TID_UNKNOWN |
  TID_END |

Definition at line 50 of file OgreScriptLexer.h.

anonymous enum

This enum defines the integer ids for keywords this compiler handles.

Enumerator:

  ID_MATERIAL |
  ID_VERTEX_PROGRAM |
  ID_GEOMETRY_PROGRAM |
  ID_FRAGMENT_PROGRAM |
  ID_TECHNIQUE |
  ID_PASS |
  ID_TEXTURE_UNIT |
  ID_VERTEX_PROGRAM_REF |
  ID_GEOMETRY_PROGRAM_REF |
  ID_FRAGMENT_PROGRAM_REF |
  ID_SHADOW_CASTER_VERTEX_PROGRAM_REF |
  ID_SHADOW_RECEIVER_VERTEX_PROGRAM_REF |
  ID_SHADOW_RECEIVER_FRAGMENT_PROGRAM_REF |
  ID_SHADOW_CASTER_MATERIAL |
  ID_SHADOW_RECEIVER_MATERIAL |
  ID_LOD_VALUES |
  ID_LOD_STRATEGY |
  ID_LOD_DISTANCES |
  ID_RECEIVE_SHADOWS |
  ID_TRANSPARENCY_CASTS_SHADOWS |
  ID_SET_TEXTURE_ALIAS |
  ID_SOURCE |
  ID_SYNTAX |
  ID_DEFAULT_PARAMS |
  ID_PARAM_INDEXED |
  ID_PARAM_NAMED |
  ID_PARAM_INDEXED_AUTO |
  ID_PARAM_NAMED_AUTO |
  ID_SCHEME |
  ID_LOD_INDEX |
  ID_GPU_VENDOR_RULE |
  ID_GPU_DEVICE_RULE |
  ID_INCLUDE |
  ID_EXCLUDE |
  ID_AMBIENT |
  ID_DIFFUSE |
  ID_SPECULAR |
  ID_EMISSIVE |
  ID_VERTEXCOLOUR |
  ID_SCENE_BLEND |
  ID_COLOUR_BLEND |
  ID_ONE |
  ID_ZERO |
  ID_DEST_COLOUR |
  ID_SRC_COLOUR |
  ID_ONE_MINUS_DEST_COLOUR |
  ID_ONE_MINUS_SRC_COLOUR |
  ID_DEST_ALPHA |
  ID_SRC_ALPHA |
  ID_ONE_MINUS_DEST_ALPHA |
  ID_ONE_MINUS_SRC_ALPHA |
  ID_SEPARATE_SCENE_BLEND |
  ID_SCENE_BLEND_OP |
  ID_REVERSE_SUBTRACT |
  ID_MIN |
  ID_MAX |
  ID_SEPARATE_SCENE_BLEND_OP |
  ID_DEPTH_CHECK |
  ID_DEPTH_WRITE |
  ID_DEPTH_FUNC |
  ID_DEPTH_BIAS |
  ID_ITERATION_DEPTH_BIAS |
  ID_ALWAYS_FAIL |
  ID_ALWAYS_PASS |
  ID_LESS_EQUAL |
  ID_LESS |
  ID_EQUAL |
  ID_NOT_EQUAL |
  ID_GREATER_EQUAL |
  ID_GREATER |
  ID_ALPHA_REJECTION |
  ID_ALPHA_TO_COVERAGE |
  ID_LIGHT_SCISSOR |
  ID_LIGHT_CLIP_PLANES |
  ID_TRANSPARENT_SORTING |
  ID_ILLUMINATION_STAGE |
  ID_DECAL |
  ID_CULL_HARDWARE |
  ID_CLOCKWISE |
  ID_ANTICLOCKWISE |
  ID_CULL_SOFTWARE |
  ID_BACK |
  ID_FRONT |
  ID_NORMALISE_NORMALS |
  ID_LIGHTING |
  ID_SHADING |
  ID_FLAT |
  ID_GOURAUD |
  ID_PHONG |
  ID_POLYGON_MODE |
  ID_SOLID |
  ID_WIREFRAME |
  ID_POINTS |
  ID_POLYGON_MODE_OVERRIDEABLE |
  ID_FOG_OVERRIDE |
  ID_NONE |
  ID_LINEAR |
  ID_EXP |
  ID_EXP2 |
  ID_COLOUR_WRITE |
  ID_MAX_LIGHTS |
  ID_START_LIGHT |
  ID_ITERATION |
  ID_ONCE |
  ID_ONCE_PER_LIGHT |
  ID_PER_LIGHT |
  ID_PER_N_LIGHTS |
  ID_POINT |
  ID_SPOT |
  ID_DIRECTIONAL |
  ID_POINT_SIZE |
  ID_POINT_SPRITES |
  ID_POINT_SIZE_ATTENUATION |
  ID_POINT_SIZE_MIN |
  ID_POINT_SIZE_MAX |
  ID_TEXTURE_ALIAS |
  ID_TEXTURE |
  ID_1D |
  ID_2D |
  ID_3D |
  ID_CUBIC |
  ID_UNLIMITED |
  ID_ALPHA |
  ID_GAMMA |
  ID_ANIM_TEXTURE |
  ID_CUBIC_TEXTURE |
  ID_SEPARATE_UV |
  ID_COMBINED_UVW |
  ID_TEX_COORD_SET |
  ID_TEX_ADDRESS_MODE |
  ID_WRAP |
  ID_CLAMP |
  ID_BORDER |
  ID_MIRROR |
  ID_TEX_BORDER_COLOUR |
  ID_FILTERING |
  ID_BILINEAR |
  ID_TRILINEAR |
  ID_ANISOTROPIC |
  ID_MAX_ANISOTROPY |
  ID_MIPMAP_BIAS |
  ID_COLOUR_OP |
  ID_REPLACE |
  ID_ADD |
  ID_MODULATE |
  ID_ALPHA_BLEND |
  ID_COLOUR_OP_EX |
  ID_SOURCE1 |
  ID_SOURCE2 |
  ID_MODULATE_X2 |
  ID_MODULATE_X4 |
  ID_ADD_SIGNED |
  ID_ADD_SMOOTH |
  ID_SUBTRACT |
  ID_BLEND_DIFFUSE_COLOUR |
  ID_BLEND_DIFFUSE_ALPHA |
  ID_BLEND_TEXTURE_ALPHA |
  ID_BLEND_CURRENT_ALPHA |
  ID_BLEND_MANUAL |
  ID_DOT_PRODUCT |
  ID_SRC_CURRENT |
  ID_SRC_TEXTURE |
  ID_SRC_DIFFUSE |
  ID_SRC_SPECULAR |
  ID_SRC_MANUAL |
  ID_COLOUR_OP_MULTIPASS_FALLBACK |
  ID_ALPHA_OP_EX |
  ID_ENV_MAP |
  ID_SPHERICAL |
  ID_PLANAR |
  ID_CUBIC_REFLECTION |
  ID_CUBIC_NORMAL |
  ID_SCROLL |
  ID_SCROLL_ANIM |
  ID_ROTATE |
  ID_ROTATE_ANIM |
  ID_SCALE |
  ID_WAVE_XFORM |
  ID_SCROLL_X |
  ID_SCROLL_Y |
  ID_SCALE_X |
  ID_SCALE_Y |
  ID_SINE |
  ID_TRIANGLE |
  ID_SQUARE |
  ID_SAWTOOTH |
  ID_INVERSE_SAWTOOTH |
  ID_TRANSFORM |
  ID_BINDING_TYPE |
  ID_VERTEX |
  ID_FRAGMENT |
  ID_CONTENT_TYPE |
  ID_NAMED |
  ID_SHADOW |
  ID_TEXTURE_SOURCE |
  ID_SHARED_PARAMS |
  ID_SHARED_PARAM_NAMED |
  ID_SHARED_PARAMS_REF |
  ID_PARTICLE_SYSTEM |
  ID_EMITTER |
  ID_AFFECTOR |
  ID_COMPOSITOR |
  ID_TARGET |
  ID_TARGET_OUTPUT |
  ID_INPUT |
  ID_PREVIOUS |
  ID_TARGET_WIDTH |
  ID_TARGET_HEIGHT |
  ID_TARGET_WIDTH_SCALED |
  ID_TARGET_HEIGHT_SCALED |
  ID_COMPOSITOR_LOGIC |
  ID_TEXTURE_REF |
  ID_SCOPE_LOCAL |
  ID_SCOPE_CHAIN |
  ID_SCOPE_GLOBAL |
  ID_POOLED |
  ID_NO_FSAA |
  ID_ONLY_INITIAL |
  ID_VISIBILITY_MASK |
  ID_LOD_BIAS |
  ID_MATERIAL_SCHEME |
  ID_SHADOWS_ENABLED |
  ID_CLEAR |
  ID_STENCIL |
  ID_RENDER_SCENE |
  ID_RENDER_QUAD |
  ID_IDENTIFIER |
  ID_FIRST_RENDER_QUEUE |
  ID_LAST_RENDER_QUEUE |
  ID_QUAD_NORMALS |
  ID_CAMERA_FAR_CORNERS_VIEW_SPACE |
  ID_CAMERA_FAR_CORNERS_WORLD_SPACE |
  ID_BUFFERS |
  ID_COLOUR |
  ID_DEPTH |
  ID_COLOUR_VALUE |
  ID_DEPTH_VALUE |
  ID_STENCIL_VALUE |
  ID_CHECK |
  ID_COMP_FUNC |
  ID_REF_VALUE |
  ID_MASK |
  ID_FAIL_OP |
  ID_KEEP |
  ID_INCREMENT |
  ID_DECREMENT |
  ID_INCREMENT_WRAP |
  ID_DECREMENT_WRAP |
  ID_INVERT |
  ID_DEPTH_FAIL_OP |
  ID_PASS_OP |
  ID_TWO_SIDED |
  ID_END_BUILTIN_IDS |

Definition at line 572 of file OgreScriptCompiler.h.

enum Ogre::AbstractNodeType

This enum holds the types of the possible abstract nodes.

Enumerator:

  ANT_UNKNOWN |
  ANT_ATOM |
  ANT_OBJECT |
  ANT_PROPERTY |
  ANT_IMPORT |
  ANT_VARIABLE_SET |
  ANT_VARIABLE_ACCESS |

Definition at line 75 of file OgreScriptCompiler.h.

enum Ogre::ClipResult

Generic result of clipping.

Enumerator:

  CLIPPED_NONE | Nothing was clipped.
  CLIPPED_SOME | Partially clipped.
  CLIPPED_ALL | Everything was clipped away.

Definition at line 714 of file OgreCommon.h.

enum Ogre::CompareFunction

Comparison functions used for the depth/stencil buffer operations and others.

Enumerator:

  CMPF_ALWAYS_FAIL |
  CMPF_ALWAYS_PASS |
  CMPF_LESS |
  CMPF_LESS_EQUAL |
  CMPF_EQUAL |
  CMPF_NOT_EQUAL |
  CMPF_GREATER_EQUAL |
  CMPF_GREATER |

Definition at line 65 of file OgreCommon.h.

enum Ogre::ConcreteNodeType

These enums hold the types of the concrete parsed nodes.

Enumerator:

  CNT_VARIABLE |
  CNT_VARIABLE_ASSIGN |
  CNT_WORD |
  CNT_IMPORT |
  CNT_QUOTE |
  CNT_LBRACE |
  CNT_RBRACE |
  CNT_COLON |

Definition at line 48 of file OgreScriptCompiler.h.

enum Ogre::CullingMode

Hardware culling modes based on vertex winding.

This setting applies to how the hardware API culls triangles it is sent.

Enumerator:

  CULL_NONE | Hardware never culls triangles and renders everything it receives.
  CULL_CLOCKWISE | Hardware culls triangles whose vertices are listed clockwise in the view (default).
  CULL_ANTICLOCKWISE | Hardware culls triangles whose vertices are listed anticlockwise in the view.

Definition at line 136 of file OgreCommon.h.

enum Ogre::FilterOptions

Filtering options for textures / mipmaps.

Enumerator:

  FO_NONE | No filtering, used for FILT_MIP to turn off mipmapping.
  FO_POINT | Use the closest pixel.
  FO_LINEAR | Average of a 2x2 pixel area, denotes bilinear for MIN and MAG, trilinear for MIP.
  FO_ANISOTROPIC | Similar to FO_LINEAR, but compensates for the angle of the texture plane.

Definition at line 101 of file OgreCommon.h.

enum Ogre::FilterType

Enumerator:

  FT_MIN | The filter used when shrinking a texture.
  FT_MAG | The filter used when magnifying a texture.
  FT_MIP | The filter used when determining the mipmap.

Definition at line 91 of file OgreCommon.h.

enum Ogre::FogMode

Fog modes.

Enumerator:

  FOG_NONE | No fog. Duh.
  FOG_EXP | Fog density increases exponentially from the camera (fog = 1/e^(distance * density)).
  FOG_EXP2 | Fog density increases at the square of FOG_EXP, i.e. even quicker (fog = 1/e^(distance * density)^2).
  FOG_LINEAR | Fog density increases linearly between the start and end distances.

Definition at line 122 of file OgreCommon.h.

enum Ogre::FrameBufferType

Defines the frame buffer types.

Enumerator:

  FBT_COLOUR |
  FBT_DEPTH |
  FBT_STENCIL |

Definition at line 296 of file OgreCommon.h.

enum Ogre::LoggingLevel

The level of detail to which the log will go into.

Enumerator:

  LL_LOW |
  LL_NORMAL |
  LL_BOREME |

Definition at line 48 of file OgreLog.h.

enum Ogre::LogMessageLevel

The importance of a logged message.

Enumerator:

  LML_TRIVIAL |
  LML_NORMAL |
  LML_CRITICAL |

Definition at line 57 of file OgreLog.h.

enum Ogre::ManualCullingMode

Manual culling modes based on vertex normals.

This setting applies to how the software culls triangles before sending them to the hardware API. This culling mode is used by scene managers which choose to implement it - normally those which deal with large amounts of fixed world geometry which is often planar (software culling movable variable geometry is expensive).

Enumerator:

  MANUAL_CULL_NONE | No culling so everything is sent to the hardware.
  MANUAL_CULL_BACK | Cull triangles whose normal is pointing away from the camera (default).
  MANUAL_CULL_FRONT | Cull triangles whose normal is pointing towards the camera.

Definition at line 151 of file OgreCommon.h.

enum Ogre::ParameterType

List of parameter types available.

Enumerator:

  PT_BOOL |
  PT_REAL |
  PT_INT |
  PT_UNSIGNED_INT |
  PT_SHORT |
  PT_UNSIGNED_SHORT |
  PT_LONG |
  PT_UNSIGNED_LONG |
  PT_STRING |
  PT_VECTOR3 |
  PT_MATRIX3 |
  PT_MATRIX4 |
  PT_QUATERNION |
  PT_COLOURVALUE |

Definition at line 46 of file OgreStringInterface.h.

enum Ogre::PolygonMode

The polygon mode to use when rasterising.

Enumerator:

  PM_POINTS | Only points are rendered.
  PM_WIREFRAME | Wireframe models are rendered.
  PM_SOLID | Solid polygons are rendered.

Definition at line 180 of file OgreCommon.h.

enum Ogre::ProfileGroupMask

List of reserved profiling masks.

Enumerator:

  OGREPROF_USER_DEFAULT | User default profile.
  OGREPROF_ALL | All in-built Ogre profiling will match this mask.
  OGREPROF_GENERAL | General processing.
  OGREPROF_CULLING | Culling.
  OGREPROF_RENDERING | Rendering.

Definition at line 75 of file OgreProfiler.h.

enum Ogre::ShadeOptions

Light shading modes.

Enumerator:

  SO_FLAT |
  SO_GOURAUD |
  SO_PHONG |

Definition at line 114 of file OgreCommon.h.

enum Ogre::ShadowTechnique

An enumeration of broad shadow techniques.

Enumerator:

  SHADOWTYPE_NONE | No shadows.
  SHADOWDETAILTYPE_ADDITIVE | Mask for additive shadows (not for direct use, use SHADOWTYPE_ enum instead).
  SHADOWDETAILTYPE_MODULATIVE | Mask for modulative shadows (not for direct use, use SHADOWTYPE_ enum instead).
  SHADOWDETAILTYPE_INTEGRATED | Mask for integrated shadows (not for direct use, use SHADOWTYPE_ enum instead).
  SHADOWDETAILTYPE_STENCIL | Mask for stencil shadows (not for direct use, use SHADOWTYPE_ enum instead).
  SHADOWDETAILTYPE_TEXTURE | Mask for texture shadows (not for direct use, use SHADOWTYPE_ enum instead).
  SHADOWTYPE_STENCIL_MODULATIVE | Stencil shadow technique which renders all shadow volumes as a modulation after all the non-transparent areas have been rendered. This technique is considerably less fillrate intensive than the additive stencil shadow approach when there are multiple lights, but is not an accurate model.

  SHADOWTYPE_STENCIL_ADDITIVE

  Stencil shadow technique which renders each light as a separate additive pass to the scene.

  This technique can be very fillrate intensive because it requires at least 2 passes of the entire scene, more if there are multiple lights. However, it is a more accurate model than the modulative stencil approach and this is especially apparent when using coloured lights or bump mapping.

  SHADOWTYPE_TEXTURE_MODULATIVE | Texture-based shadow technique which involves a monochrome render-to-texture of the shadow caster and a projection of that texture onto the shadow receivers as a modulative pass.

  SHADOWTYPE_TEXTURE_ADDITIVE

  Texture-based shadow technique which involves a render-to-texture of the shadow caster and a projection of that texture onto the shadow receivers, built up per light as additive passes.

  This technique can be very fillrate intensive because it requires numLights + 2 passes of the entire scene. However, it is a more accurate model than the modulative approach and this is especially apparent when using coloured lights or bump mapping.

  SHADOWTYPE_TEXTURE_ADDITIVE_INTEGRATED

  Texture-based shadow technique which involves a render-to-texture of the shadow caster and a projection of that texture on to the shadow receivers, with the usage of those shadow textures completely controlled by the materials of the receivers.

  This technique is easily the most flexible of all techniques because the material author is in complete control over how the shadows are combined with regular rendering. It can perform shadows as accurately as SHADOWTYPE_TEXTURE_ADDITIVE but more efficiently because it requires less passes. However it also requires more expertise to use, and in almost all cases, shader capable hardware to really use to the full.
  Note:
    The 'additive' part of this mode means that the colour of the rendered shadow texture is by default plain black. It does not mean it does the adding on your receivers automatically though, how you use that result is up to you.

  SHADOWTYPE_TEXTURE_MODULATIVE_INTEGRATED

  Texture-based shadow technique which involves a render-to-texture of the shadow caster and a projection of that texture on to the shadow receivers, with the usage of those shadow textures completely controlled by the materials of the receivers.

  This technique is easily the most flexible of all techniques because the material author is in complete control over how the shadows are combined with regular rendering. It can perform shadows as accurately as SHADOWTYPE_TEXTURE_ADDITIVE but more efficiently because it requires less passes. However it also requires more expertise to use, and in almost all cases, shader capable hardware to really use to the full.
  Note:
    The 'modulative' part of this mode means that the colour of the rendered shadow texture is by default the 'shadow colour'. It does not mean it modulates on your receivers automatically though, how you use that result is up to you.

Definition at line 191 of file OgreCommon.h.

enum Ogre::SharedPtrFreeMethod

The method to use to free memory on destruction.

Enumerator:

  SPFM_DELETE | Use OGRE_DELETE to free the memory.
  SPFM_DELETE_T | Use OGRE_DELETE_T to free (only MEMCATEGORY_GENERAL supported).
  SPFM_FREE | Use OGRE_FREE to free (only MEMCATEGORY_GENERAL supported).

Definition at line 42 of file OgreSharedPtr.h.

enum Ogre::SortMode

Sort mode for billboard-set and particle-system.

Enumerator:

  SM_DIRECTION | Sort by direction of the camera.
  SM_DISTANCE | Sort by distance from the camera.

Definition at line 287 of file OgreCommon.h.

enum Ogre::TextureFilterOptions

High-level filtering options providing shortcuts to settings the minification, magnification and mip filters.

Enumerator:

  TFO_NONE | Equal to: min=FO_POINT, mag=FO_POINT, mip=FO_NONE.
  TFO_BILINEAR | Equal to: min=FO_LINEAR, mag=FO_LINEAR, mip=FO_POINT.
  TFO_TRILINEAR | Equal to: min=FO_LINEAR, mag=FO_LINEAR, mip=FO_LINEAR.
  TFO_ANISOTROPIC | Equal to: min=FO_ANISOTROPIC, max=FO_ANISOTROPIC, mip=FO_LINEAR.

Definition at line 79 of file OgreCommon.h.

enum Ogre::TrackVertexColourEnum

Enumerator:

  TVC_NONE |
  TVC_AMBIENT |
  TVC_DIFFUSE |
  TVC_SPECULAR |
  TVC_EMISSIVE |

Definition at line 278 of file OgreCommon.h.

enum Ogre::WaveformType

Enumerates the wave types usable with the Ogre engine.

Enumerator:

  WFT_SINE | Standard sine wave which smoothly changes from low to high and back again.
  WFT_TRIANGLE | An angular wave with a constant increase / decrease speed with pointed peaks.
  WFT_SQUARE | Half of the time is spent at the min, half at the max with instant transition between.
  WFT_SAWTOOTH | Gradual steady increase from min to max over the period with an instant return to min at the end.
  WFT_INVERSE_SAWTOOTH | Gradual steady decrease from max to min over the period, with an instant return to max at the end.
  WFT_PWM | Pulse Width Modulation. Works like WFT_SQUARE, except the high to low transition is controlled by duty cycle. With a duty cycle of 50% (0.5) will give the same output as WFT_SQUARE.

Definition at line 162 of file OgreCommon.h.

## Function Documentation

template<typename ValueType >

ValueType* Ogre::any_cast | ( | Any * | operand | ) |

Definition at line 383 of file OgreAny.h.

References Ogre::Any::getType(), and Ogre::Any::mContent.

Referenced by Ogre::any_cast().

template<typename ValueType >

const ValueType* Ogre::any_cast | ( | const Any * | operand | ) |

Definition at line 391 of file OgreAny.h.

References Ogre::any_cast().

template<typename ValueType >

ValueType Ogre::any_cast | ( | const Any & | operand | ) |

Definition at line 397 of file OgreAny.h.

References Ogre::any_cast(), Ogre::Exception::ERR_INVALIDPARAMS, Ogre::Any::getType(), and OGRE_EXCEPT.

uint32 _OgreExport Ogre::FastHash | ( | const char * | data,
|  | int | len,
|  | uint32 | hashSoFar = `0` |
| ) |  |  |

Fast general hashing algorithm.

Referenced by Ogre::HashedVector< Light * >::addToHash(), Ogre::HashCombine(), and Ogre::RTShader::sh_hash_combine().

int _OgreExport Ogre::findCommandLineOpts | ( | int | numargs,
|  | char ** | argv,
|  | UnaryOptionList & | unaryOptList,
|  | BinaryOptionList & | binOptList |
| ) |  |  |

Locate command-line options of the unary form '-blah' and of the binary form '-blah foo', passing back the index of the next non-option.

Parameters:

  | numargs,argv | The standard parameters passed to the main method
  | unaryOptList | Map of unary options (i.e. those that do not require a parameter). Should be pre-populated with, for example '-e' in the key and false in the value. Options which are found will be set to true on return.
  | binOptList | Map of binary options (i.e. those that require a parameter e.g. '-e afile.txt'). Should be pre-populated with, for example '-e' and the default setting. Options which are found will have the value updated.

template<typename T >

uint32 Ogre::HashCombine | ( | uint32 | hashSoFar,
|  | const T & | data |
| ) |  |  |

Combine hashes with same style as boost::hash_combine.

Definition at line 57 of file OgreCommon.h.

References Ogre::FastHash().

Rectangle Ogre::intersect | ( | const Rectangle & | lhs,
|  | const Rectangle & | rhs |
| ) |  |  |

Geometric intersection of two rectanglar regions.

Remarks:
  Calculates the geometric intersection of two rectangular regions. Rectangle coordinates must be ([0-N], [0-N]), such that (0,0) is in the upper left hand corner.

If the two input rectangles do not intersect, then the result will be a degenerate rectangle, i.e. left >= right or top >= bottom, or both.

Definition at line 61 of file OgreRectangle.h.

References Ogre::Rectangle::bottom, Ogre::Rectangle::left, Ogre::Rectangle::right, and Ogre::Rectangle::top.

template<class T , class U >

bool Ogre::operator!= | ( | SharedPtr< T > const & | a,
|  | SharedPtr< U > const & | b |
| ) |  |  |

Definition at line 263 of file OgreSharedPtr.h.

References Ogre::SharedPtr< T >::get().

template<class T , class U >

bool Ogre::operator< | ( | SharedPtr< T > const & | a,
|  | SharedPtr< U > const & | b |
| ) |  |  |

Definition at line 268 of file OgreSharedPtr.h.

template<typename T >

std::ostream& Ogre::operator<< | ( | std::ostream & | o,
|  | const TRect< T > & | r |
| ) |  |  |

Definition at line 610 of file OgreCommon.h.

References Ogre::TRect< T >::left.

template<class T , class U >

bool Ogre::operator== | ( | SharedPtr< T > const & | a,
|  | SharedPtr< U > const & | b |
| ) |  |  |

Definition at line 258 of file OgreSharedPtr.h.

References Ogre::SharedPtr< T >::get().

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:53