OgreShaderRenderState.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 _ShaderRenderState_
#define _ShaderRenderState_

#include "OgreShaderPrerequisites.h"
#include "OgreShaderSubRenderState.h"

namespace Ogre {
namespace RTShader {

class _OgreRTSSExport RenderState : public RTShaderSystemAlloc
{

    // Interface.
public:

    RenderState();

    virtual ~RenderState();

    void reset();

    void addTemplateSubRenderState(SubRenderState* subRenderState);

    void removeTemplateSubRenderState(SubRenderState* subRenderState);

    const SubRenderStateList& getTemplateSubRenderStateList() const { return mSubRenderStateList; }

    void setLightCount(const int lightCount[3]);

    void getLightCount(int lightCount[3]) const;

    void setLightCountAutoUpdate(bool autoUpdate) { mLightCountAutoUpdate = autoUpdate; }

    bool getLightCountAutoUpdate() const { return mLightCountAutoUpdate; }

    


    // Attributes.
protected:
    // The sub render states list.  
    SubRenderStateList mSubRenderStateList;
    // The light count per light type definition.
    int mLightCount[3];
    // True if light count was explicitly set.
    bool mLightCountAutoUpdate;

private:
    friend class ProgramManager;
    friend class FFPRenderStateBuilder;
};


typedef vector<RenderState*>::type              RenderStateList;
typedef RenderStateList::iterator               RenderStateIterator;
typedef RenderStateList::const_iterator         RenderStateConstIterator;


class TargetRenderState : public RenderState
{

// Interface.
public:
    
    TargetRenderState();

    virtual ~TargetRenderState();

    void link(const RenderState& other, Pass* srcPass, Pass* dstPass);

    void updateGpuProgramsParams(Renderable* rend, Pass* pass, const AutoParamDataSource* source, const LightList* pLightList);
    
// Protected methods
protected:

    void sortSubRenderStates();
    
    bool createCpuPrograms();

    ProgramSet* createProgramSet();

    /* Destroy the program set of this render state. */
    void destroyProgramSet();

    ProgramSet* getProgramSet() { return mProgramSet; }

    void addSubRenderStateInstance(SubRenderState* subRenderState);

    void removeSubRenderStateInstance(SubRenderState* subRenderState);

    
// Attributes.
protected:
    // Tells if the list of the sub render states is sorted.
    bool mSubRenderStateSortValid;
    // The program set of this RenderState.
    ProgramSet* mProgramSet;
    

private:
    friend class ProgramManager;
    friend class FFPRenderStateBuilder;
};


}
}

#endif