OGRE: OgreCommon.h File Reference - OGRE Documentation

# OgreCommon.h File Reference

`#include "OgreString.h"`
`#include <utility>`
`#include <vector>`
`#include <map>`

Go to the source code of this file.

## Namespaces
namespace | Ogre
## Classes
struct | Ogre::TRect< T >
struct | Ogre::Box
| Structure used to define a box in a 3-D integer space. More...
## Typedefs
typedef int | Ogre::TrackVertexColourType
| An enumeration describing which material properties should track the vertex colours.
typedef std::vector< Light * > | Ogre::LightList
typedef std::map< String, bool > | Ogre::UnaryOptionList
typedef std::map< String, String > | Ogre::BinaryOptionList
typedef std::map< String, String > | Ogre::NameValuePairList
| Name / value parameter pair (first = name, second = value).
typedef std::map< String, String > | Ogre::AliasTextureNamePairList
| Alias / Texture name pair (first = alias, second = texture name).
typedef TRect< float > | Ogre::FloatRect
| Structure used to define a rectangle in a 2-D floating point space.
typedef TRect< Real > | Ogre::RealRect
| Structure used to define a rectangle in a 2-D floating point space, subject to double / single floating point settings.
typedef TRect< long > | Ogre::Rect
| Structure used to define a rectangle in a 2-D integer space.
## Enumerations
enum | Ogre::CompareFunction { Ogre::CMPF_ALWAYS_FAIL, Ogre::CMPF_ALWAYS_PASS, Ogre::CMPF_LESS, Ogre::CMPF_LESS_EQUAL, Ogre::CMPF_EQUAL, Ogre::CMPF_NOT_EQUAL, Ogre::CMPF_GREATER_EQUAL, Ogre::CMPF_GREATER }
| Comparison functions used for the depth/stencil buffer operations and others. More...
enum | Ogre::TextureFilterOptions { Ogre::TFO_NONE, Ogre::TFO_BILINEAR, Ogre::TFO_TRILINEAR, Ogre::TFO_ANISOTROPIC }
| High-level filtering options providing shortcuts to settings the minification, magnification and mip filters. More...
enum | Ogre::FilterType { Ogre::FT_MIN, Ogre::FT_MAG, Ogre::FT_MIP }
enum | Ogre::FilterOptions { Ogre::FO_NONE, Ogre::FO_POINT, Ogre::FO_LINEAR, Ogre::FO_ANISOTROPIC }
| Filtering options for textures / mipmaps. More...
enum | Ogre::ShadeOptions { Ogre::SO_FLAT, Ogre::SO_GOURAUD, Ogre::SO_PHONG }
| Light shading modes. More...
enum | Ogre::FogMode { Ogre::FOG_NONE, Ogre::FOG_EXP, Ogre::FOG_EXP2, Ogre::FOG_LINEAR }
| Fog modes. More...
enum | Ogre::CullingMode { Ogre::CULL_NONE = 1, Ogre::CULL_CLOCKWISE = 2, Ogre::CULL_ANTICLOCKWISE = 3 }
| Hardware culling modes based on vertex winding. More...
enum | Ogre::ManualCullingMode { Ogre::MANUAL_CULL_NONE = 1, Ogre::MANUAL_CULL_BACK = 2, Ogre::MANUAL_CULL_FRONT = 3 }
| Manual culling modes based on vertex normals. More...
enum | Ogre::WaveformType { Ogre::WFT_SINE, Ogre::WFT_TRIANGLE, Ogre::WFT_SQUARE, Ogre::WFT_SAWTOOTH, Ogre::WFT_INVERSE_SAWTOOTH, Ogre::WFT_PWM }
| Enumerates the wave types usable with the Ogre engine. More...
enum | Ogre::PolygonMode { Ogre::PM_POINTS = 1, Ogre::PM_WIREFRAME = 2, Ogre::PM_SOLID = 3 }
| The polygon mode to use when rasterising. More...
enum | Ogre::ShadowTechnique { Ogre::SHADOWTYPE_NONE = 0x00, Ogre::SHADOWDETAILTYPE_ADDITIVE = 0x01, Ogre::SHADOWDETAILTYPE_MODULATIVE = 0x02, Ogre::SHADOWDETAILTYPE_INTEGRATED = 0x04, Ogre::SHADOWDETAILTYPE_STENCIL = 0x10, Ogre::SHADOWDETAILTYPE_TEXTURE = 0x20, Ogre::SHADOWTYPE_STENCIL_MODULATIVE = 0x12, Ogre::SHADOWTYPE_STENCIL_ADDITIVE = 0x11, Ogre::SHADOWTYPE_TEXTURE_MODULATIVE = 0x22, Ogre::SHADOWTYPE_TEXTURE_ADDITIVE = 0x21, Ogre::SHADOWTYPE_TEXTURE_ADDITIVE_INTEGRATED = 0x25, Ogre::SHADOWTYPE_TEXTURE_MODULATIVE_INTEGRATED = 0x26 }
| An enumeration of broad shadow techniques. More...
enum | Ogre::TrackVertexColourEnum { Ogre::TVC_NONE = 0x0, Ogre::TVC_AMBIENT = 0x1, Ogre::TVC_DIFFUSE = 0x2, Ogre::TVC_SPECULAR = 0x4, Ogre::TVC_EMISSIVE = 0x8 }
enum | Ogre::SortMode { Ogre::SM_DIRECTION, Ogre::SM_DISTANCE }
| Sort mode for billboard-set and particle-system. More...
enum | Ogre::FrameBufferType { Ogre::FBT_COLOUR = 0x1, Ogre::FBT_DEPTH = 0x2, Ogre::FBT_STENCIL = 0x4 }
| Defines the frame buffer types. More...
enum | Ogre::ClipResult { Ogre::CLIPPED_NONE = 0, Ogre::CLIPPED_SOME = 1, Ogre::CLIPPED_ALL = 2 }
| Generic result of clipping. More...
## Functions
int _OgreExport | Ogre::findCommandLineOpts (int numargs, char **argv, UnaryOptionList &unaryOptList, BinaryOptionList &binOptList)
| Locate command-line options of the unary form '-blah' and of the binary form '-blah foo', passing back the index of the next non-option.

Copyright © 2008 Torus Knot Software Ltd
This work is licensed under a Creative Commons Attribution-ShareAlike 2.5 License.
Last modified Sun Jul 26 11:32:21 2009