OgreShaderExIntegratedPSSM3.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 _ShaderExIntegratedPSSM3_
#define _ShaderExIntegratedPSSM3_

#include "OgreShaderPrerequisites.h"
#ifdef RTSHADER_SYSTEM_BUILD_EXT_SHADERS
#include "OgreVector4.h"
#include "OgreLight.h"
#include "OgreCommon.h"
#include "OgreShaderSubRenderState.h"
#include "OgreShaderParameter.h"

namespace Ogre {
namespace RTShader {

#define SGX_LIB_INTEGRATEDPSSM                      "SGXLib_IntegratedPSSM"
#define SGX_FUNC_COMPUTE_SHADOW_COLOUR3             "SGX_ComputeShadowFactor_PSSM3"
#define SGX_FUNC_APPLYSHADOWFACTOR_DIFFUSE          "SGX_ApplyShadowFactor_Diffuse"
#define SGX_FUNC_MODULATE_SCALAR                    "SGX_ModulateScalar"

class _OgreRTSSExport IntegratedPSSM3 : public SubRenderState
{

    // Interface.
public:
    typedef std::vector<Real> SplitPointList;

    IntegratedPSSM3();

    virtual const String&   getType                 () const;

    virtual int             getExecutionOrder       () const;

    virtual void            updateGpuProgramsParams (Renderable* rend, Pass* pass, const AutoParamDataSource* source, const LightList* pLightList);

    virtual void            copyFrom                (const SubRenderState& rhs);


    virtual bool            preAddToRenderState     (const RenderState* renderState, Pass* srcPass, Pass* dstPass);


    
    void            setSplitPoints                  (const SplitPointList& newSplitPoints);

    static String Type;

    // Protected types:
protected:

    // Shadow texture parameters.
    struct _OgreRTSSExport ShadowTextureParams
    {                   
        Real                mMaxRange;              // The max range of this shadow texture in terms of PSSM (far plane of viewing camera).
        unsigned int        mTextureSamplerIndex;   // The shadow map sampler index.
        UniformParameterPtr mTextureSampler;        // The shadow map sampler.          
        UniformParameterPtr mInvTextureSize;        // The inverse texture 
        UniformParameterPtr mWorldViewProjMatrix;   // The source light view projection matrix combined with world matrix.      
        ParameterPtr        mVSOutLightPosition;    // The vertex shader output position in light space.
        ParameterPtr        mPSInLightPosition;     // The pixel shader input position in light space.

    };

    typedef std::vector<ShadowTextureParams>            ShadowTextureParamsList;
    typedef ShadowTextureParamsList::iterator           ShadowTextureParamsIterator;
    typedef ShadowTextureParamsList::const_iterator     ShadowTextureParamsConstIterator;

    // Protected methods
protected:



    virtual bool            resolveParameters       (ProgramSet* programSet);

    virtual bool            resolveDependencies     (ProgramSet* programSet);

    virtual bool            addFunctionInvocations  (ProgramSet* programSet);

    bool            addVSInvocation                     (Function* vsMain, const int groupOrder, int& internalCounter);

    bool            addPSInvocation                     (Program* psProgram, const int groupOrder, int& internalCounter);





    // Attributes.
protected:      
    ShadowTextureParamsList     mShadowTextureParamsList;       // Shadow texture parameter list.   
    UniformParameterPtr         mPSSplitPoints;                 // Split points parameter.
    ParameterPtr                mVSInPos;                       // Vertex shader input position parameter.  
    ParameterPtr                mVSOutPos;                      // Vertex shader output position (clip space) parameter.
    ParameterPtr                mVSOutDepth;                    // Vertex shader output depth (clip space) parameter.
    ParameterPtr                mPSInDepth;                     // Pixel shader input depth (clip space) parameter.
    ParameterPtr                mPSLocalShadowFactor;           // Pixel shader local computed shadow colour parameter.
    ParameterPtr                mPSDiffuse;                     // Pixel shader in/local diffuse colour parameter.
    ParameterPtr                mPSOutDiffuse;                  // Pixel shader output diffuse colour parameter.
    ParameterPtr                mPSSpecualr;                    // Pixel shader in/local specular colour parameter.
    UniformParameterPtr         mPSDerivedSceneColour;          // Derived scene colour (ambient term).

};


class _OgreRTSSExport IntegratedPSSM3Factory : public SubRenderStateFactory
{
public:

    virtual const String&   getType             () const;

    virtual SubRenderState* createInstance      (ScriptCompiler* compiler, PropertyAbstractNode* prop, Pass* pass, SGScriptTranslator* translator);


protected:

    virtual SubRenderState* createInstanceImpl  ();


};

}
}

#endif
#endif