Ogre::RenderSystemCapabilitiesSerializer Class Reference
Core » RenderSystem

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

`#include <OgreRenderSystemCapabilitiesSerializer.h>`

Inheritance diagram for Ogre::RenderSystemCapabilitiesSerializer:
[legend]

## Public Member Functions

| RenderSystemCapabilitiesSerializer ()
| default constructor More...
virtual | ~RenderSystemCapabilitiesSerializer ()
| default destructor More...
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 *)
void * | operator new (size_t sz, const char *file, int line, const char *func)
| operator new, with debug line info More...
void * | operator new (size_t sz)
void * | operator new (size_t sz, void *ptr)
| placement operator new More...
void * | operator new[] (size_t sz, const char *file, int line, const char *func)
| array operator new, with debug line info More...
void * | operator new[] (size_t sz)
void | parseScript (DataStreamPtr &stream)
| Parses a RenderSystemCapabilities script file passed as a stream. More...
void | writeScript (const RenderSystemCapabilities *caps, String name, String filename)
| Writes a RenderSystemCapabilities object to a data stream. More...
String | writeString (const RenderSystemCapabilities *caps, String name)
| Writes a RenderSystemCapabilities object to a string. More...

## Protected Types

typedef vector< std::pair< String, int > >::type | CapabilitiesLinesList
typedef map< String, Capabilities >::type | CapabilitiesMap
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 }
typedef map< String, CapabilityKeywordType >::type | KeywordTypeMap
enum | ParseAction { PARSE_HEADER, FIND_OPEN_BRACE, COLLECT_LINES }
typedef void(RenderSystemCapabilities::* | SetBoolMethod) (bool)
typedef map< String, SetBoolMethod >::type | SetBoolMethodDispatchTable
typedef void(RenderSystemCapabilities::* | SetIntMethod) (ushort)
typedef map< String, SetIntMethod >::type | SetIntMethodDispatchTable
typedef void(RenderSystemCapabilities::* | SetRealMethod) (Real)
typedef map< String, SetRealMethod >::type | SetRealMethodDispatchTable
typedef void(RenderSystemCapabilities::* | SetStringMethod) (const String &)
typedef map< String, SetStringMethod >::type | SetStringMethodDispatchTable

## Protected Member Functions

void | addCapabilitiesMapping (String name, Capabilities cap)
void | addKeywordType (String keyword, CapabilityKeywordType type)
void | addSetBoolMethod (String keyword, SetBoolMethod method)
void | addSetIntMethod (String keyword, SetIntMethod method)
void | addSetRealMethod (String keyword, SetRealMethod method)
void | addSetStringMethod (String keyword, SetStringMethod method)
void | addShaderProfile (String &val)
void | callSetBoolMethod (String &keyword, bool val)
void | callSetIntMethod (String &keyword, ushort val)
void | callSetRealMethod (String &keyword, Real val)
void | callSetStringMethod (String &keyword, String &val)
CapabilityKeywordType | getKeywordType (const String &keyword) const
void | initialiaseDispatchTables ()
void | logParseError (const String &error) const
void | parseCapabilitiesLines (CapabilitiesLinesList &linesList)
void | setCapabilityEnumBool (String &name, bool val)

## Protected Attributes

CapabilitiesMap | mCapabilitiesMap
RenderSystemCapabilities * | mCurrentCapabilities
String * | mCurrentLine
int | mCurrentLineNumber
DataStreamPtr | mCurrentStream
KeywordTypeMap | mKeywordTypeMap
SetBoolMethodDispatchTable | mSetBoolMethodDispatchTable
SetIntMethodDispatchTable | mSetIntMethodDispatchTable
SetRealMethodDispatchTable | mSetRealMethodDispatchTable
SetStringMethodDispatchTable | mSetStringMethodDispatchTable

## Detailed Description

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

Definition at line 48 of file OgreRenderSystemCapabilitiesSerializer.h.

## Member Typedef Documentation

## CapabilitiesLinesList

typedef vector<std::pair<String, int> >::type Ogre::RenderSystemCapabilitiesSerializer::CapabilitiesLinesList

protected

Definition at line 110 of file OgreRenderSystemCapabilitiesSerializer.h.

## CapabilitiesMap

typedef map<String, Capabilities>::type Ogre::RenderSystemCapabilitiesSerializer::CapabilitiesMap

protected

Definition at line 100 of file OgreRenderSystemCapabilitiesSerializer.h.

## KeywordTypeMap

typedef map<String, CapabilityKeywordType>::type Ogre::RenderSystemCapabilitiesSerializer::KeywordTypeMap

protected

Definition at line 77 of file OgreRenderSystemCapabilitiesSerializer.h.

## SetBoolMethod

typedef void(RenderSystemCapabilities::* Ogre::RenderSystemCapabilitiesSerializer::SetBoolMethod) (bool)

protected

Definition at line 91 of file OgreRenderSystemCapabilitiesSerializer.h.

## SetBoolMethodDispatchTable

typedef map<String, SetBoolMethod>::type Ogre::RenderSystemCapabilitiesSerializer::SetBoolMethodDispatchTable

protected

Definition at line 92 of file OgreRenderSystemCapabilitiesSerializer.h.

## SetIntMethod

typedef void(RenderSystemCapabilities::* Ogre::RenderSystemCapabilitiesSerializer::SetIntMethod) (ushort)

protected

Definition at line 86 of file OgreRenderSystemCapabilitiesSerializer.h.

## SetIntMethodDispatchTable

typedef map<String, SetIntMethod>::type Ogre::RenderSystemCapabilitiesSerializer::SetIntMethodDispatchTable

protected

Definition at line 87 of file OgreRenderSystemCapabilitiesSerializer.h.

## SetRealMethod

typedef void(RenderSystemCapabilities::* Ogre::RenderSystemCapabilitiesSerializer::SetRealMethod) (Real)

protected

Definition at line 96 of file OgreRenderSystemCapabilitiesSerializer.h.

## SetRealMethodDispatchTable

typedef map<String, SetRealMethod>::type Ogre::RenderSystemCapabilitiesSerializer::SetRealMethodDispatchTable

protected

Definition at line 97 of file OgreRenderSystemCapabilitiesSerializer.h.

## SetStringMethod

typedef void(RenderSystemCapabilities::* Ogre::RenderSystemCapabilitiesSerializer::SetStringMethod) (const String &)

protected

Definition at line 80 of file OgreRenderSystemCapabilitiesSerializer.h.

## SetStringMethodDispatchTable

typedef map<String, SetStringMethod>::type Ogre::RenderSystemCapabilitiesSerializer::SetStringMethodDispatchTable

protected

Definition at line 82 of file OgreRenderSystemCapabilitiesSerializer.h.

## Member Enumeration Documentation

## CapabilityKeywordType

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 71 of file OgreRenderSystemCapabilitiesSerializer.h.

## ParseAction

enum Ogre::RenderSystemCapabilitiesSerializer::ParseAction

protected

Enumerator
PARSE_HEADER |
FIND_OPEN_BRACE |
COLLECT_LINES |

Definition at line 112 of file OgreRenderSystemCapabilitiesSerializer.h.

## Constructor & Destructor Documentation

## RenderSystemCapabilitiesSerializer()

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

default constructor

## ~RenderSystemCapabilitiesSerializer()

virtual Ogre::RenderSystemCapabilitiesSerializer::~RenderSystemCapabilitiesSerializer | ( |  | ) |

virtual

default destructor

Definition at line 55 of file OgreRenderSystemCapabilitiesSerializer.h.

## Member Function Documentation

## addCapabilitiesMapping()

void Ogre::RenderSystemCapabilitiesSerializer::addCapabilitiesMapping | ( | String | name,
|  | Capabilities | cap
| ) |  |

protected

Definition at line 103 of file OgreRenderSystemCapabilitiesSerializer.h.

## addKeywordType()

void Ogre::RenderSystemCapabilitiesSerializer::addKeywordType | ( | String | keyword,
|  | CapabilityKeywordType | type
| ) |  |

protected

Definition at line 120 of file OgreRenderSystemCapabilitiesSerializer.h.

## addSetBoolMethod()

void Ogre::RenderSystemCapabilitiesSerializer::addSetBoolMethod | ( | String | keyword,
|  | SetBoolMethod | method
| ) |  |

protected

Definition at line 177 of file OgreRenderSystemCapabilitiesSerializer.h.

## addSetIntMethod()

void Ogre::RenderSystemCapabilitiesSerializer::addSetIntMethod | ( | String | keyword,
|  | SetIntMethod | method
| ) |  |

protected

Definition at line 157 of file OgreRenderSystemCapabilitiesSerializer.h.

## addSetRealMethod()

void Ogre::RenderSystemCapabilitiesSerializer::addSetRealMethod | ( | String | keyword,
|  | SetRealMethod | method
| ) |  |

protected

Definition at line 197 of file OgreRenderSystemCapabilitiesSerializer.h.

## addSetStringMethod()

void Ogre::RenderSystemCapabilitiesSerializer::addSetStringMethod | ( | String | keyword,
|  | SetStringMethod | method
| ) |  |

protected

Definition at line 137 of file OgreRenderSystemCapabilitiesSerializer.h.

## addShaderProfile()

void Ogre::RenderSystemCapabilitiesSerializer::addShaderProfile | ( | String & | val | ) |

protected

Definition at line 216 of file OgreRenderSystemCapabilitiesSerializer.h.

## callSetBoolMethod()

void Ogre::RenderSystemCapabilitiesSerializer::callSetBoolMethod | ( | String & | keyword,
|  | bool | val
| ) |  |

protected

Definition at line 182 of file OgreRenderSystemCapabilitiesSerializer.h.

## callSetIntMethod()

void Ogre::RenderSystemCapabilitiesSerializer::callSetIntMethod | ( | String & | keyword,
|  | ushort | val
| ) |  |

protected

Definition at line 162 of file OgreRenderSystemCapabilitiesSerializer.h.

## callSetRealMethod()

void Ogre::RenderSystemCapabilitiesSerializer::callSetRealMethod | ( | String & | keyword,
|  | Real | val
| ) |  |

protected

Definition at line 202 of file OgreRenderSystemCapabilitiesSerializer.h.

## callSetStringMethod()

void Ogre::RenderSystemCapabilitiesSerializer::callSetStringMethod | ( | String & | keyword,
|  | String & | val
| ) |  |

protected

Definition at line 142 of file OgreRenderSystemCapabilitiesSerializer.h.

## getKeywordType()

CapabilityKeywordType Ogre::RenderSystemCapabilitiesSerializer::getKeywordType | ( | const String & | keyword | ) | const

protected

Definition at line 125 of file OgreRenderSystemCapabilitiesSerializer.h.

## initialiaseDispatchTables()

void Ogre::RenderSystemCapabilitiesSerializer::initialiaseDispatchTables | ( |  | ) |

protected

## logParseError()

void Ogre::RenderSystemCapabilitiesSerializer::logParseError | ( | const String & | error | ) | const

protected

## operator delete() [1/3]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete | ( | void * | ptr | ) |

inherited

Definition at line 96 of file OgreMemoryAllocatedObject.h.

## operator delete() [2/3]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete | ( | void * | ptr,
|  | void * |
| ) |  |

inherited

Definition at line 102 of file OgreMemoryAllocatedObject.h.

## operator delete() [3/3]

template<class Alloc >

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

inherited

Definition at line 108 of file OgreMemoryAllocatedObject.h.

## operator delete[]() [1/2]

template<class Alloc >

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

inherited

Definition at line 113 of file OgreMemoryAllocatedObject.h.

## operator delete[]() [2/2]

template<class Alloc >

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

inherited

Definition at line 119 of file OgreMemoryAllocatedObject.h.

## operator new() [1/3]

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 68 of file OgreMemoryAllocatedObject.h.

## operator new() [2/3]

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new | ( | size_t | sz | ) |

inherited

Definition at line 73 of file OgreMemoryAllocatedObject.h.

## operator new() [3/3]

template<class Alloc >

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

inherited

placement operator new

Definition at line 79 of file OgreMemoryAllocatedObject.h.

## operator new[]() [1/2]

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 86 of file OgreMemoryAllocatedObject.h.

## operator new[]() [2/2]

template<class Alloc >

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

inherited

Definition at line 91 of file OgreMemoryAllocatedObject.h.

## parseCapabilitiesLines()

void Ogre::RenderSystemCapabilitiesSerializer::parseCapabilitiesLines | ( | CapabilitiesLinesList & | linesList | ) |

protected

## parseScript()

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

Parses a RenderSystemCapabilities script file passed as a stream.

Adds it to RenderSystemCapabilitiesManager::_addRenderSystemCapabilities

## setCapabilityEnumBool()

void Ogre::RenderSystemCapabilitiesSerializer::setCapabilityEnumBool | ( | String & | name,
|  | bool | val
| ) |  |

protected

Definition at line 221 of file OgreRenderSystemCapabilitiesSerializer.h.

## writeScript()

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

Writes a RenderSystemCapabilities object to a data stream.

## writeString()

String Ogre::RenderSystemCapabilitiesSerializer::writeString | ( | const RenderSystemCapabilities * | caps,
|  | String | name
| ) |  |

Writes a RenderSystemCapabilities object to a string.

## Member Data Documentation

## mCapabilitiesMap

CapabilitiesMap Ogre::RenderSystemCapabilitiesSerializer::mCapabilitiesMap

protected

Definition at line 101 of file OgreRenderSystemCapabilitiesSerializer.h.

## mCurrentCapabilities

RenderSystemCapabilities* Ogre::RenderSystemCapabilitiesSerializer::mCurrentCapabilities

protected

Definition at line 118 of file OgreRenderSystemCapabilitiesSerializer.h.

## mCurrentLine

String* Ogre::RenderSystemCapabilitiesSerializer::mCurrentLine

protected

Definition at line 115 of file OgreRenderSystemCapabilitiesSerializer.h.

## mCurrentLineNumber

int Ogre::RenderSystemCapabilitiesSerializer::mCurrentLineNumber

protected

Definition at line 114 of file OgreRenderSystemCapabilitiesSerializer.h.

## mCurrentStream

DataStreamPtr Ogre::RenderSystemCapabilitiesSerializer::mCurrentStream

protected

Definition at line 116 of file OgreRenderSystemCapabilitiesSerializer.h.

## mKeywordTypeMap

KeywordTypeMap Ogre::RenderSystemCapabilitiesSerializer::mKeywordTypeMap

protected

Definition at line 78 of file OgreRenderSystemCapabilitiesSerializer.h.

## mSetBoolMethodDispatchTable

SetBoolMethodDispatchTable Ogre::RenderSystemCapabilitiesSerializer::mSetBoolMethodDispatchTable

protected

Definition at line 93 of file OgreRenderSystemCapabilitiesSerializer.h.

## mSetIntMethodDispatchTable

SetIntMethodDispatchTable Ogre::RenderSystemCapabilitiesSerializer::mSetIntMethodDispatchTable

protected

Definition at line 88 of file OgreRenderSystemCapabilitiesSerializer.h.

## mSetRealMethodDispatchTable

SetRealMethodDispatchTable Ogre::RenderSystemCapabilitiesSerializer::mSetRealMethodDispatchTable

protected

Definition at line 98 of file OgreRenderSystemCapabilitiesSerializer.h.

## mSetStringMethodDispatchTable

SetStringMethodDispatchTable Ogre::RenderSystemCapabilitiesSerializer::mSetStringMethodDispatchTable

protected

Definition at line 83 of file OgreRenderSystemCapabilitiesSerializer.h.

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

- OgreRenderSystemCapabilitiesSerializer.h

Copyright © 2012 Torus Knot Software Ltd
This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.