SLGLShader.h

Go to the documentation of this file.

/**
 * \file      SLGLShader.h
 * \authors   Marcus Hudritsch, Martin Christens, http://www.clockworkcoders.com
 * \date      July 2014
 * \copyright http://opensource.org/licenses/GPL-3.0
 * \remarks   Please use clangformat to format the code. See more code style on
 *            https://github.com/cpvrlab/SLProject4/wiki/SLProject-Coding-Style
*/
 
#ifndef SLGLSHADER_H
#define SLGLSHADER_H
 
#include <SLEnums.h>
#include <SLObject.h>
 
//-----------------------------------------------------------------------------
//! Encapsulation of an OpenGL shader object
/*!
 The SLGLShader class represents a shader object of the OpenGL Shading Language
 (GLSL). It can load & compile an GLSL shader file and is later on attached
 to an OpenGL program (SLGLProgram). Instances of SLShader are owned and
 deleted by their program (SLGLProgram).
*/
class SLGLShader : public SLObject
{
    friend class SLGLProgram;
 
public:
    SLGLShader();
    SLGLShader(const SLstring& filename,
               SLShaderType    type);
    ~SLGLShader() override;
 
    void            load(const SLstring& filename);
    void            loadFromMemory(const SLstring& program);
    SLstring        typeName();
    static SLstring removeComments(SLstring src);
 
    // Getters
    SLShaderType type() { return _type; }
    SLuint       shaderID() const { return _shaderID; }
    SLstring     code() { return _code; }
 
    // Setters
    void code(SLstring strCode) { _code = strCode; }
    void file(SLstring strFile) { _file = strFile; }
 
private:
    SLbool   createAndCompile(SLVLight* lights);
    SLstring preprocessIncludePragmas(SLstring inCode);
    SLstring preprocessDefinePragmas(SLstring inCode, SLVLight* lights);
 
protected:
    SLShaderType _type;     //!< Shader type enumeration
    SLuint       _shaderID; //!< Program Object
    SLstring     _code;     //!< ASCII Source-Code
    SLstring     _file;     //!< Path & filename of shader
};
//-----------------------------------------------------------------------------
#endif // SLGLSHADER_H