OgreShaderFunctionAtom.h

Go to the documentation of this file.

/*
-----------------------------------------------------------------------------
This source file is part of OGRE
(Object-oriented Graphics Rendering Engine)
For the latest info, see http://www.ogre3d.org

Copyright (c) 2000-2014 Torus Knot Software Ltd
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
-----------------------------------------------------------------------------
*/
#ifndef _ShaderFunctionAtom_
#define _ShaderFunctionAtom_

#include "OgreShaderPrerequisites.h"
#include "OgreGpuProgram.h"
#include "OgreSingleton.h"
#include "OgreShaderParameter.h"
#include "OgreStringVector.h"

namespace Ogre {
namespace RTShader {

class _OgreRTSSExport FunctionAtom : public RTShaderSystemAlloc
{
// Interface.
public:
    FunctionAtom();

    virtual ~FunctionAtom() {}

    int getGroupExecutionOrder() const;
    
    int getInternalExecutionOrder() const;
    
    virtual void writeSourceCode(std::ostream& os, const String& targetLanguage) const = 0;
    
    virtual const String& getFunctionAtomType() = 0;

// Attributes.
protected:
    // The owner group execution order. 
    int mGroupExecutionOrder;
    // The execution order within the group.        
    int mInternalExecutionOrder;
};

class _OgreRTSSExport Operand : public RTShaderSystemAlloc
{
public:

    // InOut semantic
    enum OpSemantic
    {
        OPS_IN, 
        OPS_OUT,
        OPS_INOUT
    };

    // Used field mask
    enum OpMask
    {
        OPM_ALL     = 0x0001,
        OPM_X       = 0x0002,
        OPM_Y       = 0x0004,
        OPM_Z       = 0x0008,
        OPM_W       = 0x0010,
        OPM_XY      = OPM_X | OPM_Y,
        OPM_XZ      = OPM_X | OPM_Z,
        OPM_XW      = OPM_X | OPM_W,
        OPM_YZ      = OPM_Y | OPM_Z,
        OPM_YW      = OPM_Y | OPM_W,
        OPM_ZW      = OPM_Z | OPM_W,
        OPM_XYZ     = OPM_X | OPM_Y | OPM_Z,
        OPM_XYW     = OPM_X | OPM_Y | OPM_W,
        OPM_XZW     = OPM_X | OPM_Z | OPM_W,
        OPM_YZW     = OPM_Y | OPM_Z | OPM_W,
        OPM_XYZW    = OPM_X | OPM_Y | OPM_Z | OPM_W
    };

    Operand(ParameterPtr parameter, Operand::OpSemantic opSemantic, int opMask = Operand::OPM_ALL, ushort indirectionLevel = 0);

    Operand(const Operand& rhs);

    Operand& operator= (const Operand & rhs);

    ~Operand();

    const ParameterPtr& getParameter()  const { return mParameter; }

    bool hasFreeFields()    const { return ((mMask & ~OPM_ALL) && ((mMask & ~OPM_X) || (mMask & ~OPM_Y) || (mMask & ~OPM_Z) || (mMask & ~OPM_W))); }
    
    int getMask()   const { return mMask; }

    OpSemantic getSemantic()    const { return mSemantic; }

    ushort getIndirectionLevel()    const { return mIndirectionLevel; }

    String toString()   const;

    static String getMaskAsString(int mask);

    static int getFloatCount(int mask);

    static GpuConstantType getGpuConstantType(int mask);

protected:
    ParameterPtr mParameter;
    OpSemantic mSemantic;
    int mMask;
    ushort mIndirectionLevel;
};

class _OgreRTSSExport FunctionInvocation : public FunctionAtom
{
    // Interface.
public: 
    typedef vector<Operand>::type OperandVector;

    FunctionInvocation(const String& functionName, int groupOrder, int internalOrder, String returnType = "void");

    FunctionInvocation(const FunctionInvocation& rhs);

    virtual void writeSourceCode(std::ostream& os, const String& targetLanguage) const;

    virtual const String& getFunctionAtomType() { return Type; }

    OperandVector& getOperandList() { return mOperands; }
    
    void pushOperand(ParameterPtr parameter, Operand::OpSemantic opSemantic, int opMask = Operand::OPM_ALL, int indirectionLevel = 0);

    const String& getFunctionName() const { return mFunctionName; }

    const String& getReturnType() const { return mReturnType; }

    bool operator == ( const FunctionInvocation& rhs ) const;

    bool operator != ( const FunctionInvocation& rhs ) const;

    bool operator <  ( const FunctionInvocation& rhs ) const;

    struct FunctionInvocationLessThan
    {
        bool operator()(FunctionInvocation const& lhs, FunctionInvocation const& rhs) const;
    };

    struct FunctionInvocationCompare
    {
        bool operator()(FunctionInvocation const& lhs, FunctionInvocation const& rhs) const;
    };

    static String Type;

    // Attributes.
protected:  
    String mFunctionName;
    String mReturnType;
    OperandVector mOperands;    
};

typedef vector<FunctionAtom*>::type                 FunctionAtomInstanceList;
typedef FunctionAtomInstanceList::iterator          FunctionAtomInstanceIterator;
typedef FunctionAtomInstanceList::const_iterator    FunctionAtomInstanceConstIterator;

}
}

#endif