source: downloads/OgreMain/src/OgreTechnique.cpp @ 6

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

Copyright (c) 2000-2006 Torus Knot Software Ltd
Also see acknowledgements in Readme.html

This program 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 2 of the License, or (at your option) any later
version.

This program 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
this program if not, write to the Free Software Foundation, Inc., 59 Temple
Place - Suite 330, Boston, MA 02111-1307, USA, or go to
http://www.gnu.org/copyleft/lesser.txt.

You may alternatively use this source under the terms of a specific version of
the OGRE Unrestricted License provided you have obtained such a license from
Torus Knot Software Ltd.
-----------------------------------------------------------------------------
*/
#include "OgreStableHeaders.h"

#include "OgreTechnique.h"
#include "OgreMaterial.h"
#include "OgrePass.h"
#include "OgreRoot.h"
#include "OgreRenderSystem.h"
#include "OgreRenderSystemCapabilities.h"
#include "OgreGpuProgramManager.h"
#include "OgreMaterialManager.h"


namespace Ogre {
    //-----------------------------------------------------------------------------
    Technique::Technique(Material* parent)
        : mParent(parent), mIsSupported(false), mIlluminationPassesCompilationPhase(IPS_NOT_COMPILED), mLodIndex(0), mSchemeIndex(0)
    {
        // See above, defaults to unsupported until examined
    }
    //-----------------------------------------------------------------------------
    Technique::Technique(Material* parent, const Technique& oth)
        : mParent(parent), mLodIndex(0), mSchemeIndex(0)
    {
        // Copy using operator=
        *this = oth;
    }
    //-----------------------------------------------------------------------------
    Technique::~Technique()
    {
        removeAllPasses();
        clearIlluminationPasses();
    }
    //-----------------------------------------------------------------------------
    bool Technique::isSupported(void) const
    {
        return mIsSupported;
    }
    //-----------------------------------------------------------------------------
    String Technique::_compile(bool autoManageTextureUnits)
    {
                StringUtil::StrStreamType compileErrors;

                // assume not supported
                mIsSupported = false;
        // Go through each pass, checking requirements
        Passes::iterator i;
                unsigned short passNum = 0;
                const RenderSystemCapabilities* caps =
                        Root::getSingleton().getRenderSystem()->getCapabilities();
                unsigned short numTexUnits = caps->getNumTextureUnits();
        for (i = mPasses.begin(); i != mPasses.end(); ++i, ++passNum)
        {
            Pass* currPass = *i;
                        // Adjust pass index
                        currPass->_notifyIndex(passNum);
            // Check texture unit requirements
            size_t numTexUnitsRequested = currPass->getNumTextureUnitStates();
                        // Don't trust getNumTextureUnits for programmable
                        if(!currPass->hasFragmentProgram())
                        {
        #if defined(OGRE_PRETEND_TEXTURE_UNITS) && OGRE_PRETEND_TEXTURE_UNITS > 0
                                if (numTexUnits > OGRE_PRETEND_TEXTURE_UNITS)
                                        numTexUnits = OGRE_PRETEND_TEXTURE_UNITS;
        #endif
                                if (numTexUnitsRequested > numTexUnits)
                                {
                                        if (!autoManageTextureUnits)
                                        {
                                                // The user disabled auto pass split
                                                compileErrors << "Pass " << passNum << 
                                                        ": Too many texture units for the current hardware and no splitting allowed."
                                                        << std::endl;
                                                return compileErrors.str();
                                        }
                                        else if (currPass->hasVertexProgram())
                                        {
                                                // Can't do this one, and can't split a programmable pass
                                                compileErrors << "Pass " << passNum << 
                                                        ": Too many texture units for the current hardware and "
                                                        "cannot split programmable passes."
                                                        << std::endl;
                                                return compileErrors.str();
                                        }
                                }
                        }

                        if (currPass->hasVertexProgram())
                        {
                                // Check vertex program version
                                if (!currPass->getVertexProgram()->isSupported() )
                                {
                                        // Can't do this one
                                        compileErrors << "Pass " << passNum << 
                                                ": Vertex program " << currPass->getVertexProgram()->getName()
                                                << " cannot be used - ";
                                        if (currPass->getVertexProgram()->hasCompileError())
                                                compileErrors << "compile error.";
                                        else
                                                compileErrors << "not supported.";

                                        compileErrors << std::endl;
                                        return compileErrors.str();
                                }
                        }
            if (currPass->hasFragmentProgram())
            {
                // Check fragment program version
                if (!currPass->getFragmentProgram()->isSupported())
                {
                    // Can't do this one
                                        compileErrors << "Pass " << passNum << 
                                                ": Fragment program " << currPass->getFragmentProgram()->getName()
                                                << " cannot be used - ";
                                        if (currPass->getFragmentProgram()->hasCompileError())
                                                compileErrors << "compile error.";
                                        else
                                                compileErrors << "not supported.";

                                        compileErrors << std::endl;
                                        return compileErrors.str();
                }
            }
            else
            {
                                // Check a few fixed-function options in texture layers
                Pass::TextureUnitStateIterator texi = currPass->getTextureUnitStateIterator();
                                size_t texUnit = 0;
                                while (texi.hasMoreElements())
                                {
                                        TextureUnitState* tex = texi.getNext();
                                        // Any Cube textures? NB we make the assumption that any
                                        // card capable of running fragment programs can support
                                        // cubic textures, which has to be true, surely?
                                        if (tex->is3D() && !caps->hasCapability(RSC_CUBEMAPPING))
                                        {
                                                // Fail
                                                compileErrors << "Pass " << passNum << 
                                                        " Tex " << texUnit <<
                                                        ": Cube maps not supported by current environment."
                                                        << std::endl;
                                                return compileErrors.str();
                                        }
                                        // Any 3D textures? NB we make the assumption that any
                                        // card capable of running fragment programs can support
                                        // 3D textures, which has to be true, surely?
                                        if (tex->getTextureType() == TEX_TYPE_3D && !caps->hasCapability(RSC_TEXTURE_3D))
                                        {
                                                // Fail
                                                compileErrors << "Pass " << passNum << 
                                                        " Tex " << texUnit <<
                                                        ": Volume textures not supported by current environment."
                                                        << std::endl;
                                                return compileErrors.str();
                                        }
                                        // Any Dot3 blending?
                                        if (tex->getColourBlendMode().operation == LBX_DOTPRODUCT &&
                                                        !caps->hasCapability(RSC_DOT3))
                                        {
                                                // Fail
                                                compileErrors << "Pass " << passNum << 
                                                        " Tex " << texUnit <<
                                                        ": DOT3 blending not supported by current environment."
                                                        << std::endl;
                                                return compileErrors.str();
                                        }
                                        ++texUnit;
                                }

                                // We're ok on operations, now we need to check # texture units
                                if (!currPass->hasFragmentProgram())
                                {
                                        // Keep splitting this pass so long as units requested > gpu units
                                        while (numTexUnitsRequested > numTexUnits)
                                        {
                                                // chop this pass into many passes
                                                currPass = currPass->_split(numTexUnits);
                                                numTexUnitsRequested = currPass->getNumTextureUnitStates();
                                                // Advance pass number
                                                ++passNum;
                                                // Reset iterator
                                                i = mPasses.begin() + passNum;
                                                // Move the new pass to the right place (will have been created
                                                // at the end, may be other passes in between)
                                                assert(mPasses.back() == currPass);
                                                std::copy_backward(i, (mPasses.end()-1), mPasses.end());
                                                *i = currPass;
                                                // Adjust pass index
                                                currPass->_notifyIndex(passNum);
                                        }
                                }
            }

                }
        // If we got this far, we're ok
        mIsSupported = true;

        // Compile for categorised illumination on demand
        clearIlluminationPasses();
        mIlluminationPassesCompilationPhase = IPS_NOT_COMPILED;

                return StringUtil::BLANK;

    }
    //-----------------------------------------------------------------------------
    Pass* Technique::createPass(void)
    {
                Pass* newPass = new Pass(this, static_cast<unsigned short>(mPasses.size()));
                mPasses.push_back(newPass);
                return newPass;
    }
    //-----------------------------------------------------------------------------
    Pass* Technique::getPass(unsigned short index)
    {
                assert(index < mPasses.size() && "Index out of bounds");
                return mPasses[index];
    }
    //-----------------------------------------------------------------------------
    Pass* Technique::getPass(const String& name)
    {
        Passes::iterator i    = mPasses.begin();
        Passes::iterator iend = mPasses.end();
        Pass* foundPass = 0;

        // iterate through techniques to find a match
        while (i != iend)
        {
            if ( (*i)->getName() == name )
            {
                foundPass = (*i);
                break;
            }
            ++i;
        }

        return foundPass;
    }
    //-----------------------------------------------------------------------------
    unsigned short Technique::getNumPasses(void) const
    {
                return static_cast<unsigned short>(mPasses.size());
    }
    //-----------------------------------------------------------------------------
    void Technique::removePass(unsigned short index)
    {
                assert(index < mPasses.size() && "Index out of bounds");
                Passes::iterator i = mPasses.begin() + index;
                (*i)->queueForDeletion();
                i = mPasses.erase(i);
                // Adjust passes index
                for (; i != mPasses.end(); ++i, ++index)
                {
                        (*i)->_notifyIndex(index);
                }
    }
    //-----------------------------------------------------------------------------
    void Technique::removeAllPasses(void)
    {
        Passes::iterator i, iend;
        iend = mPasses.end();
        for (i = mPasses.begin(); i != iend; ++i)
        {
            (*i)->queueForDeletion();
        }
        mPasses.clear();
    }

    //-----------------------------------------------------------------------------
    bool Technique::movePass(const unsigned short sourceIndex, const unsigned short destinationIndex)
    {
        bool moveSuccessful = false;

        // don't move the pass if source == destination
        if (sourceIndex == destinationIndex) return true;

        if( (sourceIndex < mPasses.size()) && (destinationIndex < mPasses.size()))
        {
            Passes::iterator i = mPasses.begin() + sourceIndex;
            //Passes::iterator DestinationIterator = mPasses.begin() + destinationIndex;

            Pass* pass = (*i);
            mPasses.erase(i);

            i = mPasses.begin() + destinationIndex;

            // compensate for source erase if destination is greater than source
            if (destinationIndex > sourceIndex) --i;

            mPasses.insert(i, pass);

                        // Adjust passes index
                        unsigned short beginIndex, endIndex;
                        if (destinationIndex > sourceIndex)
                        {
                                beginIndex = sourceIndex;
                                endIndex = destinationIndex;
                        }
                        else
                        {
                                beginIndex = destinationIndex;
                                endIndex = sourceIndex;
                        }
                        for (unsigned short index = beginIndex; index <= endIndex; ++index)
                        {
                                mPasses[index]->_notifyIndex(index);
                        }
            moveSuccessful = true;
        }

        return moveSuccessful;
    }

    //-----------------------------------------------------------------------------
    const Technique::PassIterator Technique::getPassIterator(void)
    {
                return PassIterator(mPasses.begin(), mPasses.end());
    }
    //-----------------------------------------------------------------------------
    Technique& Technique::operator=(const Technique& rhs)
    {
        mName = rhs.mName;
                this->mIsSupported = rhs.mIsSupported;
        this->mLodIndex = rhs.mLodIndex;
                this->mSchemeIndex = rhs.mSchemeIndex;
                // copy passes
                removeAllPasses();
                Passes::const_iterator i, iend;
                iend = rhs.mPasses.end();
                for (i = rhs.mPasses.begin(); i != iend; ++i)
                {
                        Pass* p = new Pass(this, (*i)->getIndex(), *(*i));
                        mPasses.push_back(p);
                }
        // Compile for categorised illumination on demand
        clearIlluminationPasses();
        mIlluminationPassesCompilationPhase = IPS_NOT_COMPILED;
                return *this;
    }
    //-----------------------------------------------------------------------------
    bool Technique::isTransparent(void) const
    {
        if (mPasses.empty())
        {
            return false;
        }
        else
        {
            // Base decision on the transparency of the first pass
            return mPasses[0]->isTransparent();
        }
    }
    //-----------------------------------------------------------------------------
    bool Technique::isDepthWriteEnabled(void) const
    {
        if (mPasses.empty())
        {
            return false;
        }
        else
        {
            // Base decision on the depth settings of the first pass
            return mPasses[0]->getDepthWriteEnabled();
        }
    }
    //-----------------------------------------------------------------------------
    bool Technique::isDepthCheckEnabled(void) const
    {
        if (mPasses.empty())
        {
            return false;
        }
        else
        {
            // Base decision on the depth settings of the first pass
            return mPasses[0]->getDepthCheckEnabled();
        }
    }
    //-----------------------------------------------------------------------------
    bool Technique::hasColourWriteDisabled(void) const
    {
        if (mPasses.empty())
        {
            return true;
        }
        else
        {
            // Base decision on the colour write settings of the first pass
            return !mPasses[0]->getColourWriteEnabled();
        }
    }
    //-----------------------------------------------------------------------------
    void Technique::_load(void)
    {
                assert (mIsSupported && "This technique is not supported");
                // Load each pass
                Passes::iterator i, iend;
                iend = mPasses.end();
                for (i = mPasses.begin(); i != iend; ++i)
                {
                        (*i)->_load();
                }

                IlluminationPassList::iterator il, ilend;
                ilend = mIlluminationPasses.end();
                for (il = mIlluminationPasses.begin(); il != ilend; ++il)
                {
                        if((*il)->pass != (*il)->originalPass)
                            (*il)->pass->_load();
                }
    }
    //-----------------------------------------------------------------------------
    void Technique::_unload(void)
    {
                // Unload each pass
                Passes::iterator i, iend;
                iend = mPasses.end();
                for (i = mPasses.begin(); i != iend; ++i)
                {
                        (*i)->_unload();
                }
    }
    //-----------------------------------------------------------------------------
    bool Technique::isLoaded(void) const
    {
        // Only supported technique will be loaded
        return mParent->isLoaded() && mIsSupported;
    }
    //-----------------------------------------------------------------------
    void Technique::setPointSize(Real ps)
    {
        Passes::iterator i, iend;
        iend = mPasses.end();
        for (i = mPasses.begin(); i != iend; ++i)
        {
            (*i)->setPointSize(ps);
        }

    }
    //-----------------------------------------------------------------------
    void Technique::setAmbient(Real red, Real green, Real blue)
    {
        Passes::iterator i, iend;
        iend = mPasses.end();
        for (i = mPasses.begin(); i != iend; ++i)
        {
            (*i)->setAmbient(red, green, blue);
        }

    }
    //-----------------------------------------------------------------------
    void Technique::setAmbient(const ColourValue& ambient)
    {
        setAmbient(ambient.r, ambient.g, ambient.b);
    }
    //-----------------------------------------------------------------------
    void Technique::setDiffuse(Real red, Real green, Real blue, Real alpha)
    {
        Passes::iterator i, iend;
        iend = mPasses.end();
        for (i = mPasses.begin(); i != iend; ++i)
        {
            (*i)->setDiffuse(red, green, blue, alpha);
        }
    }
    //-----------------------------------------------------------------------
    void Technique::setDiffuse(const ColourValue& diffuse)
    {
        setDiffuse(diffuse.r, diffuse.g, diffuse.b, diffuse.a);
    }
    //-----------------------------------------------------------------------
    void Technique::setSpecular(Real red, Real green, Real blue, Real alpha)
    {
        Passes::iterator i, iend;
        iend = mPasses.end();
        for (i = mPasses.begin(); i != iend; ++i)
        {
            (*i)->setSpecular(red, green, blue, alpha);
        }
    }
    //-----------------------------------------------------------------------
    void Technique::setSpecular(const ColourValue& specular)
    {
        setSpecular(specular.r, specular.g, specular.b, specular.a);
    }
    //-----------------------------------------------------------------------
    void Technique::setShininess(Real val)
    {
        Passes::iterator i, iend;
        iend = mPasses.end();
        for (i = mPasses.begin(); i != iend; ++i)
        {
            (*i)->setShininess(val);
        }
    }
    //-----------------------------------------------------------------------
    void Technique::setSelfIllumination(Real red, Real green, Real blue)
    {
        Passes::iterator i, iend;
        iend = mPasses.end();
        for (i = mPasses.begin(); i != iend; ++i)
        {
            (*i)->setSelfIllumination(red, green, blue);
        }
    }
    //-----------------------------------------------------------------------
    void Technique::setSelfIllumination(const ColourValue& selfIllum)
    {
        setSelfIllumination(selfIllum.r, selfIllum.g, selfIllum.b);
    }
    //-----------------------------------------------------------------------
    void Technique::setDepthCheckEnabled(bool enabled)
    {
        Passes::iterator i, iend;
        iend = mPasses.end();
        for (i = mPasses.begin(); i != iend; ++i)
        {
            (*i)->setDepthCheckEnabled(enabled);
        }
    }
    //-----------------------------------------------------------------------
    void Technique::setDepthWriteEnabled(bool enabled)
    {
        Passes::iterator i, iend;
        iend = mPasses.end();
        for (i = mPasses.begin(); i != iend; ++i)
        {
            (*i)->setDepthWriteEnabled(enabled);
        }
    }
    //-----------------------------------------------------------------------
    void Technique::setDepthFunction( CompareFunction func )
    {
        Passes::iterator i, iend;
        iend = mPasses.end();
        for (i = mPasses.begin(); i != iend; ++i)
        {
            (*i)->setDepthFunction(func);
        }
    }
    //-----------------------------------------------------------------------
        void Technique::setColourWriteEnabled(bool enabled)
    {
        Passes::iterator i, iend;
        iend = mPasses.end();
        for (i = mPasses.begin(); i != iend; ++i)
        {
            (*i)->setColourWriteEnabled(enabled);
        }
    }
    //-----------------------------------------------------------------------
    void Technique::setCullingMode( CullingMode mode )
    {
        Passes::iterator i, iend;
        iend = mPasses.end();
        for (i = mPasses.begin(); i != iend; ++i)
        {
            (*i)->setCullingMode(mode);
        }
    }
    //-----------------------------------------------------------------------
    void Technique::setManualCullingMode( ManualCullingMode mode )
    {
        Passes::iterator i, iend;
        iend = mPasses.end();
        for (i = mPasses.begin(); i != iend; ++i)
        {
            (*i)->setManualCullingMode(mode);
        }
    }
    //-----------------------------------------------------------------------
    void Technique::setLightingEnabled(bool enabled)
    {
        Passes::iterator i, iend;
        iend = mPasses.end();
        for (i = mPasses.begin(); i != iend; ++i)
        {
            (*i)->setLightingEnabled(enabled);
        }
    }
    //-----------------------------------------------------------------------
    void Technique::setShadingMode( ShadeOptions mode )
    {
        Passes::iterator i, iend;
        iend = mPasses.end();
        for (i = mPasses.begin(); i != iend; ++i)
        {
            (*i)->setShadingMode(mode);
        }
    }
    //-----------------------------------------------------------------------
    void Technique::setFog(bool overrideScene, FogMode mode, const ColourValue& colour,
        Real expDensity, Real linearStart, Real linearEnd)
    {
        Passes::iterator i, iend;
        iend = mPasses.end();
        for (i = mPasses.begin(); i != iend; ++i)
        {
            (*i)->setFog(overrideScene, mode, colour, expDensity, linearStart, linearEnd);
        }
    }
    //-----------------------------------------------------------------------
    void Technique::setDepthBias(float constantBias, float slopeScaleBias)
    {
        Passes::iterator i, iend;
        iend = mPasses.end();
        for (i = mPasses.begin(); i != iend; ++i)
        {
            (*i)->setDepthBias(constantBias, slopeScaleBias);
        }
    }
    //-----------------------------------------------------------------------
    void Technique::setTextureFiltering(TextureFilterOptions filterType)
    {
        Passes::iterator i, iend;
        iend = mPasses.end();
        for (i = mPasses.begin(); i != iend; ++i)
        {
            (*i)->setTextureFiltering(filterType);
        }
    }
    // --------------------------------------------------------------------
    void Technique::setTextureAnisotropy(unsigned int maxAniso)
    {
        Passes::iterator i, iend;
        iend = mPasses.end();
        for (i = mPasses.begin(); i != iend; ++i)
        {
            (*i)->setTextureAnisotropy(maxAniso);
        }
    }
    // --------------------------------------------------------------------
    void Technique::setSceneBlending( const SceneBlendType sbt )
    {
        Passes::iterator i, iend;
        iend = mPasses.end();
        for (i = mPasses.begin(); i != iend; ++i)
        {
            (*i)->setSceneBlending(sbt);
        }
    }
    // --------------------------------------------------------------------
    void Technique::setSceneBlending( const SceneBlendFactor sourceFactor,
        const SceneBlendFactor destFactor)
    {
        Passes::iterator i, iend;
        iend = mPasses.end();
        for (i = mPasses.begin(); i != iend; ++i)
        {
            (*i)->setSceneBlending(sourceFactor, destFactor);
        }
    }

    // --------------------------------------------------------------------
    void Technique::setName(const String& name)
    {
        mName = name;
    }


    //-----------------------------------------------------------------------
    void Technique::_notifyNeedsRecompile(void)
    {
        // Disable require to recompile when splitting illumination passes
        if (mIlluminationPassesCompilationPhase != IPS_COMPILE_DISABLED)
        {
            mParent->_notifyNeedsRecompile();
        }
    }
    //-----------------------------------------------------------------------
    void Technique::setLodIndex(unsigned short index)
    {
        mLodIndex = index;
        _notifyNeedsRecompile();
    }
    //-----------------------------------------------------------------------
        void Technique::setSchemeName(const String& schemeName)
        {
                mSchemeIndex = MaterialManager::getSingleton()._getSchemeIndex(schemeName);
        _notifyNeedsRecompile();
        }
    //-----------------------------------------------------------------------
        const String& Technique::getSchemeName(void) const
        {
                return MaterialManager::getSingleton()._getSchemeName(mSchemeIndex);
        }
    //-----------------------------------------------------------------------
        unsigned short Technique::_getSchemeIndex(void) const
        {
                return mSchemeIndex;
        }
    //-----------------------------------------------------------------------
    void Technique::_compileIlluminationPasses(void)
    {
        clearIlluminationPasses();

        Passes::iterator i, iend;
        iend = mPasses.end();
        i = mPasses.begin();

        IlluminationStage iStage = IS_AMBIENT;

        bool haveAmbient = false;
        while (i != iend)
        {
            IlluminationPass* iPass;
            Pass* p = *i;
            switch(iStage)
            {
            case IS_AMBIENT:
                // Keep looking for ambient only
                if (p->isAmbientOnly())
                {
                    // Add this pass wholesale
                    iPass = new IlluminationPass();
                    iPass->destroyOnShutdown = false;
                    iPass->originalPass = iPass->pass = p;
                    iPass->stage = iStage;
                    mIlluminationPasses.push_back(iPass);
                    haveAmbient = true;
                    // progress to next pass
                    ++i;
                }
                else
                {
                    // Split off any ambient part
                    if (p->getAmbient() != ColourValue::Black ||
                        p->getSelfIllumination() != ColourValue::Black ||
                        p->getAlphaRejectFunction() != CMPF_ALWAYS_PASS)
                    {
                        // Copy existing pass
                        Pass* newPass = new Pass(this, p->getIndex(), *p);
                        if (newPass->getAlphaRejectFunction() != CMPF_ALWAYS_PASS)
                        {
                            // Alpha rejection passes must retain their transparency, so
                            // we allow the texture units, but override the colour functions
                            Pass::TextureUnitStateIterator tusi = newPass->getTextureUnitStateIterator();
                            while (tusi.hasMoreElements())
                            {
                                TextureUnitState* tus = tusi.getNext();
                                tus->setColourOperationEx(LBX_SOURCE1, LBS_CURRENT);
                            }
                        }
                        else
                        {
                            // Remove any texture units
                            newPass->removeAllTextureUnitStates();
                        }
                        // Remove any fragment program
                        if (newPass->hasFragmentProgram())
                            newPass->setFragmentProgram("");
                        // We have to leave vertex program alone (if any) and
                        // just trust that the author is using light bindings, which
                        // we will ensure there are none in the ambient pass
                        newPass->setDiffuse(0, 0, 0, newPass->getDiffuse().a);  // Preserving alpha
                        newPass->setSpecular(ColourValue::Black);

                        // Calculate hash value for new pass, because we are compiling
                        // illumination passes on demand, which will loss hash calculate
                        // before it add to render queue first time.
                        newPass->_recalculateHash();

                        iPass = new IlluminationPass();
                        iPass->destroyOnShutdown = true;
                        iPass->originalPass = p;
                        iPass->pass = newPass;
                        iPass->stage = iStage;

                        mIlluminationPasses.push_back(iPass);
                        haveAmbient = true;

                    }

                    if (!haveAmbient)
                    {
                        // Make up a new basic pass
                        Pass* newPass = new Pass(this, p->getIndex());
                        newPass->setAmbient(ColourValue::Black);
                        newPass->setDiffuse(ColourValue::Black);

                        // Calculate hash value for new pass, because we are compiling
                        // illumination passes on demand, which will loss hash calculate
                        // before it add to render queue first time.
                        newPass->_recalculateHash();

                        iPass = new IlluminationPass();
                        iPass->destroyOnShutdown = true;
                        iPass->originalPass = p;
                        iPass->pass = newPass;
                        iPass->stage = iStage;
                        mIlluminationPasses.push_back(iPass);
                        haveAmbient = true;
                    }
                    // This means we're done with ambients, progress to per-light
                    iStage = IS_PER_LIGHT;
                }
                break;
            case IS_PER_LIGHT:
                if (p->getIteratePerLight())
                {
                    // If this is per-light already, use it directly
                    iPass = new IlluminationPass();
                    iPass->destroyOnShutdown = false;
                    iPass->originalPass = iPass->pass = p;
                    iPass->stage = iStage;
                    mIlluminationPasses.push_back(iPass);
                    // progress to next pass
                    ++i;
                }
                else
                {
                    // Split off per-light details (can only be done for one)
                    if (p->getLightingEnabled() &&
                        (p->getDiffuse() != ColourValue::Black ||
                        p->getSpecular() != ColourValue::Black))
                    {
                        // Copy existing pass
                        Pass* newPass = new Pass(this, p->getIndex(), *p);
                        if (newPass->getAlphaRejectFunction() != CMPF_ALWAYS_PASS)
                        {
                            // Alpha rejection passes must retain their transparency, so
                            // we allow the texture units, but override the colour functions
                            Pass::TextureUnitStateIterator tusi = newPass->getTextureUnitStateIterator();
                            while (tusi.hasMoreElements())
                            {
                                TextureUnitState* tus = tusi.getNext();
                                tus->setColourOperationEx(LBX_SOURCE1, LBS_CURRENT);
                            }
                        }
                        else
                        {
                            // remove texture units
                            newPass->removeAllTextureUnitStates();
                        }
                        // remove fragment programs
                        if (newPass->hasFragmentProgram())
                            newPass->setFragmentProgram("");
                        // Cannot remove vertex program, have to assume that
                        // it will process diffuse lights, ambient will be turned off
                        newPass->setAmbient(ColourValue::Black);
                        newPass->setSelfIllumination(ColourValue::Black);
                        // must be additive
                        newPass->setSceneBlending(SBF_ONE, SBF_ONE);

                        // Calculate hash value for new pass, because we are compiling
                        // illumination passes on demand, which will loss hash calculate
                        // before it add to render queue first time.
                        newPass->_recalculateHash();

                        iPass = new IlluminationPass();
                        iPass->destroyOnShutdown = true;
                        iPass->originalPass = p;
                        iPass->pass = newPass;
                        iPass->stage = iStage;

                        mIlluminationPasses.push_back(iPass);

                    }
                    // This means the end of per-light passes
                    iStage = IS_DECAL;
                }
                break;
            case IS_DECAL:
                // We just want a 'lighting off' pass to finish off
                // and only if there are texture units
                if (p->getNumTextureUnitStates() > 0)
                {
                    if (!p->getLightingEnabled())
                    {
                        // we assume this pass already combines as required with the scene
                        iPass = new IlluminationPass();
                        iPass->destroyOnShutdown = false;
                        iPass->originalPass = iPass->pass = p;
                        iPass->stage = iStage;
                        mIlluminationPasses.push_back(iPass);
                    }
                    else
                    {
                        // Copy the pass and tweak away the lighting parts
                        Pass* newPass = new Pass(this, p->getIndex(), *p);
                        newPass->setAmbient(ColourValue::Black);
                        newPass->setDiffuse(0, 0, 0, newPass->getDiffuse().a);  // Preserving alpha
                        newPass->setSpecular(ColourValue::Black);
                        newPass->setSelfIllumination(ColourValue::Black);
                        newPass->setLightingEnabled(false);
                                                newPass->setIteratePerLight(false, false);
                        // modulate
                        newPass->setSceneBlending(SBF_DEST_COLOUR, SBF_ZERO);

                        // Calculate hash value for new pass, because we are compiling
                        // illumination passes on demand, which will loss hash calculate
                        // before it add to render queue first time.
                        newPass->_recalculateHash();

                        // NB there is nothing we can do about vertex & fragment
                        // programs here, so people will just have to make their
                        // programs friendly-like if they want to use this technique
                        iPass = new IlluminationPass();
                        iPass->destroyOnShutdown = true;
                        iPass->originalPass = p;
                        iPass->pass = newPass;
                        iPass->stage = iStage;
                        mIlluminationPasses.push_back(iPass);

                    }
                }
                ++i; // always increment on decal, since nothing more to do with this pass

                break;
            }
        }

    }
    //-----------------------------------------------------------------------
    void Technique::clearIlluminationPasses(void)
    {
        IlluminationPassList::iterator i, iend;
        iend = mIlluminationPasses.end();
        for (i = mIlluminationPasses.begin(); i != iend; ++i)
        {
            if ((*i)->destroyOnShutdown)
            {
                (*i)->pass->queueForDeletion();
            }
            delete *i;
        }
        mIlluminationPasses.clear();
    }
    //-----------------------------------------------------------------------
    const Technique::IlluminationPassIterator
    Technique::getIlluminationPassIterator(void)
    {
        IlluminationPassesState targetState = IPS_COMPILED;
        if (mIlluminationPassesCompilationPhase != targetState)
        {
            // prevents parent->_notifyNeedsRecompile() call during compile
            mIlluminationPassesCompilationPhase = IPS_COMPILE_DISABLED;
            // Splitting the passes into illumination passes
            _compileIlluminationPasses();
            // Mark that illumination passes compilation finished
            mIlluminationPassesCompilationPhase = targetState;
        }

        return IlluminationPassIterator(mIlluminationPasses.begin(),
            mIlluminationPasses.end());
    }
    //-----------------------------------------------------------------------
        const String& Technique::getResourceGroup(void) const
        {
                return mParent->getGroup();
        }

    //-----------------------------------------------------------------------
    bool Technique::applyTextureAliases(const AliasTextureNamePairList& aliasList, const bool apply) const
    {
        // iterate through passes and apply texture alias
        Passes::const_iterator i, iend;
        iend = mPasses.end();
        bool testResult = false;

        for(i = mPasses.begin(); i != iend; ++i)
        {
            if ((*i)->applyTextureAliases(aliasList, apply))
                testResult = true;
        }

        return testResult;
    }

}