OGRE  1.11.6
Object-Oriented Graphics Rendering Engine
Ogre::RTShader::AssignmentAtom Class Reference

shorthand for "lhs = rhs;" insted of using FFP_Assign(rhs, lhs) More...

#include <OgreShaderFunctionAtom.h>

+ Inheritance diagram for Ogre::RTShader::AssignmentAtom:

Public Types

typedef std::vector< OperandOperandVector
 

Public Member Functions

 AssignmentAtom (int groupOrder)
 
 AssignmentAtom (const Out &lhs, const In &rhs, int groupOrder)
 
const StringgetFunctionAtomType ()
 
const StringgetFunctionName () const
 Return the function name. More...
 
int getGroupExecutionOrder () const
 Get the group execution order of this function atom. More...
 
int getInternalExecutionOrder () const
 Get an internal execution order within a group of this function atom. More...
 
OperandVectorgetOperandList ()
 Get a list of parameters this function invocation will use in the function call as arguments. More...
 
const StringgetReturnType () const
 Return the return type. More...
 
bool operator!= (const FunctionInvocation &rhs) const
 Determines if the current object is not equal to the compared one. More...
 
bool operator< (const FunctionInvocation &rhs) const
 Determines if the current object is less than the compared one. More...
 
bool operator== (const FunctionInvocation &rhs) const
 Determines if the current object is equal to the compared one. More...
 
void pushOperand (ParameterPtr parameter, Operand::OpSemantic opSemantic, int opMask=Operand::OPM_ALL, int indirectionLevel=0)
 Push a new operand (on the end) to the function. More...
 
void setOperands (const OperandVector &ops)
 
void writeSourceCode (std::ostream &os, const String &targetLanguage) const
 

Static Public Attributes

static String Type
 

Detailed Description

shorthand for "lhs = rhs;" insted of using FFP_Assign(rhs, lhs)

Member Typedef Documentation

◆ OperandVector

Constructor & Destructor Documentation

◆ AssignmentAtom() [1/2]

Ogre::RTShader::AssignmentAtom::AssignmentAtom ( int  groupOrder)
inlineexplicit

◆ AssignmentAtom() [2/2]

Ogre::RTShader::AssignmentAtom::AssignmentAtom ( const Out lhs,
const In rhs,
int  groupOrder 
)
Note
the argument order is reversed comered to all other function invocations

Member Function Documentation

◆ writeSourceCode()

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

◆ getFunctionAtomType()

const String& Ogre::RTShader::AssignmentAtom::getFunctionAtomType ( )
inlinevirtual

◆ getOperandList()

OperandVector& Ogre::RTShader::FunctionInvocation::getOperandList ( )
inlineinherited

Get a list of parameters this function invocation will use in the function call as arguments.

References Ogre::RTShader::Operand::OPM_ALL.

◆ pushOperand()

void Ogre::RTShader::FunctionInvocation::pushOperand ( ParameterPtr  parameter,
Operand::OpSemantic  opSemantic,
int  opMask = Operand::OPM_ALL,
int  indirectionLevel = 0 
)
inherited

Push a new operand (on the end) to the function.

Parameters
parameterA function parameter.
opSemanticThe in/out semantic of the parameter.
opMaskThe field mask of the parameter.
indirectionLevelThe level of nesting inside brackets

◆ setOperands()

void Ogre::RTShader::FunctionInvocation::setOperands ( const OperandVector ops)
inherited

◆ getFunctionName()

const String& Ogre::RTShader::FunctionInvocation::getFunctionName ( ) const
inlineinherited

Return the function name.

◆ getReturnType()

const String& Ogre::RTShader::FunctionInvocation::getReturnType ( ) const
inlineinherited

Return the return type.

References Ogre::operator!=(), Ogre::operator<(), and Ogre::operator==().

◆ operator==()

bool Ogre::RTShader::FunctionInvocation::operator== ( const FunctionInvocation rhs) const
inherited

Determines if the current object is equal to the compared one.

◆ operator!=()

bool Ogre::RTShader::FunctionInvocation::operator!= ( const FunctionInvocation rhs) const
inherited

Determines if the current object is not equal to the compared one.

◆ operator<()

bool Ogre::RTShader::FunctionInvocation::operator< ( const FunctionInvocation rhs) const
inherited

Determines if the current object is less than the compared one.

◆ getGroupExecutionOrder()

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

Get the group execution order of this function atom.

◆ getInternalExecutionOrder()

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

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

Member Data Documentation

◆ Type

String Ogre::RTShader::AssignmentAtom::Type
static

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