CShader.h

Go to the documentation of this file.

//==============================================================================
/*
    Software License Agreement (BSD License)
    Copyright (c) 2003-2016, CHAI3D.
    (www.chai3d.org)

    All rights reserved.

    Redistribution and use in source and binary forms, with or without
    modification, are permitted provided that the following conditions
    are met:

    * Redistributions of source code must retain the above copyright
    notice, this list of conditions and the following disclaimer.

    * Redistributions in binary form must reproduce the above
    copyright notice, this list of conditions and the following
    disclaimer in the documentation and/or other materials provided
    with the distribution.

    * Neither the name of CHAI3D nor the names of its contributors may
    be used to endorse or promote products derived from this software
    without specific prior written permission.

    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
    "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
    FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
    COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
    INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
    BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
    LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
    CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
    LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
    ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
    POSSIBILITY OF SUCH DAMAGE. 

    \author    <http://www.chai3d.org>
    \author    Francois Conti, Sonny Chan
    \version   3.2.0 $Rev: 2187 $
*/
//==============================================================================

//------------------------------------------------------------------------------
#ifndef CShaderH
#define CShaderH
//------------------------------------------------------------------------------
#include "system/CGlobals.h"
#include "system/CString.h"
#include "math/CConstants.h"
//------------------------------------------------------------------------------
#ifdef C_USE_OPENGL
#include "graphics/COpenGLHeaders.h"
#endif
//------------------------------------------------------------------------------

//------------------------------------------------------------------------------
namespace chai3d {
//------------------------------------------------------------------------------

//==============================================================================
//==============================================================================

//------------------------------------------------------------------------------
// vertex array bindings
#define C_VB_INDEX_BUFFER       0
#define C_VB_POSITION           1
#define C_VB_NORMAL             2
#define C_VB_TEXCOORD           3
#define C_VB_COLOR              4
#define C_VB_TANGENT            5
#define C_VB_BITANGENT          6

// texture unit bindings
#define C_TU_TEXTURE            0
#define C_TU_SHADOWMAP          1
#define C_TU_NORMALMAP          2
#define C_TU_SPECULARMAP        3

#define C_TU_IMAGEBUFFER        2
#define C_TU_DEPTHBUFFER        3

#define C_TU_IBL_ENVIRONMENT    4
#define C_TU_IBL_FILTERED       5
#define C_TU_IBL_BRDF           6
     

       
#define C_TU_UNALLOCATED        7

//------------------------------------------------------------------------------

//------------------------------------------------------------------------------
enum cShaderType
{
    C_VERTEX_SHADER          = 0x0001,
    C_FRAGMENT_SHADER        = 0x0002,
    C_GEOMETRY_SHADER        = 0X0003
};
//------------------------------------------------------------------------------

//------------------------------------------------------------------------------
class cShader;
typedef std::shared_ptr<cShader> cShaderPtr;
//------------------------------------------------------------------------------

//==============================================================================
//==============================================================================
class cShader
{
    //--------------------------------------------------------------------------
    // CONSTRUCTOR & DESTRUCTOR:
    //--------------------------------------------------------------------------

public:

    cShader(cShaderType a_type);

    virtual ~cShader(){};

    static cShaderPtr create(cShaderType a_type) { return (std::make_shared<cShader>(a_type)); }


    //--------------------------------------------------------------------------
    // PUBLIC METHODS:
    //--------------------------------------------------------------------------

public:

    bool loadSourceCode(const char *a_source);

    bool loadSourceCode(const std::string& a_source);

    bool loadSourceFile(const std::string& a_fileName);

    bool compile(); 

    bool isCompiled() const { return (m_compiled); }
    
    std::string getLog() const { return (m_log); }

    GLuint getId() const { return (m_id); }

    std::string getSource() { return (m_source); }

    cShaderType getType() const { return (m_type); }


    //--------------------------------------------------------------------------
    // STATIC METHODS:
    //--------------------------------------------------------------------------

public:

    static bool hasOpenGLShaders(cShaderType a_type);


    //--------------------------------------------------------------------------
    // PROTECTED MEMBERS:
    //--------------------------------------------------------------------------

protected:

    cShaderType m_type;

    GLuint m_id;

    std::string m_source; 

    std::string m_log;

    bool m_compiled;
};

//------------------------------------------------------------------------------
} // namespace chai3d
//------------------------------------------------------------------------------

//------------------------------------------------------------------------------
#endif
//------------------------------------------------------------------------------