OGRE  2.0
Object-Oriented Graphics Rendering Engine
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Ogre::RTShader::ProgramWriter Class Referenceabstract

Base class interface for shader program writers. More...

#include <OgreShaderProgramWriter.h>

+ Inheritance diagram for Ogre::RTShader::ProgramWriter:
+ Collaboration diagram for Ogre::RTShader::ProgramWriter:

Public Member Functions

virtual ~ProgramWriter ()
 Class destructor. More...
 
virtual const StringgetTargetLanguage () const =0
 Return the target language of this writer. 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)
 
virtual void writeSourceCode (std::ostream &os, Program *program)=0
 Write the program shader source code. More...
 

Protected Member Functions

void writeFunctionTitle (std::ostream &os, Function *function)
 Write a function title. More...
 
void writeProgramTitle (std::ostream &os, Program *program)
 Write the program title. More...
 
void writeUniformParametersTitle (std::ostream &os, Program *program)
 Write the uniform parameters title. More...
 

Detailed Description

Base class interface for shader program writers.

The main usage of this class is to generate a shader source code from the given CPU program. In order to support specific shader language one should subclass this interface and implement the pure methods.

Definition at line 60 of file OgreShaderProgramWriter.h.

Constructor & Destructor Documentation

virtual Ogre::RTShader::ProgramWriter::~ProgramWriter ( )
inlinevirtual

Class destructor.

Definition at line 66 of file OgreShaderProgramWriter.h.

Member Function Documentation

virtual const String& Ogre::RTShader::ProgramWriter::getTargetLanguage ( ) const
pure virtual
template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr)
inlineinherited

Definition at line 96 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr,
void *   
)
inlineinherited

Definition at line 102 of file OgreMemoryAllocatedObject.h.

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

Definition at line 108 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete[] ( void *  ptr)
inlineinherited

Definition at line 113 of file OgreMemoryAllocatedObject.h.

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

Definition at line 119 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz,
const char *  file,
int  line,
const char *  func 
)
inlineinherited

operator new, with debug line info

Definition at line 68 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz)
inlineinherited

Definition at line 73 of file OgreMemoryAllocatedObject.h.

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

placement operator new

Definition at line 79 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new[] ( size_t  sz,
const char *  file,
int  line,
const char *  func 
)
inlineinherited

array operator new, with debug line info

Definition at line 86 of file OgreMemoryAllocatedObject.h.

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

Definition at line 91 of file OgreMemoryAllocatedObject.h.

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

Write a function title.

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

Write the program title.

virtual void Ogre::RTShader::ProgramWriter::writeSourceCode ( std::ostream &  os,
Program program 
)
pure virtual

Write the program shader source code.

Parameters
osThe output stream to write to code into.
programThe source CPU program for the GPU program code.

Implemented in Ogre::RTShader::CGProgramWriter, Ogre::RTShader::GLSLESProgramWriter, Ogre::RTShader::HLSLProgramWriter, and Ogre::RTShader::GLSLProgramWriter.

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

Write the uniform parameters title.


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