al_Shader.hpp

#ifndef INCLUDE_AL_GRAPHICS_SHADER_HPP
#define INCLUDE_AL_GRAPHICS_SHADER_HPP
 
/*  Allocore --
  Multimedia / virtual environment application class library
 
  Copyright (C) 2009. AlloSphere Research Group, Media Arts & Technology, UCSB.
  Copyright (C) 2012. The Regents of the University of California.
  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 the University of California 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 HOLDER 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.
 
 
  File description:
  Wrappers to OpenGL GLSL shaders
 
  File author(s):
  Lance Putnam, 2010, putnam.lance@gmail.com
  Graham Wakefield, 2010, grrrwaaa@gmail.com
  Wesley Smith, 2010, wesley.hoke@gmail.com
  Keehong Youn, 2017, younkeehong@gmail.com
 
*/
 
#include <string>
#include <unordered_map>
#include "al/graphics/al_GPUObject.hpp"
#include "al/math/al_Mat.hpp"
#include "al/math/al_Quat.hpp"
#include "al/math/al_Vec.hpp"
#include "al/types/al_Color.hpp"
 
#define AL_SHADER_MAX_LOG_SIZE 4096
 
namespace al {
 
class ShaderBase : public GPUObject {
 public:
  virtual ~ShaderBase() {}
 
  const char *log() const;
 
  void printLog() const;
 
 protected:
  virtual void get(int pname, void *params) const = 0;
  virtual void getLog(char *buf) const = 0;
};
 
 
class Shader : public ShaderBase {
 public:
  enum Type { VERTEX, GEOMETRY, FRAGMENT };
 
  Shader(const std::string &source = "", Shader::Type type = FRAGMENT);
 
  virtual ~Shader() { destroy(); }
 
  Shader &source(const std::string &v);
  Shader &source(const std::string &v, Shader::Type type);
  Shader &compile();
  bool compiled() const;
 
  Shader::Type type() const { return mType; }
 
 private:
  std::string mSource;
  Shader::Type mType;
 
  virtual void get(int pname, void *params) const;
  virtual void getLog(char *buf) const;
 
  virtual void onCreate();
  virtual void onDestroy();
};
 
 
class ShaderProgram : public ShaderBase {
 public:
  enum Type {
    NONE = 0,  // uninitialized type
 
    FLOAT,  
    VEC2,   
    VEC3,   
    VEC4,   
 
    INT,   
    INT2,  
    INT3,  
    INT4,  
 
    BOOL,   
    BOOL2,  
    BOOL3,  
    BOOL4,  
 
    MAT22,  
    MAT33,  
    MAT44,  
 
    SAMPLER_1D,         
    SAMPLER_2D,         
    SAMPLER_RECT,       
    SAMPLER_3D,         
    SAMPLER_CUBE,       
    SAMPLER_1D_SHADOW,  
    SAMPLER_2D_SHADOW   
 
    // textures? non square matrices? attributes?
  };
 
  struct Attribute {};
 
  ShaderProgram();
 
  virtual ~ShaderProgram();
 
 
  ShaderProgram &attach(Shader &s);
 
  const ShaderProgram &detach(const Shader &s) const;
 
 
  const ShaderProgram &link(bool doValidate = true) const;
 
  bool compile(const std::string &vertSource, const std::string &fragSource,
               const std::string &geomSource = "");
 
  const ShaderProgram &use();
 
  void begin();
 
  void end() const;
 
  bool linked() const;
 
  bool validateProgram(bool printLog = false) const;
 
  void listParams() const;
 
  int getUniformLocation(const char *name) const;
  int getUniformLocation(const std::string &s) const {
    return getUniformLocation(s.c_str());
  }
 
  int attribute(const char *name) const;
 
  const ShaderProgram &uniform(const char *name, const Color &c) const {
    return uniform4(name, c.components);
  }
 
  void uniform4f(int loc, float v0, float v1, float v2, float v3) const;
  void uniformMat4f(int loc, float *data) const;
 
  const ShaderProgram &uniform(int loc, int v) const;
  const ShaderProgram &uniform(int loc, float v) const;
  const ShaderProgram &uniform(int loc, double v) const {
    return uniform(loc, float(v));
  }
  const ShaderProgram &uniform(int loc, float v0, float v1) const;
  const ShaderProgram &uniform(int loc, float v0, float v1, float v2) const;
  const ShaderProgram &uniform(int loc, float v0, float v1, float v2,
                               float v3) const;
  const ShaderProgram &uniform4v(int loc, const float *v, int count = 1) const;
 
  template <typename T>
  const ShaderProgram &uniform(int loc, const Vec<2, T> &v) const {
    return uniform(loc, v.x, v.y);
  }
  template <typename T>
  const ShaderProgram &uniform(int loc, const Vec<3, T> &v) const {
    return uniform(loc, v.x, v.y, v.z);
  }
  template <typename T>
  const ShaderProgram &uniform(int loc, const Vec<4, T> &v) const {
    return uniform(loc, v.x, v.y, v.z, v.w);
  }
  const ShaderProgram &uniformMatrix3(int loc, const float *v,
                                      bool transpose = false) const;
  const ShaderProgram &uniformMatrix4(int loc, const float *v,
                                      bool transpose = false) const;
  const ShaderProgram &uniform(int loc, const Mat<4, float> &m) const {
    return uniformMatrix4(loc, m.elems());
  }
  template <typename T>
  const ShaderProgram &uniform(int loc, const Mat<4, T> &m) const {
    return uniform(loc, Mat4f(m));
  }
 
  const ShaderProgram &uniform(const char *name, int v) const;
  const ShaderProgram &uniform(const char *name, float v) const;
  const ShaderProgram &uniform(const char *name, double v) const {
    return uniform(name, float(v));
  }
  const ShaderProgram &uniform(const char *name, float v0, float v1) const;
  const ShaderProgram &uniform(const char *name, float v0, float v1,
                               float v2) const;
  const ShaderProgram &uniform(const char *name, float v0, float v1, float v2,
                               float v3) const;
 
  template <typename T>
  const ShaderProgram &uniform(const char *name, const Vec<2, T> &v) const {
    return uniform(name, v.x, v.y);
  }
 
  template <typename T>
  const ShaderProgram &uniform(const char *name, const Vec<3, T> &v) const {
    return uniform(name, v.x, v.y, v.z);
  }
 
  template <typename T>
  const ShaderProgram &uniform(const char *name, const Vec<4, T> &v) const {
    return uniform(name, v.x, v.y, v.z, v.w);
  }
 
  const ShaderProgram &uniform(const char *name, const Mat<4, float> &m,
                               bool transpose = false) const {
    return uniformMatrix4(name, m.elems(), transpose);
  }
 
  template <typename T>
  const ShaderProgram &uniform(const char *name, const Mat<4, T> &m,
                               bool transpose = false) const {
    return uniform(name, Mat4f(m), transpose);
  }
 
  template <typename T>
  const ShaderProgram &uniform(const char *name, const Quat<T> &q) const {
    // note wxyz => xyzw for GLSL vec4:
    return uniform(name, q.x, q.y, q.z, q.w);
  }
 
  const ShaderProgram &uniform1(const char *name, const float *v,
                                int count = 1) const;
  const ShaderProgram &uniform2(const char *name, const float *v,
                                int count = 1) const;
  const ShaderProgram &uniform3(const char *name, const float *v,
                                int count = 1) const;
  const ShaderProgram &uniform4(const char *name, const float *v,
                                int count = 1) const;
 
  const ShaderProgram &uniformMatrix3(const char *name, const float *v,
                                      bool transpose = false) const;
  const ShaderProgram &uniformMatrix4(const char *name, const float *v,
                                      bool transpose = false) const;
 
  const ShaderProgram &attribute(int loc, float v) const;
  const ShaderProgram &attribute(int loc, float v0, float v1) const;
  const ShaderProgram &attribute(int loc, float v0, float v1, float v2) const;
  const ShaderProgram &attribute(int loc, float v0, float v1, float v2,
                                 float v3) const;
 
  const ShaderProgram &attribute(const char *name, float v) const;
  const ShaderProgram &attribute(const char *name, float v0, float v1) const;
  const ShaderProgram &attribute(const char *name, float v0, float v1,
                                 float v2) const;
  const ShaderProgram &attribute(const char *name, float v0, float v1, float v2,
                                 float v3) const;
 
  const ShaderProgram &attribute1(const char *name, const float *v) const;
  const ShaderProgram &attribute2(const char *name, const float *v) const;
  const ShaderProgram &attribute3(const char *name, const float *v) const;
  const ShaderProgram &attribute4(const char *name, const float *v) const;
  const ShaderProgram &attribute1(int loc, const double *v) const;
  const ShaderProgram &attribute2(int loc, const double *v) const;
  const ShaderProgram &attribute3(int loc, const double *v) const;
  const ShaderProgram &attribute4(int loc, const double *v) const;
 
  template <typename T>
  const ShaderProgram &attribute(int loc, const Vec<2, T> &v) const {
    return attribute(loc, v.x, v.y);
  }
  template <typename T>
  const ShaderProgram &attribute(int loc, const Vec<3, T> &v) const {
    return attribute(loc, v.x, v.y, v.z);
  }
  template <typename T>
  const ShaderProgram &attribute(int loc, const Vec<4, T> &v) const {
    return attribute(loc, v.x, v.y, v.z, v.w);
  }
  template <typename T>
  const ShaderProgram &attribute(int loc, const Quat<T> &q) const {
    // note wxyz => xyzw for GLSL vec4:
    return attribute(loc, q.x, q.y, q.z, q.w);
  }
 
  static void use(unsigned programID);
 
 protected:
  // Graphics::Primitive mInPrim, mOutPrim;  // IO primitives for geometry
  // shaders unsigned int mOutVertices;
  std::string mVertSource, mFragSource, mGeomSource;
  mutable std::unordered_map<std::string, int> mUniformLocs, mAttribLocs;
  // bool mActive;
 
  virtual void get(int pname, void *params) const;
  virtual void getLog(char *buf) const;
 
  virtual void onCreate();
  virtual void onDestroy();
};
 
}  // namespace al
 
#endif