OgreShaderFunction.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-2012 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 _ShaderProgramFunction_
#define _ShaderProgramFunction_

#include "OgreShaderPrerequisites.h"
#include "OgreShaderParameter.h"
#include "OgreShaderFunctionAtom.h"

namespace Ogre {
namespace RTShader {

class _OgreRTSSExport Function : public RTShaderSystemAlloc
{
// Interface.
public:
    enum FunctionType
    {
        // internal function (default)
        FFT_INTERNAL,
        // Vertex program main
        FFT_VS_MAIN,
        // Pixel shader main
        FFT_PS_MAIN
    };

    const String&               getName                 () const { return mName; }

    const String&               getDescription          () const { return mDescription; }

    ParameterPtr                resolveInputParameter   (Parameter::Semantic semantic, int index,  const Parameter::Content content, GpuConstantType type);


    ParameterPtr                resolveOutputParameter  (Parameter::Semantic semantic, int index,  const Parameter::Content content, GpuConstantType type);

    ParameterPtr                resolveLocalParameter   (Parameter::Semantic semantic, int index, const String& name, GpuConstantType type);

    ParameterPtr                resolveLocalParameter   (Parameter::Semantic semantic, int index, const Parameter::Content content, GpuConstantType type);
    

    static ParameterPtr             getParameterByName      (const ShaderParameterList& parameterList, const String& name);

    static ParameterPtr             getParameterBySemantic  (const ShaderParameterList& parameterList, const Parameter::Semantic semantic, int index);


    ParameterPtr                    getParameterByContent   (const ShaderParameterList& parameterList, const Parameter::Content content, GpuConstantType type);

    const ShaderParameterList&      getInputParameters      () const { return mInputParameters; }   

    const ShaderParameterList&      getOutputParameters     () const { return mOutputParameters; }

    const ShaderParameterList&      getLocalParameters      () const { return mLocalParameters; }   
    
    void                            addAtomInstance         (FunctionAtom* atomInstance);

    bool                            deleteAtomInstance      (FunctionAtom* atomInstance);

    void                            sortAtomInstances       ();

    FunctionAtomInstanceList&       getAtomInstances        () { return mAtomInstances; }

    const FunctionAtomInstanceList& getAtomInstances        () const { return mAtomInstances; }

    void                        addInputParameter           (ParameterPtr parameter);

    void                        addOutputParameter          (ParameterPtr parameter);

    void                        deleteInputParameter        (ParameterPtr parameter);

    void                        deleteOutputParameter       (ParameterPtr parameter);

    void                        deleteAllInputParameters    ();

    void                        deleteAllOutputParameters   ();

    FunctionType getFunctionType() const;


protected:

    Function            (const String& name, const String& desc, const FunctionType functionType);

    ~Function           ();

    void                        addParameter                (ShaderParameterList& parameterList, ParameterPtr parameter);

    void                        deleteParameter             (ShaderParameterList& parameterList, ParameterPtr parameter);

    static int                  sAtomInstanceCompare        (const void * p0, const void *p1);

protected:
    String                      mName;                      // Function name.
    String                      mDescription;               // Function description.
    ShaderParameterList         mInputParameters;           // Input parameters.
    ShaderParameterList         mOutputParameters;          // Output parameters.
    ShaderParameterList         mLocalParameters;           // Local parameters.
    FunctionAtomInstanceList    mAtomInstances;             // Atom instances composing this function.
    FunctionType                mFunctionType;              // Function type
    
private:
    friend class Program;
};

typedef vector<Function*>::type                     ShaderFunctionList;
typedef ShaderFunctionList::iterator                ShaderFunctionIterator;
typedef ShaderFunctionList::const_iterator          ShaderFunctionConstIterator;

}
}

#endif