OgreGpuProgram.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 __GpuProgram_H_
#define __GpuProgram_H_

// Precompiler options
#include "OgrePrerequisites.h"
#include "OgreResource.h"
#include "OgreSharedPtr.h"
#include "OgreIteratorWrappers.h"
#include "OgreSerializer.h"
#include "OgreRenderOperation.h"
#include "OgreGpuProgramParams.h"

namespace Ogre {

    enum GpuProgramType
    {
        GPT_VERTEX_PROGRAM,
        GPT_FRAGMENT_PROGRAM,
        GPT_GEOMETRY_PROGRAM
    };


    // Forward declaration 
    class GpuProgramPtr;

    class _OgreExport GpuProgram : public Resource
    {
    protected:
        class _OgreExport CmdType : public ParamCommand
        {
        public:
            String doGet(const void* target) const;
            void doSet(void* target, const String& val);
        };
        class _OgreExport CmdSyntax : public ParamCommand
        {
        public:
            String doGet(const void* target) const;
            void doSet(void* target, const String& val);
        };
        class _OgreExport CmdSkeletal : public ParamCommand
        {
        public:
            String doGet(const void* target) const;
            void doSet(void* target, const String& val);
        };
        class _OgreExport CmdMorph : public ParamCommand
        {
        public:
            String doGet(const void* target) const;
            void doSet(void* target, const String& val);
        };
        class _OgreExport CmdPose : public ParamCommand
        {
        public:
            String doGet(const void* target) const;
            void doSet(void* target, const String& val);
        };
        class _OgreExport CmdVTF : public ParamCommand
        {
        public:
            String doGet(const void* target) const;
            void doSet(void* target, const String& val);
        };
        class _OgreExport CmdManualNamedConstsFile : public ParamCommand
        {
        public:
            String doGet(const void* target) const;
            void doSet(void* target, const String& val);
        };
        class _OgreExport CmdAdjacency : public ParamCommand
        {
        public:
            String doGet(const void* target) const;
            void doSet(void* target, const String& val);
        };
        // Command object for setting / getting parameters
        static CmdType msTypeCmd;
        static CmdSyntax msSyntaxCmd;
        static CmdSkeletal msSkeletalCmd;
        static CmdMorph msMorphCmd;
        static CmdPose msPoseCmd;
        static CmdVTF msVTFCmd;
        static CmdManualNamedConstsFile msManNamedConstsFileCmd;
        static CmdAdjacency msAdjacencyCmd;
        GpuProgramType mType;
        String mFilename;
        String mSource;
        bool mLoadFromFile;
        String mSyntaxCode;
        bool mSkeletalAnimation;
        bool mMorphAnimation;
        ushort mPoseAnimation;
        bool mVertexTextureFetch;
        bool mNeedsAdjacencyInfo;
        GpuProgramParametersSharedPtr mDefaultParams;
        bool mCompileError;
        mutable GpuLogicalBufferStructPtr mFloatLogicalToPhysical;
        mutable GpuLogicalBufferStructPtr mIntLogicalToPhysical;
        mutable GpuNamedConstantsPtr mConstantDefs;
        String mManualNamedConstantsFile;
        bool mLoadedManualNamedConstants;


        void setupBaseParamDictionary(void);

        bool isRequiredCapabilitiesSupported(void) const;

        size_t calculateSize(void) const { return 0; } // TODO 

        void loadImpl(void);

        void createParameterMappingStructures(bool recreateIfExists = true) const;
        void createLogicalParameterMappingStructures(bool recreateIfExists = true) const;
        void createNamedParameterMappingStructures(bool recreateIfExists = true) const;

    public:

        GpuProgram(ResourceManager* creator, const String& name, ResourceHandle handle,
            const String& group, bool isManual = false, ManualResourceLoader* loader = 0);

        virtual ~GpuProgram() {}

        virtual void setSourceFile(const String& filename);

        virtual void setSource(const String& source);

        virtual const String& getSyntaxCode(void) const { return mSyntaxCode; }

        virtual void setSyntaxCode(const String& syntax);

        virtual const String& getSourceFile(void) const { return mFilename; }
        virtual const String& getSource(void) const { return mSource; }
        virtual void setType(GpuProgramType t);
        virtual GpuProgramType getType(void) const { return mType; }

        virtual GpuProgram* _getBindingDelegate(void) { return this; }

        virtual bool isSupported(void) const;

        virtual GpuProgramParametersSharedPtr createParameters(void);

        virtual void setSkeletalAnimationIncluded(bool included) 
        { mSkeletalAnimation = included; }

        virtual bool isSkeletalAnimationIncluded(void) const { return mSkeletalAnimation; }

        virtual void setMorphAnimationIncluded(bool included) 
        { mMorphAnimation = included; }

        virtual void setPoseAnimationIncluded(ushort poseCount) 
        { mPoseAnimation = poseCount; }

        virtual bool isMorphAnimationIncluded(void) const { return mMorphAnimation; }

        virtual bool isPoseAnimationIncluded(void) const { return mPoseAnimation > 0; }
        virtual ushort getNumberOfPosesIncluded(void) const { return mPoseAnimation; }
        virtual void setVertexTextureFetchRequired(bool r) { mVertexTextureFetch = r; }
        virtual bool isVertexTextureFetchRequired(void) const { return mVertexTextureFetch; }

        virtual void setAdjacencyInfoRequired(bool r) { mNeedsAdjacencyInfo = r; }
        virtual bool isAdjacencyInfoRequired(void) const { return mNeedsAdjacencyInfo; }
        
        virtual GpuProgramParametersSharedPtr getDefaultParameters(void);

        virtual bool hasDefaultParameters(void) const { return !mDefaultParams.isNull(); }

        virtual bool getPassSurfaceAndLightStates(void) const { return false; }

        virtual bool getPassFogStates(void) const { return true; }

        virtual bool getPassTransformStates(void) const { return false; }

        virtual const String& getLanguage(void) const;

        virtual bool hasCompileError(void) const { return mCompileError; }

        virtual void resetCompileError(void) { mCompileError = false; }

        virtual void setManualNamedConstants(const GpuNamedConstants& namedConstants);

        virtual const GpuNamedConstants& getNamedConstants() const { return *mConstantDefs.get(); }

        virtual void setManualNamedConstantsFile(const String& paramDefFile);

        virtual const String& getManualNamedConstantsFile() const { return mManualNamedConstantsFile; }
        virtual const GpuNamedConstants& getConstantDefinitions() const { return *mConstantDefs.get(); }


    protected:
        virtual void loadFromSource(void) = 0;

    };


    class _OgreExport GpuProgramPtr : public SharedPtr<GpuProgram> 
    {
    public:
        GpuProgramPtr() : SharedPtr<GpuProgram>() {}
        explicit GpuProgramPtr(GpuProgram* rep) : SharedPtr<GpuProgram>(rep) {}
        GpuProgramPtr(const GpuProgramPtr& r) : SharedPtr<GpuProgram>(r) {} 
        GpuProgramPtr(const ResourcePtr& r) : SharedPtr<GpuProgram>()
        {
            // lock & copy other mutex pointer
            OGRE_MUTEX_CONDITIONAL(r.OGRE_AUTO_MUTEX_NAME)
            {
                OGRE_LOCK_MUTEX(*r.OGRE_AUTO_MUTEX_NAME)
                OGRE_COPY_AUTO_SHARED_MUTEX(r.OGRE_AUTO_MUTEX_NAME)
                pRep = static_cast<GpuProgram*>(r.getPointer());
                pUseCount = r.useCountPointer();
                if (pUseCount)
                {
                    ++(*pUseCount);
                }
            }
        }

        GpuProgramPtr& operator=(const ResourcePtr& r)
        {
            if (pRep == static_cast<GpuProgram*>(r.getPointer()))
                return *this;
            release();
            // lock & copy other mutex pointer
            OGRE_MUTEX_CONDITIONAL(r.OGRE_AUTO_MUTEX_NAME)
            {
                OGRE_LOCK_MUTEX(*r.OGRE_AUTO_MUTEX_NAME)
                OGRE_COPY_AUTO_SHARED_MUTEX(r.OGRE_AUTO_MUTEX_NAME)
                pRep = static_cast<GpuProgram*>(r.getPointer());
                pUseCount = r.useCountPointer();
                if (pUseCount)
                {
                    ++(*pUseCount);
                }
            }
            else
            {
                // RHS must be a null pointer
                assert(r.isNull() && "RHS must be null if it has no mutex!");
                setNull();
            }
            return *this;
        }
        GpuProgramPtr& operator=(const HighLevelGpuProgramPtr& r);
    };
}

#endif