FastGpuParamRef.h

Go to the documentation of this file.

/*
This file is part of Caelum.
See http://www.ogre3d.org/wiki/index.php/Caelum 

Copyright (c) 2009 Caelum team. See Contributors.txt for details.

Caelum is free software: you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published
by the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

Caelum is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License
along with Caelum. If not, see <http://www.gnu.org/licenses/>.
*/

#ifndef CAELUM__FAST_GPU_PARAM_REF_H
#define CAELUM__FAST_GPU_PARAM_REF_H

#include "CaelumPrerequisites.h"

namespace Caelum
{
    #define CAELUM_DEBUG_PARAM_REF OGRE_DEBUG_MODE

    class CAELUM_EXPORT FastGpuParamRef
    {
    public:
        FastGpuParamRef(): mPhysicalIndex(InvalidPhysicalIndex)
        {
            // mParams needs no initialization; SharedPtrs start as 0.
        }

        FastGpuParamRef(Ogre::GpuProgramParametersSharedPtr paramsPtr, const Ogre::String& name);

        void bind(
                Ogre::GpuProgramParametersSharedPtr paramsPtr,
                const Ogre::String& name,
                bool throwIfNotFound = false);

        void unbind();

        inline bool isBound() const { return mPhysicalIndex != InvalidPhysicalIndex; }

        inline size_t getPhysicalIndex () const { return mPhysicalIndex; }

    protected:
        template<typename ArgumentT>
        inline void doSet(const Ogre::GpuProgramParametersSharedPtr& params, ArgumentT arg) const {
            #if CAELUM_DEBUG_PARAM_REF
                assert(params.getPointer() == mParams.getPointer());
            #endif
            assert(!params.isNull());
            if (mPhysicalIndex != InvalidPhysicalIndex) {
                params->_writeRawConstant(mPhysicalIndex, arg);
            }
        }

        template<typename ArgumentT>
        inline void doSet(const Ogre::GpuProgramParametersSharedPtr& params, ArgumentT arg, size_t count) const {
            #if CAELUM_DEBUG_PARAM_REF
                assert(params.getPointer() == mParams.getPointer());
            #endif
            assert(!params.isNull());
            if (mPhysicalIndex != InvalidPhysicalIndex) {
                params->_writeRawConstant(mPhysicalIndex, arg, count);
            }
        }

    public:
        inline void set(const Ogre::GpuProgramParametersSharedPtr& params, int val) const { doSet<int>(params, val); }
        inline void set(const Ogre::GpuProgramParametersSharedPtr& params, Ogre::Real val) const { doSet<Ogre::Real>(params, val); }
        inline void set(const Ogre::GpuProgramParametersSharedPtr& params, const Ogre::Vector3& val) const { doSet<const Ogre::Vector3&>(params, val); }
        inline void set(const Ogre::GpuProgramParametersSharedPtr& params, const Ogre::Vector4& val) const { doSet<const Ogre::Vector4&>(params, val); }
        inline void set(const Ogre::GpuProgramParametersSharedPtr& params, const Ogre::ColourValue& val) const { doSet<const Ogre::ColourValue&>(params, val); }
        inline void set(const Ogre::GpuProgramParametersSharedPtr& params, const Ogre::Matrix4& val) const { doSet<const Ogre::Matrix4*>(params, &val, 1); }

    private:
        #if CAELUM_DEBUG_PARAM_REF
            Ogre::GpuProgramParametersSharedPtr mParams;
        #endif
        static const size_t InvalidPhysicalIndex = 0xFFFFFFFF;
        size_t mPhysicalIndex;
    };
}

#endif /* CAELUM__FAST_GPU_PARAM_REF_H */