Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Related Pages  

Ogre Namespace Reference


Compounds

class  Ogre::AnimationControllerFunction
 Predefined controller function for dealing with animation. More...

class  Ogre::AreaEmitter
 Particle emitter which emits particles randomly from points inside an area (box, sphere, ellipsoid whatever subclasses choose to be). More...

class  Ogre::BorderPanelGuiElement
 A specialisation of the PanelGuiElement to provide a panel with a border. More...

class  Ogre::BorderPanelGuiElementFactory
 Factory for creating BorderPanelGuiElement instances. More...

class  Ogre::BorderRenderable
 Class for rendering the border of a BorderPanelGuiElement. More...

class  Ogre::BoxEmitter
 Particle emitter which emits particles randomly from points inside a box. More...

class  Ogre::BoxEmitterFactory
 Factory class for particle emitter of type "Box". More...

class  Ogre::BspLevel
 Holds all the data associated with a Binary Space Parition (BSP) based indoor level. More...

struct  Ogre::BspLevel::BspVertex
 Vertex format for fixed geometry. More...

class  Ogre::BspNode
 Encapsulates a node in a BSP tree. More...

class  Ogre::BspResourceManager
 Manages the locating and loading of BSP-based indoor levels. More...

class  Ogre::BspSceneManager
 Specialisation of the SceneManager class to deal with indoor scenes based on a BSP tree. More...

class  Ogre::BorderPanelGuiElement::CmdBorderSize
 Command object for specifying border sizes (see ParamCommand). More...

class  Ogre::BorderPanelGuiElement::CmdBorderMaterial
 Command object for specifying the Material for the border (see ParamCommand). More...

class  Ogre::BorderPanelGuiElement::CmdBorderLeftUV
 Command object for specifying texture coordinates for the border (see ParamCommand). More...

class  Ogre::BorderPanelGuiElement::CmdBorderTopUV
 Command object for specifying texture coordinates for the border (see ParamCommand). More...

class  Ogre::BorderPanelGuiElement::CmdBorderRightUV
 Command object for specifying texture coordinates for the border (see ParamCommand). More...

class  Ogre::BorderPanelGuiElement::CmdBorderBottomUV
 Command object for specifying texture coordinates for the border (see ParamCommand). More...

class  Ogre::BorderPanelGuiElement::CmdBorderTopLeftUV
 Command object for specifying texture coordinates for the border (see ParamCommand). More...

class  Ogre::BorderPanelGuiElement::CmdBorderBottomLeftUV
 Command object for specifying texture coordinates for the border (see ParamCommand). More...

class  Ogre::BorderPanelGuiElement::CmdBorderBottomRightUV
 Command object for specifying texture coordinates for the border (see ParamCommand). More...

class  Ogre::BorderPanelGuiElement::CmdBorderTopRightUV
 Command object for specifying texture coordinates for the border (see ParamCommand). More...

class  Ogre::ButtonGuiElement
 The listener interface for receiving "interesting" mouse events (press, release, click, enter, and exit) on a component. More...

class  Ogre::ButtonGuiElement::CmdBorderDownMaterial
 Command object for specifying the Material for the border (see ParamCommand). More...

class  Ogre::ButtonGuiElement::CmdBorderUpMaterial
 Command object for specifying the Material for the border (see ParamCommand). More...

class  Ogre::ButtonGuiElement::CmdButtonCaption
 Command object for specifying the Material for the border (see ParamCommand). More...

class  Ogre::ButtonGuiElementFactory
 Factory for creating ButtonGuiElement instances. More...

class  Ogre::AreaEmitter::CmdWidth
 Command object for area emitter size (see ParamCommand). More...

class  Ogre::AreaEmitter::CmdHeight
 Command object for area emitter size (see ParamCommand). More...

class  Ogre::AreaEmitter::CmdDepth
 Command object for area emitter size (see ParamCommand). More...

class  Ogre::D3D7RenderTexture
class  Ogre::D3D7RenderWindow
 Defines the rendering window on Win32 systems. More...

class  Ogre::D3D8Device
class  Ogre::D3D8DeviceList
class  Ogre::D3D8Driver
class  Ogre::D3D8DriverList
class  Ogre::D3D8RenderSystem
 Implementation of DirectX8 as a rendering system. More...

class  Ogre::D3D8RenderTexture
class  Ogre::D3D8RenderWindow
class  Ogre::D3D8Texture
class  Ogre::D3D8TextureManager
class  Ogre::D3D8VideoMode
class  Ogre::D3D8VideoModeList
class  Ogre::D3D9Driver
class  Ogre::D3D9DriverList
class  Ogre::D3D9RenderSystem
 Implementation of DirectX9 as a rendering system. More...

class  Ogre::D3D9RenderTexture
class  Ogre::D3D9RenderWindow
class  Ogre::D3D9Texture
class  Ogre::D3D9TextureManager
class  Ogre::D3D9VideoMode
class  Ogre::D3D9VideoModeList
class  Ogre::D3DDevice
 Encapsulates a Direct3D Device. More...

class  Ogre::D3DDeviceList
 Encapsulates enumeration of Direct3D devices. More...

class  Ogre::D3DRenderSystem
 Implementation of DirectX as a rendering system. More...

class  Ogre::D3DTexture
 Direct3D7-specific texture resource implementation. More...

class  Ogre::D3DTextureManager
 Direct3D-specific implementation of a TextureManager. More...

class  Ogre::DDDriver
 Encapsulates a DirectDraw driver. More...

class  Ogre::DDDriverList
 Encapsulates enumeration of DirectDraw drivers. More...

class  Ogre::DDVideoMode
 Encapsulates a DirectDraw video mode. More...

class  Ogre::DDVideoModeList
 Encapsulates enumeration of DirectDraw video modes. More...

struct  Ogre::HardwareIndexBuffer
struct  Ogre::HardwareVertexBuffer
class  Ogre::RingEmitter::CmdInnerY
 Command object for inner size (see ParamCommand). More...

class  Ogre::RingEmitter::CmdInnerX
 Command object for inner size (see ParamCommand). More...

class  Ogre::LinearForceAffector::CmdForceApp
 Command object for force application (see ParamCommand). More...

class  Ogre::LinearForceAffector::CmdForceVector
 Command object for force vector (see ParamCommand). More...

class  Ogre::HollowEllipsoidEmitter::CmdInnerZ
 Command object for inner size (see ParamCommand). More...

class  Ogre::HollowEllipsoidEmitter::CmdInnerY
 Command object for inner size (see ParamCommand). More...

class  Ogre::HollowEllipsoidEmitter::CmdInnerX
 Command object for inner size (see ParamCommand). More...

class  Ogre::ColourFaderAffector::CmdAlphaAdjust
 Command object for alpha adjust (see ParamCommand). More...

class  Ogre::ColourFaderAffector::CmdBlueAdjust
 Command object for blue adjust (see ParamCommand). More...

class  Ogre::ColourFaderAffector::CmdGreenAdjust
 Command object for green adjust (see ParamCommand). More...

class  Ogre::ColourFaderAffector::CmdRedAdjust
 Command object for red adjust (see ParamCommand). More...

class  Ogre::ColourFaderAffector
 This plugin subclass of ParticleAffector allows you to alter the colour of particles. More...

class  Ogre::ColourFaderAffectorFactory
 Factory class for ColourFaderAffector. More...

class  Ogre::CylinderEmitter
 Particle emitter which emits particles randomly from points inside a cylinder. More...

class  Ogre::CylinderEmitterFactory
 Factory class for particle emitter of type "Cylinder". More...

class  Ogre::EllipsoidEmitter
 Particle emitter which emits particles randomly from points inside an ellipsoid. More...

class  Ogre::EllipsoidEmitterFactory
 Factory class for particle emitter of type "Ellipsoid". More...

class  Ogre::HollowEllipsoidEmitter
 Particle emitter which emits particles randomly from points inside a hollow ellipsoid. More...

class  Ogre::HollowEllipsoidEmitterFactory
 Factory class for particle emitter of type "HollowEllipsoid". More...

class  Ogre::LinearForceAffector
 This class defines a ParticleAffector which applies a linear force to particles in a system. More...

class  Ogre::LinearForceAffectorFactory
 Factory class for LinearForceAffector. More...

class  Ogre::Octree
 Octree datastructure for managing scene nodes. More...

class  Ogre::OctreeCamera
 Specialized viewpoint from which an Octree can be rendered. More...

class  Ogre::OctreeNode
 Specialized SceneNode that is customized for working within an Octree. More...

class  Ogre::OctreeSceneManager
 Specialized SceneManager that divides the geometry into an octree in order to faciliate spatial queries. More...

class  Ogre::PointEmitter
 Particle emitter which emits particles from a single point. More...

class  Ogre::PointEmitterFactory
 Factory class for particle emitter of type "Point". More...

class  Ogre::RingEmitter
 Particle emitter which emits particles randomly from points inside a ring (e.g. More...

class  Ogre::RingEmitterFactory
 Factory class for particle emitter of type "Ring". More...

class  Ogre::SDLRenderSystem
 Implementation of SDL as a rendering system. More...

class  Ogre::SDLTexture
class  Ogre::SDLTextureManager
 SDL/GL-specific implementation of a TextureManager. More...

class  Ogre::SDLWindow
class  Ogre::TerrainIndexBuffer
class  Ogre::TerrainOptions
 A simple class for encapsulating parameters passed in when initializing a TerrainRenderable. More...

class  Ogre::TerrainRenderable
 Represents a terrain tile. More...

class  Ogre::TerrainSceneManager
 This is a basic SceneManager for organizing TerrainRenderables into a total landscape. More...

class  Ogre::TextAreaGuiElement::CmdColour
 Command object for setting the constant colour. More...

class  Ogre::TextAreaGuiElement::CmdColourBottom
 Command object for setting the bottom colour. More...

class  Ogre::TextAreaGuiElement::CmdColourTop
 Command object for setting the top colour. More...

class  Ogre::TextAreaGuiElement::CmdFontName
 Command object for setting the caption. More...

class  Ogre::TextAreaGuiElement::CmdCharHeight
 Command object for setting the char height. More...

class  Ogre::TextAreaGuiElement::CmdCaption
 Command object for setting the caption. More...

class  Ogre::PanelGuiElement::CmdTransparent
 Command object for specifying transparency (see ParamCommand). More...

class  Ogre::PanelGuiElement::CmdTiling
 Command object for specifying tiling (see ParamCommand). More...

class  Ogre::ListGuiElement::CmdItemPanelMaterialSelected
 Command object for specifying texture coordinates for the border (see ParamCommand). More...

class  Ogre::ListGuiElement::CmdItemPanelMaterial
 Command object for specifying texture coordinates for the border (see ParamCommand). More...

class  Ogre::ListGuiElement::CmdHSpacing
 Command object for specifying texture coordinates for the border (see ParamCommand). More...

class  Ogre::ListGuiElement::CmdVSpacing
 Command object for specifying texture coordinates for the border (see ParamCommand). More...

class  Ogre::ListGuiElement::CmdItemTemplate
 Command object for specifying texture coordinates for the border (see ParamCommand). More...

class  Ogre::CursorGuiElement
 The listener interface for receiving "interesting" mouse events (press, release, click, enter, and exit) on a component. More...

class  Ogre::FrameTimeControllerValue
 Predefined controller value for getting the latest frame time. More...

class  Ogre::ListGuiElement
 The listener interface for receiving "interesting" mouse events (press, release, click, enter, and exit) on a component. More...

class  Ogre::ListGuiElementFactory
 Factory for creating ButtonGuiElement instances. More...

struct  Ogre::ManualLodSortLess
class  Ogre::PanelGuiElement
 GuiElement representing a flat, single-material (or transparent) panel which can contain other elements. More...

class  Ogre::PanelGuiElementFactory
 Factory for creating PanelGuiElement instances. More...

struct  Ogre::Quake3Shader::Pass
class  Ogre::Quake3Level
 Support for loading and extracting data from a Quake3 level file. More...

class  Ogre::Quake3Shader
 Class for recording Quake3 shaders. More...

class  Ogre::Quake3ShaderManager
 Class for managing Quake3 custom shaders. More...

class  Ogre::SDLConfig::ModelColumns
class  Ogre::ParamCommand
 Abstract class which is command object which gets/sets parameters. More...

class  Ogre::ParamDictionary
 Class to hold a dictionary of parameters for a single class. More...

class  Ogre::ParameterDef
 Definition of a parameter supported by a StringInterface class, for introspection. More...

struct  Ogre::SceneManager::materialLess
 Comparator for material map, for sorting materials into render order (e.g. More...

struct  Ogre::ProgressiveMesh::PMWorkingData
 Data used to calculate the collapse costs. More...

class  Ogre::ProgressiveMesh::PMVertex
 A vertex in the progressive mesh, holds info like collapse cost etc. More...

class  Ogre::ProgressiveMesh::PMTriangle
 A triangle in the progressive mesh, holds extra info like face normal. More...

class  Ogre::ProgressiveMesh::PMFaceVertex
 A vertex as used by a face. More...

struct  Ogre::ProgressiveMesh::LODFaceData
 Struct for holding the returned LOD geometry information. More...

class  Ogre::ParticleSystem::CmdCommonDirection
 Command object for common direction (see ParamCommand). More...

class  Ogre::ParticleSystem::CmdBillboardType
 Command object for billboard type (see ParamCommand). More...

class  Ogre::ParticleSystem::CmdHeight
 Command object for particle_height (see ParamCommand). More...

class  Ogre::ParticleSystem::CmdWidth
 Command object for particle_width (see ParamCommand). More...

class  Ogre::ParticleSystem::CmdCull
 Command object for cull_each (see ParamCommand). More...

class  Ogre::ParticleSystem::CmdMaterial
 Command object for material (see ParamCommand). More...

class  Ogre::ParticleSystem::CmdQuota
 Command object for quota (see ParamCommand). More...

struct  Ogre::OofModelFile::MaterialData
 Struct containing model material data. More...

struct  Ogre::_ConfigOption
 Packages the details of a configuration option. More...

struct  Ogre::_GeomVector
 Helper struct when dealing with buffers. More...

class  Ogre::ActionEvent
class  Ogre::ActionListener
 Specialised EventListener for receiving component-specific ActionEvent events. More...

class  Ogre::ActionTarget
 Handles the adding and removing of ActionListeners. More...

class  Ogre::Animation
 An animation sequence. More...

class  Ogre::AnimationState
 Represents the state of an animation and the weight of it's influence. More...

class  Ogre::AnimationTrack
 A 'track' in an animation sequence, ie a sequence of keyframes which affect a certain type of animable object. More...

class  Ogre::ArchiveEx
 Archive-handling class. More...

struct  Ogre::ArchiveEx::FileInfo
 Information about a file/directory within the archive will be returned using a FileInfo struct. More...

class  Ogre::ArchiveFactory
 Abstract factory class, archive codec plugins can register concrete subclasses of this. More...

class  Ogre::ArchiveManager
 ResourceManager specialization to handle Archive plug-ins. More...

class  Ogre::AxisAlignedBox
 A 3D box aligned with the x/y/z axes. More...

class  Ogre::Billboard
 A billboard is a primitive which always faces the camera in every frame. More...

class  Ogre::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  Ogre::Bitwise
 Class for manipulating bit patterns. More...

class  Ogre::Bone
 A bone in a skeleton. More...

class  Ogre::Camera
 A viewpoint from which the scene will be rendered. More...

class  Ogre::Codec
 Abstract class that defines a 'codec'. More...

class  Ogre::Codec::CodecData
class  Ogre::ColourValue
 Class representing colour. More...

class  Ogre::ConfigDialog
 Defines the behaviour of an automatic renderer configuration dialog. More...

class  Ogre::ConfigFile
 Class for quickly loading settings from a text file. More...

class  Ogre::Controller
 Instances of this class 'control' the value of another object in the system. More...

class  Ogre::ControllerFunction
 Subclasses of this class are responsible for performing a function on an input value for a Controller. More...

class  Ogre::ControllerManager
 Class for managing Controller instances. More...

class  Ogre::ControllerValue
 Can either be used as an input or output value. More...

class  Ogre::Cursor
 The Cursor is an non-visual object that contains a the XYZ values that are modified by a InputReader. More...

class  Ogre::DataChunk
 Wraps a chunk of memory, storing both size and a pointer to the data. More...

class  Ogre::DynLib
 Resource holding data about a dynamic library. More...

class  Ogre::DynLibManager
 Manager for Dynamic-loading Libraries. More...

class  Ogre::Entity
 Defines an instance of a discrete, movable object based on a Mesh. More...

class  Ogre::ErrorDialog
 Class for displaying the error dialog if Ogre fails badly. More...

class  Ogre::EventDispatcher
 Handles the Dispatching of events to a EventTarget (mainly a PositionTarget for mouse moving). More...

class  Ogre::EventListener
 EventListener is an abstract class used as a base for EventMulticaster. More...

class  Ogre::EventMulticaster
 This class implements efficient and thread-safe multi-cast event dispatching. More...

class  Ogre::EventProcessor
 The EventProcessor controls getting events, storing them in a queue, and dispatching events. More...

class  Ogre::EventQueue
 This class holds InputEvents given to it by the EventProcessor in a FIFO queue. More...

class  Ogre::EventTarget
 This is an abstract class that is the base class of all consumers of InputEvent instances. More...

class  Ogre::Exception
 When thrown, provides information about an error that has occurred inside the engine. More...

class  Ogre::FactoryObj
 Abstract factory class. More...

class  Ogre::Font
 Class representing a font in the system. More...

class  Ogre::FontManager
 Manages Font resources, parsing .fontdef files and generally organising them. More...

struct  Ogre::FrameEvent
 Struct containing information about a frame event. More...

class  Ogre::FrameListener
 A interface class defining a listener which can be used to receive notifications of frame events. More...

struct  Ogre::GeometryData
 Common structure containing info about geometry. More...

struct  Ogre::GeomTexCoord2D
 Helper struct when dealing with buffers. More...

class  Ogre::GuiContainer
 A 2D element which contains other GuiElement instances. More...

class  Ogre::GuiElement
 Abstract definition of a 2D element to be displayed in an Overlay. More...

class  Ogre::GuiElementFactory
 Defines the interface which all components wishing to supply GuiElement subclasses must implement. More...

class  Ogre::GuiManager
 This class acts as a repository and regitrar of overlay components. More...

class  Ogre::Image
 Class representing an image file. More...

class  Ogre::ImageCodec
 Codec specialized in images. More...

class  Ogre::ImageCodec::ImageData
 Codec return class for images. More...

class  Ogre::InputEvent
 The root event class for all GuiElement-level input events. More...

class  Ogre::InputReader
 Abstract class which allows input to be read from various controllers. More...

class  Ogre::JPEGCodec
 ImageCodec specialized in JPEG images. More...

class  Ogre::JPGCodec
class  Ogre::KeyFrame
 A key frame in an animation sequence defined by an AnimationTrack. More...

class  Ogre::LayerBlendModeEx
 Class which manages blending of both colour and alpha components. More...

class  Ogre::Light
 Representation of a dynamic light source in the scene. More...

class  Ogre::ListChanger
class  Ogre::ListSelectionEvent
class  Ogre::ListSelectionListener
 Specialised EventListener for list-style component events. More...

class  Ogre::ListSelectionTarget
 Manages Overlay objects, parsing them from .overlay files and storing a lookup library of them. More...

class  Ogre::Log
 Log class for writing debug/log data to files. More...

class  Ogre::LogManager
 The log manager handles the creation and retrieval of logs for the application. More...

class  Ogre::MapIterator
 Wraps iteration over a map. More...

class  Ogre::Material
 Class encapsulates rendering properties of an object. More...

class  Ogre::MaterialManager
 Class for managing Material settings for Ogre. More...

class  Ogre::Math
 Class to provide access to common mathematical functions. More...

class  Ogre::Matrix3
 A 3x3 matrix which can represent rotations around axes. More...

class  Ogre::Matrix4
 Class encapsulating a standard 4x4 homogenous matrix. More...

class  Ogre::MemoryManager
 See the The memory manager information page. More...

class  Ogre::Mesh
 Resource holding data about 3D mesh. More...

struct  Ogre::Mesh::MeshLodUsage
 A way of recording the way each LODs is recorded this Mesh. More...

class  Ogre::MeshManager
 Handles the management of mesh resources. More...

class  Ogre::MeshSerializer
 Class for serialising mesh data to/from an OGRE .mesh file. More...

class  Ogre::MouseEvent
 An event which indicates that a mouse action occurred in a MouseTarget (e.g. More...

class  Ogre::MouseListener
 Specialised EventListener for discrete mouse events. More...

class  Ogre::MouseMotionListener
 Specialised EventListener for mouse motion. More...

struct  Ogre::Image::Rect
 Structure used to define a rectangle in a 2-D integer space. More...

class  Ogre::MouseMotionTarget
 Handles the adding and removing of MouseMotionListeners. More...

struct  Ogre::MouseState
 Structure representing a snapshot of the state of the mouse input controller. More...

class  Ogre::Material::TextureLayer
 Nested class representing a single texture layer of a material. More...

struct  Ogre::Material::TextureLayer::TextureEffect
 Internal structure defining a texture effect. More...

class  Ogre::MouseTarget
 Handles the adding and removing of MouseListeners. More...

class  Ogre::MovableObject
 Abstract class definining a movable object in a scene. More...

class  Ogre::Node
 Class representing a general-purpose node an articulated scene graph. More...

class  Ogre::OofModelFile
 Class to load an Ogre Object File (oof). More...

class  Ogre::Overlay
 Represents a layer which is rendered on top of the 'normal' scene contents. More...

class  Ogre::OverlayManager
 Manages Overlay objects, parsing them from .overlay files and storing a lookup library of them. More...

class  Ogre::Particle
class  Ogre::ParticleAffector
 Abstract class defining the interface to be implemented by particle affectors. More...

class  Ogre::ParticleAffectorFactory
 Abstract class defining the interface to be implemented by creators of ParticleAffector subclasses. More...

class  Ogre::ParticleEmitter
 Abstract class defining the interface to be implemented by particle emitters. More...

class  Ogre::ParticleEmitterFactory
 Abstract class defining the interface to be implemented by creators of ParticleEmitter subclasses. More...

class  Ogre::ParticleIterator
 Convenience class to make it easy to step through all particles in a ParticleSystem. More...

class  Ogre::ParticleSystem
 Class defining particle system based special effects. More...

class  Ogre::ParticleSystemManager
 Manages particle systems, particle system scripts (templates) and the available emitter & affector factories. More...

class  Ogre::PatchSurface
 A surface which is defined by curves of some kind to form a patch, e.g. More...

class  Ogre::Plane
 Defines a plane in 3D space. More...

class  Ogre::PlatformManager
 Class which manages the platform settings Ogre runs on. More...

class  Ogre::PNGCodec
 ImageCodec specialized in Portable Network Graphics images. More...

class  Ogre::PositionTarget
class  Ogre::ProgressiveMesh
 This class reduces the complexity of the geometry it is given. More...

class  Ogre::Quaternion
 Implementation of a Quaternion, i.e. More...

class  Ogre::Renderable
 Abstract class defining the interface all renderable objects must implement. More...

class  Ogre::RenderOperation
 Class describing a rendering operation like how to draw a triangle. More...

class  Ogre::RenderPriorityGroup
 Renderables in the queue grouped by priority. More...

class  Ogre::RenderQueue
 Class to manage the scene object rendering queue. More...

class  Ogre::RenderQueueGroup
 A grouping level underneath RenderQueue which groups renderables to be issued at coarsely the same time to the renderer. More...

class  Ogre::RenderQueueListener
 Abstract interface which classes must implement if they wish to receive events from the render queue. More...

class  Ogre::RenderSystem
 Defines the functionality of a 3D API. More...

class  Ogre::RenderTarget
 A 'canvas' which can receive the results of a rendering operation. More...

struct  Ogre::RenderTargetEvent
 Struct containing information about a RenderTarget event. More...

class  Ogre::RenderTargetListener
 A interface class defining a listener which can be used to receive notifications of RenderTarget events. More...

class  Ogre::RenderTargetTexture
class  Ogre::RenderTexture
class  Ogre::RenderWindow
 Manages the target rendering window. More...

class  Ogre::Resource
 Abstract class reprensenting a loadable resource (e.g. More...

class  Ogre::ResourceManager
 Defines a generic resource handler. More...

class  Ogre::Root
 The root class of the Ogre system. More...

class  Ogre::RotationalSpline
 This class interpolates orientations (rotations) along a spline using derivatives of quaternions. More...

class  Ogre::ScaleControllerFunction
 Predefined controller function which simply scales an input to an output value. More...

class  Ogre::SceneManager
 Manages the rendering of a 'scene' i.e. More...

class  Ogre::SceneManagerEnumerator
 Enumerates the SceneManager classes available to applications. More...

class  Ogre::SceneNode
 Class representing a node in the scene graph. More...

class  Ogre::SDDataChunk
 Wraps a chunk of memory, storing both size and a pointer to the data. More...

class  Ogre::SDLConfig
 Simple CLI config. More...

class  Ogre::SDLError
 Simple CLI error output. More...

class  Ogre::SDLInput
class  Ogre::Serializer
 Generic class for serialising data to / from binary chunk-based files. More...

class  Ogre::SimpleRenderable
class  Ogre::SimpleSpline
 A very simple spline class which implements the Catmull-Rom class of splines. More...

class  Ogre::Singleton
 Template class for creating single-instance global classes. More...

class  Ogre::Skeleton
 A collection of Bone objects used to animate a skinned mesh. More...

class  Ogre::SkeletonManager
 Handles the management of skeleton resources. More...

class  Ogre::SkeletonSerializer
 Class for serialising skeleton data to/from an OGRE .skeleton file. More...

class  Ogre::Sphere
 A sphere primitive, mostly used for bounds checking. More...

struct  Ogre::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  Ogre::String
 Wrapper object for String to allow DLL export. More...

class  Ogre::StringConverter
 Class for converting the core Ogre data types to/from Strings. More...

class  Ogre::StringInterface
 Class defining the common interface which classes can use to present a reflection-style, self-defining parameter set to callers. More...

class  Ogre::StringResource
 Wraps a String as a Resource for generic handling. More...

class  Ogre::SubEntity
 Utility class which defines the sub-parts of an Entity. More...

class  Ogre::SubMesh
 Defines a part of a complete mesh. More...

class  Ogre::TargetManager
 An abstract interface, implemented by OverlayManager, to return a GuiElement at a given x,y position. More...

class  Ogre::TexCoordModifierControllerValue
 Predefined controller value for getting / setting a texture coordinate modifications (scales and translates). More...

class  Ogre::TextAreaGuiElement
 GuiElement representing a flat, single-material (or transparent) panel which can contain other elements. More...

class  Ogre::TextAreaGuiElementFactory
 Factory for creating TextAreaGuiElement instances. More...

class  Ogre::Texture
 Abstract class representing a Texture resource. More...

class  Ogre::TextureFrameControllerValue
 Predefined controller value for getting / setting the frame number of a texture layer. More...

struct  Ogre::RenderPriorityGroup::TransparentQueueItemLess
 Comparator to order transparent objects. More...

class  Ogre::TextureManager
 Class for loading & managing textures. More...

class  Ogre::TGACodec
 ImageCodec specialized in Traga images. More...

struct  Ogre::TGACodec::TgaHeader
class  Ogre::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  Ogre::Vector3
 Standard 3-dimensional vector. More...

class  Ogre::Vector4
 4-dimensional homogenous vector. More...

class  Ogre::VectorIterator
 Wraps iteration over a vector. More...

struct  Ogre::RenderOperation::VertexBlendData
 Vertex blend info. More...

struct  Ogre::vectorLess
 Comparator for unique vertex list. More...

struct  Ogre::VertexBoneAssignment_s
 Records the assignment of a single vertex to a single bone with the corresponding weight. More...

struct  Ogre::ViewPoint
 Structure for holding a position & orientation pair. More...

class  Ogre::Viewport
 An abstraction of a viewport, i.e. More...

struct  Ogre::BspLevel::VisData
 Internal lookup table to determine visibility between leaves. More...

class  Ogre::WaveformControllerFunction
 Predefined controller function based on a waveform. More...

class  Ogre::Win32ConfigDialog
 A Windows 95/98/NT platform version of the default engine configuration dialog. More...

class  Ogre::Win32ErrorDialog
 Windows-specific class for displaying the error dialog if Ogre fails badly! More...

class  Ogre::Win32Input
 Utility class for dealing with user input on a Win32 system. More...

class  Ogre::Win32Input8
 Utility class for dealing with user input on a Win32 system. More...

class  Ogre::WireBoundingBox
 Allows the rendering of a wireframe bounding box. More...

class  Ogre::Zip
class  Ogre::ZipArchiveFactory
 Specialisation of ArchiveFactory for Zip files. More...


Typedefs

typedef std::map< String,
AnimationState
AnimationStateSet
typedef unsigned long RGBA
typedef unsigned long ARGB
typedef unsigned long ABGR
typedef void(* DLL_CREATECONFIGDIALOG )(ConfigDialog **ppDlg)
 Defines the interface OgrePlatform.dll/OgrePlatform.so must implement. More...

typedef Ogre::_ConfigOption ConfigOption
 Packages the details of a configuration option. More...

typedef std::map< String,
ConfigOption
ConfigOptionMap
typedef void(* DLL_CREATEERRORDIALOG )(ErrorDialog **ppDlg)
 Defines the interface a platform-specific library must implement. More...

typedef Ogre::_GeomVector GeomVertexPosition
 Helper struct when dealing with buffers. More...

typedef Ogre::_GeomVector GeomVertexNormal
 Helper struct when dealing with buffers. More...

typedef void(* DLL_CREATEINPUTREADER )(InputReader **ppReader)
 Defines the interface a platform-specific library must implement. More...

typedef void(* MATERIAL_ATTRIB_PARSER )(StringVector::iterator &, int, Material *)
 Function def for material attribute parser. More...

typedef void(* TEXLAYER_ATTRIB_PARSER )(StringVector::iterator &, int, Material *, Material::TextureLayer *)
 Function def for texture layer attribute parser. More...

typedef void(* DLL_DESTROYCONFIGDIALOG )(ConfigDialog *ppDlg)
typedef void(* DLL_DESTROYERRORDIALOG )(ErrorDialog *ppDlg)
typedef void(* DLL_DESTROYINPUTREADER )(InputReader *ppReader)
typedef float Real
typedef unsigned char uchar
 In order to avoid finger-aches :). More...

typedef unsigned short ushort
typedef unsigned int uint
typedef unsigned long ulong
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. More...

typedef HashMap< String, Resource *,
_StringHash
ResourceMap
typedef std::vector< RenderSystem * > RenderSystemList
typedef std::string _StringBase
typedef std::hash_compare<
_StringBase, std::less< _StringBase > > 
_StringHash
typedef std::vector< ParameterDefParameterList
typedef std::map< String,
ParamCommand * > 
ParamCommandMap
typedef std::map< String,
ParamDictionary
ParamDictionaryMap
typedef std::vector< StringStringVector
typedef Ogre::VertexBoneAssignment_s VertexBoneAssignment
 Records the assignment of a single vertex to a single bone with the corresponding weight. More...

typedef void(* createFunc )(ArchiveEx **, const String &)
typedef void(* DLL_START_PLUGIN )(void)
typedef void(* DLL_STOP_PLUGIN )(void)
typedef std::list< Resource * > ResourceList
typedef std::list< OctreeNode * > NodeList
typedef std::list< AxisAlignedBox * > BoxList
typedef std::list< unsigned
long > 
ColorList
typedef std::vector< TerrainIndexBuffer * > IndexArray
typedef std::vector< IndexArrayLevelArray
typedef std::vector< TerrainRenderable * > TerrainRow
typedef std::vector< TerrainRowTerrain2D

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 Material::TextureLayer::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
}
 Expert list of valid texture blending operations, for use with Material::TextureLayer::setColourOperationEx and Material::TextureLayer::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 Material::TextureLayer::setColourOperation and Material::TextureLayer::setAlphaOperation, and internally in the LayerBlendModeEx class. More...

enum  SceneBlendType { SBT_TRANSPARENT_ALPHA, SBT_TRANSPARENT_COLOUR, SBT_ADD }
 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  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  ResourceType { RESTYPE_ALL, RESTYPE_TEXTURES, RESTYPE_MODELS }
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 }
 Texture filtering defining the different minification and magnification supersampling modes. 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  PixelFormat {
  PF_UNKNOWN, PF_L8, PF_A8, PF_A4L4,
  PF_L4A4, PF_R5G6B5, PF_B5G6R5, PF_A4R4G4B4,
  PF_B4G4R4A4, PF_R8G8B8, PF_B8R8G8, PF_A8R8G8B8,
  PF_B8G8R8A8, PF_A2R10G10B10, PF_B10G10R10A2
}
 The pixel format used for textures. More...

enum  FontType { FT_TRUETYPE = 1, FT_IMAGE = 2 }
 Enumerates the types of Font usable in the engine. More...

enum  GuiMetricsMode { GMM_RELATIVE, GMM_PIXELS }
 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  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  MeshChunkID {
  M_HEADER = 0x1000, M_MATERIAL = 0x2000, M_TEXTURE_LAYER = 0x2200, M_MESH = 0x3000,
  M_SUBMESH = 0x4000, M_SUBMESH_BONE_ASSIGNMENT = 0x4100, M_GEOMETRY = 0x5000, M_GEOMETRY_NORMALS = 0x5100,
  M_GEOMETRY_COLOURS = 0x5200, M_GEOMETRY_TEXCOORDS = 0x5300, 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
}
 Definition of the OGRE .mesh file format. More...

enum  OofChunkIDs {
  OOF_HEADER = 0x1000, OOF_MATERIAL = 0x2000, OOF_TEXTURE_LAYER = 0x2200, OOF_OBJECT = 0x3000,
  OOF_VSHAREDPOSITIONS = 0x3100, OOF_VSHAREDNORMALS = 0x3200, OOF_VSHAREDTEXCOORDS = 0x3300, OOF_VSHAREDCOLOURS = 0x3400,
  OOF_MATERIAL_GROUP = 0x3500, OOF_VPOSITIONS = 0x3510, OOF_VNORMALS = 0x3520, OOF_VTEXCOORDS = 0x3530,
  OOF_VCOLOURS = 0x3540
}
 Definition of the Ogre Object Format (.oof) file format. More...

enum  RenderQueueGroupID {
  RENDER_QUEUE_BACKGROUND = 0, RENDER_QUEUE_1 = 10, RENDER_QUEUE_2 = 20, RENDER_QUEUE_3 = 30,
  RENDER_QUEUE_4 = 40, RENDER_QUEUE_MAIN = 50, RENDER_QUEUE_6 = 60, RENDER_QUEUE_7 = 70,
  RENDER_QUEUE_8 = 80, RENDER_QUEUE_9 = 90, 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 }
 Enum describing the ways to generate texture coordinates. More...

enum  StencilOperation {
  SOP_KEEP, SOP_ZERO, SOP_REPLACE, SOP_INCREMENT,
  SOP_DECREMENT, SOP_INVERT
}
 Enum describing the various actions which can be taken onthe stencil buffer. More...

enum  SceneType { ST_GENERIC, ST_EXTERIOR_CLOSE, ST_EXTERIOR_FAR, ST_INTERIOR }
 Classification of a scene to allow a decision of what type of SceenManager to provide back to the application. 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
}
 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_DEFAULT = 0x0, TU_RENDERTARGET = 0x1 }
enum  Intersection { OUTSIDE, INSIDE, INTERSECT }

Functions

std::ostream & operator<< (std::ostream &o, Camera &c)
PixelFormat ilFormat2OgreFormat (int ImageFormat, int BytesPerPixel)
std::pair< int, int > OgreFormat2ilFormat (PixelFormat format)
ColourValue _parseColourValue (StringVector::iterator &params, int numParams)
void parseAmbient (StringVector::iterator &params, int numParams, Material *pMat)
void parseDiffuse (StringVector::iterator &params, int numParams, Material *pMat)
void parseSpecular (StringVector::iterator &params, int numParams, Material *pMat)
void parseEmissive (StringVector::iterator &params, int numParams, Material *pMat)
SceneBlendFactor convertBlendFactor (const String &param)
void parseSceneBlend (StringVector::iterator &params, int numParams, Material *pMat)
CompareFunction convertCompareFunction (const String &param)
void parseDepthParams (StringVector::iterator &params, int numParams, Material *pMat)
void parseCullMode (StringVector::iterator &params, int numParams, Material *pMat)
void parseLighting (StringVector::iterator &params, int numParams, Material *pMat)
void parseFogging (StringVector::iterator &params, int numParams, Material *pMat)
void parseShading (StringVector::iterator &params, int numParams, Material *pMat)
void parseFiltering (StringVector::iterator &params, int numParams, Material *pMat)
void parseTexture (StringVector::iterator &params, int numParams, Material *pMat, Material::TextureLayer *pTex)
void parseAnimTexture (StringVector::iterator &params, int numParams, Material *pMat, Material::TextureLayer *pTex)
void parseCubicTexture (StringVector::iterator &params, int numParams, Material *pMat, Material::TextureLayer *pTex)
void parseTexCoord (StringVector::iterator &params, int numParams, Material *pMat, Material::TextureLayer *pTex)
void parseTexAddressMode (StringVector::iterator &params, int numParams, Material *pMat, Material::TextureLayer *pTex)
void parseColourOp (StringVector::iterator &params, int numParams, Material *pMat, Material::TextureLayer *pTex)
void parseAlphaRejection (StringVector::iterator &params, int numParams, Material *pMat, Material::TextureLayer *pTex)
LayerBlendOperationEx convertBlendOpEx (const String &param)
LayerBlendSource convertBlendSource (const String &param)
void parseColourOpEx (StringVector::iterator &params, int numParams, Material *pMat, Material::TextureLayer *pTex)
void parseColourOpFallback (StringVector::iterator &params, int numParams, Material *pMat, Material::TextureLayer *pTex)
void parseAlphaOpEx (StringVector::iterator &params, int numParams, Material *pMat, Material::TextureLayer *pTex)
void parseEnvMap (StringVector::iterator &params, int numParams, Material *pMat, Material::TextureLayer *pTex)
void parseScroll (StringVector::iterator &params, int numParams, Material *pMat, Material::TextureLayer *pTex)
void parseRotate (StringVector::iterator &params, int numParams, Material *pMat, Material::TextureLayer *pTex)
void parseScale (StringVector::iterator &params, int numParams, Material *pMat, Material::TextureLayer *pTex)
void parseWaveXform (StringVector::iterator &params, int numParams, Material *pMat, Material::TextureLayer *pTex)
void parseDepthBias (StringVector::iterator &params, int numParams, Material *pMat)
Vector3 operator * (const Vector3 &rkPoint, const Matrix3 &rkMatrix)
Matrix3 operator * (Real fScalar, const Matrix3 &rkMatrix)
std::ostream & operator<< (std::ostream &o, Plane &p)
Quaternion operator * (Real fScalar, const Quaternion &rkQ)
String convertPath (const String &init)
 Internal method for standardising paths - use forward slashes only, end with slash. More...

_OgreExport void handleTerminate (void)
void createPlatformConfigDialog (ConfigDialog **ppDlg)
 Retrieves an instance of a config dialog for this platform. More...

void createPlatformErrorDialog (ErrorDialog **ppDlg)
 Retrieves an instance of an error dialog for this platform. More...

void createPlatformInputReader (InputReader **ppDlg)
 Retrieves an instance of an input reader for this platform. More...

void destroyPlatformConfigDialog (ConfigDialog *dlg)
 Destroys. More...

void destroyPlatformErrorDialog (ErrorDialog *dlg)
 Destroys. More...

void destroyPlatformRenderWindow (RenderWindow *wnd)
 Destroys. More...

void destroyPlatformInputReader (InputReader *reader)
 Destroys. More...

std::ostream & operator<< (std::ostream &o, BspNode &n)
void dllStartPlugin (void)
void dllStopPlugin (void)
Real _max (Real x, Real y)
Intersection intersect (const AxisAlignedBox &one, const AxisAlignedBox &two)
 Checks how the second box intersects with the first. More...

Intersection intersect (const Sphere &one, const AxisAlignedBox &two)
 Checks how the box intersects with the sphere. More...

void registerParticleFactories (void)
void destroyParticleFactories (void)
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 ()
HRESULT CALLBACK EnumZBuffersCallback (DDPIXELFORMAT *pddpf, VOID *pFormats)
HRESULT CALLBACK D3DEnumDevicesCallback (LPSTR lpDeviceDescription, LPSTR lpDeviceName, LPD3DDEVICEDESC7 lpD3DDeviceDesc, LPVOID lpContext)
bool OgreFormatRequiresEndianFlipping (PixelFormat format)
D3DX_SURFACEFORMAT OgreFormat_to_D3DXFormat (PixelFormat format)
void OgreFormat_to_DDPixelFormat (PixelFormat format, DDPIXELFORMAT &out)
BOOL WINAPI DDEnumCallbackEx (GUID FAR *lpGUID, LPSTR lpDriverDescription, LPSTR lpDriverName, LPVOID lpContext, HMONITOR hm)
BOOL WINAPI DDEnumCallback (GUID FAR *lpGUID, LPSTR lpDriverDescription, LPSTR lpDriverName, LPVOID lpContext)
HRESULT CALLBACK DDEnumModesCallback (LPDDSURFACEDESC2 lpDDSD2, LPVOID lpContext)

Variables

const unsigned long CHUNK_OVERHEAD_SIZE = sizeof(unsigned short) + sizeof(unsigned long)
 Chunk overhead = ID + size. More...

const unsigned short HEADER_CHUNK_ID = 0x1000
Win32ConfigDialogdlg
bool firstTime = true
std::ofstream of
BspSceneManagerbspPlugin
GuiElementFactorypPanelFactory = NULL
GuiElementFactorypBorderPanelFactory = NULL
GuiElementFactorypTextAreaFactory = NULL
GuiElementFactorypButtonFactory = NULL
GuiElementFactorypListFactory = NULL
CursorGuiElementpCursorGui = NULL
unsigned long red = 0xFF0000FF
unsigned long green = 0xFFFFFFFF
unsigned long white = 0xFFFFFFFF
OctreeSceneManageroctreePlugin
TerrainSceneManagerterrainPlugin
std::vector< ParticleEmitterFactory * > emitterFactories
std::vector< ParticleAffectorFactory * > affectorFactories
_OgreD3DExport D3DDevice
D3DRenderSystemd3dRendPlugin
int driverCount = 0
int modeCount = 0
SDLRenderSystemsdlRendPlugin


Detailed Description

Author:
Jon Anderson


Typedef Documentation

typedef std::string Ogre::_StringBase
 

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

typedef unsigned long Ogre::ABGR
 

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

typedef unsigned long Ogre::ARGB
 

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

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

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
 

typedef void(* Ogre::createFunc)( ArchiveEx**, const String& )
 

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

Defines the interface OgrePlatform.dll/OgrePlatform.so must implement.

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)

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

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)

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

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

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

typedef void(* Ogre::DLL_START_PLUGIN)(void)
 

typedef void(* Ogre::DLL_STOP_PLUGIN)(void)
 

typedef struct Ogre::_GeomVector Ogre::GeomVertexNormal
 

Helper struct when dealing with buffers.

typedef struct Ogre::_GeomVector Ogre::GeomVertexPosition
 

Helper struct when dealing with buffers.

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

typedef std::vector< IndexArray > Ogre::LevelArray
 

typedef void(* Ogre::MATERIAL_ATTRIB_PARSER)(StringVector::iterator&, int, Material*)
 

Function def for material attribute parser.

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

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

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

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

typedef float Ogre::Real
 

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

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

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

typedef std::list<Resource*> Ogre::ResourceList
 

typedef HashMap< String, Resource*, _StringHash > Ogre::ResourceMap
 

typedef unsigned long Ogre::RGBA
 

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

typedef std::vector< TerrainRow > Ogre::Terrain2D
 

typedef std::vector< TerrainRenderable * > Ogre::TerrainRow
 

typedef void(* Ogre::TEXLAYER_ATTRIB_PARSER)(StringVector::iterator&, int, Material*, Material::TextureLayer*)
 

Function def for texture layer attribute parser.

typedef unsigned char Ogre::uchar
 

In order to avoid finger-aches :).

typedef unsigned int Ogre::uint
 

typedef unsigned long Ogre::ulong
 

typedef unsigned short Ogre::ushort
 

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

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.

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 

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.

enum Ogre::FaceGroupType
 

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

Enumeration values:
FGT_FACE_LIST 
FGT_PATCH 
FGT_UNKNOWN 

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.

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.

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 

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 

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.

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 

enum Ogre::Intersection
 

Enumeration values:
OUTSIDE 
INSIDE 
INTERSECT 

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 

enum Ogre::LayerBlendOperation
 

List of valid texture blending operations, for use with Material::TextureLayer::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.

enum Ogre::LayerBlendOperationEx
 

Expert list of valid texture blending operations, for use with Material::TextureLayer::setColourOperationEx and Material::TextureLayer::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).

enum Ogre::LayerBlendSource
 

List of valid sources of values for blending operations used in Material::TextureLayer::setColourOperation and Material::TextureLayer::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.

enum Ogre::LayerBlendType
 

Type of texture blend mode.

Enumeration values:
LBT_COLOUR 
LBT_ALPHA 

enum Ogre::LoggingLevel
 

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

Enumeration values:
LL_LOW 
LL_NORMAL 
LL_BOREME 

enum Ogre::LogMessageLevel
 

The importance of a logged message.

Enumeration values:
LML_TRIVIAL 
LML_NORMAL 
LML_CRITICAL 

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.

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_MATERIAL 
M_TEXTURE_LAYER 
M_MESH 
M_SUBMESH 
M_SUBMESH_BONE_ASSIGNMENT 
M_GEOMETRY 
M_GEOMETRY_NORMALS 
M_GEOMETRY_COLOURS 
M_GEOMETRY_TEXCOORDS 
M_MESH_SKELETON_LINK 
M_MESH_BONE_ASSIGNMENT 
M_MESH_LOD 
M_MESH_LOD_USAGE 
M_MESH_LOD_MANUAL 
M_MESH_LOD_GENERATED 

enum Ogre::OofChunkIDs
 

Definition of the Ogre Object Format (.oof) file format.

Remarks:
This format is now DEPRECATED.The .mesh format replaces it.

OOF files 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 short DATA_LENGTH : length of the contained data in bytes void* DATA : the data, which may contain other sub-chunks (various data types)

Enumeration values:
OOF_HEADER 
OOF_MATERIAL 
OOF_TEXTURE_LAYER 
OOF_OBJECT 
OOF_VSHAREDPOSITIONS 
OOF_VSHAREDNORMALS 
OOF_VSHAREDTEXCOORDS 
OOF_VSHAREDCOLOURS 
OOF_MATERIAL_GROUP 
OOF_VPOSITIONS 
OOF_VNORMALS 
OOF_VTEXCOORDS 
OOF_VCOLOURS 

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 

enum Ogre::PixelFormat
 

The pixel format used for textures.

Enumeration values:
PF_UNKNOWN  Unknown pixel format.
PF_L8  8-bit pixel format, all bits luminace.
PF_A8  8-bit pixel format, all bits alpha.
PF_A4L4  8-bit pixel format, 4 bits alpha, 4 bits luminace.
PF_L4A4  8-bit pixel format, 4 bits luminace, 4 bits alpha.
PF_R5G6B5  16-bit pixel format, 5 bits red, 6 bits green, 5 bits blue.
PF_B5G6R5  16-bit pixel format, 5 bits blue, 6 bits green, 5 bits red.
PF_A4R4G4B4  16-bit pixel format, 4 bits for alpha, red, green and blue.
PF_B4G4R4A4  16-bit pixel format, 4 bits for blue, green, red and alpha.
PF_R8G8B8  24-bit pixel format, 8 bits for red, green and blue.
PF_B8R8G8  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_B8G8R8A8  32-bit pixel format, 8 bits for blue, green, red and alpha.
PF_A2R10G10B10  32-bit pixel format, 2 bits for alpha, 10 bits for red, green and blue.
PF_B10G10R10A2  32-bit pixel format, 10 bits for blue, green and red, 2 bits for alpha.

enum Ogre::ProjectionType
 

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

Enumeration values:
PT_ORTHOGRAPHIC 
PT_PERSPECTIVE 

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_1  First queue (after backgrounds), used for skyboxes if rendered first.
RENDER_QUEUE_2 
RENDER_QUEUE_3 
RENDER_QUEUE_4 
RENDER_QUEUE_MAIN  The default render queue.
RENDER_QUEUE_6 
RENDER_QUEUE_7 
RENDER_QUEUE_8 
RENDER_QUEUE_9  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.

enum Ogre::ResourceType
 

Enumeration values:
RESTYPE_ALL  All resource types.
RESTYPE_TEXTURES  Textures.
RESTYPE_MODELS  Models.

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 

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.

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.

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_INTERIOR 

enum Ogre::ShadeOptions
 

Light shading modes.

Enumeration values:
SO_FLAT 
SO_GOURAUD 
SO_PHONG 

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.

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 

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_INVERT  Invert the bits of the stencil buffer.

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.

enum Ogre::TextureFilterOptions
 

Texture filtering defining the different minification and magnification supersampling modes.

Enumeration values:
TFO_NONE 
TFO_BILINEAR 
TFO_TRILINEAR 

enum Ogre::TextureUsage
 

Enumeration values:
TU_DEFAULT 
TU_RENDERTARGET 

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.


Function Documentation

template<typename _Interf>
void Ogre::__safeRelease _Interf **    interf throw () [inline]
 

Real _max Real    x,
Real    y
[inline]
 

ColourValue _parseColourValue StringVector::iterator &    params,
int    numParams
 

SceneBlendFactor convertBlendFactor const String   param
 

LayerBlendOperationEx convertBlendOpEx const String   param
 

LayerBlendSource convertBlendSource const String   param
 

CompareFunction convertCompareFunction const String   param
 

String convertPath const String   init [static]
 

Internal method for standardising paths - use forward slashes only, end with slash.

C void Ogre::createPlatformConfigDialog ConfigDialog **    ppDlg
 

Retrieves an instance of a config dialog for this platform.

C void Ogre::createPlatformErrorDialog ErrorDialog **    ppDlg
 

Retrieves an instance of an error dialog for this platform.

C void Ogre::createPlatformInputReader InputReader **    ppReader
 

Retrieves an instance of an input reader for this platform.

HRESULT CALLBACK D3DEnumDevicesCallback LPSTR    lpDeviceDescription,
LPSTR    lpDeviceName,
LPD3DDEVICEDESC7    lpD3DDeviceDesc,
LPVOID    lpContext
[static]
 

HRESULT CALLBACK Ogre::D3DEnumDevicesCallback GUID FAR *    lpGuid,
LPSTR    lpDeviceDescription,
LPSTR    lpDeviceName,
LPD3DDEVICEDESC7    lpD3DHWDeviceDesc,
LPD3DDEVICEDESC7    lpD3DHELDeviceDesc,
LPVOID    lpContext
 

BOOL WINAPI DDEnumCallback GUID FAR *    lpGUID,
LPSTR    lpDriverDescription,
LPSTR    lpDriverName,
LPVOID    lpContext
[static]
 

BOOL WINAPI DDEnumCallbackEx GUID FAR *    lpGUID,
LPSTR    lpDriverDescription,
LPSTR    lpDriverName,
LPVOID    lpContext,
HMONITOR    hm
[static]
 

HRESULT CALLBACK DDEnumModesCallback LPDDSURFACEDESC2    lpDDSD2,
LPVOID    lpContext
[static]
 

void destroyParticleFactories void   
 

C void Ogre::destroyPlatformConfigDialog ConfigDialog   dlg
 

Destroys.

C void Ogre::destroyPlatformErrorDialog ErrorDialog   dlg
 

Destroys.

C void Ogre::destroyPlatformInputReader InputReader   reader
 

Destroys.

C void Ogre::destroyPlatformRenderWindow RenderWindow   wnd
 

Destroys.

void Ogre::dllStartPlugin void   
 

void Ogre::dllStopPlugin void   
 

HRESULT WINAPI Ogre::EnumModesCallback LPDDSURFACEDESC2    lpDDSurfaceDesc,
LPVOID    lpContext
 

HRESULT CALLBACK EnumZBuffersCallback DDPIXELFORMAT *    pddpf,
VOID *    pFormats
[static]
 

_OgreExport void handleTerminate void   
 

PixelFormat ilFormat2OgreFormat int    ImageFormat,
int    BytesPerPixel
 

Intersection intersect const Sphere   one,
const AxisAlignedBox   two
 

Checks how the box intersects with the sphere.

Intersection intersect const AxisAlignedBox   one,
const AxisAlignedBox   two
 

Checks how the second box intersects with the first.

std::pair< int, int > OgreFormat2ilFormat PixelFormat    format
 

D3DX_SURFACEFORMAT OgreFormat_to_D3DXFormat PixelFormat    format [static]
 

void OgreFormat_to_DDPixelFormat PixelFormat    format,
DDPIXELFORMAT &    out
[static]
 

bool OgreFormatRequiresEndianFlipping PixelFormat    format [static]
 

Quaternion operator * Real    fScalar,
const Quaternion   rkQ
 

Matrix3 operator * Real    fScalar,
const Matrix3   rkMatrix
 

Vector3 operator * const Vector3   rkPoint,
const Matrix3   rkMatrix
 

std::ostream& operator<< std::ostream &    o,
BspNode   n
 

std::ostream& operator<< std::ostream &    o,
Plane   p
 

std::ostream& operator<< std::ostream &    o,
Camera   c
 

void parseAlphaOpEx StringVector::iterator &    params,
int    numParams,
Material   pMat,
Material::TextureLayer   pTex
 

void parseAlphaRejection StringVector::iterator &    params,
int    numParams,
Material   pMat,
Material::TextureLayer   pTex
 

void parseAmbient StringVector::iterator &    params,
int    numParams,
Material   pMat
 

void parseAnimTexture StringVector::iterator &    params,
int    numParams,
Material   pMat,
Material::TextureLayer   pTex
 

void parseColourOp StringVector::iterator &    params,
int    numParams,
Material   pMat,
Material::TextureLayer   pTex
 

void parseColourOpEx StringVector::iterator &    params,
int    numParams,
Material   pMat,
Material::TextureLayer   pTex
 

void parseColourOpFallback StringVector::iterator &    params,
int    numParams,
Material   pMat,
Material::TextureLayer   pTex
 

void parseCubicTexture StringVector::iterator &    params,
int    numParams,
Material   pMat,
Material::TextureLayer   pTex
 

void parseCullMode StringVector::iterator &    params,
int    numParams,
Material   pMat
 

void parseDepthBias StringVector::iterator &    params,
int    numParams,
Material   pMat
 

void parseDepthParams StringVector::iterator &    params,
int    numParams,
Material   pMat
 

void parseDiffuse StringVector::iterator &    params,
int    numParams,
Material   pMat
 

void parseEmissive StringVector::iterator &    params,
int    numParams,
Material   pMat
 

void parseEnvMap StringVector::iterator &    params,
int    numParams,
Material   pMat,
Material::TextureLayer   pTex
 

void parseFiltering StringVector::iterator &    params,
int    numParams,
Material   pMat
 

void parseFogging StringVector::iterator &    params,
int    numParams,
Material   pMat
 

void parseLighting StringVector::iterator &    params,
int    numParams,
Material   pMat
 

void parseRotate StringVector::iterator &    params,
int    numParams,
Material   pMat,
Material::TextureLayer   pTex
 

void parseScale StringVector::iterator &    params,
int    numParams,
Material   pMat,
Material::TextureLayer   pTex
 

void parseSceneBlend StringVector::iterator &    params,
int    numParams,
Material   pMat
 

void parseScroll StringVector::iterator &    params,
int    numParams,
Material   pMat,
Material::TextureLayer   pTex
 

void parseShading StringVector::iterator &    params,
int    numParams,
Material   pMat
 

void parseSpecular StringVector::iterator &    params,
int    numParams,
Material   pMat
 

void parseTexAddressMode StringVector::iterator &    params,
int    numParams,
Material   pMat,
Material::TextureLayer   pTex
 

void parseTexCoord StringVector::iterator &    params,
int    numParams,
Material   pMat,
Material::TextureLayer   pTex
 

void parseTexture StringVector::iterator &    params,
int    numParams,
Material   pMat,
Material::TextureLayer   pTex
 

void parseWaveXform StringVector::iterator &    params,
int    numParams,
Material   pMat,
Material::TextureLayer   pTex
 

void registerParticleFactories void   
 


Variable Documentation

std::vector<ParticleAffectorFactory*> Ogre::affectorFactories
 

BspSceneManager* Ogre::bspPlugin
 

const unsigned long Ogre::CHUNK_OVERHEAD_SIZE = sizeof(unsigned short) + sizeof(unsigned long)
 

Chunk overhead = ID + size.

class _OgreD3DExport Ogre::D3DDevice
 

D3D9RenderSystem * Ogre::d3dRendPlugin
 

Win32ErrorDialog * Ogre::dlg
 

int Ogre::driverCount = 0 [static]
 

std::vector<ParticleEmitterFactory*> Ogre::emitterFactories
 

bool Ogre::firstTime = true
 

unsigned long Ogre::green = 0xFFFFFFFF
 

const unsigned short Ogre::HEADER_CHUNK_ID = 0x1000
 

int Ogre::modeCount = 0 [static]
 

OctreeSceneManager* Ogre::octreePlugin
 

std::ofstream Ogre::of
 

GuiElementFactory* Ogre::pBorderPanelFactory = NULL
 

GuiElementFactory* Ogre::pButtonFactory = NULL
 

CursorGuiElement* Ogre::pCursorGui = NULL
 

GuiElementFactory* Ogre::pListFactory = NULL
 

GuiElementFactory* Ogre::pPanelFactory = NULL
 

GuiElementFactory* Ogre::pTextAreaFactory = NULL
 

unsigned long Ogre::red = 0xFF0000FF
 

SDLRenderSystem* Ogre::sdlRendPlugin
 

TerrainSceneManager* Ogre::terrainPlugin
 

unsigned long Ogre::white = 0xFFFFFFFF
 

Copyright © 2002 by The OGRE Team