OgreCommon.h File Reference

#include "OgreVector.h"
#include "OgreHeaderPrefix.h"
#include "OgreMurmurHash3.h"
#include "OgreHeaderSuffix.h"

Classes
struct	Ogre::Box
	Structure used to define a box in a 3-D integer space. More...
struct	Ogre::RenderWindowDescription
	Render window creation parameters. More...
struct	Ogre::TRect< T >

Namespaces
namespace	Ogre

Typedefs
typedef std::map< String, String >	Ogre::AliasTextureNamePairList
	Alias / Texture name pair (first = alias, second = texture name)
typedef std::map< String, String >	Ogre::BinaryOptionList
typedef TRect< float >	Ogre::FloatRect
	Structure used to define a rectangle in a 2-D floating point space.
typedef std::vector< Light * >	Ogre::LightList
typedef std::map< String, String >	Ogre::NameValuePairList
	Name / value parameter pair (first = name, second = value)
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< int32 >	Ogre::Rect
	Structure used to define a rectangle in a 2-D integer space.
typedef std::vector< RenderWindowDescription >	Ogre::RenderWindowDescriptionList
	Render window creation parameters container.
typedef std::vector< RenderWindow * >	Ogre::RenderWindowList
	Render window container.
typedef int	Ogre::TrackVertexColourType
	An enumeration describing which material properties should track the vertex colours.
typedef std::map< String, bool >	Ogre::UnaryOptionList

Enumerations
enum	Ogre::ClipResult { Ogre::CLIPPED_NONE = 0 , Ogre::CLIPPED_SOME = 1 , Ogre::CLIPPED_ALL = 2 }
	Generic result of clipping. More...
enum	Ogre::ColourBufferType { Ogre::CBT_BACK = 0x0 , Ogre::CBT_BACK_LEFT , Ogre::CBT_BACK_RIGHT }
	Defines the colour buffer types. More...
enum	Ogre::CompareFunction : uint8 {   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::CullingMode : uint8 { Ogre::CULL_NONE = 1 , Ogre::CULL_CLOCKWISE = 2 , Ogre::CULL_ANTICLOCKWISE = 3 }
	Hardware culling modes based on vertex winding. More...
enum	Ogre::FilterOptions : uint8 { Ogre::FO_NONE , Ogre::FO_POINT , Ogre::FO_LINEAR , Ogre::FO_ANISOTROPIC }
	Filtering options for textures / mipmaps. More...
enum	Ogre::FilterType { Ogre::FT_MIN , Ogre::FT_MAG , Ogre::FT_MIP }
enum	Ogre::FogMode : uint8 { Ogre::FOG_NONE , Ogre::FOG_EXP , Ogre::FOG_EXP2 , Ogre::FOG_LINEAR }
	Fog modes. More...
enum	Ogre::FrameBufferType { Ogre::FBT_COLOUR = 0x1 , Ogre::FBT_DEPTH = 0x2 , Ogre::FBT_STENCIL = 0x4 }
	Defines the frame buffer types. More...
enum	Ogre::InstanceManagerFlags {   Ogre::IM_USE16BIT = 0x0001 , Ogre::IM_VTFBESTFIT = 0x0002 , Ogre::IM_VTFBONEMATRIXLOOKUP = 0x0004 , Ogre::IM_USEBONEDUALQUATERNIONS = 0x0008 ,   Ogre::IM_USEONEWEIGHT = 0x0010 , Ogre::IM_FORCEONEWEIGHT = 0x0020 , Ogre::IM_USEALL = IM_USE16BIT|IM_VTFBESTFIT|IM_USEONEWEIGHT }
	Flags for the Instance Manager when calculating ideal number of instances per batch. More...
enum	Ogre::ManualCullingMode : uint8 { 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::PolygonMode : uint8 { Ogre::PM_POINTS = 1 , Ogre::PM_WIREFRAME = 2 , Ogre::PM_SOLID = 3 }
	The polygon mode to use when rasterising. More...
enum	Ogre::ShadeOptions : uint8 { Ogre::SO_FLAT , Ogre::SO_GOURAUD , Ogre::SO_PHONG }
	Light shading modes. More...
enum	Ogre::ShadowTechnique {   Ogre::SHADOWTYPE_NONE = 0x00 , Ogre::SHADOWDETAILTYPE_ADDITIVE = 0x01 , Ogre::SHADOWDETAILTYPE_MODULATIVE = 0x02 , Ogre::SHADOWDETAILTYPE_INTEGRATED = 0x04 ,   Ogre::SHADOWDETAILTYPE_STENCIL = 0x10 , Ogre::SHADOWDETAILTYPE_TEXTURE = 0x20 , Ogre::SHADOWTYPE_STENCIL_MODULATIVE = SHADOWDETAILTYPE_STENCIL | SHADOWDETAILTYPE_MODULATIVE , Ogre::SHADOWTYPE_STENCIL_ADDITIVE = SHADOWDETAILTYPE_STENCIL | SHADOWDETAILTYPE_ADDITIVE ,   Ogre::SHADOWTYPE_TEXTURE_MODULATIVE = SHADOWDETAILTYPE_TEXTURE | SHADOWDETAILTYPE_MODULATIVE , Ogre::SHADOWTYPE_TEXTURE_ADDITIVE = SHADOWDETAILTYPE_TEXTURE | SHADOWDETAILTYPE_ADDITIVE , Ogre::SHADOWTYPE_TEXTURE_ADDITIVE_INTEGRATED = SHADOWTYPE_TEXTURE_ADDITIVE | SHADOWDETAILTYPE_INTEGRATED , Ogre::SHADOWTYPE_TEXTURE_MODULATIVE_INTEGRATED = SHADOWTYPE_TEXTURE_MODULATIVE | SHADOWDETAILTYPE_INTEGRATED }
	An enumeration of broad shadow techniques. More...
enum	Ogre::SortMode : uint8 { Ogre::SM_DIRECTION , Ogre::SM_DISTANCE }
	Function used compute the camera-distance for sorting objects. More...
enum	Ogre::TextureAddressingMode : uint8 { Ogre::TAM_WRAP , Ogre::TAM_MIRROR , Ogre::TAM_CLAMP , Ogre::TAM_BORDER }
	Texture addressing modes - default is TAM_WRAP. More...
enum	Ogre::TextureFilterOptions { Ogre::TFO_NONE , Ogre::TFO_BILINEAR , Ogre::TFO_TRILINEAR , Ogre::TFO_ANISOTROPIC }
	High-level filtering options providing shortcuts to settings the minification, magnification and mip filters. More...
enum	Ogre::TrackVertexColourEnum {   Ogre::TVC_NONE = 0x0 , Ogre::TVC_AMBIENT = 0x1 , Ogre::TVC_DIFFUSE = 0x2 , Ogre::TVC_SPECULAR = 0x4 ,   Ogre::TVC_EMISSIVE = 0x8 }
enum	Ogre::WaveformType {   Ogre::WFT_SINE , Ogre::WFT_TRIANGLE , Ogre::WFT_SQUARE , Ogre::WFT_SAWTOOTH ,   Ogre::WFT_INVERSE_SAWTOOTH , Ogre::WFT_PWM }
	Enumerates the wave types usable with the Ogre engine. More...

Functions
uint32	Ogre::FastHash (const char *data, size_t len, uint32 hashSoFar=0)
	Fast general hashing algorithm.
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.
template<typename T >
uint32	Ogre::HashCombine (uint32 hashSoFar, const T &data)
	Combine hashes with same style as boost::hash_combine.
template<typename T >
std::ostream &	Ogre::operator<< (std::ostream &o, const TRect< T > &r)

Variables
const String	Ogre::BLANKSTRING
	Constant blank string, useful for returning by ref where local does not exist.