OgreShaderExPerPixelLighting.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-2011 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 _ShaderExPerPixelLighting_
#define _ShaderExPerPixelLighting_

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

namespace Ogre {
namespace RTShader {

class _OgreRTSSExport PerPixelLighting : public SubRenderState
{

// Interface.
public:
    PerPixelLighting();

    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     (RenderState* renderState, Pass* srcPass, Pass* dstPass);


    
    static String Type;

// Protected types:
protected:
    
    // Per light parameters.
    struct _OgreRTSSExport LightParams
    {
        Light::LightTypes       mType;              // Light type.      
        UniformParameterPtr     mPosition;          // Light position.
        UniformParameterPtr     mDirection;         // Light direction.
        UniformParameterPtr     mAttenuatParams;    // Attenuation parameters.
        UniformParameterPtr     mSpotParams;        // Spot light parameters.
        UniformParameterPtr     mDiffuseColour;     // Diffuse colour.
        UniformParameterPtr     mSpecularColour;    // Specular colour.

    };

    typedef vector<LightParams>::type               LightParamsList;
    typedef LightParamsList::iterator               LightParamsIterator;
    typedef LightParamsList::const_iterator         LightParamsConstIterator;

// Protected methods
protected:

    void                    setTrackVertexColourType(TrackVertexColourType type) { mTrackVertexColourType = type; }

    TrackVertexColourType   getTrackVertexColourType() const { return mTrackVertexColourType; }


    void                    setLightCount           (const int lightCount[3]);

    void                    getLightCount           (int lightCount[3]) const;
    void                    setSpecularEnable       (bool enable) { mSpecularEnable = enable; }

    bool                    getSpecularEnable       () const      { return mSpecularEnable; }


    virtual bool            resolveParameters           (ProgramSet* programSet);

    bool                    resolveGlobalParameters     (ProgramSet* programSet);

    bool                    resolvePerLightParameters   (ProgramSet* programSet);

    virtual bool            resolveDependencies     (ProgramSet* programSet);

    virtual bool            addFunctionInvocations  (ProgramSet* programSet);
    

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

    
    bool            addPSGlobalIlluminationInvocation   (Function* psMain, const int groupOrder, int& internalCounter);

    bool            addPSIlluminationInvocation     (LightParams* curLightParams, Function* psMain, const int groupOrder, int& internalCounter);

    bool            addPSFinalAssignmentInvocation  (Function* psMain, const int groupOrder, int& internalCounter);


// Attributes.
protected:  
    TrackVertexColourType   mTrackVertexColourType;         // Track per vertex colour type.
    bool                    mSpecularEnable;                // Specular component enabled/disabled.
    LightParamsList         mLightParamsList;               // Light list.
    UniformParameterPtr     mWorldViewMatrix;               // World view matrix parameter.
    UniformParameterPtr     mWorldViewITMatrix;             // World view matrix inverse transpose parameter.
    ParameterPtr            mVSInPosition;                  // Vertex shader input position parameter.
    ParameterPtr            mVSOutViewPos;                  // Vertex shader output view position (position in camera space) parameter.
    ParameterPtr            mPSInViewPos;                   // Pixel shader input view position (position in camera space) parameter.
    ParameterPtr            mVSInNormal;                    // Vertex shader input normal.
    ParameterPtr            mVSOutNormal;                   // Vertex shader output normal.
    ParameterPtr            mPSInNormal;                    // Pixel shader input normal.
    ParameterPtr            mPSTempDiffuseColour;           // Pixel shader temporary diffuse calculation parameter.
    ParameterPtr            mPSTempSpecularColour;          // Pixel shader temporary specular calculation parameter.
    ParameterPtr            mPSDiffuse;                     // Pixel shader input/local diffuse parameter.  
    ParameterPtr            mPSSpecular;                    // Pixel shader input/local specular parameter. 
    ParameterPtr            mPSOutDiffuse;                  // Pixel shader output diffuse parameter.   
    ParameterPtr            mPSOutSpecular;                 // Pixel shader output specular parameter.  
    UniformParameterPtr     mDerivedSceneColour;            // Derived scene colour parameter.
    UniformParameterPtr     mLightAmbientColour;            // Ambient light colour parameter.
    UniformParameterPtr     mDerivedAmbientLightColour;     // Derived ambient light colour parameter.
    UniformParameterPtr     mSurfaceAmbientColour;          // Surface ambient colour parameter.
    UniformParameterPtr     mSurfaceDiffuseColour;          // Surface diffuse colour parameter.
    UniformParameterPtr     mSurfaceSpecularColour;         // Surface specular colour parameter.
    UniformParameterPtr     mSurfaceEmissiveColour;         // Surface emissive colour parameter.
    UniformParameterPtr     mSurfaceShininess;              // Surface shininess parameter.
    static Light            msBlankLight;                   // Shared blank light.
};


class _OgreRTSSExport PerPixelLightingFactory : public SubRenderStateFactory
{
public:

    virtual const String&   getType             () const;

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

    virtual void            writeInstance       (MaterialSerializer* ser, SubRenderState* subRenderState, Pass* srcPass, Pass* dstPass);

    
protected:

    virtual SubRenderState* createInstanceImpl  ();


};

}
}

#endif
#endif