OgreShaderFFPColour.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 _ShaderFFPColur_
#define _ShaderFFPColur_

#include "OgreShaderPrerequisites.h"
#ifdef RTSHADER_SYSTEM_BUILD_CORE_SHADERS
#include "OgreShaderSubRenderState.h"
#include "OgreShaderParameter.h"

namespace Ogre {
namespace RTShader {

class _OgreRTSSExport FFPColour : public SubRenderState
{
public:

    // Parameter stage flags of the colour component.
    enum StageFlags
    {
        SF_VS_INPUT_DIFFUSE     = 1 << 1,
        SF_VS_INPUT_SPECULAR    = 1 << 2,
        SF_VS_OUTPUT_DIFFUSE    = 1 << 3,
        SF_VS_OUTPUT_SPECULAR   = 1 << 4,
        SF_PS_INPUT_DIFFUSE     = 1 << 5,
        SF_PS_INPUT_SPECULAR    = 1 << 6,
        SF_PS_OUTPUT_DIFFUSE    = 1 << 7,
        SF_PS_OUTPUT_SPECULAR   = 1 << 8
    };

// Interface.
public:

    FFPColour();


    virtual const String&   getType                 () const;

    virtual int             getExecutionOrder       () const;

    virtual void            copyFrom                (const SubRenderState& rhs);

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

    void                setResolveStageFlags        (unsigned int flags) { mResolveStageFlags = flags; }

    unsigned int        getResolveStageFlags        () const             { return mResolveStageFlags; }

    void                addResolveStageMask         (unsigned int mask)  { mResolveStageFlags |= mask; }

    void                removeResolveStageMask      (unsigned int mask)  { mResolveStageFlags &= ~mask; }

    static String Type;

// Protected methods
protected:  
    virtual bool            resolveParameters       (ProgramSet* programSet);   
    virtual bool            resolveDependencies     (ProgramSet* programSet);
    virtual bool            addFunctionInvocations  (ProgramSet* programSet);

// Attributes.
protected:
    ParameterPtr    mVSInputDiffuse;            // Vertex shader input diffuse component.
    ParameterPtr    mVSInputSpecular;           // Vertex shader input specular component.
    ParameterPtr    mVSOutputDiffuse;           // Vertex shader output diffuse component.
    ParameterPtr    mVSOutputSpecular;          // Vertex shader input specular component.
    ParameterPtr    mPSInputDiffuse;            // Pixel shader input diffuse component.
    ParameterPtr    mPSInputSpecular;           // Pixel shader input specular component.
    ParameterPtr    mPSOutputDiffuse;           // Pixel shader output diffuse component.
    ParameterPtr    mPSOutputSpecular;          // Pixel shader input specular component.
    unsigned int    mResolveStageFlags;         // Stage flags that defines resolve parameters definitions.
};


class _OgreRTSSExport FFPColourFactory : public SubRenderStateFactory
{
public:

    virtual const String&   getType             () const;

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

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

    
protected:

    virtual SubRenderState* createInstanceImpl  ();


};

}
}

#endif
#endif