Ogre::RTShader::HLSLProgramWriter Class Reference
Core » RTShader

HLSL target language writer implementation. More...

`#include <OgreShaderHLSLProgramWriter.h>`

Inheritance diagram for Ogre::RTShader::HLSLProgramWriter:
[legend]

## Public Member Functions

| HLSLProgramWriter ()
| Class constructor. More...
virtual | ~HLSLProgramWriter ()
| Class destructor. More...
virtual const String & | getTargetLanguage () const
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)
virtual void | writeSourceCode (std::ostream &os, Program *program)

## Static Public Attributes

static String | TargetLanguage

## Protected Types

typedef map< GpuConstantType, const char * >::type | GpuConstTypeToStringMap
typedef map< Parameter::Semantic, const char * >::type | ParamSemanticToStringMap

## Protected Member Functions

void | initializeStringMaps ()
| Initialize string maps. More...
void | writeAtomInstance (std::ostream &os, FunctionAtom *atom)
| Write function atom instance. More...
void | writeFunctionDeclaration (std::ostream &os, Function *function)
| Write a function declaration. More...
void | writeFunctionParameter (std::ostream &os, ParameterPtr parameter, const char *forcedSemantic)
| Write a function parameter. More...
void | writeFunctionTitle (std::ostream &os, Function *function)
| Write a function title. More...
void | writeLocalParameter (std::ostream &os, ParameterPtr parameter)
| Write a local parameter. More...
void | writeProgramDependencies (std::ostream &os, Program *program)
| Write the program dependencies. More...
void | writeProgramTitle (std::ostream &os, Program *program)
| Write the program title. More...
void | writeUniformParameter (std::ostream &os, UniformParameterPtr parameter)
| Write a uniform parameter. More...
void | writeUniformParametersTitle (std::ostream &os, Program *program)
| Write the uniform parameters title. More...

## Protected Attributes

GpuConstTypeToStringMap | mGpuConstTypeMap
ParamSemanticToStringMap | mParamSemanticMap

## Detailed Description

HLSL target language writer implementation.

See also
  ProgramWriter.

Definition at line 46 of file OgreShaderHLSLProgramWriter.h.

## Member Typedef Documentation

## GpuConstTypeToStringMap

typedef map<GpuConstantType, const char*>::type Ogre::RTShader::HLSLProgramWriter::GpuConstTypeToStringMap

protected

Definition at line 96 of file OgreShaderHLSLProgramWriter.h.

## ParamSemanticToStringMap

typedef map<Parameter::Semantic, const char*>::type Ogre::RTShader::HLSLProgramWriter::ParamSemanticToStringMap

protected

Definition at line 97 of file OgreShaderHLSLProgramWriter.h.

## Constructor & Destructor Documentation

## HLSLProgramWriter()

Ogre::RTShader::HLSLProgramWriter::HLSLProgramWriter | ( |  | ) |

Class constructor.

## ~HLSLProgramWriter()

virtual Ogre::RTShader::HLSLProgramWriter::~HLSLProgramWriter | ( |  | ) |

virtual

Class destructor.

## Member Function Documentation

## getTargetLanguage()

virtual const String& Ogre::RTShader::HLSLProgramWriter::getTargetLanguage | ( |  | ) | const

virtual

See also
  ProgramWriter::getTargetLanguage.

Implements Ogre::RTShader::ProgramWriter.

Definition at line 67 of file OgreShaderHLSLProgramWriter.h.

## initializeStringMaps()

void Ogre::RTShader::HLSLProgramWriter::initializeStringMaps | ( |  | ) |

protected

Initialize string maps.

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

## writeAtomInstance()

void Ogre::RTShader::HLSLProgramWriter::writeAtomInstance | ( | std::ostream & | os,
|  | FunctionAtom * | atom
| ) |  |

protected

Write function atom instance.

## writeFunctionDeclaration()

void Ogre::RTShader::HLSLProgramWriter::writeFunctionDeclaration | ( | std::ostream & | os,
|  | Function * | function
| ) |  |

protected

Write a function declaration.

## writeFunctionParameter()

void Ogre::RTShader::HLSLProgramWriter::writeFunctionParameter | ( | std::ostream & | os,
|  | ParameterPtr | parameter,
|  | const char * | forcedSemantic
| ) |  |

protected

Write a function parameter.

## writeFunctionTitle()

void Ogre::RTShader::ProgramWriter::writeFunctionTitle | ( | std::ostream & | os,
|  | Function * | function
| ) |  |

protected inherited

Write a function title.

## writeLocalParameter()

void Ogre::RTShader::HLSLProgramWriter::writeLocalParameter | ( | std::ostream & | os,
|  | ParameterPtr | parameter
| ) |  |

protected

Write a local parameter.

## writeProgramDependencies()

void Ogre::RTShader::HLSLProgramWriter::writeProgramDependencies | ( | std::ostream & | os,
|  | Program * | program
| ) |  |

protected

Write the program dependencies.

## writeProgramTitle()

void Ogre::RTShader::ProgramWriter::writeProgramTitle | ( | std::ostream & | os,
|  | Program * | program
| ) |  |

protected inherited

Write the program title.

## writeSourceCode()

virtual void Ogre::RTShader::HLSLProgramWriter::writeSourceCode | ( | std::ostream & | os,
|  | Program * | program
| ) |  |

virtual

See also
  ProgramWriter::writeSourceCode.

Implements Ogre::RTShader::ProgramWriter.

## writeUniformParameter()

void Ogre::RTShader::HLSLProgramWriter::writeUniformParameter | ( | std::ostream & | os,
|  | UniformParameterPtr | parameter
| ) |  |

protected

Write a uniform parameter.

## writeUniformParametersTitle()

void Ogre::RTShader::ProgramWriter::writeUniformParametersTitle | ( | std::ostream & | os,
|  | Program * | program
| ) |  |

protected inherited

Write the uniform parameters title.

## Member Data Documentation

## mGpuConstTypeMap

GpuConstTypeToStringMap Ogre::RTShader::HLSLProgramWriter::mGpuConstTypeMap

protected

Definition at line 102 of file OgreShaderHLSLProgramWriter.h.

## mParamSemanticMap

ParamSemanticToStringMap Ogre::RTShader::HLSLProgramWriter::mParamSemanticMap

protected

Definition at line 104 of file OgreShaderHLSLProgramWriter.h.

## TargetLanguage

String Ogre::RTShader::HLSLProgramWriter::TargetLanguage

static

Definition at line 69 of file OgreShaderHLSLProgramWriter.h.

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

- OgreShaderHLSLProgramWriter.h

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