# Ogre Namespace Reference

## Classes

class | Animation
| An animation sequence. More...
class | AnimationState
| Represents the state of an animation and the weight of it's influence. More...
class | AnimationTrack
| A 'track' in an animation sequence, ie a sequence of keyframes which affect a certain type of animable object. More...
struct | FileInfo
| Information about a file/directory within the archive will be returned using a FileInfo struct. More...
class | Archive
| Archive-handling class. More...
class | ArchiveFactory
| Abstract factory class, archive codec plugins can register concrete subclasses of this. More...
class | ArchiveManager
| This class manages the available ArchiveFactory plugins. More...
class | AutoParamDataSource
| This utility class is used to hold the information used to generate the matrices and other information required to automatically populate GpuProgramParameters. More...
class | AxisAlignedBox
| A 3D box aligned with the x/y/z axes. More...
class | Billboard
| A billboard is a primitive which always faces the camera in every frame. More...
class | BillboardParticleRenderer
| Specialisation of ParticleSystemRenderer to render particles using a BillboardSet. More...
class | BillboardParticleRenderer::CmdBillboardType
| Command object for billboard type (see ParamCommand). More...
class | BillboardParticleRenderer::CmdCommonDirection
| Command object for common direction (see ParamCommand). More...
class | BillboardParticleRendererFactory
| Factory class for BillboardParticleRenderer. More...
class | BillboardSet
| A collection of billboards (faces which are always facing the camera) with the same (default) dimensions, material and which are fairly close proximity to each other. More...
class | Bitwise
| Class for manipulating bit patterns. More...
class | LayerBlendModeEx
| Class which manages blending of both colour and alpha components. More...
class | Bone
| A bone in a skeleton. More...
class | BorderPanelOverlayElement
| A specialisation of the PanelOverlayElement to provide a panel with a border. More...
class | BorderPanelOverlayElement::CmdBorderSize
| Command object for specifying border sizes (see ParamCommand). More...
class | BorderPanelOverlayElement::CmdBorderMaterial
| Command object for specifying the Material for the border (see ParamCommand). More...
class | BorderPanelOverlayElement::CmdBorderLeftUV
| Command object for specifying texture coordinates for the border (see ParamCommand). More...
class | BorderPanelOverlayElement::CmdBorderTopUV
| Command object for specifying texture coordinates for the border (see ParamCommand). More...
class | BorderPanelOverlayElement::CmdBorderRightUV
| Command object for specifying texture coordinates for the border (see ParamCommand). More...
class | BorderPanelOverlayElement::CmdBorderBottomUV
| Command object for specifying texture coordinates for the border (see ParamCommand). More...
class | BorderPanelOverlayElement::CmdBorderTopLeftUV
| Command object for specifying texture coordinates for the border (see ParamCommand). More...
class | BorderPanelOverlayElement::CmdBorderBottomLeftUV
| Command object for specifying texture coordinates for the border (see ParamCommand). More...
class | BorderPanelOverlayElement::CmdBorderBottomRightUV
| Command object for specifying texture coordinates for the border (see ParamCommand). More...
class | BorderPanelOverlayElement::CmdBorderTopRightUV
| Command object for specifying texture coordinates for the border (see ParamCommand). More...
struct | BorderPanelOverlayElement::CellUV
class | BorderRenderable
| Class for rendering the border of a BorderPanelOverlayElement. More...
class | Camera
| A viewpoint from which the scene will be rendered. More...
class | Codec
| Abstract class that defines a 'codec'. More...
class | Codec::CodecData
class | ColourValue
| Class representing colour. More...
struct | Rect
| Structure used to define a rectangle in a 2-D integer space. More...
struct | Box
| Structure used to define a box in a 3-D integer space. More...
class | ConfigDialog
| Defines the behaviour of an automatic renderer configuration dialog. More...
class | ConfigFile
| Class for quickly loading settings from a text file. More...
struct | _ConfigOption
| Packages the details of a configuration option. More...
class | ControllerFunction
| Subclasses of this class are responsible for performing a function on an input value for a Controller. More...
class | ControllerValue
| Can either be used as an input or output value. More...
class | Controller
| Instances of this class 'control' the value of another object in the system. More...
class | ControllerManager
| Class for managing Controller instances. More...
class | Cursor
| The Cursor is an non-visual object that contains a the XYZ values that are modified by a InputReader. More...
class | DataStream
| General purpose class used for encapsulating the reading of data. More...
class | MemoryDataStream
| Common subclass of DataStream for handling data from chunks of memory. More...
class | FileStreamDataStream
| Common subclass of DataStream for handling data from std::basic_istream. More...
class | FileHandleDataStream
| Common subclass of DataStream for handling data from C-style file handles. More...
class | DefaultHardwareVertexBuffer
| Specialisation of HardwareVertexBuffer for emulation. More...
class | DefaultHardwareIndexBuffer
| Specialisation of HardwareIndexBuffer for emulation. More...
class | DefaultHardwareBufferManager
| Specialisation of HardwareBufferManager to emulate hardware buffers. More...
class | DynLib
| Resource holding data about a dynamic library. More...
class | DynLibManager
| Manager for Dynamic-loading Libraries. More...
class | EdgeData
| This class contains the information required to describe the edge connectivity of a given set of vertices and indexes. More...
struct | EdgeData::Triangle
| Basic triangle structure. More...
struct | EdgeData::Edge
| Edge data. More...
struct | EdgeData::EdgeGroup
| A group of edges sharing the same vertex data. More...
class | EdgeListBuilder
| General utility class for building edge lists for geometry. More...
struct | EdgeListBuilder::CommonVertex
| A vertex can actually represent several vertices in the final model, because vertices along texture seams etc will have been duplicated. More...
struct | EdgeListBuilder::Geometry
| A set of indexed geometry data. More...
struct | EdgeListBuilder::geometryLess
| Comparator for sorting geometries by vertex set. More...
struct | EdgeListBuilder::vectorLess
| Comparator for unique vertex list. More...
class | Entity
| Defines an instance of a discrete, movable object based on a Mesh. More...
class | Entity::EntityShadowRenderable
| Nested class to allow entity shadows. More...
class | ErrorDialog
| Class for displaying the error dialog if Ogre fails badly. More...
class | EventDispatcher
| Handles the Dispatching of events to a EventTarget (mainly a PositionTarget for mouse moving). More...
class | EventListener
class | MouseListener
| Specialised EventListener for discrete mouse events. More...
class | KeyListener
class | MouseMotionListener
| Specialised EventListener for mouse motion. More...
class | EventProcessor
| The EventProcessor controls getting events, storing them in a queue, and dispatching events. More...
class | EventQueue
| This class holds InputEvents given to it by the EventProcessor in a FIFO queue. More...
class | EventTarget
| This is an abstract class that is the base class of all consumers of InputEvent instances. More...
class | Exception
| When thrown, provides information about an error that has occurred inside the engine. More...
class | AutomaticGuardUnguard
| Internal class. More...
class | ExternalTextureSource
| IMPORTANT: **Plugins must override default dictionary name!** Base class that texture plugins derive from. More...
class | ExternalTextureSource::CmdInputFileName
class | ExternalTextureSource::CmdFPS
class | ExternalTextureSource::CmdPlayMode
class | ExternalTextureSource::CmdTecPassState
class | ExternalTextureSourceManager
| Singleton Class which handles the registering and control of texture plugins. More...
class | FactoryObj
| Abstract factory class. More...
class | FileSystemArchive
| Specialisation of the Archive class to allow reading of files from filesystem folders / directories. More...
class | FileSystemArchiveFactory
| Specialisation of ArchiveFactory for FileSystem files. More...
class | Font
| Class representing a font in the system. More...
class | Font::CmdType
| Command object for Font - see ParamCommand. More...
class | Font::CmdSource
| Command object for Font - see ParamCommand. More...
class | Font::CmdSize
| Command object for Font - see ParamCommand. More...
class | Font::CmdResolution
| Command object for Font - see ParamCommand. More...
class | FontPtr
| Specialisation of SharedPtr to allow SharedPtr to be assigned to FontPtr. More...
class | FontManager
| Manages Font resources, parsing .fontdef files and generally organising them. More...
struct | FrameEvent
| Struct containing information about a frame event. More...
class | FrameListener
| A interface class defining a listener which can be used to receive notifications of frame events. More...
class | Frustum
| A frustum represents a pyramid, capped at the near and far end which is used to represent either a visible area or a projection area. More...
class | GpuProgramParameters
| Collects together the program parameters used for a GpuProgram. More...
class | GpuProgramParameters::AutoConstantEntry
| Structure recording the use of an automatic parameter. More...
struct | GpuProgramParameters::RealConstantEntry
| Real parameter entry; contains both a group of 4 values and an indicator to say if it's been set or not. More...
struct | GpuProgramParameters::IntConstantEntry
| Int parameter entry; contains both a group of 4 values and an indicator to say if it's been set or not. More...
class | GpuProgram
| Defines a program which runs on the GPU such as a vertex or fragment program. More...
class | GpuProgram::CmdType
| Command object - see ParamCommand. More...
class | GpuProgram::CmdSyntax
class | GpuProgram::CmdSkeletal
class | GpuProgramPtr
| Specialisation of SharedPtr to allow SharedPtr to be assigned to GpuProgramPtr. More...
class | GpuProgramManager
class | GpuProgramUsage
| This class makes the usage of a vertex and fragment programs (low-level or high-level), with a given set of parameters, explicit. More...
class | HardwareBuffer
| Abstract class defining common features of hardware buffers. More...
class | HardwareBufferLicensee
| Abtract interface representing a 'licensee' of a hardware buffer copy. More...
class | TempBlendedBufferInfo
| Structure for recording the use of temporary blend buffers. More...
class | HardwareBufferManager
| Abstract singleton class for managing hardware buffers, a concrete instance of this will be created by the RenderSystem. More...
class | HardwareBufferManager::VertexBufferLicense
| Struct holding details of a license to use a temporary shared buffer. More...
class | HardwareIndexBuffer
| Specialisation of HardwareBuffer for vertex index buffers, still abstract. More...
class | HardwareIndexBufferSharedPtr
| Shared pointer implementation used to share index buffers. More...
class | HardwareOcclusionQuery
| This is a abstract class that that provides the interface for the query class for hardware occlusion. More...
class | HardwarePixelBuffer
| Specialisation of HardwareBuffer for a pixel buffer. More...
class | HardwarePixelBufferSharedPtr
| Shared pointer implementation used to share pixel buffers. More...
class | HardwareVertexBuffer
| Specialisation of HardwareBuffer for a vertex buffer. More...
class | HardwareVertexBufferSharedPtr
| Shared pointer implementation used to share index buffers. More...
class | VertexElement
| This class declares the usage of a single vertex buffer as a component of a complete VertexDeclaration. More...
class | VertexDeclaration
| This class declares the format of a set of vertex inputs, which can be issued to the rendering API through a RenderOperation. More...
class | VertexBufferBinding
| Records the state of all the vertex buffer bindings required to provide a vertex declaration with the input data it needs for the vertex elements. More...
class | HighLevelGpuProgram
| Abstract base class representing a high-level program (a vertex or fragment program). More...
class | HighLevelGpuProgramPtr
| Specialisation of SharedPtr to allow SharedPtr to be assigned to HighLevelGpuProgramPtr. More...
class | HighLevelGpuProgramFactory
| Interface definition for factories of HighLevelGpuProgram. More...
class | HighLevelGpuProgramManager
| This ResourceManager manages high-level vertex and fragment programs. More...
class | ILCodecs
class | ILImageCodec
| Codec specialized in images loaded using DevIL. More...
class | ILUtil
struct | ILUtil::ILFormat
| Structure that encapsulates a devIL image format definition. More...
class | Image
| Class representing an image file. More...
class | ImageCodec
| Codec specialized in images. More...
class | ImageCodec::ImageData
| Codec return class for images. More...
struct | MouseState
| Structure representing a snapshot of the state of the mouse input controller. More...
class | InputReader
| Abstract class which allows input to be read from various controllers. More...
class | InputEvent
| The root event class for all GuiElement-level input events. More...
class | VectorIterator
| Wraps iteration over a vector. More...
class | MapIterator
| Wraps iteration over a map. More...
class | ConstVectorIterator
| Wraps iteration over a const vector. More...
class | ConstMapIterator
| Wraps iteration over a const map. More...
class | KeyEvent
class | KeyFrame
| A key frame in an animation sequence defined by an AnimationTrack. More...
class | KeyTarget
class | Light
| Representation of a dynamic light source in the scene. More...
class | Log
| Log class for writing debug/log data to files. More...
class | LogListener
| The log listener is here to provide alternate means to write out log data. More...
class | LogManager
| The log manager handles the creation and retrieval of logs for the application. More...
class | Material
| Class encapsulates rendering properties of an object. More...
class | MaterialPtr
| Specialisation of SharedPtr to allow SharedPtr to be assigned to MaterialPtr. More...
class | MaterialManager
| Class for managing Material settings for Ogre. More...
struct | MaterialScriptProgramDefinition
| Struct for holding a program definition which is in progress. More...
struct | MaterialScriptContext
| Struct for holding the script context while parsing. More...
class | MaterialSerializer
| Class for serializing Materials to / from a .material script. More...
class | Radian
| Wrapper class which indicates a given angle value is in Radians. More...
class | Degree
| Wrapper class which indicates a given angle value is in Degrees. More...
class | Angle
| Wrapper class which identifies a value as the currently default angle type, as defined by Math::setAngleUnit. More...
class | Math
| Class to provide access to common mathematical functions. More...
class | Matrix3
| A 3x3 matrix which can represent rotations around axes. More...
class | Matrix4
| Class encapsulating a standard 4x4 homogenous matrix. More...
class | MemoryManager
| See the The memory manager information page. More...
class | Mesh
class | MeshPtr
| Specialisation of SharedPtr to allow SharedPtr to be assigned to MeshPtr. More...
struct | MeshLodUsage
| A way of recording the way each LODs is recorded this Mesh. More...
class | MeshManager
| Handles the management of mesh resources. More...
struct | MeshManager::MeshBuildParams
| Saved parameters used to (re)build a manual mesh built by this class. More...
class | MeshSerializer
| Class for serialising mesh data to/from an OGRE .mesh file. More...
class | MeshSerializerImpl
| Internal implementation of Mesh reading / writing for the latest version of the .mesh format. More...
class | MeshSerializerImpl_v1_2
| Class for providing backwards-compatibility for loading version 1.2 of the .mesh format. More...
class | MeshSerializerImpl_v1_1
| Class for providing backwards-compatibility for loading version 1.1 of the .mesh format. More...
class | MouseEvent
| An event which indicates that a mouse action occurred in a MouseTarget (e.g. More...
class | MouseMotionTarget
| Handles the adding and removing of MouseMotionListeners. More...
class | MouseTarget
| Handles the adding and removing of MouseListeners. More...
class | MovableObject
| Abstract class definining a movable object in a scene. More...
class | MovablePlane
| Definition of a Plane that may be attached to a node, and the derived details of it retrieved simply. More...
class | Node
| Class representing a general-purpose node an articulated scene graph. More...
class | Overlay
| Represents a layer which is rendered on top of the 'normal' scene contents. More...
class | OverlayContainer
| A 2D element which contains other OverlayElement instances. More...
class | OverlayElement
| Abstract definition of a 2D element to be displayed in an Overlay. More...
class | OverlayElementFactory
| Defines the interface which all components wishing to supply OverlayElement subclasses must implement. More...
class | PanelOverlayElementFactory
| Factory for creating PanelOverlayElement instances. More...
class | BorderPanelOverlayElementFactory
| Factory for creating BorderPanelOverlayElement instances. More...
class | TextAreaOverlayElementFactory
| Factory for creating TextAreaOverlayElement instances. More...
class | OverlayManager
| Manages Overlay objects, parsing them from .overlay files and storing a lookup library of them. More...
class | PanelOverlayElement
| OverlayElement representing a flat, single-material (or transparent) panel which can contain other elements. More...
class | PanelOverlayElement::CmdTiling
| Command object for specifying tiling (see ParamCommand). More...
class | PanelOverlayElement::CmdTransparent
| Command object for specifying transparency (see ParamCommand). More...
class | ParticleVisualData
| Abstract class containing any additional data required to be associated with a particle to perform the required rendering. More...
class | Particle
| Class representing a single particle instance. More...
class | ParticleAffector
| Abstract class defining the interface to be implemented by particle affectors. More...
class | ParticleAffectorFactory
| Abstract class defining the interface to be implemented by creators of ParticleAffector subclasses. More...
class | ParticleEmitter
| Abstract class defining the interface to be implemented by particle emitters. More...
class | ParticleEmitterFactory
| Abstract class defining the interface to be implemented by creators of ParticleEmitter subclasses. More...
class | ParticleIterator
| Convenience class to make it easy to step through all particles in a ParticleSystem. More...
class | ParticleSystem
| Class defining particle system based special effects. More...
class | ParticleSystem::CmdQuota
| Command object for quota (see ParamCommand). More...
class | ParticleSystem::CmdMaterial
| Command object for material (see ParamCommand). More...
class | ParticleSystem::CmdCull
| Command object for cull_each (see ParamCommand). More...
class | ParticleSystem::CmdWidth
| Command object for particle_width (see ParamCommand). More...
class | ParticleSystem::CmdHeight
| Command object for particle_height (see ParamCommand). More...
class | ParticleSystem::CmdRenderer
| Command object for renderer (see ParamCommand). More...
class | ParticleSystemManager
| Manages particle systems, particle system scripts (templates) and the available emitter & affector factories. More...
class | ParticleSystemRenderer
| Abstract class defining the interface required to be implemented by classes which provide rendering capability to ParticleSystem instances. More...
class | ParticleSystemRendererFactory
| Abstract class definition of a factory object for ParticleSystemRenderer. More...
class | Pass
| Class defining a single pass of a Technique (of a Material), ie a single rendering call. More...
struct | IlluminationPass
| Struct recording a pass which can be used for a specific illumination stage. More...
class | PatchMesh
| Patch specialisation of Mesh. More...
class | PatchMeshPtr
| Specialisation of SharedPtr to allow SharedPtr to be assigned to PatchMeshPtr. More...
class | PatchSurface
| A surface which is defined by curves of some kind to form a patch, e.g. More...
class | PixelBox
| A primitive describing a volume (3D), image (2D) or line (1D) of pixels in memory. More...
class | PixelUtil
| Some utility functions for packing and unpacking pixel data. More...
class | Plane
| Defines a plane in 3D space. More...
class | PlaneBoundedVolume
| Represents a convex volume bounded by planes. More...
class | PlatformManager
| Class which manages the platform settings Ogre runs on. More...
class | PositionTarget
class | FrameTimeControllerValue
| Predefined controller value for getting the latest frame time. More...
class | TextureFrameControllerValue
| Predefined controller value for getting / setting the frame number of a texture layer. More...
class | TexCoordModifierControllerValue
| Predefined controller value for getting / setting a texture coordinate modifications (scales and translates). More...
class | FloatGpuParameterControllerValue
| Predefined controller value for setting a single floating- point value in a constant paramter of a vertex or fragment program. More...
class | AnimationControllerFunction
| Predefined controller function for dealing with animation. More...
class | ScaleControllerFunction
| Predefined controller function which simply scales an input to an output value. More...
class | WaveformControllerFunction
| Predefined controller function based on a waveform. More...
class | Profile
| An individual profile that will be processed by the Profiler. More...
class | Profiler
| The profiler allows you to measure the performance of your code. More...
struct | Profiler::ProfileInstance
| Represents an individual profile call. More...
struct | Profiler::ProfileFrame
| Represents the total timing information of a profile since profiles can be called more than once each frame. More...
struct | Profiler::ProfileHistory
| Represents a history of each profile during the duration of the app. More...
class | ProgressiveMesh
| This class reduces the complexity of the geometry it is given. More...
class | ProgressiveMesh::PMFaceVertex
| A vertex as used by a face. More...
class | ProgressiveMesh::PMTriangle
| A triangle in the progressive mesh, holds extra info like face normal. More...
class | ProgressiveMesh::PMVertex
| A vertex in the progressive mesh, holds info like collapse cost etc. More...
struct | ProgressiveMesh::PMWorkingData
| Data used to calculate the collapse costs. More...
class | Quaternion
| Implementation of a Quaternion, i.e. More...
class | Ray
| Representation of a ray in space, ie a line with an origin and direction. More...
struct | Rectangle
class | Rectangle2D
| Allows the rendering of a simple 2D rectangle This class renders a simple 2D rectangle; this rectangle has no depth and therefore is best used with specific render queue and depth settings, like RENDER_QUEUE_BACKGROUND and 'depth_write off' for backdrops, and RENDER_QUEUE_OVERLAY and 'depth_check off' for fullscreen quads. More...
class | Renderable
| Abstract class defining the interface all renderable objects must implement. More...
class | RenderOperation
| 'New' rendering operation using vertex buffers. More...
class | RenderQueue
| Class to manage the scene object rendering queue. More...
class | RenderQueueListener
| Abstract interface which classes must implement if they wish to receive events from the render queue. More...
class | RenderPriorityGroup
| Renderables in the queue grouped by priority. More...
struct | RenderPriorityGroup::RenderablePass
| Internal struct reflecting a single Pass for a Renderable. More...
struct | RenderPriorityGroup::SolidQueueItemLess
| Comparator to order non-transparent object passes. More...
struct | RenderPriorityGroup::TransparentQueueItemLess
| Comparator to order transparent object passes. More...
class | RenderQueueGroup
| A grouping level underneath RenderQueue which groups renderables to be issued at coarsely the same time to the renderer. More...
class | RenderSystem
| Defines the functionality of a 3D API. More...
class | RenderSystem::Listener
| Defines a listener on the custom events that this render system can raise. More...
class | RenderSystemCapabilities
| singleton class for storing the capabilities of the graphics card. More...
class | RenderTarget
| A 'canvas' which can receive the results of a rendering operation. More...
struct | RenderTarget::FrameStats
struct | RenderTargetEvent
| Struct containing information about a RenderTarget event. More...
struct | RenderTargetViewportEvent
| Struct containing information about a RenderTarget Viewport-specific event. More...
class | RenderTargetListener
| A interface class defining a listener which can be used to receive notifications of RenderTarget events. More...
class | RenderTargetTexture
class | RenderTexture
class | RenderWindow
| Manages the target rendering window. More...
class | Resource
| Abstract class reprensenting a loadable resource (e.g. More...
class | ManualResourceLoader
| Interface describing a manual resource loader. More...
class | ResourceBackgroundQueueListener
| This abstract listener interface lets you get immediate notifications of completed background processes instead of having to check ticket statuses. More...
class | ResourceBackgroundQueue
| This class is used to perform Resource operations in a background thread. More...
struct | ResourceBackgroundQueue::Request
| Encapsulates a queued request for the background queue. More...
class | ResourceGroupListener
| This abstract class defines an interface which is called back during resource group loading to indicate the progress of the load. More...
class | ResourceGroupManager
| This singleton class manages the list of resource groups, and notifying the various resource managers of their obligations to load / unload resources in a group. More...
struct | ResourceGroupManager::ResourceDeclaration
| Nested struct defining a resource declaration. More...
struct | ResourceGroupManager::ResourceLocation
| Resource location entry. More...
struct | ResourceGroupManager::ResourceGroup
| Resource group entry. More...
class | ResourceManager
| Defines a generic resource handler. More...
class | Root
| The root class of the Ogre system. More...
class | RotationalSpline
| This class interpolates orientations (rotations) along a spline using derivatives of quaternions. More...
struct | ViewPoint
| Structure for holding a position & orientation pair. More...
class | SceneManager
| Manages the rendering of a 'scene' i.e. More...
struct | SceneManager::materialLess
| Comparator for material map, for sorting materials into render order (e.g. More...
struct | SceneManager::lightLess
| Comparator for sorting lights relative to a point. More...
class | SceneManager::ShadowCasterSceneQueryListener
| Inner class to use as callback for shadow caster scene query. More...
class | DefaultIntersectionSceneQuery
| Default implementation of IntersectionSceneQuery. More...
class | DefaultRaySceneQuery
| Default implementation of RaySceneQuery. More...
class | DefaultSphereSceneQuery
| Default implementation of SphereSceneQuery. More...
class | DefaultPlaneBoundedVolumeListSceneQuery
| Default implementation of PlaneBoundedVolumeListSceneQuery. More...
class | DefaultAxisAlignedBoxSceneQuery
| Default implementation of AxisAlignedBoxSceneQuery. More...
class | SceneManagerEnumerator
| Enumerates the SceneManager classes available to applications. More...
class | SceneNode
| Class representing a node in the scene graph. More...
class | SceneQuery
| A class for performing queries on a scene. More...
struct | SceneQuery::WorldFragment
| Represents part of the world geometry that is a result of a SceneQuery. More...
class | SceneQueryListener
| This optional class allows you to receive per-result callbacks from SceneQuery executions instead of a single set of consolidated results. More...
struct | SceneQueryResult
| Holds the results of a scene query. More...
class | RegionSceneQuery
| Abstract class defining a query which returns single results from a region. More...
class | AxisAlignedBoxSceneQuery
| Specialises the SceneQuery class for querying within an axis aligned box. More...
class | SphereSceneQuery
| Specialises the SceneQuery class for querying within a sphere. More...
class | PlaneBoundedVolumeListSceneQuery
| Specialises the SceneQuery class for querying within a plane-bounded volume. More...
class | RaySceneQueryListener
| Alternative listener class for dealing with RaySceneQuery. More...
struct | RaySceneQueryResultEntry
| This struct allows a single comparison of result data no matter what the type. More...
class | RaySceneQuery
| Specialises the SceneQuery class for querying along a ray. More...
class | IntersectionSceneQueryListener
| Alternative listener class for dealing with IntersectionSceneQuery. More...
struct | IntersectionSceneQueryResult
| Holds the results of an intersection scene query (pair values). More...
class | IntersectionSceneQuery
| Separate SceneQuery class to query for pairs of objects which are possibly intersecting one another. More...
class | ScriptLoader
| Abstract class defining the interface used by classes which wish to perform script loading to define instances of whatever they manage. More...
class | Serializer
| Generic class for serialising data to / from binary stream-based files. More...
class | ShadowRenderable
| Class which represents the renderable aspects of a set of shadow volume faces. More...
class | ShadowCaster
| This class defines the interface that must be implemented by shadow casters. More...
class | ShadowVolumeExtrudeProgram
| Static class containing source for vertex programs for extruding shadow volumes. More...
class | SharedPtr
| Reference-counted shared pointer, used for objects where implicit destruction is required. More...
class | SimpleRenderable
class | SimpleSpline
| A very simple spline class which implements the Catmull-Rom class of splines. More...
class | Singleton
| Template class for creating single-instance global classes. More...
class | Skeleton
| A collection of Bone objects used to animate a skinned mesh. More...
class | SkeletonPtr
| Specialisation of SharedPtr to allow SharedPtr to be assigned to SkeletonPtr. More...
struct | LinkedSkeletonAnimationSource
| Link to another skeleton to share animations. More...
class | SkeletonInstance
| A SkeletonInstance is a single instance of a Skeleton used by a world object. More...
class | SkeletonManager
| Handles the management of skeleton resources. More...
class | SkeletonSerializer
| Class for serialising skeleton data to/from an OGRE .skeleton file. More...
class | Sphere
| A sphere primitive, mostly used for bounds checking. More...
struct | StaticFaceGroup
| Collectes a group of static ie immovable faces together which have common properties like the material they use, the plane they lie on. More...
class | StaticGeometry
| Pre-transforms and batches up meshes for efficient use as static geometry in a scene. More...
class | StaticGeometry::OptimisedSubMeshGeometry
| Struct holding geometry optimised per SubMesh / lod level, ready for copying to instances. More...
struct | StaticGeometry::SubMeshLodGeometryLink
| Saved link between SubMesh at a LOD and vertex/index data May point to original or optimised geometry. More...
struct | StaticGeometry::QueuedSubMesh
| Structure recording a queued submesh for the build. More...
struct | StaticGeometry::QueuedGeometry
| Structure recording a queued geometry for low level builds. More...
class | StaticGeometry::GeometryBucket
| A GeometryBucket is a the lowest level bucket where geometry with the same vertex & index format is stored. More...
class | StaticGeometry::MaterialBucket
| A MaterialBucket is a collection of smaller buckets with the same Material (and implicitly the same LOD). More...
class | StaticGeometry::LODBucket
| A LODBucket is a collection of smaller buckets with the same LOD. More...
class | StaticGeometry::Region
| The details of a topological region which is the highest level of partitioning for this class. More...
class | StaticGeometry::Region::RegionShadowRenderable
| Nested class to allow region shadows. More...
class | StringUtil
| Utility class for manipulating Strings. More...
class | StringConverter
| Class for converting the core Ogre data types to/from Strings. More...
class | ParameterDef
| Definition of a parameter supported by a StringInterface class, for introspection. More...
class | ParamCommand
| Abstract class which is command object which gets/sets parameters. More...
class | ParamDictionary
| Class to hold a dictionary of parameters for a single class. More...
class | StringInterface
| Class defining the common interface which classes can use to present a reflection-style, self-defining parameter set to callers. More...
class | SubEntity
| Utility class which defines the sub-parts of an Entity. More...
class | SubMesh
| Defines a part of a complete mesh. More...
class | TagPoint
| A tagged point on a skeleton, which can be used to attach entities to on specific other entities. More...
class | TargetManager
| An abstract interface, implemented by OverlayManager, to return a GuiElement at a given x,y position. More...
class | Technique
| Class representing an approach to rendering this particular Material. More...
class | TextAreaOverlayElement
| OverlayElement representing a flat, single-material (or transparent) panel which can contain other elements. More...
class | TextAreaOverlayElement::CmdCaption
| Command object for setting the caption. More...
class | TextAreaOverlayElement::CmdCharHeight
| Command object for setting the char height. More...
class | TextAreaOverlayElement::CmdSpaceWidth
| Command object for setting the width of a space. More...
class | TextAreaOverlayElement::CmdFontName
| Command object for setting the caption. More...
class | TextAreaOverlayElement::CmdColourTop
| Command object for setting the top colour. More...
class | TextAreaOverlayElement::CmdColourBottom
| Command object for setting the bottom colour. More...
class | TextAreaOverlayElement::CmdColour
| Command object for setting the constant colour. More...
class | TextAreaOverlayElement::CmdAlignment
| Command object for setting the alignment. More...
class | Texture
| Abstract class representing a Texture resource. More...
class | TexturePtr
| Specialisation of SharedPtr to allow SharedPtr to be assigned to TexturePtr. More...
class | TextureManager
| Class for loading & managing textures. More...
class | TextureUnitState
| Class representing the state of a single texture unit during a Pass of a Technique, of a Material. More...
struct | TextureUnitState::TextureEffect
| Internal structure defining a texture effect. More...
class | Timer
| Platform-independent Timer class. More...
class | UserDefinedObject
| This class is designed to be subclassed by OGRE users, to allow them to associate their own application objects with MovableObject instances in the engine. More...
class | Vector2
| Standard 2-dimensional vector. More...
class | Vector3
| Standard 3-dimensional vector. More...
class | Vector4
| 4-dimensional homogenous vector. More...
struct | VertexBoneAssignment_s
| Records the assignment of a single vertex to a single bone with the corresponding weight. More...
class | VertexData
| Summary class collecting together vertex source information. More...
class | IndexData
| Summary class collecting together index data source information. More...
class | Viewport
| An abstraction of a viewport, i.e. More...
class | WireBoundingBox
| Allows the rendering of a wireframe bounding box. More...
class | ZipArchive
| Specialisation of the Archive class to allow reading of files from a zip format source archive. More...
class | ZipArchiveFactory
| Specialisation of ArchiveFactory for Zip files. More...
class | ZipDataStream
| Specialisation of DataStream to handle streaming data from zip archives. More...
struct | NearestResampler
struct | LinearResampler
struct | LinearResampler_Float32
struct | LinearResampler_Byte
class | GLXConfig
| Simple CLI config. More...
class | GLXError
| Simple CLI error output. More...
class | GLXInput
class | GLXTimer
class | SDLConfig
| Simple CLI config. More...
class | SDLConfig::ModelColumns
class | SDLError
| Simple CLI error output. More...
class | SDLInput
class | SDLTimer
class | Win32ConfigDialog
| A Windows 95/98/NT platform version of the default engine configuration dialog. More...
class | Win32ErrorDialog
| Windows-specific class for displaying the error dialog if Ogre fails badly! More...
class | Win32Input8
| Utility class for dealing with user input on a Win32 system. More...
class | Win32Timer
class | BspLevel
| Holds all the data associated with a Binary Space Parition (BSP) based indoor level. More...
struct | BspLevel::BspVertex
| Vertex format for fixed geometry. More...
struct | BspLevel::VisData
| Internal lookup table to determine visibility between leaves. More...
class | BspLevelPtr
| Specialisation of SharedPtr to allow SharedPtr to be assigned to BspLevelPtr. More...
class | BspNode
| Encapsulates a node in a BSP tree. More...
struct | BspNode::Brush
class | BspResourceManager
| Manages the locating and loading of BSP-based indoor levels. More...
class | BspSceneManager
| Specialisation of the SceneManager class to deal with indoor scenes based on a BSP tree. More...
class | BspIntersectionSceneQuery
| BSP specialisation of IntersectionSceneQuery. More...
class | BspRaySceneQuery
| BSP specialisation of RaySceneQuery. More...
class | BspSceneNode
| Specialisation of SceneNode for the BspSceneManager. More...
class | Quake3Level
| Support for loading and extracting data from a Quake3 level file. More...
class | Quake3Shader
| Class for recording Quake3 shaders. More...
struct | Quake3Shader::Pass
class | Quake3ShaderManager
| Class for managing Quake3 custom shaders. More...
class | CgProgram
| Specialisation of HighLevelGpuProgram to provide support for nVidia's CG language. More...
class | CgProgram::CmdEntryPoint
| Command object for setting entry point. More...
class | CgProgram::CmdProfiles
| Command object for setting profiles. More...
class | CgProgram::CmdArgs
| Command object for setting compilation arguments. More...
class | CgProgramFactory
| Factory class for Cg programs. More...
class | EXRCodec
| Codec specialized in loading OpenEXR high dynamic range images. More...
class | HeightmapTerrainPageSource
| Specialisation of the TerrainPageSource class to provide tiles loaded from a 2D greyscale image. More...
class | Octree
| Octree datastructure for managing scene nodes. More...
class | OctreeCamera
| Specialized viewpoint from which an Octree can be rendered. More...
class | OctreeNode
| Specialized SceneNode that is customized for working within an Octree. More...
class | OctreeSceneManager
| Specialized SceneManager that divides the geometry into an octree in order to faciliate spatial queries. More...
class | OctreeIntersectionSceneQuery
| Octree implementation of IntersectionSceneQuery. More...
class | OctreeRaySceneQuery
| Octree implementation of RaySceneQuery. More...
class | OctreeSphereSceneQuery
| Octree implementation of SphereSceneQuery. More...
class | OctreePlaneBoundedVolumeListSceneQuery
| Octree implementation of PlaneBoundedVolumeListSceneQuery. More...
class | OctreeAxisAlignedBoxSceneQuery
| Octree implementation of AxisAlignedBoxSceneQuery. More...
class | TerrainPage
| Groups a number of TerrainRenderables (tiles) into a page, which is the unit of loading / unloading. More...
class | TerrainPageSourceListener
| Abstract class which classes can override to receive notifications when a page is ready to be added to the terrain manager. More...
class | TerrainPageSourceListenerManager
| Simple manager class to hold onto a list of page source listeners across all sources. More...
class | TerrainPageSource
| Abstract class which describes the interface which a source of terrain pages must implement. More...
class | TerrainBufferCache
| A cache of TerrainIndexBuffers. More...
class | TerrainOptions
| A simple class for encapsulating parameters which are commonly needed by both TerrainSceneManager and TerrainRenderable. More...
class | TerrainRenderable
| Represents a terrain tile. More...
class | TerrainRaySceneQuery
| Default implementation of RaySceneQuery. More...
class | TerrainSceneManager
| This is a basic SceneManager for organizing TerrainRenderables into a total landscape. More...
class | TerrainVertexProgram
class | AreaEmitter
| Particle emitter which emits particles randomly from points inside an area (box, sphere, ellipsoid whatever subclasses choose to be). More...
class | AreaEmitter::CmdWidth
| Command object for area emitter size (see ParamCommand). More...
class | AreaEmitter::CmdHeight
| Command object for area emitter size (see ParamCommand). More...
class | AreaEmitter::CmdDepth
| Command object for area emitter size (see ParamCommand). More...
class | BoxEmitter
| Particle emitter which emits particles randomly from points inside a box. More...
class | BoxEmitterFactory
| Factory class for particle emitter of type "Box". More...
class | ColourFaderAffector
| This plugin subclass of ParticleAffector allows you to alter the colour of particles. More...
class | ColourFaderAffector::CmdRedAdjust
| Command object for red adjust (see ParamCommand). More...
class | ColourFaderAffector::CmdGreenAdjust
| Command object for green adjust (see ParamCommand). More...
class | ColourFaderAffector::CmdBlueAdjust
| Command object for blue adjust (see ParamCommand). More...
class | ColourFaderAffector::CmdAlphaAdjust
| Command object for alpha adjust (see ParamCommand). More...
class | ColourFaderAffector2
| This plugin subclass of ParticleAffector allows you to alter the colour of particles. More...
class | ColourFaderAffector2::CmdRedAdjust1
| Command object for red adjust (see ParamCommand). More...
class | ColourFaderAffector2::CmdGreenAdjust1
| Command object for green adjust (see ParamCommand). More...
class | ColourFaderAffector2::CmdBlueAdjust1
| Command object for blue adjust (see ParamCommand). More...
class | ColourFaderAffector2::CmdAlphaAdjust1
| Command object for alpha adjust (see ParamCommand). More...
class | ColourFaderAffector2::CmdRedAdjust2
| Command object for red adjust (see ParamCommand). More...
class | ColourFaderAffector2::CmdGreenAdjust2
| Command object for green adjust (see ParamCommand). More...
class | ColourFaderAffector2::CmdBlueAdjust2
| Command object for blue adjust (see ParamCommand). More...
class | ColourFaderAffector2::CmdAlphaAdjust2
| Command object for alpha adjust (see ParamCommand). More...
class | ColourFaderAffector2::CmdStateChange
| Command object for alpha adjust (see ParamCommand). More...
class | ColourFaderAffectorFactory
| Factory class for ColourFaderAffector. More...
class | ColourFaderAffectorFactory2
| Factory class for ColourFaderAffector. More...
class | ColourImageAffector
class | ColourImageAffector::CmdImageAdjust
| Command object for red adjust (see ParamCommand). More...
class | ColourImageAffectorFactory
| Factory class for ColourImageAffector. More...
class | ColourInterpolatorAffector
class | ColourInterpolatorAffector::CmdColourAdjust
| Command object for red adjust (see ParamCommand). More...
class | ColourInterpolatorAffector::CmdTimeAdjust
| Command object for red adjust (see ParamCommand). More...
class | ColourInterpolatorAffectorFactory
| Factory class for ColourInterpolatorAffector. More...
class | CylinderEmitter
| Particle emitter which emits particles randomly from points inside a cylinder. More...
class | CylinderEmitterFactory
| Factory class for particle emitter of type "Cylinder". More...
class | EllipsoidEmitter
| Particle emitter which emits particles randomly from points inside an ellipsoid. More...
class | EllipsoidEmitterFactory
| Factory class for particle emitter of type "Ellipsoid". More...
class | HollowEllipsoidEmitter
| Particle emitter which emits particles randomly from points inside a hollow ellipsoid. More...
class | HollowEllipsoidEmitter::CmdInnerX
| Command object for inner size (see ParamCommand). More...
class | HollowEllipsoidEmitter::CmdInnerY
| Command object for inner size (see ParamCommand). More...
class | HollowEllipsoidEmitter::CmdInnerZ
| Command object for inner size (see ParamCommand). More...
class | HollowEllipsoidEmitterFactory
| Factory class for particle emitter of type "HollowEllipsoid". More...
class | LinearForceAffector
| This class defines a ParticleAffector which applies a linear force to particles in a system. More...
class | LinearForceAffector::CmdForceVector
| Command object for force vector (see ParamCommand). More...
class | LinearForceAffector::CmdForceApp
| Command object for force application (see ParamCommand). More...
class | LinearForceAffectorFactory
| Factory class for LinearForceAffector. More...
class | PointEmitter
| Particle emitter which emits particles from a single point. More...
class | PointEmitterFactory
| Factory class for particle emitter of type "Point". More...
class | RingEmitter
| Particle emitter which emits particles randomly from points inside a ring (e.g. More...
class | RingEmitter::CmdInnerX
| Command object for inner size (see ParamCommand). More...
class | RingEmitter::CmdInnerY
| Command object for inner size (see ParamCommand). More...
class | RingEmitterFactory
| Factory class for particle emitter of type "Ring". More...
class | RotationAffector
| This plugin subclass of ParticleAffector allows you to alter the rotation of particles. More...
class | RotationAffector::CmdRotationSpeedRangeStart
| Command object for particle emitter - see ParamCommand. More...
class | RotationAffector::CmdRotationSpeedRangeEnd
| Command object for particle emitter - see ParamCommand. More...
class | RotationAffector::CmdRotationRangeStart
| Command object for particle emitter - see ParamCommand. More...
class | RotationAffector::CmdRotationRangeEnd
| Command object for particle emitter - see ParamCommand. More...
class | RotationAffectorFactory
| Factory class for RotationAffector. More...
class | ScaleAffector
| This plugin subclass of ParticleAffector allows you to alter the scale of particles. More...
class | ScaleAffector::CmdScaleAdjust
| Command object for scale adjust (see ParamCommand). More...
class | ScaleAffectorFactory
| Factory class for ScaleAffector. More...
class | D3DDevice
| Encapsulates a Direct3D Device. More...
class | D3DDeviceList
| Encapsulates enumeration of Direct3D devices. More...
class | D3D7GpuProgram
| Dummy implementation of GpuProgram - cannot do anything since D3D7 did not support vertex or fragment programs. More...
class | D3D7GpuProgramManager
| Dummy implementation of GpuProgramManager - cannot do anything since D3D7 did not support vertex or fragment programs. More...
class | D3D7HardwareBufferManager
| Specialisation of HardwareBufferManager for D3D7. More...
class | D3D7HardwarePixelBuffer
class | D3DRenderSystem
| Implementation of DirectX as a rendering system. More...
struct | D3DRenderSystem::sD3DTextureStageDesc
| structure holding texture unit settings for every stage More...
class | D3D7RenderWindow
| Defines the rendering window on Win32 systems. More...
class | D3DTexture
| Direct3D7-specific texture resource implementation. More...
class | D3DTexturePtr
| Specialisation of SharedPtr to allow SharedPtr to be assigned to D3DTexturePtr. More...
class | D3D7RenderTexture
| D3D7 implementation of RenderTexture. More...
class | D3DTextureManager
| Direct3D-specific implementation of a TextureManager. More...
class | DDDriver
| Encapsulates a DirectDraw driver. More...
class | DDDriverList
| Encapsulates enumeration of DirectDraw drivers. More...
class | DDVideoMode
| Encapsulates a DirectDraw video mode. More...
class | DDVideoModeList
| Encapsulates enumeration of DirectDraw video modes. More...
class | D3D9Driver
class | D3D9DriverList
class | D3D9GpuProgram
| Direct3D implementation of a few things common to low-level vertex & fragment programs. More...
class | D3D9GpuVertexProgram
| Direct3D implementation of low-level vertex programs. More...
class | D3D9GpuFragmentProgram
| Direct3D implementation of low-level fragment programs. More...
class | D3D9GpuProgramPtr
| Specialisation of SharedPtr to allow SharedPtr to be assigned to D3D9GpuProgramPtr. More...
class | D3D9GpuProgramManager
class | D3D9HardwareBufferManager
| Implementation of HardwareBufferManager for D3D9. More...
class | D3D9HardwareIndexBuffer
class | D3D9HardwareOcclusionQuery
| This is a class that is the DirectX9 implementation of hardware occlusion testing. More...
class | D3D9HardwarePixelBuffer
class | D3D9HardwareVertexBuffer
| Specialisation of HardwareVertexBuffer for D3D9. More...
class | D3D9HLSLProgram
| Specialisation of HighLevelGpuProgram to provide support for D3D9 High-Level Shader Language (HLSL). More...
class | D3D9HLSLProgram::CmdEntryPoint
| Command object for setting entry point. More...
class | D3D9HLSLProgram::CmdTarget
| Command object for setting target assembler. More...
class | D3D9HLSLProgramFactory
| Factory class for D3D9 HLSL programs. More...
class | D3D9Mappings
class | D3D9RenderSystem
| Implementation of DirectX9 as a rendering system. More...
struct | D3D9RenderSystem::sD3DTextureStageDesc
| structure holding texture unit settings for every stage More...
class | D3D9RenderWindow
class | D3D9Texture
class | D3D9TexturePtr
| Specialisation of SharedPtr to allow SharedPtr to be assigned to D3D9TexturePtr. More...
class | D3D9RenderTexture
| RenderTexture implementation for D3D9. More...
class | D3D9TextureManager
class | D3D9VertexDeclaration
| Specialisation of VertexDeclaration for D3D9. More...
class | D3D9VideoMode
class | D3D9VideoModeList
class | GLXContext
class | GLXGLSupport
class | GLXRenderTexture
class | FBConfigData
| Class that acquires and stores properties of a frame buffer configuration. More...
class | GLXUtils
class | GLXWindow
class | GLXWindowInterface
| Interface that provides some GLX specific notification to an Ogre GLX window. More...
class | GTKGLSupport
| GL support in a GTK window. More...
class | OGREWidget
class | GTKWindow
class | GLContext
| Class that encapsulates an GL context. More...
class | GLDefaultHardwareVertexBuffer
| Specialisation of HardwareVertexBuffer for emulation. More...
class | GLDefaultHardwareIndexBuffer
| Specialisation of HardwareIndexBuffer for emulation. More...
class | GLDefaultHardwareBufferManager
| Specialisation of HardwareBufferManager to emulate hardware buffers. More...
class | GLGpuNvparseProgram
class | GLGpuProgram
| Generalised low-level GL program, can be applied to multiple types (eg ARB and NV). More...
class | GLArbGpuProgram
| Specialisation of the GL low-level program for ARB programs. More...
class | GLGpuProgramManager
class | GLHardwareBufferManager
| Implementation of HardwareBufferManager for OpenGL. More...
class | GLHardwareIndexBuffer
class | GLHardwareOcclusionQuery
| This is a class that is the base class of the query class for hardware occlusion. More...
class | GLHardwarePixelBuffer
class | GLHardwareVertexBuffer
| Specialisation of HardwareVertexBuffer for OpenGL. More...
class | GLPixelUtil
| Class to do pixel format mapping between GL and OGRE. More...
class | GLRenderSystem
| Implementation of GL as a rendering system. More...
class | GLSupport
class | GLTexture
class | GLTexturePtr
| Specialisation of SharedPtr to allow SharedPtr to be assigned to GLTexturePtr. More...
class | GLRenderTexture
| GL implementation of RenderTexture. More...
class | GLTextureManager
| SDL/GL-specific implementation of a TextureManager. More...
class | SDLGLSupport
class | SDLWindow
class | Win32Context
class | Win32GLSupport
class | Win32RenderTexture
class | Win32Window
class | GLSLGpuProgram
| GLSL low level compiled shader object - this class is used to get at the linked program object and provide an interface for GLRenderSystem calls. More...
class | GLSLLinkProgram
| C++ encapsulation of GLSL Program Object. More...
struct | GLSLLinkProgram::UniformReference
| structure used to keep track of named uniforms in the linked program object More...
class | GLSLLinkProgramManager
| Ogre assumes that there are seperate vertex and fragment programs to deal with but GLSL has one program object that represents the active vertex and fragment shader objects during a rendering state. More...
class | GLSLProgram
| Specialisation of HighLevelGpuProgram to provide support for OpenGL Shader Language (GLSL). More...
class | GLSLProgram::CmdAttach
| Command object for attaching another GLSL Program. More...
class | GLSLProgramFactory
| Factory class for GLSL programs. More...

## Typedefs

typedef std::map< String, AnimationState > | AnimationStateSet
typedef MapIterator< AnimationStateSet > | AnimationStateIterator
typedef std::vector< FileInfo > | FileInfoList
typedef SharedPtr< FileInfoList > | FileInfoListPtr
typedef uint32 | RGBA
typedef uint32 | ARGB
typedef uint32 | ABGR
typedef int | TrackVertexColourType
| An enumeration describing which material properties should track the vertex colours.
typedef std::vector< Light * > | LightList
typedef std::map< String, bool > | UnaryOptionList
typedef std::map< String, String > | BinaryOptionList
typedef std::map< String, String > | NameValuePairList
| Name / value parameter pair (first = name, second = value).
typedef void(* | DLL_CREATECONFIGDIALOG )(ConfigDialog **ppDlg)
| Defines the interface OgrePlatform.dll/OgrePlatform.so must implement.
typedef Ogre::_ConfigOption | ConfigOption
| Packages the details of a configuration option.
typedef std::map< String, ConfigOption > | ConfigOptionMap
typedef SharedPtr< ControllerValue< Real > > | ControllerValueRealPtr
typedef SharedPtr< ControllerFunction< Real > > | ControllerFunctionRealPtr
typedef SharedPtr< DataStream > | DataStreamPtr
| Shared pointer to allow data streams to be passed around without worrying about deallocation.
typedef std::list< DataStreamPtr > | DataStreamList
| List of DataStream items.
typedef SharedPtr< DataStreamList > | DataStreamListPtr
| Shared pointer to list of DataStream items.
typedef SharedPtr< MemoryDataStream > | MemoryDataStreamPtr
| Shared pointer to allow memory data streams to be passed around without worrying about deallocation.
typedef void(* | DLL_CREATEERRORDIALOG )(ErrorDialog **ppDlg)
| Defines the interface a platform-specific library must implement.
typedef SharedPtr< GpuProgramParameters > | GpuProgramParametersSharedPtr
| Shared pointer used to hold references to GpuProgramParameters instances.
typedef enum Ogre::_OCCLUSIONQUERY | HW_OCCLUSIONQUERY
| Hardware occlusion query flags.
typedef void(* | DLL_CREATEINPUTREADER )(InputReader **ppReader)
| Defines the interface a platform-specific library must implement.
typedef bool(* | ATTRIBUTE_PARSER )(String &params, MaterialScriptContext &context)
| Function def for material attribute parser; return value determines if the next line should be {.
typedef std::vector< IlluminationPass * > | IlluminationPassList
typedef std::vector< Plane > | PlaneList
typedef std::vector< PlaneBoundedVolume > | PlaneBoundedVolumeList
typedef unsigned int | uint32
typedef unsigned short | uint16
typedef unsigned char | uint8
typedef void(* | DLL_CREATETIMER )(Timer **ppTimer)
typedef void(* | DLL_DESTROYCONFIGDIALOG )(ConfigDialog *ppDlg)
typedef void(* | DLL_DESTROYERRORDIALOG )(ErrorDialog *ppDlg)
typedef void(* | DLL_DESTROYINPUTREADER )(InputReader *ppReader)
typedef void(* | DLL_DESTROYTIMER )(Timer *ppTimer)
typedef float | Real
| Software floating point type.
typedef unsigned char | uchar
| In order to avoid finger-aches :).
typedef unsigned short | ushort
typedef unsigned int | uint
typedef unsigned long | ulong
typedef std::string | _StringBase
typedef _StringBase | String
typedef std::map< String, RenderTarget * > | RenderTargetMap
typedef std::multimap< uchar, RenderTarget * > | RenderTargetPriorityMap
typedef void(* | DLL_CREATERENDERWINDOW )(RenderWindow **ppWindow)
| Defines the interface a DLL implemeting a platform-specific version must implement.
typedef unsigned long | ResourceHandle
typedef SharedPtr< Resource > | ResourcePtr
| Shared pointer to a Resource.
typedef unsigned long | BackgroundProcessTicket
| Identifier of a background process.
typedef std::vector< RenderSystem * > | RenderSystemList
typedef std::list< MovableObject * > | SceneQueryResultMovableList
typedef std::list< SceneQuery::WorldFragment * > | SceneQueryResultWorldFragmentList
typedef std::list< RaySceneQueryResultEntry > | RaySceneQueryResult
typedef std::pair< MovableObject *, MovableObject * > | SceneQueryMovableObjectPair
typedef std::pair< MovableObject *, SceneQuery::WorldFragment * > | SceneQueryMovableObjectWorldFragmentPair
typedef std::list< SceneQueryMovableObjectPair > | SceneQueryMovableIntersectionList
typedef std::list< SceneQueryMovableObjectWorldFragmentPair > | SceneQueryMovableWorldFragmentIntersectionList
typedef stdext::hash_compare< _StringBase, std::less< _StringBase > > | _StringHash
typedef std::vector< ParameterDef > | ParameterList
typedef std::map< String, ParamCommand * > | ParamCommandMap
typedef std::map< String, ParamDictionary > | ParamDictionaryMap
typedef std::vector< String > | StringVector
typedef SharedPtr< StringVector > | StringVectorPtr
typedef Ogre::VertexBoneAssignment_s | VertexBoneAssignment
| Records the assignment of a single vertex to a single bone with the corresponding weight.
typedef std::vector< HardwareBuffer::Usage > | BufferUsageList
| Define a list of usage flags.
typedef unsigned __int64 | uint64
typedef std::list< OctreeNode * > | NodeList
typedef std::list< WireBoundingBox * > | BoxList
typedef std::list< unsigned long > | ColorList
typedef std::pair< String, String > | TerrainPageSourceOption
typedef std::vector< TerrainPageSourceOption > | TerrainPageSourceOptionList
typedef std::map< unsigned int, IndexData * > | IndexMap
typedef std::vector< IndexData * > | IndexArray
typedef std::vector< IndexMap * > | LevelArray
typedef std::vector< TerrainPage * > | TerrainPageRow
typedef std::vector< TerrainPageRow > | TerrainPage2D

## Enumerations

enum | BillboardOrigin { BBO_TOP_LEFT, BBO_TOP_CENTER, BBO_TOP_RIGHT, BBO_CENTER_LEFT, BBO_CENTER, BBO_CENTER_RIGHT, BBO_BOTTOM_LEFT, BBO_BOTTOM_CENTER, BBO_BOTTOM_RIGHT }
| Enum covering what exactly a billboard's position means (center, top-left etc). More...
enum | BillboardType { BBT_POINT, BBT_ORIENTED_COMMON, BBT_ORIENTED_SELF }
| The type of billboard to use. More...
enum | LayerBlendType { LBT_COLOUR, LBT_ALPHA }
| Type of texture blend mode. More...
enum | LayerBlendOperation { LBO_REPLACE, LBO_ADD, LBO_MODULATE, LBO_ALPHA_BLEND }
| List of valid texture blending operations, for use with TextureUnitState::setColourOperation. More...
enum | LayerBlendOperationEx { LBX_SOURCE1, LBX_SOURCE2, LBX_MODULATE, LBX_MODULATE_X2, LBX_MODULATE_X4, LBX_ADD, LBX_ADD_SIGNED, LBX_ADD_SMOOTH, LBX_SUBTRACT, LBX_BLEND_DIFFUSE_ALPHA, LBX_BLEND_TEXTURE_ALPHA, LBX_BLEND_CURRENT_ALPHA, LBX_BLEND_MANUAL, LBX_DOTPRODUCT }
| Expert list of valid texture blending operations, for use with TextureUnitState::setColourOperationEx and TextureUnitState::setAlphaOperation, and internally in the LayerBlendModeEx class. More...
enum | LayerBlendSource { LBS_CURRENT, LBS_TEXTURE, LBS_DIFFUSE, LBS_SPECULAR, LBS_MANUAL }
| List of valid sources of values for blending operations used in TextureUnitState::setColourOperation and TextureUnitState::setAlphaOperation, and internally in the LayerBlendModeEx class. More...
enum | SceneBlendType { SBT_TRANSPARENT_ALPHA, SBT_TRANSPARENT_COLOUR, SBT_ADD, SBT_MODULATE }
| Types of blending that you can specify between an object and the existing contents of the scene. More...
enum | SceneBlendFactor { SBF_ONE, SBF_ZERO, SBF_DEST_COLOUR, SBF_SOURCE_COLOUR, SBF_ONE_MINUS_DEST_COLOUR, SBF_ONE_MINUS_SOURCE_COLOUR, SBF_DEST_ALPHA, SBF_SOURCE_ALPHA, SBF_ONE_MINUS_DEST_ALPHA, SBF_ONE_MINUS_SOURCE_ALPHA }
| Blending factors for manually blending objects with the scene. More...
enum | CompareFunction { CMPF_ALWAYS_FAIL, CMPF_ALWAYS_PASS, CMPF_LESS, CMPF_LESS_EQUAL, CMPF_EQUAL, CMPF_NOT_EQUAL, CMPF_GREATER_EQUAL, CMPF_GREATER }
| Comparison functions used for the depth/stencil buffer operations and others. More...
enum | TextureFilterOptions { TFO_NONE, TFO_BILINEAR, TFO_TRILINEAR, TFO_ANISOTROPIC }
| High-level filtering options providing shortcuts to settings the minification, magnification and mip filters. More...
enum | FilterType { FT_MIN, FT_MAG, FT_MIP }
enum | FilterOptions { FO_NONE, FO_POINT, FO_LINEAR, FO_ANISOTROPIC }
| Filtering options for textures / mipmaps. More...
enum | ShadeOptions { SO_FLAT, SO_GOURAUD, SO_PHONG }
| Light shading modes. More...
enum | FogMode { FOG_NONE, FOG_EXP, FOG_EXP2, FOG_LINEAR }
| Fog modes. More...
enum | CullingMode { CULL_NONE = 1, CULL_CLOCKWISE = 2, CULL_ANTICLOCKWISE = 3 }
| Hardware culling modes based on vertex winding. More...
enum | ManualCullingMode { MANUAL_CULL_NONE = 1, MANUAL_CULL_BACK = 2, MANUAL_CULL_FRONT = 3 }
| Manual culling modes based on vertex normals. More...
enum | WaveformType { WFT_SINE, WFT_TRIANGLE, WFT_SQUARE, WFT_SAWTOOTH, WFT_INVERSE_SAWTOOTH }
| Enumerates the wave types usable with the Ogre engine. More...
enum | SceneDetailLevel { SDL_POINTS = 1, SDL_WIREFRAME = 2, SDL_SOLID = 3 }
| The broad type of detail for rendering. More...
enum | ShadowTechnique { SHADOWTYPE_NONE, SHADOWTYPE_STENCIL_MODULATIVE, SHADOWTYPE_STENCIL_ADDITIVE, SHADOWTYPE_TEXTURE_MODULATIVE }
| An enumeration of broad shadow techniques. More...
enum | TrackVertexColourEnum { TVC_NONE = 0x0, TVC_AMBIENT = 0x1, TVC_DIFFUSE = 0x2, TVC_SPECULAR = 0x4, TVC_EMISSIVE = 0x8 }
enum | eTexturePlayMode { TextureEffectPause = 0, TextureEffectPlay_ASAP = 1, TextureEffectPlay_Looping = 2 }
| Enum for type of texture play mode. More...
enum | FontType { FT_TRUETYPE = 1, FT_IMAGE = 2 }
| Enumerates the types of Font usable in the engine. More...
enum | ProjectionType { PT_ORTHOGRAPHIC, PT_PERSPECTIVE }
| Specifies perspective (realistic) or orthographic (architectural) projection. More...
enum | FrustumPlane { FRUSTUM_PLANE_NEAR = 0, FRUSTUM_PLANE_FAR = 1, FRUSTUM_PLANE_LEFT = 2, FRUSTUM_PLANE_RIGHT = 3, FRUSTUM_PLANE_TOP = 4, FRUSTUM_PLANE_BOTTOM = 5 }
| Worldspace clipping planes. More...
enum | GpuProgramType { GPT_VERTEX_PROGRAM, GPT_FRAGMENT_PROGRAM }
| Enumerates the types of programs which can run on the GPU. More...
enum | _OCCLUSIONQUERY { HWOCCLUSIONQUERY_FLUSH, HWOCCLUSIONQUERY_NOFLUSH }
| Hardware occlusion query flags. More...
enum | VertexElementSemantic { VES_POSITION = 1, VES_BLEND_WEIGHTS = 2, VES_BLEND_INDICES = 3, VES_NORMAL = 4, VES_DIFFUSE = 5, VES_SPECULAR = 6, VES_TEXTURE_COORDINATES = 7, VES_BINORMAL = 8, VES_TANGENT = 9 }
| Vertex element semantics, used to identify the meaning of vertex buffer contents. More...
enum | VertexElementType { VET_FLOAT1, VET_FLOAT2, VET_FLOAT3, VET_FLOAT4, VET_COLOUR, VET_SHORT1, VET_SHORT2, VET_SHORT3, VET_SHORT4, VET_UBYTE4 }
| Vertex element type, used to identify the base types of the vertex contents. More...
enum | ImageFlags { IF_COMPRESSED = 0x00000001, IF_CUBEMAP = 0x00000002, IF_3D_TEXTURE = 0x00000004 }

enum

KeyCode {
KC_ESCAPE = 0x01, KC_1 = 0x02, KC_2 = 0x03, KC_3 = 0x04,
KC_4 = 0x05, KC_5 = 0x06, KC_6 = 0x07, KC_7 = 0x08,
KC_8 = 0x09, KC_9 = 0x0A, KC_0 = 0x0B, KC_MINUS = 0x0C,
KC_EQUALS = 0x0D, KC_BACK = 0x0E, KC_TAB = 0x0F, KC_Q = 0x10,
KC_W = 0x11, KC_E = 0x12, KC_R = 0x13, KC_T = 0x14,
KC_Y = 0x15, KC_U = 0x16, KC_I = 0x17, KC_O = 0x18,
KC_P = 0x19, KC_LBRACKET = 0x1A, KC_RBRACKET = 0x1B, KC_RETURN = 0x1C,
KC_LCONTROL = 0x1D, KC_A = 0x1E, KC_S = 0x1F, KC_D = 0x20,
KC_F = 0x21, KC_G = 0x22, KC_H = 0x23, KC_J = 0x24,
KC_K = 0x25, KC_L = 0x26, KC_SEMICOLON = 0x27, KC_APOSTROPHE = 0x28,
KC_GRAVE = 0x29, KC_LSHIFT = 0x2A, KC_BACKSLASH = 0x2B, KC_Z = 0x2C,
KC_X = 0x2D, KC_C = 0x2E, KC_V = 0x2F, KC_B = 0x30,
KC_N = 0x31, KC_M = 0x32, KC_COMMA = 0x33, KC_PERIOD = 0x34,
KC_SLASH = 0x35, KC_RSHIFT = 0x36, KC_MULTIPLY = 0x37, KC_LMENU = 0x38,
KC_SPACE = 0x39, KC_CAPITAL = 0x3A, KC_F1 = 0x3B, KC_F2 = 0x3C,
KC_F3 = 0x3D, KC_F4 = 0x3E, KC_F5 = 0x3F, KC_F6 = 0x40,
KC_F7 = 0x41, KC_F8 = 0x42, KC_F9 = 0x43, KC_F10 = 0x44,
KC_NUMLOCK = 0x45, KC_SCROLL = 0x46, KC_NUMPAD7 = 0x47, KC_NUMPAD8 = 0x48,
KC_NUMPAD9 = 0x49, KC_SUBTRACT = 0x4A, KC_NUMPAD4 = 0x4B, KC_NUMPAD5 = 0x4C,
KC_NUMPAD6 = 0x4D, KC_ADD = 0x4E, KC_NUMPAD1 = 0x4F, KC_NUMPAD2 = 0x50,
KC_NUMPAD3 = 0x51, KC_NUMPAD0 = 0x52, KC_DECIMAL = 0x53, KC_OEM_102 = 0x56,
KC_F11 = 0x57, KC_F12 = 0x58, KC_F13 = 0x64, KC_F14 = 0x65,
KC_F15 = 0x66, KC_KANA = 0x70, KC_ABNT_C1 = 0x73, KC_CONVERT = 0x79,
KC_NOCONVERT = 0x7B, KC_YEN = 0x7D, KC_ABNT_C2 = 0x7E, KC_NUMPADEQUALS = 0x8D,
KC_PREVTRACK = 0x90, KC_AT = 0x91, KC_COLON = 0x92, KC_UNDERLINE = 0x93,
KC_KANJI = 0x94, KC_STOP = 0x95, KC_AX = 0x96, KC_UNLABELED = 0x97,
KC_NEXTTRACK = 0x99, KC_NUMPADENTER = 0x9C, KC_RCONTROL = 0x9D, KC_MUTE = 0xA0,
KC_CALCULATOR = 0xA1, KC_PLAYPAUSE = 0xA2, KC_MEDIASTOP = 0xA4, KC_VOLUMEDOWN = 0xAE,
KC_VOLUMEUP = 0xB0, KC_WEBHOME = 0xB2, KC_NUMPADCOMMA = 0xB3, KC_DIVIDE = 0xB5,
KC_SYSRQ = 0xB7, KC_RMENU = 0xB8, KC_PAUSE = 0xC5, KC_HOME = 0xC7,
KC_UP = 0xC8, KC_PGUP = 0xC9, KC_LEFT = 0xCB, KC_RIGHT = 0xCD,
KC_END = 0xCF, KC_DOWN = 0xD0, KC_PGDOWN = 0xD1, KC_INSERT = 0xD2,
KC_DELETE = 0xD3, KC_LWIN = 0xDB, KC_RWIN = 0xDC, KC_APPS = 0xDD,
KC_POWER = 0xDE, KC_SLEEP = 0xDF, KC_WAKE = 0xE3, KC_WEBSEARCH = 0xE5,
KC_WEBFAVORITES = 0xE6, KC_WEBREFRESH = 0xE7, KC_WEBSTOP = 0xE8, KC_WEBFORWARD = 0xE9,
KC_WEBBACK = 0xEA, KC_MYCOMPUTER = 0xEB, KC_MAIL = 0xEC, KC_MEDIASELECT = 0xED
}

| Keyboard scan codes - copied from DirectInput for now for speed. More...
enum | LoggingLevel { LL_LOW = 1, LL_NORMAL = 2, LL_BOREME = 3 }
| The level of detail to which the log will go into. More...
enum | LogMessageLevel { LML_TRIVIAL = 1, LML_NORMAL = 2, LML_CRITICAL = 3 }
| The importance of a logged message. More...
enum | MaterialScriptSection { MSS_NONE, MSS_MATERIAL, MSS_TECHNIQUE, MSS_PASS, MSS_TEXTUREUNIT, MSS_PROGRAM_REF, MSS_PROGRAM, MSS_DEFAULT_PARAMETERS, MSS_TEXTURESOURCE }
| Enum to identify material sections. More...

enum

MeshChunkID {
M_HEADER = 0x1000, M_MESH = 0x3000, M_SUBMESH = 0x4000, M_SUBMESH_OPERATION = 0x4010,
M_SUBMESH_BONE_ASSIGNMENT = 0x4100, M_GEOMETRY = 0x5000, M_GEOMETRY_VERTEX_DECLARATION = 0x5100, M_GEOMETRY_VERTEX_ELEMENT = 0x5110,
M_GEOMETRY_VERTEX_BUFFER = 0x5200, M_GEOMETRY_VERTEX_BUFFER_DATA = 0x5210, M_MESH_SKELETON_LINK = 0x6000, M_MESH_BONE_ASSIGNMENT = 0x7000,
M_MESH_LOD = 0x8000, M_MESH_LOD_USAGE = 0x8100, M_MESH_LOD_MANUAL = 0x8110, M_MESH_LOD_GENERATED = 0x8120,
M_MESH_BOUNDS = 0x9000, M_SUBMESH_NAME_TABLE = 0xA000, M_SUBMESH_NAME_TABLE_ELEMENT = 0xA100, M_EDGE_LISTS = 0xB000,
M_EDGE_LIST_LOD = 0xB100, M_EDGE_GROUP = 0xB110, M_GEOMETRY_NORMALS = 0x5100, M_GEOMETRY_COLOURS = 0x5200,
M_GEOMETRY_TEXCOORDS = 0x5300
}

| Definition of the OGRE .mesh file format. More...
enum | GuiMetricsMode { GMM_RELATIVE, GMM_PIXELS, GMM_RELATIVE_ASPECT_ADJUSTED }
| Enum describing how the position / size of an element is to be recorded. More...
enum | GuiHorizontalAlignment { GHA_LEFT, GHA_CENTER, GHA_RIGHT }
| Enum describing where '0' is in relation to the parent in the horizontal dimension. More...
enum | GuiVerticalAlignment { GVA_TOP, GVA_CENTER, GVA_BOTTOM }
| Enum describing where '0' is in relation to the parent in the vertical dimension. More...
enum | IlluminationStage { IS_AMBIENT, IS_PER_LIGHT, IS_DECAL }

enum

PixelFormat {
PF_UNKNOWN = 0, PF_L8 = 1, PF_BYTE_L = PF_L8, PF_L16 = 2,
PF_SHORT_L = PF_L16, PF_A8 = 3, PF_BYTE_A = PF_A8, PF_A4L4 = 4,
PF_BYTE_LA = 5, PF_R5G6B5 = 6, PF_B5G6R5 = 7, PF_R3G3B2 = 31,
PF_A4R4G4B4 = 8, PF_A1R5G5B5 = 9, PF_R8G8B8 = 10, PF_B8G8R8 = 11,
PF_A8R8G8B8 = 12, PF_A8B8G8R8 = 13, PF_B8G8R8A8 = 14, PF_R8G8B8A8 = 28,
PF_X8R8G8B8 = 26, PF_X8B8G8R8 = 27, PF_BYTE_RGB = PF_B8G8R8, PF_BYTE_BGR = PF_R8G8B8,
PF_BYTE_BGRA = PF_A8R8G8B8, PF_BYTE_RGBA = PF_A8B8G8R8, PF_A2R10G10B10 = 15, PF_A2B10G10R10 = 16,
PF_DXT1 = 17, PF_DXT2 = 18, PF_DXT3 = 19, PF_DXT4 = 20,
PF_DXT5 = 21, PF_FLOAT16_R = 32, PF_FLOAT16_RGB = 22, PF_FLOAT16_RGBA = 23,
PF_FLOAT32_R = 33, PF_FLOAT32_RGB = 24, PF_FLOAT32_RGBA = 25, PF_DEPTH = 29,
PF_SHORT_RGBA = 30, PF_COUNT = 34
}

| The pixel format used for images, textures, and render surfaces. More...
enum | PixelFormatFlags { PFF_HASALPHA = 0x00000001, PFF_COMPRESSED = 0x00000002, PFF_FLOAT = 0x00000004, PFF_DEPTH = 0x00000008, PFF_NATIVEENDIAN = 0x00000010, PFF_LUMINANCE = 0x00000020 }
| Flags defining some on/off properties of pixel formats. More...

enum

RenderQueueGroupID {
RENDER_QUEUE_BACKGROUND = 0, RENDER_QUEUE_SKIES_EARLY = 5, RENDER_QUEUE_1 = 10, RENDER_QUEUE_2 = 20,
RENDER_QUEUE_WORLD_GEOMETRY_1 = 25, RENDER_QUEUE_3 = 30, RENDER_QUEUE_4 = 40, RENDER_QUEUE_MAIN = 50,
RENDER_QUEUE_6 = 60, RENDER_QUEUE_7 = 70, RENDER_QUEUE_WORLD_GEOMETRY_2 = 75, RENDER_QUEUE_8 = 80,
RENDER_QUEUE_9 = 90, RENDER_QUEUE_SKIES_LATE = 95, RENDER_QUEUE_OVERLAY = 100
}

| Enumeration of queue groups, by which the application may group queued renderables so that they are rendered together with events in between. More...
enum | TexCoordCalcMethod { TEXCALC_NONE, TEXCALC_ENVIRONMENT_MAP, TEXCALC_ENVIRONMENT_MAP_PLANAR, TEXCALC_ENVIRONMENT_MAP_REFLECTION, TEXCALC_ENVIRONMENT_MAP_NORMAL, TEXCALC_PROJECTIVE_TEXTURE }
| Enum describing the ways to generate texture coordinates. More...
enum | StencilOperation { SOP_KEEP, SOP_ZERO, SOP_REPLACE, SOP_INCREMENT, SOP_DECREMENT, SOP_INCREMENT_WRAP, SOP_DECREMENT_WRAP, SOP_INVERT }
| Enum describing the various actions which can be taken onthe stencil buffer. More...
enum | FrameBufferType { FBT_COLOUR = 0x1, FBT_DEPTH = 0x2, FBT_STENCIL = 0x4 }
| Defines the frame buffers which can be cleared. More...

enum

Capabilities {
RSC_AUTOMIPMAP = 0x00000002, RSC_BLENDING = 0x00000004, RSC_ANISOTROPY = 0x00000008, RSC_DOT3 = 0x00000010,
RSC_CUBEMAPPING = 0x00000020, RSC_HWSTENCIL = 0x00000040, RSC_VBO = 0x00000080, RSC_VERTEX_PROGRAM = 0x00000200,
RSC_FRAGMENT_PROGRAM = 0x00000400, RSC_TEXTURE_COMPRESSION = 0x00000800, RSC_TEXTURE_COMPRESSION_DXT = 0x00001000, RSC_TEXTURE_COMPRESSION_VTC = 0x00002000,
RSC_SCISSOR_TEST = 0x00004000, RSC_TWO_SIDED_STENCIL = 0x00008000, RSC_STENCIL_WRAP = 0x00010000, RSC_HWOCCLUSION = 0x00020000,
RSC_USER_CLIP_PLANES = 0x00040000, RSC_VERTEX_FORMAT_UBYTE4 = 0x00080000, RSC_INFINITE_FAR_PLANE = 0x00100000, RSC_HWRENDER_TO_TEXTURE = 0x00200000,
RSC_TEXTURE_FLOAT = 0x00400000, RSC_NON_POWER_OF_2_TEXTURES = 0x00800000, RSC_TEXTURE_3D = 0x01000000
}

| Enum describing the different hardware capabilities we want to check for. More...
enum | SceneType { ST_GENERIC, ST_EXTERIOR_CLOSE, ST_EXTERIOR_FAR, ST_EXTERIOR_REAL_FAR, ST_INTERIOR }
| Classification of a scene to allow a decision of what type of SceenManager to provide back to the application. More...
enum | ShadowRenderableFlags { SRF_INCLUDE_LIGHT_CAP = 0x00000001, SRF_INCLUDE_DARK_CAP = 0x00000002, SRF_EXTRUDE_TO_INFINITY = 0x00000004 }
| A set of flags that can be used to influence ShadowRenderable creation. More...
enum | SkeletonAnimationBlendMode { ANIMBLEND_AVERAGE, ANIMBLEND_CUMULATIVE }
enum | SkeletonChunkID { SKELETON_HEADER = 0x1000, SKELETON_BONE = 0x2000, SKELETON_BONE_PARENT = 0x3000, SKELETON_ANIMATION = 0x4000, SKELETON_ANIMATION_TRACK = 0x4100, SKELETON_ANIMATION_TRACK_KEYFRAME = 0x4110, SKELETON_ANIMATION_LINK = 0x5000 }
| Definition of the OGRE .skeleton file format. More...
enum | FaceGroupType { FGT_FACE_LIST, FGT_PATCH, FGT_UNKNOWN }
| A type of face group, ie face list of procedural etc. More...
enum | ParameterType { 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 }
| List of parameter types available. More...

enum

TextureUsage {
TU_STATIC = HardwareBuffer::HBU_STATIC, TU_DYNAMIC = HardwareBuffer::HBU_DYNAMIC, TU_WRITE_ONLY = HardwareBuffer::HBU_WRITE_ONLY, TU_STATIC_WRITE_ONLY = HardwareBuffer::HBU_STATIC_WRITE_ONLY,
TU_DYNAMIC_WRITE_ONLY = HardwareBuffer::HBU_DYNAMIC_WRITE_ONLY, TU_DYNAMIC_WRITE_ONLY_DISCARDABLE = HardwareBuffer::HBU_DYNAMIC_WRITE_ONLY_DISCARDABLE, TU_AUTOMIPMAP = 0x100, TU_RENDERTARGET = 0x200,
TU_DEFAULT = TU_AUTOMIPMAP | TU_STATIC_WRITE_ONLY
}

| Enum identifying the texture usage. More...
enum | TextureType { TEX_TYPE_1D = 1, TEX_TYPE_2D = 2, TEX_TYPE_3D = 3, TEX_TYPE_CUBE_MAP = 4 }
| Enum identifying the texture type. More...
enum | TextureMipmap { MIP_UNLIMITED = 0x7FFFFFFF }
| Enum identifying special mipmap numbers. More...
enum | GrabMode { GRAB_NONE, GRAB_MOUSE_OVER, GRAB_MOUSE_CLICK }

## Functions

_OgreExport void | CopyAnimationStateSubset (AnimationStateSet &target, const AnimationStateSet &source)
| Copies a subset animation states from source to target.
int _OgreExport | 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.
Radian | operator * (Real a, const Radian &b)
Radian | operator/ (Real a, const Radian &b)
Degree | operator * (Real a, const Degree &b)
Degree | operator/ (Real a, const Degree &b)
Vector4 | operator * (const Vector4 &v, const Matrix4 &mat)
Rectangle | intersect (const Rectangle &lhs, const Rectangle &rhs)
| Geometric intersection of two rectanglar regions.
template<class T, class U> bool | operator== (SharedPtr< T > const &a, SharedPtr< U > const &b)
template<class T, class U> bool | operator!= (SharedPtr< T > const &a, SharedPtr< U > const &b)
void | checkForCgError (const String &ogreMethod, const String &errorTextPrefix, CGcontext context)
| Utility function, checks Cg for errors, throw exception if detected.
Real | _max (Real x, Real y)
HRESULT WINAPI | EnumModesCallback (LPDDSURFACEDESC2 lpDDSurfaceDesc, LPVOID lpContext)
HRESULT CALLBACK | D3DEnumDevicesCallback (GUID FAR *lpGuid, LPSTR lpDeviceDescription, LPSTR lpDeviceName, LPD3DDEVICEDESC7 lpD3DHWDeviceDesc, LPD3DDEVICEDESC7 lpD3DHELDeviceDesc, LPVOID lpContext)
template<typename _Interf> void | __safeRelease (_Interf **interf) throw ()
bool | InitGLShaderLanguageExtensions (GLSupport &glSupport)
void | checkForGLSLError (const String &ogreMethod, const String &errorTextPrefix, const GLhandleARB obj, const bool forceInfoLog=false, const bool forceException=false)
| Check for GL errors and report them in the Ogre Log.
String | logObjectInfo (const String &msg, const GLhandleARB obj)
| if there is a message in GL info log then post it in the Ogre Log
GLSupport * | getGLSupport ()

## Variables

unsigned char | SPOT_SHADOW_FADE_PNG [SPOT_SHADOW_FADE_PNG_SIZE]
_OgreD3DExport | D3DDevice
unsigned int | driverCount = 0
unsigned int | modeCount = 0
PFNGLCREATEPROGRAMOBJECTARBPROC | glCreateProgramObjectARB_ptr
PFNGLCREATESHADEROBJECTARBPROC | glCreateShaderObjectARB_ptr
PFNGLDELETEOBJECTARBPROC | glDeleteObjectARB_ptr
PFNGLDETACHOBJECTARBPROC | glDetachObjectARB_ptr
PFNGLATTACHOBJECTARBPROC | glAttachObjectARB_ptr
PFNGLSHADERSOURCEARBPROC | glShaderSourceARB_ptr
PFNGLCOMPILESHADERARBPROC | glCompileShaderARB_ptr
PFNGLLINKPROGRAMARBPROC | glLinkProgramARB_ptr
PFNGLGETINFOLOGARBPROC | glGetInfoLogARB_ptr
PFNGLUSEPROGRAMOBJECTARBPROC | glUseProgramObjectARB_ptr
PFNGLGETOBJECTPARAMETERIVARBPROC | glGetObjectParameterivARB_ptr
PFNGLGETOBJECTPARAMETERFVARBPROC | glGetObjectParameterfvARB_ptr
PFNGLGETUNIFORMLOCATIONARBPROC | glGetUniformLocationARB_ptr
PFNGLGETATTRIBLOCATIONARBPROC | glGetAttribLocationARB_ptr
PFNGLGETACTIVEUNIFORMARBPROC | glGetActiveUniformARB_ptr
PFNGLBINDATTRIBLOCATIONARBPROC | glBindAttribLocationARB_ptr
PFNGLUNIFORM1FARBPROC | glUniform1fARB_ptr
PFNGLUNIFORM2FARBPROC | glUniform2fARB_ptr
PFNGLUNIFORM3FARBPROC | glUniform3fARB_ptr
PFNGLUNIFORM4FARBPROC | glUniform4fARB_ptr
PFNGLUNIFORM1IARBPROC | glUniform1iARB_ptr
PFNGLUNIFORM2IARBPROC | glUniform2iARB_ptr
PFNGLUNIFORM3IARBPROC | glUniform3iARB_ptr
PFNGLUNIFORM4IARBPROC | glUniform4iARB_ptr
PFNGLUNIFORM1FVARBPROC | glUniform1fvARB_ptr
PFNGLUNIFORM2FVARBPROC | glUniform2fvARB_ptr
PFNGLUNIFORM3FVARBPROC | glUniform3fvARB_ptr
PFNGLUNIFORM4FVARBPROC | glUniform4fvARB_ptr
PFNGLUNIFORM1IVARBPROC | glUniform1ivARB_ptr
PFNGLUNIFORM2IVARBPROC | glUniform2ivARB_ptr
PFNGLUNIFORM3IVARBPROC | glUniform3ivARB_ptr
PFNGLUNIFORM4IVARBPROC | glUniform4ivARB_ptr
PFNGLVERTEXATTRIB4FVARBPROC | glVertexAttrib4fvARB_ptr
PFNGLVERTEXATTRIB3FVARBPROC | glVertexAttrib3fvARB_ptr
PFNGLVERTEXATTRIB2FVARBPROC | glVertexAttrib2fvARB_ptr
PFNGLVERTEXATTRIB1FVARBPROC | glVertexAttrib1fvARB_ptr
PFNGLVERTEXATTRIB4FARBPROC | glVertexAttrib4fARB_ptr
PFNGLVERTEXATTRIB3FARBPROC | glVertexAttrib3fARB_ptr
PFNGLVERTEXATTRIB2FARBPROC | glVertexAttrib2fARB_ptr
PFNGLVERTEXATTRIB1FARBPROC | glVertexAttrib1fARB_ptr

## Detailed Description

Author:
  Jon Anderson

## Typedef Documentation

typedef std::string Ogre::_StringBase

| Definition at line 151 of file OgrePrerequisites.h. Referenced by stdext::hash_compare< Ogre::_StringBase, std::less< Ogre::_StringBase > >::operator()().

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

| Definition at line 172 of file OgreString.h.

typedef uint32 Ogre::ABGR

| Definition at line 34 of file OgreColourValue.h.

typedef MapIterator<AnimationStateSet> Ogre::AnimationStateIterator

| Definition at line 119 of file OgreAnimationState.h. Referenced by Ogre::SceneManager::getAnimationStateIterator().

typedef std::map<String, AnimationState> Ogre::AnimationStateSet

| Definition at line 118 of file OgreAnimationState.h.

typedef uint32 Ogre::ARGB

| Definition at line 33 of file OgreColourValue.h.

typedef bool(* Ogre::ATTRIBUTE_PARSER)(String& params, MaterialScriptContext& context)

| Function def for material attribute parser; return value determines if the next line should be {. Definition at line 86 of file OgreMaterialSerializer.h.

typedef unsigned long Ogre::BackgroundProcessTicket

| Identifier of a background process. Definition at line 41 of file OgreResourceBackgroundQueue.h.

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

| Definition at line 198 of file OgreCommon.h.

typedef std::list< WireBoundingBox * > Ogre::BoxList

| Definition at line 60 of file OgreOctreeSceneManager.h.

typedef std::vector<HardwareBuffer::Usage> Ogre::BufferUsageList

| Define a list of usage flags. Definition at line 35 of file OgreVertexIndexData.h.

typedef std::list< unsigned long > Ogre::ColorList

| Definition at line 61 of file OgreOctreeSceneManager.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 std::map< String, ConfigOption > Ogre::ConfigOptionMap

| Definition at line 49 of file OgreConfigOptionMap.h.

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

| Definition at line 40 of file OgreControllerManager.h.

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

| Definition at line 39 of file OgreControllerManager.h.

typedef std::list<DataStreamPtr> Ogre::DataStreamList

| List of DataStream items. Definition at line 152 of file OgreDataStream.h.

typedef SharedPtr<DataStreamList> Ogre::DataStreamListPtr

| Shared pointer to list of DataStream items. Definition at line 154 of file OgreDataStream.h.

typedef SharedPtr<DataStream> Ogre::DataStreamPtr

| Shared pointer to allow data streams to be passed around without worrying about deallocation. Definition at line 149 of file OgreDataStream.h. Referenced by Ogre::Image::loadRawData(), and Ogre::ResourceManager::parseScript().

typedef void(* Ogre::DLL_CREATECONFIGDIALOG)(ConfigDialog **ppDlg)

| Defines the interface OgrePlatform.dll/OgrePlatform.so must implement. Definition at line 69 of file OgreConfigDialog.h.

typedef void(* Ogre::DLL_CREATEERRORDIALOG)(ErrorDialog **ppDlg)

Defines the interface a platform-specific library must implement.

Remarks:
  Any library (.dll, .so) wishing to implement a platform-specific version of this dialog must export the symbol 'createErrorDialog' with the signature void createPlatformErrorDialog(ErrorDialog** ppDlg)

Definition at line 59 of file OgreErrorDialog.h.

typedef void(* Ogre::DLL_CREATEINPUTREADER)(InputReader **ppReader)

Defines the interface a platform-specific library must implement.

Remarks:
  Any library (.dll, .so) wishing to implement a platform-specific version of this input reader must export the symbol 'createInputReader' with the signature void createPlatformInputReader(InputReader** ppReader).

Definition at line 365 of file OgreInput.h.

typedef void(* Ogre::DLL_CREATERENDERWINDOW)(RenderWindow** ppWindow)

Defines the interface a DLL implemeting a platform-specific version must implement.

Remarks:
  Any library (.dll, .so) wishing to implement a platform-specific version of this dialog must export the symbol 'createRenderWindow' with the signature void createPlatformRenderWindow(RenderWindow** ppDlg)

Definition at line 187 of file OgreRenderWindow.h.

typedef void(* Ogre::DLL_CREATETIMER)(Timer** ppTimer)

| Definition at line 36 of file OgrePlatformManager.h.

typedef void(* Ogre::DLL_DESTROYCONFIGDIALOG)(ConfigDialog* ppDlg)

| Definition at line 38 of file OgrePlatformManager.h.

typedef void(* Ogre::DLL_DESTROYERRORDIALOG)(ErrorDialog* ppDlg)

| Definition at line 39 of file OgrePlatformManager.h.

typedef void(* Ogre::DLL_DESTROYINPUTREADER)(InputReader* ppReader)

| Definition at line 40 of file OgrePlatformManager.h.

typedef void(* Ogre::DLL_DESTROYTIMER)(Timer* ppTimer)

| Definition at line 41 of file OgrePlatformManager.h.

typedef std::vector<FileInfo> Ogre::FileInfoList

| Definition at line 57 of file OgreArchive.h.

typedef SharedPtr<FileInfoList> Ogre::FileInfoListPtr

| Definition at line 58 of file OgreArchive.h.

typedef SharedPtr<GpuProgramParameters> Ogre::GpuProgramParametersSharedPtr

| Shared pointer used to hold references to GpuProgramParameters instances. Definition at line 695 of file OgreGpuProgram.h. Referenced by Ogre::D3DRenderSystem::bindGpuProgramParameters(), Ogre::GLGpuProgram::bindProgramParameters(), and Ogre::D3D7GpuProgramManager::createParameters().

typedef enum Ogre::_OCCLUSIONQUERY Ogre::HW_OCCLUSIONQUERY

| Hardware occlusion query flags.

typedef std::vector<IlluminationPass*> Ogre::IlluminationPassList

| Definition at line 970 of file OgrePass.h.

typedef std::vector< IndexData* > Ogre::IndexArray

| Definition at line 54 of file OgreTerrainRenderable.h.

typedef std::map<unsigned int, IndexData* > Ogre::IndexMap

| Definition at line 53 of file OgreTerrainRenderable.h.

typedef std::vector< IndexMap* > Ogre::LevelArray

| Definition at line 55 of file OgreTerrainRenderable.h.

typedef std::vector<Light*> Ogre::LightList

| Definition at line 195 of file OgreCommon.h. Referenced by Ogre::OverlayElement::getLights(), and Ogre::BorderRenderable::getLights().

typedef SharedPtr<MemoryDataStream> Ogre::MemoryDataStreamPtr

| Shared pointer to allow memory data streams to be passed around without worrying about deallocation. Definition at line 306 of file OgreDataStream.h.

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

| Name / value parameter pair (first = name, second = value). Definition at line 201 of file OgreCommon.h. Referenced by Ogre::D3D7GpuProgramManager::createImpl(), Ogre::D3D7RenderTexture::D3D7RenderTexture(), Ogre::D3D9RenderTexture::D3D9RenderTexture(), and Ogre::GLRenderTexture::GLRenderTexture().

typedef std::list< OctreeNode * > Ogre::NodeList

| Definition at line 48 of file OgreOctree.h.

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

| Definition at line 76 of file OgreStringInterface.h.

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

| Definition at line 141 of file OgreStringInterface.h.

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

| Definition at line 65 of file OgreStringInterface.h. Referenced by Ogre::ParamDictionary::getParameters().

typedef std::vector<PlaneBoundedVolume> Ogre::PlaneBoundedVolumeList

| Definition at line 125 of file OgrePlaneBoundedVolume.h. Referenced by Ogre::SceneManager::ShadowCasterSceneQueryListener::prepare().

typedef std::vector<Plane> Ogre::PlaneList

| Definition at line 100 of file OgrePlane.h. Referenced by Ogre::Renderable::getClipPlanes().

typedef std::list<RaySceneQueryResultEntry> Ogre::RaySceneQueryResult

| Definition at line 350 of file OgreSceneQuery.h.

typedef float Ogre::Real

Software floating point type.

Note:
  Not valid as a pointer to GPU buffers / parameters

Definition at line 111 of file OgrePrerequisites.h.

Referenced by Ogre::D3D9RenderSystem::__SetFloatRenderState(), Ogre::OverlayElement::_getHeight(), Ogre::OverlayElement::_getLeft(), Ogre::OverlayElement::_getTop(), Ogre::OverlayElement::_getWidth(), _max(), Ogre::Math::Abs(), Ogre::Angle::Angle(), Ogre::Math::ATan(), Ogre::Math::ATan2(), Ogre::GpuProgramParameters::AutoConstantEntry::AutoConstantEntry(), Ogre::AxisAlignedBox::AxisAlignedBox(), Ogre::Math::Ceil(), Ogre::Math::Cos(), Ogre::Degree::Degree(), Ogre::Math::DegreesToRadians(), Ogre::Vector3::directionEquals(), Ogre::Vector4::dotProduct(), Ogre::Vector3::dotProduct(), Ogre::Vector2::dotProduct(), Ogre::Math::Exp(), Ogre::Math::Floor(), Ogre::WireBoundingBox::getBoundingRadius(), Ogre::TerrainRenderable::getBoundingRadius(), Ogre::Rectangle2D::getBoundingRadius(), Ogre::ParticleSystem::getBoundingRadius(), Ogre::MovablePlane::getBoundingRadius(), Ogre::Light::getBoundingRadius(), Ogre::Font::getGlyphAspectRatio(), Ogre::Font::getGlyphTexCoords(), Ogre::ResourceManager::getLoadingOrder(), Ogre::EventDispatcher::getMouseX(), Ogre::EventDispatcher::getMouseY(), Ogre::Particle::getOwnHeight(), Ogre::Particle::getOwnWidth(), Ogre::Ray::getPoint(), Ogre::Sphere::getRadius(), Ogre::MouseEvent::getRelX(), Ogre::Cursor::getRelX(), Ogre::MouseEvent::getRelY(), Ogre::Cursor::getRelY(), Ogre::MouseEvent::getRelZ(), Ogre::Cursor::getRelZ(), Ogre::StaticGeometry::getRenderingDistance(), Ogre::Vector3::getRotationTo(), Ogre::Matrix4::getScale(), Ogre::Cursor::getScale(), Ogre::SceneManager::getShadowFarDistance(), Ogre::ParticleSystem::getSpeedFactor(), Ogre::StaticGeometry::LODBucket::getSquaredDistance(), Ogre::StaticGeometry::getSquaredRenderingDistance(), Ogre::ShadowRenderable::getSquaredViewDepth(), Ogre::Rectangle2D::getSquaredViewDepth(), Ogre::OverlayElement::getSquaredViewDepth(), Ogre::BorderRenderable::getSquaredViewDepth(), Ogre::Matrix4::getTrans(), Ogre::Rectangle::inside(), Ogre::PlaneBoundedVolume::intersects(), Ogre::Vector3::isZeroLength(), Ogre::Vector2::isZeroLength(), Ogre::Vector3::length(), Ogre::Vector2::length(), Ogre::Cursor::limit(), Ogre::LinkedSkeletonAnimationSource::LinkedSkeletonAnimationSource(), Ogre::Math::Log(), Ogre::Matrix4::makeTrans(), Ogre::Matrix3::Matrix3(), Ogre::Matrix4::Matrix4(), Ogre::Vector3::normalise(), Ogre::Vector2::normalise(), Ogre::Vector4::operator *(), Ogre::Vector3::operator *(), Ogre::Vector2::operator *(), Ogre::Ray::operator *(), Ogre::Matrix4::operator *(), operator *(), Ogre::Degree::operator *(), Ogre::Radian::operator *(), Ogre::Vector4::operator *=(), Ogre::Vector3::operator *=(), Ogre::Vector2::operator *=(), Ogre::Degree::operator *=(), Ogre::Radian::operator *=(), Ogre::RenderPriorityGroup::TransparentQueueItemLess::operator()(), Ogre::Vector4::operator/(), Ogre::Vector3::operator/(), Ogre::Vector2::operator/(), operator/(), Ogre::Degree::operator/(), Ogre::Radian::operator/(), Ogre::Vector4::operator/=(), Ogre::Vector3::operator/=(), Ogre::Vector2::operator/=(), Ogre::Degree::operator/=(), Ogre::Radian::operator/=(), Ogre::Matrix3::operator=(), Ogre::Degree::operator=(), Ogre::Radian::operator=(), Ogre::Vector4::operator[](), Ogre::Vector3::operator[](), Ogre::Vector2::operator[](), Ogre::Matrix4::operator[](), Ogre::Matrix3::operator[](), Ogre::Vector3::perpendicular(), OgreRefApp::CollideCamera::pitch(), OgreRefApp::ApplicationObject::pitch(), Ogre::Vector3::positionEquals(), Ogre::Math::Pow(), Ogre::SceneManager::ShadowCasterSceneQueryListener::prepare(), Ogre::Quaternion::Quaternion(), Ogre::Radian::Radian(), Ogre::Math::RadiansToDegrees(), Ogre::Vector2::randomDeviant(), OgreRefApp::CollideCamera::roll(), OgreRefApp::ApplicationObject::roll(), OgreRefApp::CollideCamera::rotate(), OgreRefApp::ApplicationObject::rotate(), Ogre::AxisAlignedBox::setExtents(), OgreRefApp::CollideCamera::setFOVy(), Ogre::Font::setGlyphAspectRatio(), Ogre::Font::setGlyphTexCoords(), Ogre::AxisAlignedBox::setMaximum(), Ogre::AxisAlignedBox::setMinimum(), Ogre::Sphere::setRadius(), Ogre::StaticGeometry::setRenderingDistance(), Ogre::RotationAffector::setRotationRangeEnd(), Ogre::RotationAffector::setRotationRangeStart(), Ogre::RotationAffector::setRotationSpeedRangeEnd(), Ogre::RotationAffector::setRotationSpeedRangeStart(), Ogre::Cursor::setScale(), Ogre::SceneManager::setShadowDirLightTextureOffset(), Ogre::SceneManager::setShadowTextureFadeEnd(), Ogre::SceneManager::setShadowTextureFadeStart(), Ogre::ParticleSystem::setSpeedFactor(), Ogre::Math::Sin(), Ogre::Sphere::Sphere(), Ogre::Math::Sqr(), Ogre::Math::Sqrt(), Ogre::Vector3::squaredLength(), Ogre::Vector2::squaredLength(), Ogre::Math::Tan(), Ogre::Degree::valueAngleUnits(), Ogre::Radian::valueAngleUnits(), Ogre::Radian::valueDegrees(), Ogre::Degree::valueDegrees(), Ogre::Degree::valueRadians(), Ogre::Radian::valueRadians(), Ogre::Vector2::Vector2(), Ogre::Vector3::Vector3(), Ogre::Vector4::Vector4(), Ogre::AxisAlignedBox::volume(), OgreRefApp::CollideCamera::yaw(), and OgreRefApp::ApplicationObject::yaw().

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

| Definition at line 46 of file OgreRoot.h.

typedef std::map< String, RenderTarget * > Ogre::RenderTargetMap

| Definition at line 48 of file OgreRenderSystem.h.

typedef std::multimap<uchar, RenderTarget * > Ogre::RenderTargetPriorityMap

| Definition at line 49 of file OgreRenderSystem.h.

typedef unsigned long Ogre::ResourceHandle

| Definition at line 35 of file OgreResource.h. Referenced by Ogre::D3D7GpuProgramManager::createImpl(), Ogre::D3D7GpuProgram::D3D7GpuProgram(), Ogre::Resource::getHandle(), and Ogre::ResourceManager::resourceExists().

typedef SharedPtr<Resource> Ogre::ResourcePtr

Shared pointer to a Resource.

Remarks:
  This shared pointer allows many references to a resource to be held, and when the final reference is removed, the resource will be destroyed. Note that the ResourceManager which created this Resource will be holding at least one reference, so this resource will not get destroyed until someone removes the resource from the manager - this at least gives you strong control over when resources are freed. But the nature of the shared pointer means that if anyone refers to the removed resource in the meantime, the resource will remain valid.

  You may well see references to ResourcePtr (i.e. ResourcePtr&) being passed around internally within Ogre. These are 'weak references' ie they do not increment the reference count on the Resource. This is done for efficiency in temporary operations that shouldn't need to incur the overhead of maintaining the reference count; however we don't recommend you do it yourself since these references are not guaranteed to remain valid.

Definition at line 236 of file OgreResource.h.

Referenced by Ogre::BspLevelPtr::BspLevelPtr(), Ogre::D3D9GpuProgramPtr::D3D9GpuProgramPtr(), Ogre::D3D9TexturePtr::D3D9TexturePtr(), Ogre::D3DTexturePtr::D3DTexturePtr(), Ogre::FontPtr::FontPtr(), Ogre::GLTexturePtr::GLTexturePtr(), Ogre::HighLevelGpuProgramPtr::HighLevelGpuProgramPtr(), Ogre::MaterialPtr::MaterialPtr(), Ogre::TexturePtr::operator=(), Ogre::SkeletonPtr::operator=(), Ogre::PatchMeshPtr::operator=(), Ogre::MaterialPtr::operator=(), Ogre::HighLevelGpuProgramPtr::operator=(), Ogre::GpuProgramPtr::operator=(), Ogre::GLTexturePtr::operator=(), Ogre::FontPtr::operator=(), Ogre::D3D9TexturePtr::operator=(), Ogre::D3D9GpuProgramPtr::operator=(), Ogre::D3DTexturePtr::operator=(), Ogre::BspLevelPtr::operator=(), Ogre::PatchMeshPtr::PatchMeshPtr(), Ogre::SkeletonPtr::SkeletonPtr(), and Ogre::TexturePtr::TexturePtr().

typedef uint32 Ogre::RGBA

| Definition at line 32 of file OgreColourValue.h. Referenced by Ogre::VertexElement::baseVertexPointerToElement().

typedef std::list<SceneQueryMovableObjectPair> Ogre::SceneQueryMovableIntersectionList

| Definition at line 467 of file OgreSceneQuery.h.

typedef std::pair<MovableObject*, MovableObject*> Ogre::SceneQueryMovableObjectPair

| Definition at line 465 of file OgreSceneQuery.h.

typedef std::pair<MovableObject*, SceneQuery::WorldFragment*> Ogre::SceneQueryMovableObjectWorldFragmentPair

| Definition at line 466 of file OgreSceneQuery.h.

typedef std::list<SceneQueryMovableObjectWorldFragmentPair> Ogre::SceneQueryMovableWorldFragmentIntersectionList

| Definition at line 468 of file OgreSceneQuery.h.

typedef std::list<MovableObject*> Ogre::SceneQueryResultMovableList

| Definition at line 183 of file OgreSceneQuery.h.

typedef std::list<SceneQuery::WorldFragment*> Ogre::SceneQueryResultWorldFragmentList

| Definition at line 184 of file OgreSceneQuery.h.

typedef _StringBase Ogre::String

Definition at line 154 of file OgrePrerequisites.h.

Referenced by Ogre::D3D9Texture::_getCubeFaceName(), Ogre::D3DTexture::_getCubeFaceName(), Ogre::Resource::_notifyOrigin(), Ogre::ParticleSystem::_notifyOrigin(), Ogre::Overlay::_notifyOrigin(), Ogre::GpuProgramManager::_pushSyntaxCode(), Ogre::Archive::Archive(), Ogre::AutomaticGuardUnguard::AutomaticGuardUnguard(), Ogre::BspSceneNode::BspSceneNode(), Ogre::D3D7GpuProgramManager::createImpl(), Ogre::ZipArchiveFactory::createInstance(), Ogre::FileSystemArchiveFactory::createInstance(), Ogre::TextureManager::createManual(), Ogre::TextAreaOverlayElementFactory::createOverlayElement(), Ogre::BorderPanelOverlayElementFactory::createOverlayElement(), Ogre::PanelOverlayElementFactory::createOverlayElement(), Ogre::StringInterface::createParamDictionary(), Ogre::D3D7GpuProgram::D3D7GpuProgram(), Ogre::D3D7RenderTexture::D3D7RenderTexture(), Ogre::D3D9RenderTexture::D3D9RenderTexture(), Ogre::DataStream::DataStream(), Ogre::ImageCodec::ImageData::dataType(), Ogre::Codec::CodecData::dataType(), Ogre::SDLError::display(), Ogre::GLXError::display(), Ogre::SceneManager::estimateWorldGeometry(), Ogre::GLSLProgram::getAttachedShaderNames(), Ogre::CgProgram::getCompileArguments(), Ogre::D3D9RenderTexture::getCustomAttribute(), Ogre::D3D7RenderTexture::getCustomAttribute(), Ogre::Exception::getDescription(), Ogre::TerrainSceneManager::getDetailTexture(), Ogre::ExternalTextureSource::getDictionaryStringName(), Ogre::ShadowVolumeExtrudeProgram::getDirectionalLightExtruderArbvp1(), Ogre::ShadowVolumeExtrudeProgram::getDirectionalLightExtruderArbvp1Debug(), Ogre::ShadowVolumeExtrudeProgram::getDirectionalLightExtruderArbvp1Finite(), Ogre::ShadowVolumeExtrudeProgram::getDirectionalLightExtruderArbvp1FiniteDebug(), Ogre::ShadowVolumeExtrudeProgram::getDirectionalLightExtruderVs_1_1(), Ogre::ShadowVolumeExtrudeProgram::getDirectionalLightExtruderVs_1_1Debug(), Ogre::ShadowVolumeExtrudeProgram::getDirectionalLightExtruderVs_1_1Finite(), Ogre::ShadowVolumeExtrudeProgram::getDirectionalLightExtruderVs_1_1FiniteDebug(), Ogre::D3D9HLSLProgram::getEntryPoint(), Ogre::CgProgram::getEntryPoint(), Ogre::Exception::getFile(), Ogre::GLSupport::getGLVendor(), Ogre::GLSupport::getGLVersion(), Ogre::Resource::getGroup(), Ogre::ExternalTextureSource::getInputName(), Ogre::StaticGeometry::MaterialBucket::getMaterialName(), Ogre::RenderSystemCapabilities::getMaxFragmentProgramVersion(), Ogre::RenderSystemCapabilities::getMaxVertexProgramVersion(), Ogre::TerrainRenderable::getMovableType(), Ogre::TerrainRenderable::getName(), Ogre::StaticGeometry::getName(), Ogre::ScaleAffectorFactory::getName(), Ogre::RotationAffectorFactory::getName(), Ogre::RingEmitterFactory::getName(), Ogre::Resource::getName(), Ogre::PointEmitterFactory::getName(), Ogre::ParticleSystem::getName(), Ogre::LinearForceAffectorFactory::getName(), Ogre::HollowEllipsoidEmitterFactory::getName(), Ogre::EllipsoidEmitterFactory::getName(), Ogre::DynLib::getName(), Ogre::DataStream::getName(), Ogre::CylinderEmitterFactory::getName(), Ogre::ColourInterpolatorAffectorFactory::getName(), Ogre::ColourImageAffectorFactory::getName(), Ogre::ColourFaderAffectorFactory2::getName(), Ogre::ColourFaderAffectorFactory::getName(), Ogre::BoxEmitterFactory::getName(), Ogre::Archive::getName(), Ogre::SceneManager::getOption(), Ogre::SceneManager::getOptionValues(), Ogre::Resource::getOrigin(), Ogre::ParticleSystem::getOrigin(), Ogre::Overlay::getOrigin(), Ogre::ParamDictionary::getParamCommand(), Ogre::StringInterface::getParameter(), Ogre::ExternalTextureSource::getPlugInStringName(), Ogre::ShadowVolumeExtrudeProgram::getPointLightExtruderArbvp1(), Ogre::ShadowVolumeExtrudeProgram::getPointLightExtruderArbvp1Debug(), Ogre::ShadowVolumeExtrudeProgram::getPointLightExtruderArbvp1Finite(), Ogre::ShadowVolumeExtrudeProgram::getPointLightExtruderArbvp1FiniteDebug(), Ogre::ShadowVolumeExtrudeProgram::getPointLightExtruderVs_1_1(), Ogre::ShadowVolumeExtrudeProgram::getPointLightExtruderVs_1_1Debug(), Ogre::ShadowVolumeExtrudeProgram::getPointLightExtruderVs_1_1Finite(), Ogre::ShadowVolumeExtrudeProgram::getPointLightExtruderVs_1_1FiniteDebug(), Ogre::GpuProgramUsage::getProgramName(), Ogre::ParticleSystem::getResourceGroupName(), Ogre::ResourceManager::getResourceType(), Ogre::GpuProgram::getSource(), Ogre::Exception::getSource(), Ogre::GpuProgram::getSyntaxCode(), Ogre::D3D9HLSLProgram::getTarget(), Ogre::ParticleEmitter::getType(), Ogre::ParticleAffector::getType(), Ogre::Archive::getType(), Ogre::TextAreaOverlayElementFactory::getTypeName(), Ogre::BorderPanelOverlayElementFactory::getTypeName(), Ogre::PanelOverlayElementFactory::getTypeName(), Ogre::ResourceGroupManager::getWorldResourceGroupName(), Ogre::TerrainSceneManager::getWorldTexture(), Ogre::GLRenderTexture::GLRenderTexture(), Ogre::SceneManager::hasOption(), Ogre::OverlayManager::isTemplate(), Ogre::LinkedSkeletonAnimationSource::LinkedSkeletonAnimationSource(), Ogre::LogManager::logMessage(), Ogre::ParameterDef::ParameterDef(), Ogre::StringConverter::parseAngle(), Ogre::ResourceManager::parseScript(), Ogre::ResourceManager::resourceExists(), Ogre::CgProgram::setCompileArguments(), Ogre::D3D9HLSLProgram::setEntryPoint(), Ogre::CgProgram::setEntryPoint(), Ogre::ExternalTextureSource::setInputName(), Ogre::RenderSystemCapabilities::setMaxFragmentProgramVersion(), Ogre::RenderSystemCapabilities::setMaxVertexProgramVersion(), Ogre::SceneManager::setOption(), Ogre::ResourceGroupManager::setWorldResourceGroupName(), Ogre::StringConverter::toString(), Ogre::MaterialSerializer::writeAttribute(), Ogre::MaterialSerializer::writeComment(), Ogre::D3D9RenderTexture::writeContentsToFile(), Ogre::D3D7RenderTexture::writeContentsToFile(), Ogre::MaterialSerializer::writeValue(), and Ogre::GpuProgram::~GpuProgram().

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

| Definition at line 36 of file OgreStringVector.h. Referenced by Ogre::SceneManager::getOptionKeys(), Ogre::SceneManager::getOptionValues(), Ogre::CgProgram::getProfiles(), Ogre::RenderSystem::getRenderSystemEvents(), and Ogre::ResourceManager::getScriptPatterns().

typedef SharedPtr<StringVector> Ogre::StringVectorPtr

| Definition at line 37 of file OgreStringVector.h.

typedef std::vector< TerrainPageRow > Ogre::TerrainPage2D

| Definition at line 53 of file OgreTerrainSceneManager.h.

typedef std::vector< TerrainPage * > Ogre::TerrainPageRow

| Definition at line 52 of file OgreTerrainSceneManager.h.

typedef std::pair<String, String> Ogre::TerrainPageSourceOption

| Definition at line 34 of file OgreTerrainPageSource.h.

typedef std::vector<TerrainPageSourceOption> Ogre::TerrainPageSourceOptionList

| Definition at line 35 of file OgreTerrainPageSource.h. Referenced by Ogre::TerrainPageSource::initialise().

typedef int Ogre::TrackVertexColourType

| An enumeration describing which material properties should track the vertex colours. Definition at line 186 of file OgreCommon.h.

typedef unsigned char Ogre::uchar

In order to avoid finger-aches :).

Definition at line 139 of file OgrePrerequisites.h.

Referenced by Ogre::MemoryDataStream::getCurrentPtr(), Ogre::RenderTarget::getPriority(), Ogre::MemoryDataStream::getPtr(), Ogre::MouseState::isButtonDown(), Ogre::Image::loadDynamicImage(), Ogre::LinearResampler_Byte< channels >::scale(), Ogre::LinearResampler::scale(), Ogre::NearestResampler< elemsize >::scale(), and Ogre::RenderTarget::setPriority().

typedef unsigned int Ogre::uint

| Definition at line 141 of file OgrePrerequisites.h. Referenced by Ogre::TextureManager::createManual(), and Ogre::GLRenderTexture::GLRenderTexture().

typedef unsigned short Ogre::uint16

| Definition at line 200 of file OgrePlatform.h. Referenced by Ogre::Bitwise::floatToHalf(), Ogre::Bitwise::floatToHalfI(), Ogre::Bitwise::halfToFloat(), Ogre::Bitwise::halfToFloatI(), Ogre::Bitwise::intRead(), and Ogre::Bitwise::intWrite().

typedef unsigned int Ogre::uint32

| Definition at line 199 of file OgrePlatform.h. Referenced by Ogre::Bitwise::fixedToFixed(), Ogre::Bitwise::floatToHalfI(), Ogre::StaticGeometry::Region::getID(), Ogre::Bitwise::halfToFloat(), Ogre::Bitwise::halfToFloatI(), Ogre::Bitwise::intRead(), and Ogre::Bitwise::intWrite().

typedef unsigned __int64 Ogre::uint64

| Definition at line 36 of file OgreImageResampler.h. Referenced by Ogre::LinearResampler_Byte< channels >::scale(), Ogre::LinearResampler_Float32::scale(), Ogre::LinearResampler::scale(), and Ogre::NearestResampler< elemsize >::scale().

typedef unsigned char Ogre::uint8

| Definition at line 201 of file OgrePlatform.h. Referenced by Ogre::Bitwise::intRead(), and Ogre::Bitwise::intWrite().

typedef unsigned long Ogre::ulong

| Definition at line 142 of file OgrePrerequisites.h.

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

| Definition at line 197 of file OgreCommon.h.

typedef unsigned short Ogre::ushort

Definition at line 140 of file OgrePrerequisites.h.

Referenced by Ogre::RenderQueueGroup::addRenderable(), Ogre::RenderSystemCapabilities::getFragmentProgramConstantBoolCount(), Ogre::RenderSystemCapabilities::getFragmentProgramConstantFloatCount(), Ogre::RenderSystemCapabilities::getFragmentProgramConstantIntCount(), Ogre::StaticGeometry::LODBucket::getLod(), Ogre::RenderSystemCapabilities::getNumTextureUnits(), Ogre::RenderSystemCapabilities::getNumWorldMatricies(), Ogre::RenderSystemCapabilities::getStencilBufferBitDepth(), Ogre::RenderSystemCapabilities::getVertexProgramConstantBoolCount(), Ogre::RenderSystemCapabilities::getVertexProgramConstantFloatCount(), Ogre::RenderSystemCapabilities::getVertexProgramConstantIntCount(), Ogre::OverlayElement::getZOrder(), Ogre::TerrainPageSource::initialise(), Ogre::RenderSystemCapabilities::numVertexBlendMatrices(), Ogre::RenderSystemCapabilities::setFragmentProgramConstantBoolCount(), Ogre::RenderSystemCapabilities::setFragmentProgramConstantFloatCount(), Ogre::RenderSystemCapabilities::setFragmentProgramConstantIntCount(), Ogre::RenderSystemCapabilities::setNumTextureUnits(), Ogre::RenderSystemCapabilities::setNumVertexBlendMatrices(), Ogre::RenderSystemCapabilities::setNumWorldMatricies(), Ogre::RenderSystemCapabilities::setStencilBufferBitDepth(), Ogre::RenderSystemCapabilities::setVertexProgramConstantBoolCount(), Ogre::RenderSystemCapabilities::setVertexProgramConstantFloatCount(), and Ogre::RenderSystemCapabilities::setVertexProgramConstantIntCount().

typedef struct Ogre::VertexBoneAssignment_s Ogre::VertexBoneAssignment

Records the assignment of a single vertex to a single bone with the corresponding weight.

Remarks:
  This simple struct simply holds a vertex index, bone index and weight representing the assignment of a vertex to a bone for skeletal animation. There may be many of these per vertex if blended vertex assignments are allowed.

## Enumeration Type Documentation

enum Ogre::_OCCLUSIONQUERY

Hardware occlusion query flags.

Enumeration values:

  HWOCCLUSIONQUERY_FLUSH |
  HWOCCLUSIONQUERY_NOFLUSH | Direct3D uses this, but not OpenGL.

Definition at line 37 of file OgreHardwareOcclusionQuery.h.

enum Ogre::BillboardOrigin

Enum covering what exactly a billboard's position means (center, top-left etc).

See also:
  BillboardSet::setBillboardOrigin

Enumeration values:

  BBO_TOP_LEFT |
  BBO_TOP_CENTER |
  BBO_TOP_RIGHT |
  BBO_CENTER_LEFT |
  BBO_CENTER |
  BBO_CENTER_RIGHT |
  BBO_BOTTOM_LEFT |
  BBO_BOTTOM_CENTER |
  BBO_BOTTOM_RIGHT |

Definition at line 41 of file OgreBillboardSet.h.

Referenced by Ogre::BillboardParticleRenderer::getBillboardOrigin().

enum Ogre::BillboardType

The type of billboard to use.

Enumeration values:

  BBT_POINT | Standard point billboard (default), always faces the camera completely and is always upright.
  BBT_ORIENTED_COMMON | Billboards are oriented around a shared direction vector (used as Y axis) and only rotate around this to face the camera.
  BBT_ORIENTED_SELF | Billboards are oriented around their own direction vector (their own Y axis) and only rotate around this to face the camera.

Definition at line 54 of file OgreBillboardSet.h.

enum Ogre::Capabilities

Enum describing the different hardware capabilities we want to check for.

Enumeration values:

  RSC_AUTOMIPMAP | Supporta generating mipmaps in hardware.
  RSC_BLENDING |
  RSC_ANISOTROPY | Supports anisotropic texture filtering.
  RSC_DOT3 | Supports fixed-function DOT3 texture blend.
  RSC_CUBEMAPPING | Supports cube mapping.
  RSC_HWSTENCIL | Supports hardware stencil buffer.
  RSC_VBO | Supports hardware vertex and index buffers.
  RSC_VERTEX_PROGRAM | Supports vertex programs (vertex shaders).
  RSC_FRAGMENT_PROGRAM | Supports fragment programs (pixel shaders).
  RSC_TEXTURE_COMPRESSION | Supports compressed textures.
  RSC_TEXTURE_COMPRESSION_DXT | Supports compressed textures in the DXT/ST3C formats.
  RSC_TEXTURE_COMPRESSION_VTC | Supports compressed textures in the VTC format.
  RSC_SCISSOR_TEST | Supports performing a scissor test to exclude areas of the screen.
  RSC_TWO_SIDED_STENCIL | Supports separate stencil updates for both front and back faces.
  RSC_STENCIL_WRAP | Supports wrapping the stencil value at the range extremeties.
  RSC_HWOCCLUSION | Supports hardware occlusion queries.
  RSC_USER_CLIP_PLANES | Supports user clipping planes.
  RSC_VERTEX_FORMAT_UBYTE4 | Supports the VET_UBYTE4 vertex element type.
  RSC_INFINITE_FAR_PLANE | Supports infinite far plane projection.
  RSC_HWRENDER_TO_TEXTURE | Supports hardware render-to-texture (bigger than framebuffer).
  RSC_TEXTURE_FLOAT | Supports float textures and render targets.
  RSC_NON_POWER_OF_2_TEXTURES | Supports non-power of two textures.
  RSC_TEXTURE_3D | Supports 3d (volume) textures.

Definition at line 35 of file OgreRenderSystemCapabilities.h.

enum Ogre::CompareFunction

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

Enumeration values:

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

Definition at line 36 of file OgreCommon.h.

Referenced by Ogre::Pass::getAlphaRejectFunction().

enum Ogre::CullingMode

Hardware culling modes based on vertex winding.

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

Enumeration values:

  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 107 of file OgreCommon.h.

enum Ogre::eTexturePlayMode

Enum for type of texture play mode.

Enumeration values:

  TextureEffectPause |
  TextureEffectPlay_ASAP | Video starts out paused.
  TextureEffectPlay_Looping | Video starts playing as soon as posible.

Definition at line 50 of file OgreExternalTextureSource.h.

Referenced by Ogre::ExternalTextureSource::getPlayMode().

enum Ogre::FaceGroupType

A type of face group, ie face list of procedural etc.

Enumeration values:

  FGT_FACE_LIST |
  FGT_PATCH |
  FGT_UNKNOWN |

Definition at line 36 of file OgreStaticFaceGroup.h.

enum Ogre::FilterOptions

Filtering options for textures / mipmaps.

Enumeration values:

  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 72 of file OgreCommon.h.

enum Ogre::FilterType

Enumeration values:

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

Definition at line 62 of file OgreCommon.h.

enum Ogre::FogMode

Fog modes.

Enumeration values:

  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 93 of file OgreCommon.h.

enum Ogre::FontType

Enumerates the types of Font usable in the engine.

Enumeration values:

  FT_TRUETYPE | Generated from a truetype (.ttf) font.
  FT_IMAGE | Loaded from an image created by an artist.

Definition at line 52 of file OgreFont.h.

enum Ogre::FrameBufferType

Defines the frame buffers which can be cleared.

Enumeration values:

  FBT_COLOUR |
  FBT_DEPTH |
  FBT_STENCIL |

Definition at line 88 of file OgreRenderSystem.h.

enum Ogre::FrustumPlane

Worldspace clipping planes.

Enumeration values:

  FRUSTUM_PLANE_NEAR |
  FRUSTUM_PLANE_FAR |
  FRUSTUM_PLANE_LEFT |
  FRUSTUM_PLANE_RIGHT |
  FRUSTUM_PLANE_TOP |
  FRUSTUM_PLANE_BOTTOM |

Definition at line 47 of file OgreFrustum.h.

enum Ogre::GpuProgramType

Enumerates the types of programs which can run on the GPU.

Enumeration values:

  GPT_VERTEX_PROGRAM |
  GPT_FRAGMENT_PROGRAM |

Definition at line 37 of file OgreGpuProgram.h.

Referenced by Ogre::GpuProgramUsage::getType(), and Ogre::GpuProgram::getType().

enum Ogre::GrabMode

Enumeration values:

  GRAB_NONE |
  GRAB_MOUSE_OVER |
  GRAB_MOUSE_CLICK |

Definition at line 43 of file OgreSDLInput.h.

enum Ogre::GuiHorizontalAlignment

Enum describing where '0' is in relation to the parent in the horizontal dimension.

Remarks:
  Affects how 'left' is interpreted.

Enumeration values:

  GHA_LEFT |
  GHA_CENTER |
  GHA_RIGHT |

Definition at line 56 of file OgreOverlayElement.h.

enum Ogre::GuiMetricsMode

Enum describing how the position / size of an element is to be recorded.

Enumeration values:

  GMM_RELATIVE | 'left', 'top', 'height' and 'width' are parametrics from 0.0 to 1.0
  GMM_PIXELS | Positions & sizes are in absolute pixels.
  GMM_RELATIVE_ASPECT_ADJUSTED | Positions & sizes are in virtual pixels.

Definition at line 43 of file OgreOverlayElement.h.

enum Ogre::GuiVerticalAlignment

Enum describing where '0' is in relation to the parent in the vertical dimension.

Remarks:
  Affects how 'top' is interpreted.

Enumeration values:

  GVA_TOP |
  GVA_CENTER |
  GVA_BOTTOM |

Definition at line 65 of file OgreOverlayElement.h.

enum Ogre::IlluminationStage

Enumeration values:

  IS_AMBIENT | Part of the rendering which occurs without any kind of direct lighting.
  IS_PER_LIGHT | Part of the rendering which occurs per light.
  IS_DECAL | Post-lighting rendering.

Definition at line 941 of file OgrePass.h.

enum Ogre::ImageFlags

Enumeration values:

  IF_COMPRESSED |
  IF_CUBEMAP |
  IF_3D_TEXTURE |

Definition at line 35 of file OgreImage.h.

enum Ogre::KeyCode

Keyboard scan codes - copied from DirectInput for now for speed.

Enumeration values:

  KC_ESCAPE |
  KC_1 |
  KC_2 |
  KC_3 |
  KC_4 |
  KC_5 |
  KC_6 |
  KC_7 |
  KC_8 |
  KC_9 |
  KC_0 |
  KC_MINUS |
  KC_EQUALS |
  KC_BACK |
  KC_TAB |
  KC_Q |
  KC_W |
  KC_E |
  KC_R |
  KC_T |
  KC_Y |
  KC_U |
  KC_I |
  KC_O |
  KC_P |
  KC_LBRACKET |
  KC_RBRACKET |
  KC_RETURN |
  KC_LCONTROL |
  KC_A |
  KC_S |
  KC_D |
  KC_F |
  KC_G |
  KC_H |
  KC_J |
  KC_K |
  KC_L |
  KC_SEMICOLON |
  KC_APOSTROPHE |
  KC_GRAVE |
  KC_LSHIFT |
  KC_BACKSLASH |
  KC_Z |
  KC_X |
  KC_C |
  KC_V |
  KC_B |
  KC_N |
  KC_M |
  KC_COMMA |
  KC_PERIOD |
  KC_SLASH |
  KC_RSHIFT |
  KC_MULTIPLY |
  KC_LMENU |
  KC_SPACE |
  KC_CAPITAL |
  KC_F1 |
  KC_F2 |
  KC_F3 |
  KC_F4 |
  KC_F5 |
  KC_F6 |
  KC_F7 |
  KC_F8 |
  KC_F9 |
  KC_F10 |
  KC_NUMLOCK |
  KC_SCROLL |
  KC_NUMPAD7 |
  KC_NUMPAD8 |
  KC_NUMPAD9 |
  KC_SUBTRACT |
  KC_NUMPAD4 |
  KC_NUMPAD5 |
  KC_NUMPAD6 |
  KC_ADD |
  KC_NUMPAD1 |
  KC_NUMPAD2 |
  KC_NUMPAD3 |
  KC_NUMPAD0 |
  KC_DECIMAL |
  KC_OEM_102 |
  KC_F11 |
  KC_F12 |
  KC_F13 |
  KC_F14 |
  KC_F15 |
  KC_KANA |
  KC_ABNT_C1 |
  KC_CONVERT |
  KC_NOCONVERT |
  KC_YEN |
  KC_ABNT_C2 |
  KC_NUMPADEQUALS |
  KC_PREVTRACK |
  KC_AT |
  KC_COLON |
  KC_UNDERLINE |
  KC_KANJI |
  KC_STOP |
  KC_AX |
  KC_UNLABELED |
  KC_NEXTTRACK |
  KC_NUMPADENTER |
  KC_RCONTROL |
  KC_MUTE |
  KC_CALCULATOR |
  KC_PLAYPAUSE |
  KC_MEDIASTOP |
  KC_VOLUMEDOWN |
  KC_VOLUMEUP |
  KC_WEBHOME |
  KC_NUMPADCOMMA |
  KC_DIVIDE |
  KC_SYSRQ |
  KC_RMENU |
  KC_PAUSE |
  KC_HOME |
  KC_UP |
  KC_PGUP |
  KC_LEFT |
  KC_RIGHT |
  KC_END |
  KC_DOWN |
  KC_PGDOWN |
  KC_INSERT |
  KC_DELETE |
  KC_LWIN |
  KC_RWIN |
  KC_APPS |
  KC_POWER |
  KC_SLEEP |
  KC_WAKE |
  KC_WEBSEARCH |
  KC_WEBFAVORITES |
  KC_WEBREFRESH |
  KC_WEBSTOP |
  KC_WEBFORWARD |
  KC_WEBBACK |
  KC_MYCOMPUTER |
  KC_MAIL |
  KC_MEDIASELECT |

Definition at line 34 of file OgreInput.h.

enum Ogre::LayerBlendOperation

List of valid texture blending operations, for use with TextureUnitState::setColourOperation.

Remarks:
  This list is a more limited list than LayerBlendOperationEx because it only includes operations that are supportable in both multipass and multitexture rendering and thus provides automatic fallback if multitexture hardware is lacking or insufficient.

Enumeration values:

  LBO_REPLACE | Replace all colour with texture with no adjustment.
  LBO_ADD | Add colour components together.
  LBO_MODULATE | Multiply colour components together.
  LBO_ALPHA_BLEND | Blend based on texture alpha.

Definition at line 48 of file OgreBlendMode.h.

enum Ogre::LayerBlendOperationEx

Expert list of valid texture blending operations, for use with TextureUnitState::setColourOperationEx and TextureUnitState::setAlphaOperation, and internally in the LayerBlendModeEx class.

It's worth noting that these operations are for blending between texture layers and not between rendered objects and the existing scene. Because all of these modes are only supported in multitexture hardware it may be required to set up a fallback operation where this hardware is not available.

Enumeration values:

  LBX_SOURCE1 | use source1 without modification
  LBX_SOURCE2 | use source2 without modification
  LBX_MODULATE | multiply source1 and source2 together
  LBX_MODULATE_X2 | as LBX_MODULATE but brighten afterwards (x2)
  LBX_MODULATE_X4 | as LBX_MODULATE but brighten more afterwards (x4)
  LBX_ADD | add source1 and source2 together
  LBX_ADD_SIGNED | as LBX_ADD, but subtract 0.5 from the result
  LBX_ADD_SMOOTH | as LBX_ADD, but subtract product from the sum
  LBX_SUBTRACT | subtract source2 from source1
  LBX_BLEND_DIFFUSE_ALPHA | use interpolated alpha value from vertices to scale source1, then add source2 scaled by (1-alpha)
  LBX_BLEND_TEXTURE_ALPHA | as LBX_BLEND_DIFFUSE_ALPHA, but use alpha from texture
  LBX_BLEND_CURRENT_ALPHA | as LBX_BLEND_DIFFUSE_ALPHA, but use current alpha from previous stages
  LBX_BLEND_MANUAL | as LBX_BLEND_DIFFUSE_ALPHA but use a constant manual blend value (0.0-1.0)
  LBX_DOTPRODUCT | dotproduct of color1 and color2

Definition at line 66 of file OgreBlendMode.h.

enum Ogre::LayerBlendSource

List of valid sources of values for blending operations used in TextureUnitState::setColourOperation and TextureUnitState::setAlphaOperation, and internally in the LayerBlendModeEx class.

Enumeration values:

  LBS_CURRENT | the colour as built up from previous stages
  LBS_TEXTURE | the colour derived from the texture assigned to this layer
  LBS_DIFFUSE | the interpolated diffuse colour from the vertices
  LBS_SPECULAR | the interpolated specular colour from the vertices
  LBS_MANUAL | a colour supplied manually as a separate argument

Definition at line 101 of file OgreBlendMode.h.

enum Ogre::LayerBlendType

Type of texture blend mode.

Enumeration values:

  LBT_COLOUR |
  LBT_ALPHA |

Definition at line 35 of file OgreBlendMode.h.

enum Ogre::LoggingLevel

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

Enumeration values:

  LL_LOW |
  LL_NORMAL |
  LL_BOREME |

Definition at line 38 of file OgreLog.h.

enum Ogre::LogMessageLevel

The importance of a logged message.

Enumeration values:

  LML_TRIVIAL |
  LML_NORMAL |
  LML_CRITICAL |

Definition at line 47 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).

Enumeration values:

  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 122 of file OgreCommon.h.

enum Ogre::MaterialScriptSection

Enum to identify material sections.

Enumeration values:

  MSS_NONE |
  MSS_MATERIAL |
  MSS_TECHNIQUE |
  MSS_PASS |
  MSS_TEXTUREUNIT |
  MSS_PROGRAM_REF |
  MSS_PROGRAM |
  MSS_DEFAULT_PARAMETERS |
  MSS_TEXTURESOURCE |

Definition at line 38 of file OgreMaterialSerializer.h.

enum Ogre::MeshChunkID

Definition of the OGRE .mesh file format.

.mesh files are binary files (for read efficiency at runtime) and are arranged into chunks of data, very like 3D Studio's format. A chunk always consists of: unsigned short CHUNK_ID : one of the following chunk ids identifying the chunk unsigned long LENGTH : length of the chunk in bytes, including this header void* DATA : the data, which may contain other sub-chunks (various data types)

A .mesh file can contain both the definition of the Mesh itself, and optionally the definitions of the materials is uses (although these can be omitted, if so the Mesh assumes that at runtime the Materials referred to by name in the Mesh are loaded/created from another source)

A .mesh file only contains a single mesh, which can itself have multiple submeshes.

Enumeration values:

  M_HEADER |
  M_MESH |
  M_SUBMESH |
  M_SUBMESH_OPERATION |
  M_SUBMESH_BONE_ASSIGNMENT |
  M_GEOMETRY |
  M_GEOMETRY_VERTEX_DECLARATION |
  M_GEOMETRY_VERTEX_ELEMENT |
  M_GEOMETRY_VERTEX_BUFFER |
  M_GEOMETRY_VERTEX_BUFFER_DATA |
  M_MESH_SKELETON_LINK |
  M_MESH_BONE_ASSIGNMENT |
  M_MESH_LOD |
  M_MESH_LOD_USAGE |
  M_MESH_LOD_MANUAL |
  M_MESH_LOD_GENERATED |
  M_MESH_BOUNDS |
  M_SUBMESH_NAME_TABLE |
  M_SUBMESH_NAME_TABLE_ELEMENT |
  M_EDGE_LISTS |
  M_EDGE_LIST_LOD |
  M_EDGE_GROUP |
  M_GEOMETRY_NORMALS |
  M_GEOMETRY_COLOURS |
  M_GEOMETRY_TEXCOORDS |

Definition at line 49 of file OgreMeshFileFormat.h.

enum Ogre::ParameterType

List of parameter types available.

Enumeration values:

  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 37 of file OgreStringInterface.h.

enum Ogre::PixelFormat

The pixel format used for images, textures, and render surfaces.

Enumeration values:

  PF_UNKNOWN | Unknown pixel format.
  PF_L8 | 8-bit pixel format, all bits luminace.
  PF_BYTE_L |
  PF_L16 | 16-bit pixel format, all bits luminace.
  PF_SHORT_L |
  PF_A8 | 8-bit pixel format, all bits alpha.
  PF_BYTE_A |
  PF_A4L4 | 8-bit pixel format, 4 bits alpha, 4 bits luminace.
  PF_BYTE_LA | 2 byte pixel format, 1 byte luminance, 1 byte alpha
  PF_R5G6B5 | 16-bit pixel format, 5 bits red, 6 bits green, 5 bits blue.
  PF_B5G6R5 | 16-bit pixel format, 5 bits red, 6 bits green, 5 bits blue.
  PF_R3G3B2 | 8-bit pixel format, 2 bits blue, 3 bits green, 3 bits red.
  PF_A4R4G4B4 | 16-bit pixel format, 4 bits for alpha, red, green and blue.
  PF_A1R5G5B5 | 16-bit pixel format, 5 bits for blue, green, red and 1 for alpha.
  PF_R8G8B8 | 24-bit pixel format, 8 bits for red, green and blue.
  PF_B8G8R8 | 24-bit pixel format, 8 bits for blue, green and red.
  PF_A8R8G8B8 | 32-bit pixel format, 8 bits for alpha, red, green and blue.
  PF_A8B8G8R8 | 32-bit pixel format, 8 bits for blue, green, red and alpha.
  PF_B8G8R8A8 | 32-bit pixel format, 8 bits for blue, green, red and alpha.
  PF_R8G8B8A8 | 32-bit pixel format, 8 bits for red, green, blue and alpha.
  PF_X8R8G8B8 | 32-bit pixel format, 8 bits for red, 8 bits for green, 8 bits for blue like PF_A8R8G8B8, but alpha will get discarded
  PF_X8B8G8R8 | 32-bit pixel format, 8 bits for blue, 8 bits for green, 8 bits for red like PF_A8B8G8R8, but alpha will get discarded
  PF_BYTE_RGB | 3 byte pixel format, 1 byte for red, 1 byte for green, 1 byte for blue
  PF_BYTE_BGR | 3 byte pixel format, 1 byte for blue, 1 byte for green, 1 byte for red
  PF_BYTE_BGRA | 4 byte pixel format, 1 byte for blue, 1 byte for green, 1 byte for red and one byte for alpha
  PF_BYTE_RGBA | 4 byte pixel format, 1 byte for red, 1 byte for green, 1 byte for blue, and one byte for alpha
  PF_A2R10G10B10 | 32-bit pixel format, 2 bits for alpha, 10 bits for red, green and blue.
  PF_A2B10G10R10 | 32-bit pixel format, 10 bits for blue, green and red, 2 bits for alpha.
  PF_DXT1 | DDS (DirectDraw Surface) DXT1 format.
  PF_DXT2 | DDS (DirectDraw Surface) DXT2 format.
  PF_DXT3 | DDS (DirectDraw Surface) DXT3 format.
  PF_DXT4 | DDS (DirectDraw Surface) DXT4 format.
  PF_DXT5 | DDS (DirectDraw Surface) DXT5 format.
  PF_FLOAT16_R |
  PF_FLOAT16_RGB |
  PF_FLOAT16_RGBA |
  PF_FLOAT32_R |
  PF_FLOAT32_RGB |
  PF_FLOAT32_RGBA |
  PF_DEPTH |
  PF_SHORT_RGBA |
  PF_COUNT |

Definition at line 33 of file OgrePixelFormat.h.

Referenced by Ogre::Texture::getFormat(), Ogre::HardwarePixelBuffer::getFormat(), and Ogre::SceneManager::getShadowTexturePixelFormat().

enum Ogre::PixelFormatFlags

Flags defining some on/off properties of pixel formats.

Enumeration values:

  PFF_HASALPHA |
  PFF_COMPRESSED |
  PFF_FLOAT |
  PFF_DEPTH |
  PFF_NATIVEENDIAN |
  PFF_LUMINANCE |

Definition at line 134 of file OgrePixelFormat.h.

enum Ogre::ProjectionType

Specifies perspective (realistic) or orthographic (architectural) projection.

Enumeration values:

  PT_ORTHOGRAPHIC |
  PT_PERSPECTIVE |

Definition at line 39 of file OgreFrustum.h.

enum Ogre::RenderQueueGroupID

Enumeration of queue groups, by which the application may group queued renderables so that they are rendered together with events in between.

Enumeration values:

  RENDER_QUEUE_BACKGROUND | Use this queue for objects which must be rendered first e.g. backgrounds.
  RENDER_QUEUE_SKIES_EARLY | First queue (after backgrounds), used for skyboxes if rendered first.
  RENDER_QUEUE_1 |
  RENDER_QUEUE_2 |
  RENDER_QUEUE_WORLD_GEOMETRY_1 |
  RENDER_QUEUE_3 |
  RENDER_QUEUE_4 |
  RENDER_QUEUE_MAIN | The default render queue.
  RENDER_QUEUE_6 |
  RENDER_QUEUE_7 |
  RENDER_QUEUE_WORLD_GEOMETRY_2 |
  RENDER_QUEUE_8 |
  RENDER_QUEUE_9 |
  RENDER_QUEUE_SKIES_LATE | Penultimate queue(before overlays), used for skyboxes if rendered last.
  RENDER_QUEUE_OVERLAY | Use this queue for objects which must be rendered last e.g. overlays.

Definition at line 36 of file OgreRenderQueue.h.

enum Ogre::SceneBlendFactor

Blending factors for manually blending objects with the scene.

If there isn't a predefined SceneBlendType that you like, then you can specify the blending factors directly to affect the combination of object and the existing scene. See Material::setSceneBlending for more details.

Enumeration values:

  SBF_ONE |
  SBF_ZERO |
  SBF_DEST_COLOUR |
  SBF_SOURCE_COLOUR |
  SBF_ONE_MINUS_DEST_COLOUR |
  SBF_ONE_MINUS_SOURCE_COLOUR |
  SBF_DEST_ALPHA |
  SBF_SOURCE_ALPHA |
  SBF_ONE_MINUS_DEST_ALPHA |
  SBF_ONE_MINUS_SOURCE_ALPHA |

Definition at line 221 of file OgreBlendMode.h.

enum Ogre::SceneBlendType

Types of blending that you can specify between an object and the existing contents of the scene.

Remarks:
  As opposed to the LayerBlendType, which classifies blends between texture layers, these blending types blend between the output of the texture units and the pixels already in the viewport, allowing for object transparency, glows, etc.

  These types are provided to give quick and easy access to common effects. You can also use the more manual method of supplying source and destination blending factors. See Material::setSceneBlending for more details.

See also:
  Material::setSceneBlending

Enumeration values:

  SBT_TRANSPARENT_ALPHA | Make the object transparent based on the final alpha values in the texture.
  SBT_TRANSPARENT_COLOUR | Make the object transparent based on the colour values in the texture (brighter = more opaque).
  SBT_ADD | Add the texture values to the existing scene content.
  SBT_MODULATE | Multiply the 2 colours together.

Definition at line 204 of file OgreBlendMode.h.

enum Ogre::SceneDetailLevel

The broad type of detail for rendering.

Enumeration values:

  SDL_POINTS | Only points are rendered.
  SDL_WIREFRAME | Wireframe models are rendered.
  SDL_SOLID | Solid polygons are rendered.

Definition at line 148 of file OgreCommon.h.

Referenced by Ogre::SubEntity::getRenderDetail(), and Ogre::Renderable::getRenderDetail().

enum Ogre::SceneType

Classification of a scene to allow a decision of what type of SceenManager to provide back to the application.

Enumeration values:

  ST_GENERIC |
  ST_EXTERIOR_CLOSE |
  ST_EXTERIOR_FAR |
  ST_EXTERIOR_REAL_FAR |
  ST_INTERIOR |

Definition at line 37 of file OgreSceneManagerEnumerator.h.

enum Ogre::ShadeOptions

Light shading modes.

Enumeration values:

  SO_FLAT |
  SO_GOURAUD |
  SO_PHONG |

Definition at line 85 of file OgreCommon.h.

enum Ogre::ShadowRenderableFlags

A set of flags that can be used to influence ShadowRenderable creation.

Enumeration values:

  SRF_INCLUDE_LIGHT_CAP | For shadow volume techniques only, generate a light cap on the volume.
  SRF_INCLUDE_DARK_CAP | For shadow volume techniques only, generate a dark cap on the volume.
  SRF_EXTRUDE_TO_INFINITY | For shadow volume techniques only, indicates volume is extruded to infinity.

Definition at line 92 of file OgreShadowCaster.h.

enum Ogre::ShadowTechnique

An enumeration of broad shadow techniques.

Enumeration values:

  SHADOWTYPE_NONE | No shadows.
  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 apparant 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.

Definition at line 159 of file OgreCommon.h.

Referenced by Ogre::SceneManager::getShadowTechnique().

enum Ogre::SkeletonAnimationBlendMode

Enumeration values:

  ANIMBLEND_AVERAGE | Animations are applied by calculating a weighted average of all animations.
  ANIMBLEND_CUMULATIVE | Animations are applied by calculating a weighted cumulative total.

Definition at line 38 of file OgreSkeleton.h.

enum Ogre::SkeletonChunkID

Definition of the OGRE .skeleton file format.

.skeleton files are binary files (for read efficiency at runtime) and are arranged into chunks of data, very like 3D Studio's format. A chunk always consists of: unsigned short CHUNK_ID : one of the following chunk ids identifying the chunk unsigned long LENGTH : length of the chunk in bytes, including this header void* DATA : the data, which may contain other sub-chunks (various data types)

A .skeleton file contains both the definition of the Skeleton object and the animations it contains. It contains only a single skeleton but can contain multiple animations.

Enumeration values:

  SKELETON_HEADER |
  SKELETON_BONE |
  SKELETON_BONE_PARENT |
  SKELETON_ANIMATION |
  SKELETON_ANIMATION_TRACK |
  SKELETON_ANIMATION_TRACK_KEYFRAME |
  SKELETON_ANIMATION_LINK |

Definition at line 46 of file OgreSkeletonFileFormat.h.

enum Ogre::StencilOperation

Enum describing the various actions which can be taken onthe stencil buffer.

Enumeration values:

  SOP_KEEP | Leave the stencil buffer unchanged.
  SOP_ZERO | Set the stencil value to zero.
  SOP_REPLACE | Set the stencil value to the reference value.
  SOP_INCREMENT | Increase the stencil value by 1, clamping at the maximum value.
  SOP_DECREMENT | Decrease the stencil value by 1, clamping at 0.
  SOP_INCREMENT_WRAP | Increase the stencil value by 1, wrapping back to 0 when incrementing the maximum value.
  SOP_DECREMENT_WRAP | Decrease the stencil value by 1, wrapping when decrementing 0.
  SOP_INVERT | Invert the bits of the stencil buffer.

Definition at line 67 of file OgreRenderSystem.h.

enum Ogre::TexCoordCalcMethod

Enum describing the ways to generate texture coordinates.

Enumeration values:

  TEXCALC_NONE | No calculated texture coordinates.
  TEXCALC_ENVIRONMENT_MAP | Environment map based on vertex normals.
  TEXCALC_ENVIRONMENT_MAP_PLANAR | Environment map based on vertex positions.
  TEXCALC_ENVIRONMENT_MAP_REFLECTION |
  TEXCALC_ENVIRONMENT_MAP_NORMAL |
  TEXCALC_PROJECTIVE_TEXTURE | Projective texture.

Definition at line 53 of file OgreRenderSystem.h.

enum Ogre::TextureFilterOptions

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

Enumeration values:

  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 50 of file OgreCommon.h.

enum Ogre::TextureMipmap

Enum identifying special mipmap numbers.

Enumeration values:

  MIP_UNLIMITED | Generate mipmaps up to 1x1.

Definition at line 72 of file OgreTexture.h.

enum Ogre::TextureType

Enum identifying the texture type.

Enumeration values:

  TEX_TYPE_1D | 1D texture, used in combination with 1D texture coordinates
  TEX_TYPE_2D | 2D texture, used in combination with 2D texture coordinates (default)
  TEX_TYPE_3D | 3D volume texture, used in combination with 3D texture coordinates
  TEX_TYPE_CUBE_MAP | 3D cube map, used in combination with 3D texture coordinates

Definition at line 58 of file OgreTexture.h.

Referenced by Ogre::Texture::getTextureType().

enum Ogre::TextureUsage

Enum identifying the texture usage.

Enumeration values:

  TU_STATIC |
  TU_DYNAMIC |
  TU_WRITE_ONLY |
  TU_STATIC_WRITE_ONLY |
  TU_DYNAMIC_WRITE_ONLY |
  TU_DYNAMIC_WRITE_ONLY_DISCARDABLE |
  TU_AUTOMIPMAP | mipmaps will be automatically generated for this texture
  TU_RENDERTARGET | this texture will be a render target, ie. used as a target for render to texture setting this flag will ignore all other texture usages except TU_AUTOMIPMAP
  TU_DEFAULT | default to automatic mipmap generation static textures

Definition at line 37 of file OgreTexture.h.

enum Ogre::TrackVertexColourEnum

Enumeration values:

  TVC_NONE |
  TVC_AMBIENT |
  TVC_DIFFUSE |
  TVC_SPECULAR |
  TVC_EMISSIVE |

Definition at line 187 of file OgreCommon.h.

enum Ogre::VertexElementSemantic

Vertex element semantics, used to identify the meaning of vertex buffer contents.

Enumeration values:

  VES_POSITION | Position, 3 reals per vertex.
  VES_BLEND_WEIGHTS | Blending weights.
  VES_BLEND_INDICES | Blending indices.
  VES_NORMAL | Normal, 3 reals per vertex.
  VES_DIFFUSE | Diffuse colours.
  VES_SPECULAR | Specular colours.
  VES_TEXTURE_COORDINATES | Texture coordinates.
  VES_BINORMAL | Binormal (Y axis if normal is Z).
  VES_TANGENT | Tangent (X axis if normal is Z).

Definition at line 70 of file OgreHardwareVertexBuffer.h.

Referenced by Ogre::VertexElement::getSemantic().

enum Ogre::VertexElementType

Vertex element type, used to identify the base types of the vertex contents.

Enumeration values:

  VET_FLOAT1 |
  VET_FLOAT2 |
  VET_FLOAT3 |
  VET_FLOAT4 |
  VET_COLOUR |
  VET_SHORT1 |
  VET_SHORT2 |
  VET_SHORT3 |
  VET_SHORT4 |
  VET_UBYTE4 |

Definition at line 93 of file OgreHardwareVertexBuffer.h.

Referenced by Ogre::VertexElement::getType().

enum Ogre::WaveformType

Enumerates the wave types usable with the Ogre engine.

Enumeration values:

  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.

Definition at line 133 of file OgreCommon.h.

## Function Documentation

template<typename _Interf>
void __safeRelease | ( | _Interf ** | interf | ) | throw ()

| Definition at line 49 of file OgreD3D7Prerequisites.h.

Real _max | ( | Real | x,
|  | Real | y
| ) |

| Definition at line 80 of file OgreTerrainRenderable.h. References Real.

void checkForCgError | ( | const String & | ogreMethod,
|  | const String & | errorTextPrefix,
|  | CGcontext | context
| ) |

Utility function, checks Cg for errors, throw exception if detected.

Parameters:

  ogreMethod | Ogre method name, as Class::method
  errorTextPrefix | The text to prefix the Cg error text with

void checkForGLSLError | ( | const String & | ogreMethod,
|  | const String & | errorTextPrefix,
|  | const GLhandleARB | obj,
|  | const bool | forceInfoLog = false,
|  | const bool | forceException = false
| ) |

Check for GL errors and report them in the Ogre Log.

Parameters:

  forceInfoLog | if true then message from GL info log is obtained
  forceException | if true then exception is generated if a GL error found

_OgreExport void CopyAnimationStateSubset | ( | AnimationStateSet & | target,
|  | const AnimationStateSet & | source
| ) |

Copies a subset animation states from source to target.

Remarks:
  This routine assume target is a subset of source, it will copy all animation state of the target with the settings from source.

Parameters:

  target | Reference to animation state set which will receive the states.
  source | Reference to animation state set which will use as source.

HRESULT CALLBACK D3DEnumDevicesCallback | ( | GUID FAR * | lpGuid,
|  | LPSTR | lpDeviceDescription,
|  | LPSTR | lpDeviceName,
|  | LPD3DDEVICEDESC7 | lpD3DHWDeviceDesc,
|  | LPD3DDEVICEDESC7 | lpD3DHELDeviceDesc,
|  | LPVOID | lpContext
| ) |

HRESULT WINAPI EnumModesCallback | ( | LPDDSURFACEDESC2 | lpDDSurfaceDesc,
|  | LPVOID | lpContext
| ) |

int _OgreExport 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 (ie 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 binnary options (ie 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.

GLSupport * Ogre::getGLSupport | ( |  | ) |

| Definition at line 33 of file GLX/OgreGLUtil.h.

bool InitGLShaderLanguageExtensions | ( | GLSupport & | glSupport | ) |

Rectangle 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 51 of file OgreRectangle.h.

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

String logObjectInfo | ( | const String & | msg,
|  | const GLhandleARB | obj
| ) |

if there is a message in GL info log then post it in the Ogre Log

Parameters:

  msg | the info log message string is appended to this string
  obj | the GL object that is used to retrieve the info log

Vector4 operator * | ( | const Vector4 & | v,
|  | const Matrix4 & | mat
| ) |

| Definition at line 501 of file OgreMatrix4.h. References Ogre::Vector4::w, Ogre::Vector4::x, Ogre::Vector4::y, and Ogre::Vector4::z.

Degree operator * | ( | Real | a,
|  | const Degree & | b
| ) |

| Definition at line 488 of file OgreMath.h. References Real, and Ogre::Degree::valueDegrees().

Radian operator * | ( | Real | a,
|  | const Radian & | b
| ) |

| Definition at line 478 of file OgreMath.h. References Real, and Ogre::Radian::valueRadians().

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

| Definition at line 163 of file OgreSharedPtr.h. References Ogre::SharedPtr< T >::get().

Degree operator/ | ( | Real | a,
|  | const Degree & | b
| ) |

| Definition at line 493 of file OgreMath.h. References Real, and Ogre::Degree::valueDegrees().

Radian operator/ | ( | Real | a,
|  | const Radian & | b
| ) |

| Definition at line 483 of file OgreMath.h. References Real, and Ogre::Radian::valueRadians().

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

| Definition at line 158 of file OgreSharedPtr.h. References Ogre::SharedPtr< T >::get(). Referenced by Ogre::Quaternion::operator!=(), and Ogre::Matrix3::operator!=().

## Variable Documentation

class _OgreD3DExport Ogre::D3DDevice

| Definition at line 33 of file OgreD3D7DeviceList.h.

unsigned int Ogre::driverCount = 0`[static]`

| Definition at line 39 of file OgreD3D9Driver.h.

PFNGLATTACHOBJECTARBPROC Ogre::glAttachObjectARB_ptr

| Definition at line 42 of file OgreGLSLExtSupport.h.

PFNGLBINDATTRIBLOCATIONARBPROC Ogre::glBindAttribLocationARB_ptr

| Definition at line 56 of file OgreGLSLExtSupport.h.

PFNGLCOMPILESHADERARBPROC Ogre::glCompileShaderARB_ptr

| Definition at line 45 of file OgreGLSLExtSupport.h.

PFNGLCREATEPROGRAMOBJECTARBPROC Ogre::glCreateProgramObjectARB_ptr

| Definition at line 38 of file OgreGLSLExtSupport.h.

PFNGLCREATESHADEROBJECTARBPROC Ogre::glCreateShaderObjectARB_ptr

| Definition at line 39 of file OgreGLSLExtSupport.h.

PFNGLDELETEOBJECTARBPROC Ogre::glDeleteObjectARB_ptr

| Definition at line 40 of file OgreGLSLExtSupport.h.

PFNGLDETACHOBJECTARBPROC Ogre::glDetachObjectARB_ptr

| Definition at line 41 of file OgreGLSLExtSupport.h.

PFNGLGETACTIVEUNIFORMARBPROC Ogre::glGetActiveUniformARB_ptr

| Definition at line 54 of file OgreGLSLExtSupport.h.

PFNGLGETATTRIBLOCATIONARBPROC Ogre::glGetAttribLocationARB_ptr

| Definition at line 53 of file OgreGLSLExtSupport.h.

PFNGLGETINFOLOGARBPROC Ogre::glGetInfoLogARB_ptr

| Definition at line 47 of file OgreGLSLExtSupport.h.

PFNGLGETOBJECTPARAMETERFVARBPROC Ogre::glGetObjectParameterfvARB_ptr

| Definition at line 51 of file OgreGLSLExtSupport.h.

PFNGLGETOBJECTPARAMETERIVARBPROC Ogre::glGetObjectParameterivARB_ptr

| Definition at line 50 of file OgreGLSLExtSupport.h.

PFNGLGETUNIFORMLOCATIONARBPROC Ogre::glGetUniformLocationARB_ptr

| Definition at line 52 of file OgreGLSLExtSupport.h.

PFNGLLINKPROGRAMARBPROC Ogre::glLinkProgramARB_ptr

| Definition at line 46 of file OgreGLSLExtSupport.h.

PFNGLSHADERSOURCEARBPROC Ogre::glShaderSourceARB_ptr

| Definition at line 44 of file OgreGLSLExtSupport.h.

PFNGLUNIFORM1FARBPROC Ogre::glUniform1fARB_ptr

| Definition at line 58 of file OgreGLSLExtSupport.h.

PFNGLUNIFORM1FVARBPROC Ogre::glUniform1fvARB_ptr

| Definition at line 68 of file OgreGLSLExtSupport.h.

PFNGLUNIFORM1IARBPROC Ogre::glUniform1iARB_ptr

| Definition at line 63 of file OgreGLSLExtSupport.h.

PFNGLUNIFORM1IVARBPROC Ogre::glUniform1ivARB_ptr

| Definition at line 73 of file OgreGLSLExtSupport.h.

PFNGLUNIFORM2FARBPROC Ogre::glUniform2fARB_ptr

| Definition at line 59 of file OgreGLSLExtSupport.h.

PFNGLUNIFORM2FVARBPROC Ogre::glUniform2fvARB_ptr

| Definition at line 69 of file OgreGLSLExtSupport.h.

PFNGLUNIFORM2IARBPROC Ogre::glUniform2iARB_ptr

| Definition at line 64 of file OgreGLSLExtSupport.h.

PFNGLUNIFORM2IVARBPROC Ogre::glUniform2ivARB_ptr

| Definition at line 74 of file OgreGLSLExtSupport.h.

PFNGLUNIFORM3FARBPROC Ogre::glUniform3fARB_ptr

| Definition at line 60 of file OgreGLSLExtSupport.h.

PFNGLUNIFORM3FVARBPROC Ogre::glUniform3fvARB_ptr

| Definition at line 70 of file OgreGLSLExtSupport.h.

PFNGLUNIFORM3IARBPROC Ogre::glUniform3iARB_ptr

| Definition at line 65 of file OgreGLSLExtSupport.h.

PFNGLUNIFORM3IVARBPROC Ogre::glUniform3ivARB_ptr

| Definition at line 75 of file OgreGLSLExtSupport.h.

PFNGLUNIFORM4FARBPROC Ogre::glUniform4fARB_ptr

| Definition at line 61 of file OgreGLSLExtSupport.h.

PFNGLUNIFORM4FVARBPROC Ogre::glUniform4fvARB_ptr

| Definition at line 71 of file OgreGLSLExtSupport.h.

PFNGLUNIFORM4IARBPROC Ogre::glUniform4iARB_ptr

| Definition at line 66 of file OgreGLSLExtSupport.h.

PFNGLUNIFORM4IVARBPROC Ogre::glUniform4ivARB_ptr

| Definition at line 76 of file OgreGLSLExtSupport.h.

PFNGLUSEPROGRAMOBJECTARBPROC Ogre::glUseProgramObjectARB_ptr

| Definition at line 48 of file OgreGLSLExtSupport.h.

PFNGLVERTEXATTRIB1FARBPROC Ogre::glVertexAttrib1fARB_ptr

| Definition at line 85 of file OgreGLSLExtSupport.h.

PFNGLVERTEXATTRIB1FVARBPROC Ogre::glVertexAttrib1fvARB_ptr

| Definition at line 81 of file OgreGLSLExtSupport.h.

PFNGLVERTEXATTRIB2FARBPROC Ogre::glVertexAttrib2fARB_ptr

| Definition at line 84 of file OgreGLSLExtSupport.h.

PFNGLVERTEXATTRIB2FVARBPROC Ogre::glVertexAttrib2fvARB_ptr

| Definition at line 80 of file OgreGLSLExtSupport.h.

PFNGLVERTEXATTRIB3FARBPROC Ogre::glVertexAttrib3fARB_ptr

| Definition at line 83 of file OgreGLSLExtSupport.h.

PFNGLVERTEXATTRIB3FVARBPROC Ogre::glVertexAttrib3fvARB_ptr

| Definition at line 79 of file OgreGLSLExtSupport.h.

PFNGLVERTEXATTRIB4FARBPROC Ogre::glVertexAttrib4fARB_ptr

| Definition at line 82 of file OgreGLSLExtSupport.h.

PFNGLVERTEXATTRIB4FVARBPROC Ogre::glVertexAttrib4fvARB_ptr

| Definition at line 78 of file OgreGLSLExtSupport.h.

unsigned int Ogre::modeCount = 0`[static]`

| Definition at line 37 of file OgreD3D9VideoMode.h. Referenced by Ogre::D3D9VideoMode::D3D9VideoMode(), and Ogre::D3D9VideoMode::~D3D9VideoMode().

unsigned char Ogre::SPOT_SHADOW_FADE_PNG[SPOT_SHADOW_FADE_PNG_SIZE]

| Definition at line 33 of file OgreSpotShadowFadePng.h.

Copyright © 2000-2005 by The OGRE Team
This work is licensed under a Creative Commons Attribution-ShareAlike 2.5 License.
Last modified Sun Feb 12 13:00:05 2006