OGRE: Ogre::RenderSystemCapabilitiesSerializer Class Reference - OGRE Documentation

Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes

# Ogre::RenderSystemCapabilitiesSerializer Class Reference
[RenderSystem]

Class for serializing RenderSystemCapabilities to / from a .rendercaps script. More...

`#include <OgreRenderSystemCapabilitiesSerializer.h>`

Inheritance diagram for Ogre::RenderSystemCapabilitiesSerializer:
[legend]

List of all members.

## Public Member Functions
| RenderSystemCapabilitiesSerializer ()
| default constructor
virtual | ~RenderSystemCapabilitiesSerializer ()
| default destructor
void | writeScript (const RenderSystemCapabilities *caps, String name, String filename)
| Writes a RenderSystemCapabilities object to a data stream.
void | parseScript (DataStreamPtr &stream)
| Parses a RenderSystemCapabilities script file passed as a stream.
void * | operator new (size_t sz, const char *file, int line, const char *func)
| operator new, with debug line info
void * | operator new (size_t sz)
void * | operator new (size_t sz, void *ptr)
| placement operator new
void * | operator new[] (size_t sz, const char *file, int line, const char *func)
| array operator new, with debug line info
void * | operator new[] (size_t sz)
void | operator delete (void *ptr)
void | operator delete (void *ptr, void *)
void | operator delete (void *ptr, const char *, int, const char *)
void | operator delete[] (void *ptr)
void | operator delete[] (void *ptr, const char *, int, const char *)
## Protected Types
enum | CapabilityKeywordType { UNDEFINED_CAPABILITY_TYPE = 0, SET_STRING_METHOD, SET_INT_METHOD, SET_BOOL_METHOD, SET_REAL_METHOD, SET_CAPABILITY_ENUM_BOOL, ADD_SHADER_PROFILE_STRING }
enum | ParseAction { PARSE_HEADER, FIND_OPEN_BRACE, COLLECT_LINES }
typedef map< String, CapabilityKeywordType >::type | KeywordTypeMap
typedef void(RenderSystemCapabilities::* | SetStringMethod )(const String &)
typedef map< String, SetStringMethod >::type | SetStringMethodDispatchTable
typedef void(RenderSystemCapabilities::* | SetIntMethod )(ushort)
typedef map< String, SetIntMethod >::type | SetIntMethodDispatchTable
typedef void(RenderSystemCapabilities::* | SetBoolMethod )(bool)
typedef map< String, SetBoolMethod >::type | SetBoolMethodDispatchTable
typedef void(RenderSystemCapabilities::* | SetRealMethod )(Real)
typedef map< String, SetRealMethod >::type | SetRealMethodDispatchTable
typedef map< String, Capabilities >::type | CapabilitiesMap
typedef vector< std::pair < String, int > >::type | CapabilitiesLinesList
## Protected Member Functions
void | addCapabilitiesMapping (String name, Capabilities cap)
void | addKeywordType (String keyword, CapabilityKeywordType type)
CapabilityKeywordType | getKeywordType (const String &keyword) const
void | addSetStringMethod (String keyword, SetStringMethod method)
void | callSetStringMethod (String &keyword, String &val)
void | addSetIntMethod (String keyword, SetIntMethod method)
void | callSetIntMethod (String &keyword, ushort val)
void | addSetBoolMethod (String keyword, SetBoolMethod method)
void | callSetBoolMethod (String &keyword, bool val)
void | addSetRealMethod (String keyword, SetRealMethod method)
void | callSetRealMethod (String &keyword, Real val)
void | addShaderProfile (String &val)
void | setCapabilityEnumBool (String &name, bool val)
void | initialiaseDispatchTables ()
void | parseCapabilitiesLines (CapabilitiesLinesList &linesList)
void | logParseError (const String &error) const
## Protected Attributes
KeywordTypeMap | mKeywordTypeMap
SetStringMethodDispatchTable | mSetStringMethodDispatchTable
SetIntMethodDispatchTable | mSetIntMethodDispatchTable
SetBoolMethodDispatchTable | mSetBoolMethodDispatchTable
SetRealMethodDispatchTable | mSetRealMethodDispatchTable
CapabilitiesMap | mCapabilitiesMap
int | mCurrentLineNumber
String * | mCurrentLine
DataStreamPtr | mCurrentStream
RenderSystemCapabilities * | mCurrentCapabilities

## Detailed Description

Class for serializing RenderSystemCapabilities to / from a .rendercaps script.

Definition at line 48 of file OgreRenderSystemCapabilitiesSerializer.h.

## Member Typedef Documentation

typedef vector<std::pair<String, int> >::type Ogre::RenderSystemCapabilitiesSerializer::CapabilitiesLinesList`[protected]`

Definition at line 107 of file OgreRenderSystemCapabilitiesSerializer.h.

typedef map<String, Capabilities>::type Ogre::RenderSystemCapabilitiesSerializer::CapabilitiesMap`[protected]`

Definition at line 97 of file OgreRenderSystemCapabilitiesSerializer.h.

typedef map<String, CapabilityKeywordType>::type Ogre::RenderSystemCapabilitiesSerializer::KeywordTypeMap`[protected]`

Definition at line 74 of file OgreRenderSystemCapabilitiesSerializer.h.

typedef void(RenderSystemCapabilities::* Ogre::RenderSystemCapabilitiesSerializer::SetBoolMethod)(bool)`[protected]`

Definition at line 88 of file OgreRenderSystemCapabilitiesSerializer.h.

typedef map<String, SetBoolMethod>::type Ogre::RenderSystemCapabilitiesSerializer::SetBoolMethodDispatchTable`[protected]`

Definition at line 89 of file OgreRenderSystemCapabilitiesSerializer.h.

typedef void(RenderSystemCapabilities::* Ogre::RenderSystemCapabilitiesSerializer::SetIntMethod)(ushort)`[protected]`

Definition at line 83 of file OgreRenderSystemCapabilitiesSerializer.h.

typedef map<String, SetIntMethod>::type Ogre::RenderSystemCapabilitiesSerializer::SetIntMethodDispatchTable`[protected]`

Definition at line 84 of file OgreRenderSystemCapabilitiesSerializer.h.

typedef void(RenderSystemCapabilities::* Ogre::RenderSystemCapabilitiesSerializer::SetRealMethod)(Real)`[protected]`

Definition at line 93 of file OgreRenderSystemCapabilitiesSerializer.h.

typedef map<String, SetRealMethod>::type Ogre::RenderSystemCapabilitiesSerializer::SetRealMethodDispatchTable`[protected]`

Definition at line 94 of file OgreRenderSystemCapabilitiesSerializer.h.

typedef void(RenderSystemCapabilities::* Ogre::RenderSystemCapabilitiesSerializer::SetStringMethod)(const String &)`[protected]`

Definition at line 77 of file OgreRenderSystemCapabilitiesSerializer.h.

typedef map<String, SetStringMethod>::type Ogre::RenderSystemCapabilitiesSerializer::SetStringMethodDispatchTable`[protected]`

Definition at line 79 of file OgreRenderSystemCapabilitiesSerializer.h.

## Member Enumeration Documentation

enum Ogre::RenderSystemCapabilitiesSerializer::CapabilityKeywordType`[protected]`

Enumerator:

  UNDEFINED_CAPABILITY_TYPE |
  SET_STRING_METHOD |
  SET_INT_METHOD |
  SET_BOOL_METHOD |
  SET_REAL_METHOD |
  SET_CAPABILITY_ENUM_BOOL |
  ADD_SHADER_PROFILE_STRING |

Definition at line 68 of file OgreRenderSystemCapabilitiesSerializer.h.

enum Ogre::RenderSystemCapabilitiesSerializer::ParseAction`[protected]`

Enumerator:

  PARSE_HEADER |
  FIND_OPEN_BRACE |
  COLLECT_LINES |

Definition at line 109 of file OgreRenderSystemCapabilitiesSerializer.h.

## Constructor & Destructor Documentation

Ogre::RenderSystemCapabilitiesSerializer::RenderSystemCapabilitiesSerializer | ( |  | ) |

default constructor

virtual Ogre::RenderSystemCapabilitiesSerializer::~RenderSystemCapabilitiesSerializer | ( |  | ) | `[virtual]`

default destructor

Definition at line 55 of file OgreRenderSystemCapabilitiesSerializer.h.

## Member Function Documentation

void Ogre::RenderSystemCapabilitiesSerializer::addCapabilitiesMapping | ( | String | name,
|  | Capabilities | cap |
| ) |  |  | `[protected]`

Definition at line 100 of file OgreRenderSystemCapabilitiesSerializer.h.

void Ogre::RenderSystemCapabilitiesSerializer::addKeywordType | ( | String | keyword,
|  | CapabilityKeywordType | type |
| ) |  |  | `[protected]`

Definition at line 117 of file OgreRenderSystemCapabilitiesSerializer.h.

void Ogre::RenderSystemCapabilitiesSerializer::addSetBoolMethod | ( | String | keyword,
|  | SetBoolMethod | method |
| ) |  |  | `[protected]`

Definition at line 174 of file OgreRenderSystemCapabilitiesSerializer.h.

void Ogre::RenderSystemCapabilitiesSerializer::addSetIntMethod | ( | String | keyword,
|  | SetIntMethod | method |
| ) |  |  | `[protected]`

Definition at line 154 of file OgreRenderSystemCapabilitiesSerializer.h.

void Ogre::RenderSystemCapabilitiesSerializer::addSetRealMethod | ( | String | keyword,
|  | SetRealMethod | method |
| ) |  |  | `[protected]`

Definition at line 194 of file OgreRenderSystemCapabilitiesSerializer.h.

void Ogre::RenderSystemCapabilitiesSerializer::addSetStringMethod | ( | String | keyword,
|  | SetStringMethod | method |
| ) |  |  | `[protected]`

Definition at line 134 of file OgreRenderSystemCapabilitiesSerializer.h.

void Ogre::RenderSystemCapabilitiesSerializer::addShaderProfile | ( | String & | val | ) | `[protected]`

Definition at line 213 of file OgreRenderSystemCapabilitiesSerializer.h.

void Ogre::RenderSystemCapabilitiesSerializer::callSetBoolMethod | ( | String & | keyword,
|  | bool | val |
| ) |  |  | `[protected]`

Definition at line 179 of file OgreRenderSystemCapabilitiesSerializer.h.

void Ogre::RenderSystemCapabilitiesSerializer::callSetIntMethod | ( | String & | keyword,
|  | ushort | val |
| ) |  |  | `[protected]`

Definition at line 159 of file OgreRenderSystemCapabilitiesSerializer.h.

void Ogre::RenderSystemCapabilitiesSerializer::callSetRealMethod | ( | String & | keyword,
|  | Real | val |
| ) |  |  | `[protected]`

Definition at line 199 of file OgreRenderSystemCapabilitiesSerializer.h.

void Ogre::RenderSystemCapabilitiesSerializer::callSetStringMethod | ( | String & | keyword,
|  | String & | val |
| ) |  |  | `[protected]`

Definition at line 139 of file OgreRenderSystemCapabilitiesSerializer.h.

CapabilityKeywordType Ogre::RenderSystemCapabilitiesSerializer::getKeywordType | ( | const String & | keyword | ) | const`[protected]`

Definition at line 122 of file OgreRenderSystemCapabilitiesSerializer.h.

void Ogre::RenderSystemCapabilitiesSerializer::initialiaseDispatchTables | ( |  | ) | `[protected]`

void Ogre::RenderSystemCapabilitiesSerializer::logParseError | ( | const String & | error | ) | const`[protected]`

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete | ( | void * | ptr,
|  | const char * | ,
|  | int | ,
|  | const char * |  |
| ) |  |  | `[inherited]`

Definition at line 107 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete | ( | void * | ptr | ) | `[inherited]`

Definition at line 95 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete | ( | void * | ptr,
|  | void * |  |
| ) |  |  | `[inherited]`

Definition at line 101 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete[] | ( | void * | ptr | ) | `[inherited]`

Definition at line 112 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete[] | ( | void * | ptr,
|  | const char * | ,
|  | int | ,
|  | const char * |  |
| ) |  |  | `[inherited]`

Definition at line 118 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new | ( | size_t | sz,
|  | void * | ptr |
| ) |  |  | `[inherited]`

placement operator new

Definition at line 78 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new | ( | size_t | sz,
|  | const char * | file,
|  | int | line,
|  | const char * | func |
| ) |  |  | `[inherited]`

operator new, with debug line info

Definition at line 67 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new | ( | size_t | sz | ) | `[inherited]`

Definition at line 72 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new[] | ( | size_t | sz,
|  | const char * | file,
|  | int | line,
|  | const char * | func |
| ) |  |  | `[inherited]`

array operator new, with debug line info

Definition at line 85 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new[] | ( | size_t | sz | ) | `[inherited]`

Definition at line 90 of file OgreMemoryAllocatedObject.h.

void Ogre::RenderSystemCapabilitiesSerializer::parseCapabilitiesLines | ( | CapabilitiesLinesList & | linesList | ) | `[protected]`

void Ogre::RenderSystemCapabilitiesSerializer::parseScript | ( | DataStreamPtr & | stream | ) |

Parses a RenderSystemCapabilities script file passed as a stream.

Adds it to RenderSystemCapabilitiesManager::_addRenderSystemCapabilities

void Ogre::RenderSystemCapabilitiesSerializer::setCapabilityEnumBool | ( | String & | name,
|  | bool | val |
| ) |  |  | `[protected]`

Definition at line 218 of file OgreRenderSystemCapabilitiesSerializer.h.

void Ogre::RenderSystemCapabilitiesSerializer::writeScript | ( | const RenderSystemCapabilities * | caps,
|  | String | name,
|  | String | filename |
| ) |  |  |

Writes a RenderSystemCapabilities object to a data stream.

## Member Data Documentation

CapabilitiesMap Ogre::RenderSystemCapabilitiesSerializer::mCapabilitiesMap`[protected]`

Definition at line 98 of file OgreRenderSystemCapabilitiesSerializer.h.

RenderSystemCapabilities* Ogre::RenderSystemCapabilitiesSerializer::mCurrentCapabilities`[protected]`

Definition at line 115 of file OgreRenderSystemCapabilitiesSerializer.h.

String* Ogre::RenderSystemCapabilitiesSerializer::mCurrentLine`[protected]`

Definition at line 112 of file OgreRenderSystemCapabilitiesSerializer.h.

int Ogre::RenderSystemCapabilitiesSerializer::mCurrentLineNumber`[protected]`

Definition at line 111 of file OgreRenderSystemCapabilitiesSerializer.h.

DataStreamPtr Ogre::RenderSystemCapabilitiesSerializer::mCurrentStream`[protected]`

Definition at line 113 of file OgreRenderSystemCapabilitiesSerializer.h.

KeywordTypeMap Ogre::RenderSystemCapabilitiesSerializer::mKeywordTypeMap`[protected]`

Definition at line 75 of file OgreRenderSystemCapabilitiesSerializer.h.

SetBoolMethodDispatchTable Ogre::RenderSystemCapabilitiesSerializer::mSetBoolMethodDispatchTable`[protected]`

Definition at line 90 of file OgreRenderSystemCapabilitiesSerializer.h.

SetIntMethodDispatchTable Ogre::RenderSystemCapabilitiesSerializer::mSetIntMethodDispatchTable`[protected]`

Definition at line 85 of file OgreRenderSystemCapabilitiesSerializer.h.

SetRealMethodDispatchTable Ogre::RenderSystemCapabilitiesSerializer::mSetRealMethodDispatchTable`[protected]`

Definition at line 95 of file OgreRenderSystemCapabilitiesSerializer.h.

SetStringMethodDispatchTable Ogre::RenderSystemCapabilitiesSerializer::mSetStringMethodDispatchTable`[protected]`

Definition at line 80 of file OgreRenderSystemCapabilitiesSerializer.h.

The documentation for this class was generated from the following file:

- OgreRenderSystemCapabilitiesSerializer.h

Copyright © 2008 Torus Knot Software Ltd
This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.
Last modified Wed Nov 3 2010 19:24:59