OGRE  1.12.1
Object-Oriented Graphics Rendering Engine
General

Classes

class  Ogre::AbstractNode
 
struct  Ogre::AlignedAllocator< T, Alignment >
 STL compatible wrapper for AlignedMemory. More...
 
class  Ogre::AlignedMemory
 Class to provide aligned memory allocate functionality. More...
 
class  Ogre::AnimationControllerFunction
 Predefined controller function for dealing with animation. More...
 
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::AtomAbstractNode
 This is an abstract node which cannot be broken down further. More...
 
struct  Ogre::Box
 Structure used to define a box in a 3-D integer space. More...
 
class  Ogre::Codec
 Abstract class that defines a 'codec'. More...
 
class  Ogre::ColourValue
 Class representing colour. More...
 
class  Ogre::ComPtr< T >
 
struct  Ogre::ConcreteNode
 
class  Ogre::ConfigDialog
 Defines the behaviour of an automatic renderer configuration dialog. 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::Controller< T >
 Instances of this class 'control' the value of another object in the system. 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::ControllerManager
 Class for managing Controller instances. More...
 
class  Ogre::ControllerValue< T >
 Can either be used as an input or output value. More...
 
class  Ogre::CreateCompositorScriptCompilerEvent
 
class  Ogre::CreateGpuProgramScriptCompilerEvent
 
class  Ogre::CreateGpuSharedParametersScriptCompilerEvent
 
class  Ogre::CreateHighLevelGpuProgramScriptCompilerEvent
 
class  Ogre::CreateMaterialScriptCompilerEvent
 
class  Ogre::CreateParticleSystemScriptCompilerEvent
 
class  Ogre::DefaultWorkQueueBase
 Base for a general purpose request / response style background work queue. 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...
 
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...
 
class  Ogre::FileNotFoundException
 
class  Ogre::FloatGpuParameterControllerValue
 Predefined controller value for setting a single floating- point value in a constant parameter of a vertex or fragment program. 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::FrameTimeControllerValue
 Predefined controller value for getting the latest frame time. More...
 
class  Ogre::HashedVector< T >
 A hashed vector. More...
 
class  Ogre::ImportAbstractNode
 This abstract node represents an import statement. More...
 
class  Ogre::InternalErrorException
 
class  Ogre::InvalidCallException
 
class  Ogre::InvalidParametersException
 
class  Ogre::InvalidStateException
 
class  Ogre::IOException
 
class  Ogre::ItemIdentityException
 
class  Ogre::LinearControllerFunction
 Predefined controller function based on linear function interpolation. More...
 
class  Ogre::Log
 
class  Ogre::LogListener
 
class  Ogre::LogManager
 The log manager handles the creation and retrieval of logs for the application. More...
 
class  Ogre::NameGenerator
 Utility class to generate a sequentially numbered series of names. More...
 
class  Ogre::NoAddRefRelease< T >
 
class  Ogre::ObjectAbstractNode
 This specific abstract node represents a script object. 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::ParameterDef
 Definition of a parameter supported by a StringInterface class, for introspection. More...
 
class  Ogre::PassthroughControllerFunction
 Predefined controller function which just passes through the original source directly to dest. 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::PreApplyTextureAliasesScriptCompilerEvent
 
class  Ogre::ProcessNameExclusionScriptCompilerEvent
 
class  Ogre::ProcessResourceNameScriptCompilerEvent
 
class  Ogre::Profile
 An individual profile that will be processed by the Profiler. More...
 
struct  Ogre::ProfileFrame
 Represents the total timing information of a profile since profiles can be called more than once each frame. More...
 
struct  Ogre::ProfileHistory
 Represents a history of each profile during the duration of the app. More...
 
class  Ogre::ProfileInstance
 Represents an individual profile call. More...
 
class  Ogre::Profiler
 The profiler allows you to measure the performance of your code. More...
 
class  Ogre::ProfileSessionListener
 ProfileSessionListener should be used to visualize profile results. More...
 
class  Ogre::PropertyAbstractNode
 This abstract node represents a script property. 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...
 
class  Ogre::RenderingAPIException
 
struct  Ogre::RenderWindowDescription
 Render window creation parameters. More...
 
class  Ogre::Root
 The root class of the Ogre system. More...
 
class  Ogre::RuntimeAssertionException
 
class  Ogre::ScaleControllerFunction
 Predefined controller function which simply scales an input to an output value. More...
 
class  Ogre::SceneLoader
 Abstract class for loading scenes from a file (DataStream). 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::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::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::Serializer
 Generic class for serialising data to / from binary stream-based files. More...
 
class  Ogre::SharedPtr< T >
 
class  Ogre::Singleton< T >
 Template class for creating single-instance global classes. More...
 
struct  Ogre::SPFMDeleteT
 
struct  Ogre::SPFMNone
 
class  Ogre::StringConverter
 Class for converting the core Ogre data types to/from Strings. 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::StringUtil
 Utility class for manipulating Strings. More...
 
class  Ogre::TexCoordModifierControllerValue
 Predefined controller value for getting / setting a texture coordinate modifications (scales and translates). More...
 
class  Ogre::TextureFrameControllerValue
 Predefined controller value for getting / setting the frame number of a texture layer. More...
 
struct  Ogre::TRect< T >
 
class  Ogre::UnimplementedException
 Template struct which creates a distinct type for each exception code. More...
 
class  Ogre::VariableAccessAbstractNode
 This abstract node represents a variable assignment. More...
 
class  Ogre::WaveformControllerFunction
 Predefined controller function based on a waveform. More...
 
class  Ogre::WorkQueue
 Interface to a general purpose request / response style background work queue. More...
 

Macros

#define OGRE_ALLOC_T(T, count, category)   (T*)new char[(count) * sizeof(T)]
 Allocate a block of memory for a primitive type, and indicate the category of usage. More...
 
#define OGRE_DELETE   delete
 
#define OGRE_DELETE_ARRAY_T(ptr, T, count, category)   delete[] ptr
 Free the memory allocated with OGRE_NEW_ARRAY_T. Category is required to be restated to ensure the matching policy is used, count and type to call destructor. More...
 
#define OGRE_DELETE_T(ptr, T, category)   delete ptr
 Free the memory allocated with OGRE_NEW_T. Category is required to be restated to ensure the matching policy is used. More...
 
#define OGRE_EXCEPT(...)   OGRE_EXPAND(OGRE_EXCEPT_CHOOSER(__VA_ARGS__, OGRE_EXCEPT_3, OGRE_EXCEPT_2)(__VA_ARGS__))
 
#define OGRE_EXCEPT_2(code, desc)   Ogre::ExceptionFactory::throwException(code, desc, __FUNCTION__, __FILE__, __LINE__)
 
#define OGRE_EXCEPT_3(code, desc, src)   Ogre::ExceptionFactory::throwException(code, desc, src, __FILE__, __LINE__)
 
#define OGRE_EXCEPT_CHOOSER(arg1, arg2, arg3, arg4, ...)   arg4
 
#define OGRE_EXPAND(x)   x
 
#define OGRE_FREE(ptr, category)   delete[] (char*)ptr
 Free the memory allocated with OGRE_MALLOC or OGRE_ALLOC_T. Category is required to be restated to ensure the matching policy is used. More...
 
#define OGRE_FREE_SIMD(ptr, category)   ::Ogre::AlignedMemory::deallocate((void*)ptr)
 Free the memory allocated with either OGRE_MALLOC_SIMD or OGRE_ALLOC_T_SIMD. Category is required to be restated to ensure the matching policy is used. More...
 
#define OGRE_LOG_THRESHOLD   4
 
#define OGRE_MALLOC(bytes, category)   (void*)new char[bytes]
 Allocate a block of raw memory, and indicate the category of usage. More...
 
#define OGRE_MALLOC_SIMD(bytes, category)   ::Ogre::AlignedMemory::allocate(bytes)
 Allocate a block of raw memory aligned to SIMD boundaries, and indicate the category of usage. More...
 
#define OGRE_NEW   new
 
#define OGRE_NEW_ARRAY_T(T, count, category)   new T[count]
 Allocate a block of memory for 'count' primitive types - do not use for classes that inherit from AllocatedObject. More...
 
#define OGRE_NEW_T(T, category)   new T
 Allocate space for one primitive type, external type or non-virtual type with constructor parameters. More...
 

Typedefs

typedef ::std::hash< _StringBaseOgre::_StringHash
 
typedef uint32 Ogre::ABGR
 
typedef std::list< AbstractNodePtrOgre::AbstractNodeList
 
typedef SharedPtr< AbstractNodeListOgre::AbstractNodeListPtr
 
typedef SharedPtr< AbstractNodeOgre::AbstractNodePtr
 
typedef std::map< String, StringOgre::AliasTextureNamePairList
 Alias / Texture name pair (first = alias, second = texture name) More...
 
typedef uint32 Ogre::ARGB
 
typedef uint32 Ogre::BGRA
 
typedef std::map< String, StringOgre::BinaryOptionList
 
typedef std::list< ConcreteNodePtrOgre::ConcreteNodeList
 
typedef SharedPtr< ConcreteNodeListOgre::ConcreteNodeListPtr
 
typedef SharedPtr< ConcreteNodeOgre::ConcreteNodePtr
 
typedef std::map< String, ConfigOptionOgre::ConfigOptionMap
 
typedef SharedPtr< ControllerFunction< Real > > Ogre::ControllerFunctionRealPtr
 
typedef SharedPtr< ControllerValue< Real > > Ogre::ControllerValueRealPtr
 
typedef TRect< float > Ogre::FloatRect
 Structure used to define a rectangle in a 2-D floating point space. More...
 
typedef HashedVector< Light * > Ogre::LightList
 
typedef std::map< String, StringOgre::NameValuePairList
 Name / value parameter pair (first = name, second = value) More...
 
typedef std::map< String, ParamCommand *> Ogre::ParamCommandMap
 
typedef std::map< String, ParamDictionaryOgre::ParamDictionaryMap
 
typedef std::vector< ParameterDefOgre::ParameterList
 
typedef TRect< RealOgre::RealRect
 Structure used to define a rectangle in a 2-D floating point space, subject to double / single floating point settings. More...
 
typedef TRect< long > Ogre::Rect
 Structure used to define a rectangle in a 2-D integer space. More...
 
typedef std::vector< RenderSystem * > Ogre::RenderSystemList
 
typedef std::vector< RenderWindowDescriptionOgre::RenderWindowDescriptionList
 Render window creation parameters container. More...
 
typedef std::vector< RenderWindow * > Ogre::RenderWindowList
 Render window container. More...
 
typedef uint32 Ogre::RGBA
 
typedef std::vector< StringOgre::StringVector
 
typedef SharedPtr< StringVectorOgre::StringVectorPtr
 
typedef int Ogre::TrackVertexColourType
 An enumeration describing which material properties should track the vertex colours. More...
 
typedef std::map< String, bool > Ogre::UnaryOptionList
 

Enumerations

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_CASTER_FRAGMENT_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_LIGHT_MASK,
  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_2DARRAY,
  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_CMPTEST, Ogre::ID_ON,
  Ogre::ID_OFF, Ogre::ID_CMPFUNC, 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_DEPTH_POOL, 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_READ_BACK_AS_TEXTURE, Ogre::ID_TESSELLATION_HULL_PROGRAM, Ogre::ID_TESSELLATION_DOMAIN_PROGRAM, Ogre::ID_COMPUTE_PROGRAM,
  Ogre::ID_TESSELLATION_HULL_PROGRAM_REF, Ogre::ID_TESSELLATION_DOMAIN_PROGRAM_REF, Ogre::ID_COMPUTE_PROGRAM_REF, Ogre::ID_GEOMETRY,
  Ogre::ID_TESSELLATION_HULL, Ogre::ID_TESSELLATION_DOMAIN, Ogre::ID_COMPUTE, Ogre::ID_SUBROUTINE,
  Ogre::ID_LINE_WIDTH, Ogre::ID_SAMPLER, Ogre::ID_SAMPLER_REF, Ogre::ID_THREAD_GROUPS,
  Ogre::ID_RENDER_CUSTOM, Ogre::ID_END_BUILTIN_IDS
}
 This enum defines the integer ids for keywords this compiler handles. 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::ClipResult { Ogre::CLIPPED_NONE = 0, Ogre::CLIPPED_SOME = 1, Ogre::CLIPPED_ALL = 2 }
 Generic result of clipping. More...
 
enum  Ogre::ColourBufferType { Ogre::CBT_BACK = 0x0, Ogre::CBT_BACK_LEFT, Ogre::CBT_BACK_RIGHT }
 Defines the colour buffer types. More...
 
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::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::CullingMode { Ogre::CULL_NONE = 1, Ogre::CULL_CLOCKWISE = 2, Ogre::CULL_ANTICLOCKWISE = 3 }
 Hardware culling modes based on vertex winding. More...
 
enum  Ogre::FilterOptions { Ogre::FO_NONE, Ogre::FO_POINT, Ogre::FO_LINEAR, Ogre::FO_ANISOTROPIC }
 Filtering options for textures / mipmaps. More...
 
enum  Ogre::FilterType { Ogre::FT_MIN, Ogre::FT_MAG, Ogre::FT_MIP }
 
enum  Ogre::FogMode { Ogre::FOG_NONE, Ogre::FOG_EXP, Ogre::FOG_EXP2, Ogre::FOG_LINEAR }
 Fog modes. More...
 
enum  Ogre::FrameBufferType { Ogre::FBT_COLOUR = 0x1, Ogre::FBT_DEPTH = 0x2, Ogre::FBT_STENCIL = 0x4 }
 Defines the frame buffer types. More...
 
enum  Ogre::InstanceManagerFlags {
  Ogre::IM_USE16BIT = 0x0001, Ogre::IM_VTFBESTFIT = 0x0002, Ogre::IM_VTFBONEMATRIXLOOKUP = 0x0004, Ogre::IM_USEBONEDUALQUATERNIONS = 0x0008,
  Ogre::IM_USEONEWEIGHT = 0x0010, Ogre::IM_FORCEONEWEIGHT = 0x0020, Ogre::IM_USEALL = IM_USE16BIT|IM_VTFBESTFIT|IM_USEONEWEIGHT
}
 Flags for the Instance Manager when calculating ideal number of instances per batch. 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_WARNING = 3, Ogre::LML_CRITICAL = 4 }
 The importance of a logged message. 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::MemoryCategory {
  Ogre::MEMCATEGORY_GENERAL = 0, Ogre::MEMCATEGORY_GEOMETRY = 1, Ogre::MEMCATEGORY_ANIMATION = 2, Ogre::MEMCATEGORY_SCENE_CONTROL = 3,
  Ogre::MEMCATEGORY_SCENE_OBJECTS = 4, Ogre::MEMCATEGORY_RESOURCE = 5, Ogre::MEMCATEGORY_SCRIPTING = 6, Ogre::MEMCATEGORY_RENDERSYS = 7,
  Ogre::MEMCATEGORY_COUNT = 8
}
 A set of categories that indicate the purpose of a chunk of memory being allocated. 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...
 
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::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::ShadeOptions { Ogre::SO_FLAT, Ogre::SO_GOURAUD, Ogre::SO_PHONG }
 Light shading modes. 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 = SHADOWDETAILTYPE_STENCIL | SHADOWDETAILTYPE_MODULATIVE, Ogre::SHADOWTYPE_STENCIL_ADDITIVE = SHADOWDETAILTYPE_STENCIL | SHADOWDETAILTYPE_ADDITIVE,
  Ogre::SHADOWTYPE_TEXTURE_MODULATIVE = SHADOWDETAILTYPE_TEXTURE | SHADOWDETAILTYPE_MODULATIVE, Ogre::SHADOWTYPE_TEXTURE_ADDITIVE = SHADOWDETAILTYPE_TEXTURE | SHADOWDETAILTYPE_ADDITIVE, Ogre::SHADOWTYPE_TEXTURE_ADDITIVE_INTEGRATED = SHADOWTYPE_TEXTURE_ADDITIVE | SHADOWDETAILTYPE_INTEGRATED, Ogre::SHADOWTYPE_TEXTURE_MODULATIVE_INTEGRATED = SHADOWTYPE_TEXTURE_MODULATIVE | SHADOWDETAILTYPE_INTEGRATED
}
 An enumeration of broad shadow techniques. More...
 
enum  Ogre::SortMode { Ogre::SM_DIRECTION, Ogre::SM_DISTANCE }
 Sort mode for billboard-set and particle-system. More...
 
enum  Ogre::StereoModeType { Ogre::SMT_NONE = 0x0, Ogre::SMT_FRAME_SEQUENTIAL }
 Defines the stereo mode types. More...
 
enum  Ogre::TextureAddressingMode {
  Ogre::TAM_WRAP, Ogre::TAM_MIRROR, Ogre::TAM_CLAMP, Ogre::TAM_BORDER,
  Ogre::TAM_UNKNOWN = 99
}
 Texture addressing modes - default is TAM_WRAP. 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::TrackVertexColourEnum {
  Ogre::TVC_NONE = 0x0, Ogre::TVC_AMBIENT = 0x1, Ogre::TVC_DIFFUSE = 0x2, Ogre::TVC_SPECULAR = 0x4,
  Ogre::TVC_EMISSIVE = 0x8
}
 
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...
 

Functions

template<typename ValueType >
ValueType Ogre::any_cast (const Any &operand)
 
template<typename ValueType >
ValueType * Ogre::any_cast (Any *operand)
 
template<typename ValueType >
const ValueType * Ogre::any_cast (const Any *operand)
 
uint32 Ogre::FastHash (const char *data, size_t len, uint32 hashSoFar=0)
 Fast general hashing algorithm. More...
 
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. More...
 
template<typename T >
uint32 Ogre::HashCombine (uint32 hashSoFar, const T &data)
 Combine hashes with same style as boost::hash_combine. More...
 
template<class T >
bool Ogre::operator!= (const ComPtr< T > &a, const ComPtr< T > &b) ASSUME_NOEXCEPT
 
template<class T >
bool Ogre::operator< (const ComPtr< T > &a, const ComPtr< T > &b) ASSUME_NOEXCEPT
 
template<typename T >
std::ostream & Ogre::operator<< (std::ostream &o, const TRect< T > &r)
 
template<class T >
bool Ogre::operator<= (const ComPtr< T > &a, const ComPtr< T > &b) ASSUME_NOEXCEPT
 
template<class T >
bool Ogre::operator== (const ComPtr< T > &a, const ComPtr< T > &b) ASSUME_NOEXCEPT
 
template<class T >
bool Ogre::operator> (const ComPtr< T > &a, const ComPtr< T > &b) ASSUME_NOEXCEPT
 
template<class T >
bool Ogre::operator>= (const ComPtr< T > &a, const ComPtr< T > &b) ASSUME_NOEXCEPT
 
template<class T >
void Ogre::swap (ComPtr< T > &a, ComPtr< T > &b)
 

Variables

const String Ogre::BLANKSTRING
 Constant blank string, useful for returning by ref where local does not exist. More...
 
const SPFMDeleteT Ogre::SPFM_DELETE_T
 
const SPFMNone Ogre::SPFM_NONE
 

Detailed Description

Macro Definition Documentation

◆ OGRE_EXCEPT_3

#define OGRE_EXCEPT_3 (   code,
  desc,
  src 
)    Ogre::ExceptionFactory::throwException(code, desc, src, __FILE__, __LINE__)

◆ OGRE_EXCEPT_2

#define OGRE_EXCEPT_2 (   code,
  desc 
)    Ogre::ExceptionFactory::throwException(code, desc, __FUNCTION__, __FILE__, __LINE__)

◆ OGRE_EXCEPT_CHOOSER

#define OGRE_EXCEPT_CHOOSER (   arg1,
  arg2,
  arg3,
  arg4,
  ... 
)    arg4

◆ OGRE_EXPAND

#define OGRE_EXPAND (   x)    x

◆ OGRE_EXCEPT

◆ OGRE_LOG_THRESHOLD

#define OGRE_LOG_THRESHOLD   4

◆ OGRE_MALLOC

#define OGRE_MALLOC (   bytes,
  category 
)    (void*)new char[bytes]

Allocate a block of raw memory, and indicate the category of usage.

◆ OGRE_ALLOC_T

#define OGRE_ALLOC_T (   T,
  count,
  category 
)    (T*)new char[(count) * sizeof(T)]

Allocate a block of memory for a primitive type, and indicate the category of usage.

Referenced by Ogre::Terrain::ImportData::operator=(), Ogre::StreamSerialiser::read(), and Ogre::VertexCacheProfiler::VertexCacheProfiler().

◆ OGRE_FREE

#define OGRE_FREE (   ptr,
  category 
)    delete[] (char*)ptr

Free the memory allocated with OGRE_MALLOC or OGRE_ALLOC_T. Category is required to be restated to ensure the matching policy is used.

Referenced by Ogre::Terrain::ImportData::destroy(), Ogre::StreamSerialiser::read(), and Ogre::VertexCacheProfiler::~VertexCacheProfiler().

◆ OGRE_NEW_T

#define OGRE_NEW_T (   T,
  category 
)    new T

Allocate space for one primitive type, external type or non-virtual type with constructor parameters.

Referenced by Ogre::AnyNumeric::AnyNumeric(), and Ogre::Any::destroy().

◆ OGRE_NEW_ARRAY_T

#define OGRE_NEW_ARRAY_T (   T,
  count,
  category 
)    new T[count]

Allocate a block of memory for 'count' primitive types - do not use for classes that inherit from AllocatedObject.

◆ OGRE_DELETE_T

#define OGRE_DELETE_T (   ptr,
  T,
  category 
)    delete ptr

Free the memory allocated with OGRE_NEW_T. Category is required to be restated to ensure the matching policy is used.

Referenced by Ogre::SPFMDeleteT::operator()(), and Ogre::Any::reset().

◆ OGRE_DELETE_ARRAY_T

#define OGRE_DELETE_ARRAY_T (   ptr,
  T,
  count,
  category 
)    delete[] ptr

Free the memory allocated with OGRE_NEW_ARRAY_T. Category is required to be restated to ensure the matching policy is used, count and type to call destructor.

◆ OGRE_MALLOC_SIMD

#define OGRE_MALLOC_SIMD (   bytes,
  category 
)    ::Ogre::AlignedMemory::allocate(bytes)

Allocate a block of raw memory aligned to SIMD boundaries, and indicate the category of usage.

◆ OGRE_FREE_SIMD

#define OGRE_FREE_SIMD (   ptr,
  category 
)    ::Ogre::AlignedMemory::deallocate((void*)ptr)

Free the memory allocated with either OGRE_MALLOC_SIMD or OGRE_ALLOC_T_SIMD. Category is required to be restated to ensure the matching policy is used.

◆ OGRE_NEW

◆ OGRE_DELETE

Typedef Documentation

◆ RGBA

typedef uint32 Ogre::RGBA

◆ ARGB

typedef uint32 Ogre::ARGB

◆ ABGR

typedef uint32 Ogre::ABGR

◆ BGRA

typedef uint32 Ogre::BGRA

◆ TrackVertexColourType

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

◆ LightList

◆ UnaryOptionList

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

◆ BinaryOptionList

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

◆ NameValuePairList

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

◆ AliasTextureNamePairList

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

◆ FloatRect

typedef TRect<float> Ogre::FloatRect

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

◆ RealRect

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

◆ Rect

typedef TRect< long > Ogre::Rect

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

◆ RenderWindowDescriptionList

Render window creation parameters container.

◆ RenderWindowList

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

Render window container.

◆ ConfigOptionMap

◆ ControllerValueRealPtr

◆ ControllerFunctionRealPtr

◆ RenderSystemList

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

◆ ConcreteNodePtr

◆ ConcreteNodeList

◆ ConcreteNodeListPtr

◆ AbstractNodePtr

◆ AbstractNodeList

◆ AbstractNodeListPtr

◆ _StringHash

typedef ::std::hash< _StringBase > Ogre::_StringHash

◆ ParameterList

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

◆ ParamCommandMap

◆ ParamDictionaryMap

◆ StringVector

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

◆ StringVectorPtr

Enumeration Type Documentation

◆ CompareFunction

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

Enumerator
CMPF_ALWAYS_FAIL 

Never writes a pixel to the render target.

CMPF_ALWAYS_PASS 

Always writes a pixel to the render target.

CMPF_LESS 

Write if (new_Z < existing_Z)

CMPF_LESS_EQUAL 

Write if (new_Z <= existing_Z)

CMPF_EQUAL 

Write if (new_Z == existing_Z)

CMPF_NOT_EQUAL 

Write if (new_Z != existing_Z)

CMPF_GREATER_EQUAL 

Write if (new_Z >= existing_Z)

CMPF_GREATER 

Write if (new_Z >= existing_Z)

◆ TextureFilterOptions

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

Enumerator
TFO_NONE 

No filtering or mipmapping is used.

Equal to: min=Ogre::FO_POINT, mag=Ogre::FO_POINT, mip=Ogre::FO_NONE

TFO_BILINEAR 

2x2 box filtering is performed when magnifying or reducing a texture, and a mipmap is picked from the list but no filtering is done between the levels of the mipmaps.

Equal to: min=Ogre::FO_LINEAR, mag=Ogre::FO_LINEAR, mip=Ogre::FO_POINT

TFO_TRILINEAR 

2x2 box filtering is performed when magnifying and reducing a texture, and the closest 2 mipmaps are filtered together.

Equal to: min=Ogre::FO_LINEAR, mag=Ogre::FO_LINEAR, mip=Ogre::FO_LINEAR

TFO_ANISOTROPIC 

This is the same as ’trilinear’, except the filtering algorithm takes account of the slope of the triangle in relation to the camera rather than simply doing a 2x2 pixel filter in all cases.

Equal to: min=Ogre::FO_ANISOTROPIC, max=Ogre::FO_ANISOTROPIC, mip=Ogre::FO_LINEAR

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

◆ FilterOptions

Filtering options for textures / mipmaps.

Enumerator
FO_NONE 

No filtering, used for FT_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.

Note that in order for this to make any difference, you must also set the TextureUnitState::setTextureAnisotropy attribute too.

◆ TextureAddressingMode

Texture addressing modes - default is TAM_WRAP.

Enumerator
TAM_WRAP 

Any value beyond 1.0 wraps back to 0.0. Texture is repeated.

TAM_MIRROR 

Texture flips every boundary, meaning texture is mirrored every 1.0 u or v

TAM_CLAMP 

Values beyond 1.0 are clamped to 1.0.

Texture ’streaks’ beyond 1.0 since last line of pixels is used across the rest of the address space. Useful for textures which need exact coverage from 0.0 to 1.0 without the ’fuzzy edge’ wrap gives when combined with filtering.

TAM_BORDER 

Texture coordinates outside the range [0.0, 1.0] are set to the border colour.

TAM_UNKNOWN 

Unknown.

◆ ShadeOptions

Light shading modes.

Enumerator
SO_FLAT 

No interpolation takes place. Each face is shaded with a single colour determined from the first vertex in the face.

SO_GOURAUD 

Colour at each vertex is linearly interpolated across the face.

SO_PHONG 

Vertex normals are interpolated across the face, and these are used to determine colour at each pixel. Gives a more natural lighting effect but is more expensive and works better at high levels of tessellation. Not supported on all hardware.

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

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

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

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

◆ PolygonMode

The polygon mode to use when rasterising.

Enumerator
PM_POINTS 

Only the points of each polygon are rendered.

PM_WIREFRAME 

Polygons are drawn in outline only.

PM_SOLID 

The normal situation - polygons are filled in.

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

◆ TrackVertexColourEnum

Enumerator
TVC_NONE 
TVC_AMBIENT 
TVC_DIFFUSE 
TVC_SPECULAR 
TVC_EMISSIVE 

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

◆ FrameBufferType

Defines the frame buffer types.

Enumerator
FBT_COLOUR 
FBT_DEPTH 
FBT_STENCIL 

◆ ColourBufferType

Defines the colour buffer types.

Enumerator
CBT_BACK 
CBT_BACK_LEFT 
CBT_BACK_RIGHT 

◆ StereoModeType

Defines the stereo mode types.

Enumerator
SMT_NONE 
SMT_FRAME_SEQUENTIAL 

◆ InstanceManagerFlags

Flags for the Instance Manager when calculating ideal number of instances per batch.

Enumerator
IM_USE16BIT 

Forces an amount of instances per batch low enough so that vertices * numInst < 65535 since usually improves performance.

In HW instanced techniques, this flag is ignored

IM_VTFBESTFIT 

The num.

of instances is adjusted so that as few pixels as possible are wasted in the vertex texture

IM_VTFBONEMATRIXLOOKUP 

Use a limited number of skeleton animations shared among all instances.

Update only that limited amount of animations in the vertex texture.

IM_USEBONEDUALQUATERNIONS 
IM_USEONEWEIGHT 

Use one weight per vertex when recommended (i.e.

VTF).

IM_FORCEONEWEIGHT 

All techniques are forced to one weight per vertex.

IM_USEALL 

◆ ClipResult

Generic result of clipping.

Enumerator
CLIPPED_NONE 

Nothing was clipped.

CLIPPED_SOME 

Partially clipped.

CLIPPED_ALL 

Everything was clipped away.

◆ LoggingLevel

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

Enumerator
LL_LOW 
LL_NORMAL 
LL_BOREME 

◆ LogMessageLevel

The importance of a logged message.

Enumerator
LML_TRIVIAL 
LML_NORMAL 
LML_WARNING 
LML_CRITICAL 

◆ MemoryCategory

A set of categories that indicate the purpose of a chunk of memory being allocated.

These categories will be provided at allocation time in order to allow the allocation policy to vary its behaviour if it wishes. This allows you to use a single policy but still have variant behaviour. The level of control it gives you is at a higher level than assigning different policies to different classes, but is the only control you have over general allocations that are primitive types.

Enumerator
MEMCATEGORY_GENERAL 

General purpose.

MEMCATEGORY_GEOMETRY 

Geometry held in main memory.

MEMCATEGORY_ANIMATION 

Animation data like tracks, bone matrices.

MEMCATEGORY_SCENE_CONTROL 

Nodes, control data.

MEMCATEGORY_SCENE_OBJECTS 

Scene object instances.

MEMCATEGORY_RESOURCE 

Other resources.

MEMCATEGORY_SCRIPTING 

Scripting.

MEMCATEGORY_RENDERSYS 

Rendersystem structures.

MEMCATEGORY_COUNT 

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

◆ 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 

◆ 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 

◆ anonymous enum

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_CASTER_FRAGMENT_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_LIGHT_MASK 
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_2DARRAY 
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_CMPTEST 
ID_ON 
ID_OFF 
ID_CMPFUNC 
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_DEPTH_POOL 
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_READ_BACK_AS_TEXTURE 
ID_TESSELLATION_HULL_PROGRAM 
ID_TESSELLATION_DOMAIN_PROGRAM 
ID_COMPUTE_PROGRAM 
ID_TESSELLATION_HULL_PROGRAM_REF 
ID_TESSELLATION_DOMAIN_PROGRAM_REF 
ID_COMPUTE_PROGRAM_REF 
ID_GEOMETRY 
ID_TESSELLATION_HULL 
ID_TESSELLATION_DOMAIN 
ID_COMPUTE 
ID_SUBROUTINE 
ID_LINE_WIDTH 
ID_SAMPLER 
ID_SAMPLER_REF 
ID_THREAD_GROUPS 
ID_RENDER_CUSTOM 
ID_END_BUILTIN_IDS 

◆ 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 

Function Documentation

◆ any_cast() [1/3]

template<typename ValueType >
ValueType* Ogre::any_cast ( Any operand)

References Ogre::Any::type().

◆ any_cast() [2/3]

template<typename ValueType >
const ValueType* Ogre::any_cast ( const Any operand)

References Ogre::Any::any_cast.

◆ any_cast() [3/3]

template<typename ValueType >
ValueType Ogre::any_cast ( const Any operand)

References Ogre::Any::any_cast.

◆ FastHash()

uint32 Ogre::FastHash ( const char *  data,
size_t  len,
uint32  hashSoFar = 0 
)
inline

Fast general hashing algorithm.

Referenced by Ogre::HashCombine().

◆ HashCombine()

template<typename T >
uint32 Ogre::HashCombine ( uint32  hashSoFar,
const T &  data 
)

Combine hashes with same style as boost::hash_combine.

References Ogre::FastHash().

◆ operator<<()

◆ findCommandLineOpts()

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,argvThe standard parameters passed to the main method
unaryOptListMap 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.
binOptListMap 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.

Referenced by Ogre::Box::getDepth().

◆ swap()

template<class T >
void Ogre::swap ( ComPtr< T > &  a,
ComPtr< T > &  b 
)

◆ operator==()

template<class T >
bool Ogre::operator== ( const ComPtr< T > &  a,
const ComPtr< T > &  b 
)

◆ operator!=()

template<class T >
bool Ogre::operator!= ( const ComPtr< T > &  a,
const ComPtr< T > &  b 
)

◆ operator<()

template<class T >
bool Ogre::operator< ( const ComPtr< T > &  a,
const ComPtr< T > &  b 
)

◆ operator>()

template<class T >
bool Ogre::operator> ( const ComPtr< T > &  a,
const ComPtr< T > &  b 
)

◆ operator<=()

template<class T >
bool Ogre::operator<= ( const ComPtr< T > &  a,
const ComPtr< T > &  b 
)

◆ operator>=()

template<class T >
bool Ogre::operator>= ( const ComPtr< T > &  a,
const ComPtr< T > &  b 
)

Variable Documentation

◆ BLANKSTRING

◆ SPFM_DELETE_T

const SPFMDeleteT Ogre::SPFM_DELETE_T

◆ SPFM_NONE

const SPFMNone Ogre::SPFM_NONE