OGRE  1.9.0
Ogre::RTShader::FunctionAtom Class Referenceabstract

A class that represents an atomic code section of shader based program function. More...

#include <OgreShaderFunctionAtom.h>

Inheritance diagram for Ogre::RTShader::FunctionAtom:

Public Member Functions

 FunctionAtom ()
 Class default constructor.
 
virtual ~FunctionAtom ()
 Class default destructor.
 
virtual const StringgetFunctionAtomType ()=0
 Return the type of this atom instance implementation.
 
int getGroupExecutionOrder () const
 Get the group execution order of this function atom.
 
int getInternalExecutionOrder () const
 Get an internal execution order within a group of this function atom.
 
void operator delete (void *ptr)
 
void operator delete (void *ptr, const char *, int, const char *)
 
void operator delete (void *ptr, void *)
 
void operator delete[] (void *ptr)
 
void operator delete[] (void *ptr, const char *, int, const char *)
 
void * operator new (size_t sz)
 
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 *ptr)
 placement operator new
 
void * operator new[] (size_t sz)
 
void * operator new[] (size_t sz, const char *file, int line, const char *func)
 array operator new, with debug line info
 
virtual void writeSourceCode (std::ostream &os, const String &targetLanguage) const =0
 Abstract method that writes a source code to the given output stream in the target shader language.
 

Protected Attributes

int mGroupExecutionOrder
 
int mInternalExecutionOrder
 

Detailed Description

A class that represents an atomic code section of shader based program function.

Definition at line 48 of file OgreShaderFunctionAtom.h.

Constructor & Destructor Documentation

◆ FunctionAtom()

Ogre::RTShader::FunctionAtom::FunctionAtom ( )

Class default constructor.

◆ ~FunctionAtom()

virtual Ogre::RTShader::FunctionAtom::~FunctionAtom ( )
virtual

Class default destructor.

Definition at line 56 of file OgreShaderFunctionAtom.h.

Member Function Documentation

◆ getFunctionAtomType()

virtual const String & Ogre::RTShader::FunctionAtom::getFunctionAtomType ( )
pure virtual

Return the type of this atom instance implementation.

Implemented in Ogre::RTShader::FunctionInvocation.

◆ getGroupExecutionOrder()

int Ogre::RTShader::FunctionAtom::getGroupExecutionOrder ( ) const

Get the group execution order of this function atom.

◆ getInternalExecutionOrder()

int Ogre::RTShader::FunctionAtom::getInternalExecutionOrder ( ) const

Get an internal execution order within a group of this function atom.

◆ 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,
const char * ,
int ,
const char *  )
inherited

Definition at line 108 of file OgreMemoryAllocatedObject.h.

◆ operator delete() [3/3]

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

Definition at line 102 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)
inherited

Definition at line 73 of file OgreMemoryAllocatedObject.h.

◆ operator new() [2/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() [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)
inherited

Definition at line 91 of file OgreMemoryAllocatedObject.h.

◆ operator new[]() [2/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.

◆ writeSourceCode()

virtual void Ogre::RTShader::FunctionAtom::writeSourceCode ( std::ostream & os,
const String & targetLanguage ) const
pure virtual

Abstract method that writes a source code to the given output stream in the target shader language.

Implemented in Ogre::RTShader::FunctionInvocation.

Member Data Documentation

◆ mGroupExecutionOrder

int Ogre::RTShader::FunctionAtom::mGroupExecutionOrder
protected

Definition at line 73 of file OgreShaderFunctionAtom.h.

◆ mInternalExecutionOrder

int Ogre::RTShader::FunctionAtom::mInternalExecutionOrder
protected

Definition at line 75 of file OgreShaderFunctionAtom.h.


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