shader.h

Go to the documentation of this file.

/* Copyright (c) 2008-2022 the MRtrix3 contributors.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * Covered Software is provided under this License on an "as is"
 * basis, without warranty of any kind, either expressed, implied, or
 * statutory, including, without limitation, warranties that the
 * Covered Software is free of defects, merchantable, fit for a
 * particular purpose or non-infringing.
 * See the Mozilla Public License v. 2.0 for more details.
 *
 * For more details, see http://www.mrtrix.org/.
 */
 
#ifndef __gui_opengl_shader_h__
#define __gui_opengl_shader_h__
 
#include "gui/opengl/gl.h"
#include "app.h"
 
namespace MR
{
  namespace GUI
  {
    namespace GL
    {
      namespace Shader
      {
 
        void print_log (bool is_program, const std::string& type_name, GLuint index);
 
        class Program;
 
        template <GLint TYPE> class Object
        { NOMEMALIGN
          public:
            Object () : index_ (0) { }
            Object (const std::string& source) : index_ (0) { if(!source.empty()) compile (source); }
            Object (const Object&) = delete;
            Object (Object&& other) : index_ (other.index_) { other.index_ = 0; }
            Object& operator= (const Object&) = delete;
            Object& operator= (Object&& other) {
              clear();
              index_ = other.index_;
              other.index_ = 0;
              return *this;
            }
            ~Object () { clear(); }
 
            void clear() {
              if (index_) {
                GL_DEBUG ("deleting OpenGL shader ID " + str(index_));
                gl::DeleteShader (index_);
              }
              index_ = 0;
            }
 
            operator GLuint () const { return (index_); }
 
            void compile (const std::string& source) {
              std::string code = "#version 330 core\n" + source;
              DEBUG ("compiling OpenGL " + this->type() + " shader:\n" + code);
              if (!index_) {
                index_ = gl::CreateShader (TYPE);
                GL_DEBUG ("created OpenGL " + this->type() + " shader ID " + str (index_));
              }
              const char* p = code.c_str();
              gl::ShaderSource (index_, 1, &p, NULL);
              gl::CompileShader (index_);
              GLint status;
              gl::GetShaderiv (index_, gl::COMPILE_STATUS, &status);
              if (status == gl::FALSE_) {
                debug();
                throw Exception ("error compiling OpenGL " + this->type() + " shader ID " + str (index_));
              }
            }
            static const std::string type() { return TYPE == gl::VERTEX_SHADER ? "vertex" : ( TYPE == gl::FRAGMENT_SHADER ? "fragment" : "geometry" ); }
 
            void debug () {
              assert (index_);
              print_log (false, this->type() + " shader", index_);
            }
 
          protected:
            GLuint index_;
            friend class Program;
        };
 
        using Vertex = Object<gl::VERTEX_SHADER>;
        using Geometry = Object<gl::GEOMETRY_SHADER>;
        using Fragment = Object<gl::FRAGMENT_SHADER>;
 
 
 
        class Program
        { NOMEMALIGN
          public:
            Program () : index_ (0) { }
            Program (Program&& other) : index_ (other.index_) { other.index_ = 0; }
            Program (const Program&) = delete;
            Program& operator= (const Program&) = delete;
            Program& operator= (Program&& other) {
              clear();
              index_ = other.index_;
              other.index_ = 0;
              return *this;
            }
            ~Program () { clear(); }
 
            void clear () {
              if (index_) {
                GL_DEBUG ("deleting OpenGL shader program " + str(index_));
                gl::DeleteProgram (index_);
              }
              index_ = 0;
            }
            operator GLuint () const {
              return index_;
            }
            template <GLint TYPE> void attach (const Object<TYPE>& object) {
              if (!index_) {
                index_ = gl::CreateProgram();
                GL_DEBUG ("created OpenGL shader program ID " + str(index_));
              }
              gl::AttachShader (index_, object.index_);
              GL_DEBUG ("attached OpenGL " + Object<TYPE>::type() + " shader ID " + str(object.index_) + " to program ID " + str(index_));
            }
            template <GLint TYPE> void detach (const Object<TYPE>& object) {
              assert (index_);
              assert (object.index_);
              gl::DetachShader (index_, object.index_);
              GL_DEBUG ("detached OpenGL " + Object<TYPE>::type() + " shader ID " + str(object.index_) + " from program ID " + str(index_));
            }
            void link () {
              GL_DEBUG ("linking OpenGL shader program ID " + str(index_) + "...");
              assert (index_);
              gl::LinkProgram (index_);
              GLint status;
              gl::GetProgramiv (index_, gl::LINK_STATUS, &status);
              if (status == gl::FALSE_) {
                debug();
                throw Exception (std::string ("error linking OpenGL shader program ID " + str(index_)));
              }
            }
            void start () const {
              assert (index_);
              gl::UseProgram (index_);
              GL_DEBUG ("using OpenGL shader program ID " + str(index_));
            }
            static void stop () {
              gl::UseProgram (0);
              GL_DEBUG ("using default OpenGL shader program");
            }
 
            void debug () const {
              assert (index_);
              print_log (true, "OpenGL shader program", index_);
            }
 
          protected:
            GLuint index_;
        };
 
      }
    }
  }
}
 
#endif