gzShader.h

Go to the documentation of this file.

//*****************************************************************************
// File         : gzShader.h
// Module       : 
// Description  : Class definition of the gzShader class
// Author       : Anders Modén      
// Product      : Gizmo3D 2.1.1
//      
// Copyright © 2003- Saab Training Systems AB, Sweden   
//          
// NOTE:    Gizmo3D is a high performance 3D Scene Graph and effect visualisation 
//          C++ toolkit for Linux, Mac OS X, Windows (Win32) and IRIX® for  
//          usage in Game or VisSim development.
//
//
// Revision History...                          
//                                  
// Who  Date    Description                     
//                                  
// AMO  020618  Created file    
//
//******************************************************************************
#ifndef __GZ_SHADER_H__
#define __GZ_SHADER_H__

#include "gzObject.h"
#include "gzMatrix.h"
#include "gzImage.h"

// Forwards...
class gzContext;
class gzGFXProgram;
class gzState;

enum gzGFXProgramType   { 
                            GZ_GFX_VERTEX_PROGRAM           =0 , 
                            GZ_GFX_GEOMETRY_PROGRAM         =1 ,
                            GZ_GFX_FRAGMENT_PROGRAM         =2 , 
                            GZ_GFX_SOFTWARE_PROGRAM         =3 , 
                            GZ_GFX_GLOBAL                   =4 ,    // For uniform attribs
                        };

const gzULong GZ_NUMBER_OF_GFX_PROGRAM_TYPES = 4; 

// ----------------------- Defined global parameters ----------------------

const gzString  GZ_GFX_GLOBAL_ENABLED_LIGHTS        = "gz_EnabledLights";   // bool[8]  for each lamp
const gzString  GZ_GFX_GLOBAL_ENABLED_LIGHT         = "gz_EnabledLight";    // bool     for all lamps
const gzString  GZ_GFX_GLOBAL_RENDER_TIME           = "gz_RenderTime";      // float    seconds in current day
const gzString  GZ_GFX_GLOBAL_RENDER_DAY            = "gz_RenderDay";       // float    days since 1 jan 1990 
const gzString  GZ_GFX_GLOBAL_WIN_WIDTH             = "gz_WinWidth";        // float    width of rendering window  
const gzString  GZ_GFX_GLOBAL_WIN_HEIGHT            = "gz_WinHeight";       // float    height of rendering window  

//******************************************************************************
// Class    : gzParameterUpdateInfo
//                                  
// Purpose  : Keep bind info about global updates per context
//                                  
// Notes    : - 
//                                  
// Revision History...                          
//                                  
// Who  Date    Description                     
//                                  
// AMO  030422  Created 
//                                  
//******************************************************************************
class gzParameterUpdateInfo
{
public:

    gzParameterUpdateInfo():updateID(0),contextEnumerator(0xFFFFUL),attribIndexID(0){};

    gzULong                         updateID;
    gzULong                         contextEnumerator;
    gzULong                         attribIndexID;
};


//******************************************************************************
// Class    : gzGFXProgramManager
//                                  
// Purpose  : -
//                                  
// Notes    : - 
//                                  
// Revision History...                          
//                                  
// Who  Date    Description                     
//                                  
// AMO  030204  Created 
//                                  
//******************************************************************************
class gzGFXProgramManager : public gzReference
{
public:

    GZ_DECLARE_TYPE_INTERFACE_EXPORT(GZ_GRAPH_EXPORT);  // typed interface

    GZ_GRAPH_EXPORT virtual             ~gzGFXProgramManager(){};

    GZ_GRAPH_EXPORT gzULong             getVersion()    { return m_version;     }

    GZ_GRAPH_EXPORT virtual gzBool      isManagerFor(gzGFXProgram *program)=0;

    GZ_GRAPH_EXPORT virtual gzBool      activate(gzContext *context,gzGFXProgram *program,gzGFXProgramType type)=0;

    GZ_GRAPH_EXPORT virtual gzBool      deactivate(gzContext *context,gzGFXProgram *program,gzGFXProgramType type)=0; 

    GZ_GRAPH_EXPORT virtual gzVoid      cleanUpContext(gzContext *context){};

    GZ_GRAPH_EXPORT virtual gzVoid      resetProgram(gzGFXProgram *program){};

    GZ_GRAPH_EXPORT virtual gzVoid      deleteProgram(gzGFXProgram *program){};

    // ------ statics -------------

    GZ_GRAPH_EXPORT static gzVoid       registerManager(gzGFXProgramManager *manager);

    GZ_GRAPH_EXPORT static gzVoid       unregisterManagers();

    GZ_GRAPH_EXPORT static gzGFXProgramManager * getManagerForProgram(gzGFXProgram *program);

    GZ_GRAPH_EXPORT static gzVoid       cleanUpGFXData(gzContext *context);

protected:

    GZ_GRAPH_EXPORT virtual gzVoid      registerManager()=0;

    static gzRefList<gzGFXProgramManager> s_registeredGFXProgramManagers;

    gzULong             m_version;

};

enum gzGFXProgramParameterType
{
    GZ_GFX_PARAM_INTEGER,
    GZ_GFX_PARAM_FLOAT,
    GZ_GFX_PARAM_VEC2,
    GZ_GFX_PARAM_IVEC2,
    GZ_GFX_PARAM_VEC3,
    GZ_GFX_PARAM_IVEC3,
    GZ_GFX_PARAM_VEC4,
    GZ_GFX_PARAM_IVEC4,
    GZ_GFX_PARAM_MAT2,
    GZ_GFX_PARAM_MAT3,
    GZ_GFX_PARAM_MAT4
};

union gzFloatInt
{
    gzFloat fVal;
    gzInt   iVal;
};

class gzGFXProgramParameter : public gzReference
{
public:

    virtual ~gzGFXProgramParameter(){}

    gzString                    name;
    gzUInt                      position;
    gzBool                      usePosition;
    gzGFXProgramParameterType   type;

    gzArray<gzFloatInt>         values;
};

class gzGlobalGFXProgramParams
{
public:

    gzRefList<gzGFXProgramParameter>        params;
    gzDynamicArray<gzParameterUpdateInfo>   updateInfo;
};

class gzVertexAttributeIndex : public gzReference
{
public:

    virtual ~gzVertexAttributeIndex(){};

    gzString        name;
    gzUInt          index;
};

//----------------- Special Create Attributes --------------

const gzString GZ_GFX_PROGRAM_SETTINGS                  =   "GZ_GFX_PROGRAM_SETTINGS";

//---------------- Special for geometry programs ----------

const gzString GZ_GFX_GEOMETRY_PROGRAM_INPUT_TYPE       =   "GZ_GFX_GEOMETRY_PROGRAM_INPUT_TYPE";
const gzString GZ_GFX_GEOMETRY_PROGRAM_OUTPUT_TYPE      =   "GZ_GFX_GEOMETRY_PROGRAM_OUTPUT_TYPE";
const gzString GZ_GFX_GEOMETRY_PROGRAM_VERTICES_OUT     =   "GZ_GFX_GEOMETRY_PROGRAM_VERTICES_OUT";


//******************************************************************************
// Class    : gzGFXProgram
//                                  
// Purpose  : -
//                                  
// Notes    : - 
//                                  
// Revision History...                          
//                                  
// Who  Date    Description                     
//                                  
// AMO  020618  Created 
//                                  
//******************************************************************************
class gzGFXProgram : public gzObject 
{
public:
    GZ_DECLARE_TYPE_INTERFACE_EXPORT(GZ_GRAPH_EXPORT);  // typed interface

    GZ_GRAPH_EXPORT gzGFXProgram();

    GZ_GRAPH_EXPORT virtual ~gzGFXProgram();

    GZ_GRAPH_EXPORT virtual gzBool  activate(gzContext *context,gzGFXProgramType type);

    GZ_GRAPH_EXPORT virtual gzBool  deactivate(gzContext *context,gzGFXProgramType type); 

    // ---------- Clone interface ---------------------------------------
    GZ_GRAPH_EXPORT virtual gzReference* clone() const;
    GZ_GRAPH_EXPORT virtual gzBool  useDeepCopy();

    // ---------- gzGFXProgram interface --------------------------------------

    GZ_GRAPH_EXPORT gzVoid              setProgramScript(const gzString &script);

    GZ_GRAPH_EXPORT gzBool              loadProgramScript(const gzString &url);

    GZ_GRAPH_EXPORT const gzString  &   getProgramScript();

    GZ_GRAPH_EXPORT gzGFXProgramManager *getCurrentManager() { return m_manager.get(); }

    GZ_GRAPH_EXPORT gzBool              hasError();
    
    GZ_GRAPH_EXPORT const gzString &    getError();
    
    GZ_GRAPH_EXPORT gzInt               getErrorPos();  
    
    GZ_GRAPH_EXPORT gzVoid              setError(const gzString & error,gzInt pos);


    GZ_GRAPH_EXPORT gzVoid              setManagerData(gzReference *data);
    GZ_GRAPH_EXPORT gzReference *       getManagerData();

    GZ_GRAPH_EXPORT gzVoid              setFallbackProgram(gzGFXProgram *program);
    GZ_GRAPH_EXPORT gzGFXProgram *      getFallbackProgram();

    // ---------- Vertex Attributes --------------------------------------------

    GZ_GRAPH_EXPORT gzVoid  bindVertexAttribute(const gzString &name, gzUInt index); 
    GZ_GRAPH_EXPORT gzUInt  getVertexAttributeIndex(const gzString &name);
    GZ_GRAPH_EXPORT const gzRefList<gzVertexAttributeIndex> & getVertexAttributeIndexList();


    // ---------- Index Local Attributes ---------------------------------------

    GZ_GRAPH_EXPORT gzVoid  setLocalParameter(gzUInt index,const gzFloat &val,gzBool integer=FALSE);
    GZ_GRAPH_EXPORT gzVoid  setLocalParameter(gzUInt index,const gzVec2 &val);
    GZ_GRAPH_EXPORT gzVoid  setLocalParameter(gzUInt index,const gzVec3 &val);
    GZ_GRAPH_EXPORT gzVoid  setLocalParameter(gzUInt index,const gzVec4 &val);
    GZ_GRAPH_EXPORT gzVoid  setLocalParameter(gzUInt index,const gzMatrix2 &val);
    GZ_GRAPH_EXPORT gzVoid  setLocalParameter(gzUInt index,const gzMatrix3 &val);
    GZ_GRAPH_EXPORT gzVoid  setLocalParameter(gzUInt index,const gzMatrix4 &val);

    GZ_GRAPH_EXPORT const gzGFXProgramParameter * getLocalParameter(gzUInt index,gzGFXProgramParameterType type, gzBool update=FALSE);

    GZ_GRAPH_EXPORT const gzRefList<gzGFXProgramParameter> & getLocalParameterList();

    // ---------- Named Local Attributes ---------------------------------------

    GZ_GRAPH_EXPORT gzVoid  setLocalParameter(const gzString &name,const gzFloat &val,gzBool integer=FALSE);
    GZ_GRAPH_EXPORT gzVoid  setLocalParameter(const gzString &name,const gzVec2 &val);
    GZ_GRAPH_EXPORT gzVoid  setLocalParameter(const gzString &name,const gzVec3 &val);
    GZ_GRAPH_EXPORT gzVoid  setLocalParameter(const gzString &name,const gzVec4 &val);
    GZ_GRAPH_EXPORT gzVoid  setLocalParameter(const gzString &name,const gzMatrix2 &val);
    GZ_GRAPH_EXPORT gzVoid  setLocalParameter(const gzString &name,const gzMatrix3 &val);
    GZ_GRAPH_EXPORT gzVoid  setLocalParameter(const gzString &name,const gzMatrix4 &val);

    GZ_GRAPH_EXPORT const gzGFXProgramParameter * getLocalParameter(const gzString &name,gzGFXProgramParameterType type,gzBool update=FALSE);

    GZ_GRAPH_EXPORT gzParameterUpdateInfo & getLocalUpdateInfo(gzULong contextID);

    GZ_GRAPH_EXPORT gzVoid  useGlobalProgramScripts(gzBool on);
    GZ_GRAPH_EXPORT gzBool  useGlobalProgramScripts();

    // ----------- Globals ----------------------------------------------------

    static GZ_GRAPH_EXPORT gzParameterUpdateInfo & getGlobalUpdateInfo(gzULong contextID,gzGFXProgramType type=GZ_GFX_GLOBAL);

    // ---------- Index Global Attributes ---------------------------------------

    static GZ_GRAPH_EXPORT gzVoid   setGlobalParameter(gzUInt index,const gzFloat &val,gzBool integer=FALSE,gzGFXProgramType type=GZ_GFX_GLOBAL);
    static GZ_GRAPH_EXPORT gzVoid   setGlobalParameter(gzUInt index,const gzVec2 &val,gzGFXProgramType type=GZ_GFX_GLOBAL);
    static GZ_GRAPH_EXPORT gzVoid   setGlobalParameter(gzUInt index,const gzVec3 &val,gzGFXProgramType type=GZ_GFX_GLOBAL);
    static GZ_GRAPH_EXPORT gzVoid   setGlobalParameter(gzUInt index,const gzVec4 &val,gzGFXProgramType type=GZ_GFX_GLOBAL);
    static GZ_GRAPH_EXPORT gzVoid   setGlobalParameter(gzUInt index,const gzMatrix2 &val,gzGFXProgramType type=GZ_GFX_GLOBAL);
    static GZ_GRAPH_EXPORT gzVoid   setGlobalParameter(gzUInt index,const gzMatrix3 &val,gzGFXProgramType type=GZ_GFX_GLOBAL);
    static GZ_GRAPH_EXPORT gzVoid   setGlobalParameter(gzUInt index,const gzMatrix4 &val,gzGFXProgramType type=GZ_GFX_GLOBAL);

    static GZ_GRAPH_EXPORT const gzGFXProgramParameter * getGlobalParameter(gzUInt index,gzGFXProgramParameterType type,gzGFXProgramType programType=GZ_GFX_GLOBAL,gzBool update=FALSE);

    static GZ_GRAPH_EXPORT const gzRefList<gzGFXProgramParameter> & getGlobalParameterList(gzGFXProgramType type=GZ_GFX_GLOBAL);

    // ---------- Named Global Attributes ---------------------------------------

    static GZ_GRAPH_EXPORT gzVoid   setGlobalParameter(const gzString &name,const gzFloat &val,gzBool integer=FALSE,gzGFXProgramType type=GZ_GFX_GLOBAL);
    static GZ_GRAPH_EXPORT gzVoid   setGlobalParameter(const gzString &name,const gzVec2 &val,gzGFXProgramType type=GZ_GFX_GLOBAL);
    static GZ_GRAPH_EXPORT gzVoid   setGlobalParameter(const gzString &name,const gzVec3 &val,gzGFXProgramType type=GZ_GFX_GLOBAL);
    static GZ_GRAPH_EXPORT gzVoid   setGlobalParameter(const gzString &name,const gzVec4 &val,gzGFXProgramType type=GZ_GFX_GLOBAL);
    static GZ_GRAPH_EXPORT gzVoid   setGlobalParameter(const gzString &name,const gzMatrix2 &val,gzGFXProgramType type=GZ_GFX_GLOBAL);
    static GZ_GRAPH_EXPORT gzVoid   setGlobalParameter(const gzString &name,const gzMatrix3 &val,gzGFXProgramType type=GZ_GFX_GLOBAL);
    static GZ_GRAPH_EXPORT gzVoid   setGlobalParameter(const gzString &name,const gzMatrix4 &val,gzGFXProgramType type=GZ_GFX_GLOBAL);
    static GZ_GRAPH_EXPORT gzVoid   setGlobalParameter(const gzString &name,const gzBool (&val)[8],gzGFXProgramType type=GZ_GFX_GLOBAL);

    static GZ_GRAPH_EXPORT const gzGFXProgramParameter * getGlobalParameter(const gzString &name,gzGFXProgramParameterType type,gzGFXProgramType programType=GZ_GFX_GLOBAL,gzBool update=FALSE);

    // ---------- Global program scripts ----------------------------------------

    static GZ_GRAPH_EXPORT gzVoid                       setGlobalProgramScript(gzGFXProgramType type , gzULong index,const gzString &script);
    static GZ_GRAPH_EXPORT gzDynamicArray<gzString> &   getGlobalProgramScripts(gzGFXProgramType type,gzBool update=FALSE);
    static GZ_GRAPH_EXPORT gzULong                      getGlobalProgramScriptUpdateID(gzGFXProgramType type);

    // ---------- Generic program scripts ---------------------------------------

    static GZ_GRAPH_EXPORT gzGFXProgram *getProgram(const gzString &name,gzGFXProgramType type);
    static GZ_GRAPH_EXPORT gzVoid registerProgram(const gzString &name,gzGFXProgramType type,gzGFXProgram *program);
    static GZ_GRAPH_EXPORT gzVoid unregisterProgram(const gzString &name,gzGFXProgramType type,gzGFXProgram *program);

private:

    gzString                                    m_script;
                                                
    gzRefPointer<gzGFXProgramManager>           m_manager;
                                            
    gzBool                                      m_hasError:1;

    gzBool                                      m_useGlobalProgramScripts:1;
                                                
    gzInt                                       m_errorPos;

    gzString                                    m_error;
                                                
    gzRefList<gzGFXProgramParameter>            m_params;

    gzRefList<gzVertexAttributeIndex>           m_vertexAttributeIndex;

    gzDynamicArray<gzParameterUpdateInfo>       m_updateInfo;

    gzRefPointer<gzReference>                   m_managerData;

    gzRefPointer<gzGFXProgram>                  m_fallbackProgram;

    static gzGlobalGFXProgramParams             s_globalEnvParams[GZ_NUMBER_OF_GFX_PROGRAM_TYPES+1];

    static gzDynamicArray<gzString>             s_globalProgramScripts[GZ_NUMBER_OF_GFX_PROGRAM_TYPES];

    static gzULong                              s_globalProgramScriptsUpdateID[GZ_NUMBER_OF_GFX_PROGRAM_TYPES];

    static gzRefDict<gzString,gzGFXProgram>     s_registeredPrograms[GZ_NUMBER_OF_GFX_PROGRAM_TYPES];
};


//******************************************************************************
// Class    : gzGFXProgramManager_VFP_1
//                                  
// Purpose  : Vertex and Fragment program manager low level (ARB VP & FP)
//                                  
// Notes    : - 
//                                  
// Revision History...                          
//                                  
// Who  Date    Description                     
//                                  
// AMO  030204  Created 
//                                  
//******************************************************************************
class gzGFXProgramManager_VFP_1 : public gzGFXProgramManager
{
public:

    GZ_DECLARE_TYPE_INTERFACE_EXPORT(GZ_GRAPH_EXPORT);  // typed interface

    GZ_GRAPH_EXPORT                 gzGFXProgramManager_VFP_1();

    GZ_GRAPH_EXPORT virtual         ~gzGFXProgramManager_VFP_1();

    GZ_GRAPH_EXPORT virtual gzBool  isManagerFor(gzGFXProgram *program);

    GZ_GRAPH_EXPORT virtual gzBool  activate(gzContext *context,gzGFXProgram *program,gzGFXProgramType type);

    GZ_GRAPH_EXPORT virtual gzBool  deactivate(gzContext *context,gzGFXProgram *program,gzGFXProgramType type); 

    GZ_GRAPH_EXPORT virtual gzVoid  cleanUpContext(gzContext *context);

    GZ_GRAPH_EXPORT virtual gzVoid  resetProgram(gzGFXProgram *program);

    GZ_GRAPH_EXPORT virtual gzVoid  deleteProgram(gzGFXProgram *program);

protected:

    GZ_GRAPH_EXPORT virtual gzVoid  registerManager();

private:

    static gzQueue<gzUInt>                          s_deleteBindID;

    static gzDynamicArray<gzParameterUpdateInfo>    s_updateInfo[GZ_NUMBER_OF_GFX_PROGRAM_TYPES];
};  

//******************************************************************************
// Class    : gzGFXProgramManager_GLSL_VS_1
//                                  
// Purpose  : Shader manager for GLSL
//                                  
// Notes    : - 
//                                  
// Revision History...                          
//                                  
// Who  Date    Description                     
//                                  
// AMO  040421  Created 
//                                  
//******************************************************************************
class gzGFXProgramManager_GLSL_1 : public gzGFXProgramManager
{
public:

    GZ_DECLARE_TYPE_INTERFACE_EXPORT(GZ_GRAPH_EXPORT);  // typed interface

    GZ_GRAPH_EXPORT                 gzGFXProgramManager_GLSL_1();

    GZ_GRAPH_EXPORT virtual         ~gzGFXProgramManager_GLSL_1(){};

    GZ_GRAPH_EXPORT virtual gzBool  isManagerFor(gzGFXProgram *program);

    GZ_GRAPH_EXPORT virtual gzBool  activate(gzContext *context,gzGFXProgram *program,gzGFXProgramType type);

    GZ_GRAPH_EXPORT virtual gzBool  deactivate(gzContext *context,gzGFXProgram *program,gzGFXProgramType type); 

    GZ_GRAPH_EXPORT virtual gzVoid  cleanUpContext(gzContext *context);

    GZ_GRAPH_EXPORT virtual gzVoid  resetProgram(gzGFXProgram *program);

    GZ_GRAPH_EXPORT virtual gzVoid  deleteProgram(gzGFXProgram *program);

protected:

    GZ_GRAPH_EXPORT virtual gzVoid  registerManager();

    GZ_GRAPH_EXPORT gzVoid setUniform(gzInt index,gzGFXProgramParameter *parameter);

private:

    static gzQueue<gzHandle>                        s_deleteHandles;
};  

GZ_GRAPH_EXPORT gzVoid gzInitializeGFXProgramManagers();
GZ_GRAPH_EXPORT gzVoid gzUninitializeGFXProgramManagers();

// ----------------------- BuiltIn Programs -------------------

const gzString GZ_ALPHA_NORMAL_VP   =   "GZ_ALPHA_NORMAL_VP";   

const gzString GZ_PHONG_VP          =   "GZ_PHONG_VP";          
const gzString GZ_PHONG_FP          =   "GZ_PHONG_FP";          

// ----------------------- BuiltIn Generic States ------------

GZ_GRAPH_EXPORT gzState * gzGetBuiltInState_Phong();

#endif

---