OgreShaderProgram.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-2013 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 _ShaderProgram_
#define _ShaderProgram_

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

namespace Ogre {
namespace RTShader {

class _OgreRTSSExport Program : public RTShaderSystemAlloc
{

// Interface.
public: 
    GpuProgramType getType() const;

    UniformParameterPtr resolveAutoParameterReal(GpuProgramParameters::AutoConstantType autoType, Real data, size_t size = 0);
    
    UniformParameterPtr resolveAutoParameterReal(GpuProgramParameters::AutoConstantType autoType, GpuConstantType type, Real data, size_t size = 0);

    UniformParameterPtr resolveAutoParameterInt(GpuProgramParameters::AutoConstantType autoType, size_t data, size_t size = 0);
    
    UniformParameterPtr resolveAutoParameterInt(GpuProgramParameters::AutoConstantType autoType, GpuConstantType type, size_t data, size_t size = 0);

    UniformParameterPtr resolveParameter(GpuConstantType type, int index, uint16 variability, const String& suggestedName, size_t size = 0);
    
    UniformParameterPtr getParameterByName(const String& name);

    UniformParameterPtr getParameterByAutoType(GpuProgramParameters::AutoConstantType autoType);

    UniformParameterPtr getParameterByType(GpuConstantType type, int index);

    const UniformParameterList& getParameters() const { return mParameters; };

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

    Function* getFunctionByName(const String& name);

    const ShaderFunctionList& getFunctions() const { return mFunctions; };

    void setEntryPointFunction(Function* function) { mEntryPointFunction = function; }

    Function* getEntryPointFunction()                    { return mEntryPointFunction; }

    void addDependency(const String& libFileName);

    size_t getDependencyCount() const;

    const String& getDependency(unsigned int index) const;
    

    void setSkeletalAnimationIncluded(bool value) { mSkeletalAnimation = value; }
 
    bool getSkeletalAnimationIncluded() const { return mSkeletalAnimation; }

    void setUseColumnMajorMatrices(bool value) { mColumnMajorMatrices = value; }
    
    bool getUseColumnMajorMatrices() const { return mColumnMajorMatrices; }

// Protected methods.
protected:

    Program(GpuProgramType type);

    ~Program();

    void destroyParameters();

    void destroyFunctions();

    void addParameter(UniformParameterPtr parameter);
        
    void removeParameter(UniformParameterPtr parameter);


// Attributes.
protected:
    // Program type. (Vertex, Fragment, Geometry).
    GpuProgramType mType;
    // Program uniform parameters.  
    UniformParameterList mParameters;
    // Function list.
    ShaderFunctionList mFunctions;
    // Entry point function for this program.   
    Function* mEntryPointFunction;
    // Program dependencies.
    StringVector mDependencies;
    // Skeletal animation calculation
    bool mSkeletalAnimation;
    // Whether to pass matrices as column-major.
    bool mColumnMajorMatrices;
private:
    friend class ProgramManager;
};

}
}

#endif