GLSLShader.h 11.2 KB
Newer Older
Pierre Kraemer's avatar
Pierre Kraemer committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28
/*******************************************************************************
* CGoGN: Combinatorial and Geometric modeling with Generic N-dimensional Maps  *
* version 0.1                                                                  *
* Copyright (C) 2009, IGG Team, LSIIT, University of Strasbourg                *
*                                                                              *
* This library is free software; you can redistribute it and/or modify it      *
* under the terms of the GNU Lesser General Public License as published by the *
* Free Software Foundation; either version 2.1 of the License, or (at your     *
* option) any later version.                                                   *
*                                                                              *
* This library is distributed in the hope that it will be useful, but WITHOUT  *
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or        *
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License  *
* for more details.                                                            *
*                                                                              *
* You should have received a copy of the GNU Lesser General Public License     *
* along with this library; if not, write to the Free Software Foundation,      *
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301 USA.           *
*                                                                              *
* Web site: https://iggservis.u-strasbg.fr/CGoGN/                              *
* Contact information: cgogn@unistra.fr                                        *
*                                                                              *
*******************************************************************************/

/***********************************************
*  Thanks to Frederic Larue for this class
***********************************************/

Sylvain Thery's avatar
Sylvain Thery committed
29 30
#ifndef __CGoGN_GLSL_SHADER__
#define __CGoGN_GLSL_SHADER__
Pierre Kraemer's avatar
Pierre Kraemer committed
31 32

#include "Utils/os_spec.h"
Sylvain Thery's avatar
Sylvain Thery committed
33
#include "Utils/vbo.h"
Pierre Kraemer's avatar
Pierre Kraemer committed
34

Sylvain Thery's avatar
Sylvain Thery committed
35
#include "glm/glm.hpp"
Pierre Kraemer's avatar
Pierre Kraemer committed
36 37 38 39
#include <GL/glew.h>

#include <stdlib.h>
#include <string>
40
#include <vector>
41 42
#include <set>

Pierre Kraemer's avatar
Pierre Kraemer committed
43 44
namespace CGoGN
{
Pierre Kraemer's avatar
merge..  
Pierre Kraemer committed
45

Pierre Kraemer's avatar
Pierre Kraemer committed
46 47 48
namespace Utils
{

49
class GLSLShader
Pierre Kraemer's avatar
Pierre Kraemer committed
50
{
51
public:
Sylvain Thery's avatar
Sylvain Thery committed
52 53 54 55 56 57 58 59
	struct VAStr
	{
		int va_id;
		VBO* vbo_ptr;
//		GLuint vbo_id;
//		unsigned int size;
	};

60 61 62 63
	/**
	 * enum of supported shader type
	 */
	enum shaderType {VERTEX_SHADER = 1, FRAGMENT_SHADER = 2, GEOMETRY_SHADER = 3 };
Pierre Kraemer's avatar
Pierre Kraemer committed
64

Sylvain Thery's avatar
Sylvain Thery committed
65 66
	static unsigned int CURRENT_OGL_VERSION;

Pierre Kraemer's avatar
merge..  
Pierre Kraemer committed
67
	static std::set< std::pair<void*, GLSLShader*> > m_registeredShaders;
Pierre Kraemer's avatar
Pierre Kraemer committed
68 69

protected:
Sylvain Thery's avatar
Sylvain Thery committed
70 71 72 73 74 75
	static std::string DEFINES_GL2;

	static std::string DEFINES_GL3;

	static std::string* DEFINES_GL;

76 77
	static std::string defines_Geom(const std::string& primitivesIn, const std::string& primitivesOut, int maxVert);

78 79 80 81 82 83 84 85 86 87 88 89 90 91 92
	/**
	 * handle of vertex shader
	 */
	GLhandleARB	m_vertex_shader_object;

	/**
	 * handle of fragment shader
	 */
	GLhandleARB	m_fragment_shader_object;

	/**
	 * handle of geometry shader
	 */
	GLhandleARB	m_geom_shader_object;

Sylvain Thery's avatar
Sylvain Thery committed
93 94 95 96
	std::string m_nameVS;
	std::string m_nameFS;
	std::string m_nameGS;

97 98 99 100 101
	/**
	 * handle of program
	 */
	GLhandleARB m_program_object;

102 103 104 105 106 107 108 109 110 111 112 113
	GLint m_uniMat_Proj;
	GLint m_uniMat_Model;
	GLint m_uniMat_ModelProj;
	GLint m_uniMat_Normal;

	char* m_vertex_shader_source;
	char* m_fragment_shader_source;
	char* m_geom_shader_source;

	GLint m_geom_inputPrimitives;
	GLint m_geom_outputPrimitives;

Sylvain Thery's avatar
Sylvain Thery committed
114 115 116 117 118 119 120 121
	/**
	 * a set of pair VA_id / VBO_id
	 */
//	std::vector<pair<int,unsigned int> > m_va_vbo_binding;
	std::vector<VAStr> m_va_vbo_binding;

	static std::vector<std::string> m_pathes;

122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138
	/**
	 * load vertex shader
	 * @param vertex_shader_source src text shader
	 */
	bool loadVertexShaderSourceString( const char* vertex_shader_source );

	/**
	 * load fragment shader
	 * @param fragment_shader_source src text shader
	 */
	bool loadFragmentShaderSourceString( const char* fragment_shader_source );

	/**
	 * load geometry shader
	 * @param geom_shader_source src text shader
	 */
	bool loadGeometryShaderSourceString( const char* geom_shader_source );
Pierre Kraemer's avatar
Pierre Kraemer committed
139

140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174
	/**
	 * load vertex shader
	 * @param filename file name
	 */
	bool loadVertexShader( const std::string& filename );

	/**
	 * load fragment shader
	 * @param filename file name
	 */
	bool loadFragmentShader( const std::string& filename );

	/**
	 * load geometry shader
	 * @param filename file name
	 */
	bool  loadGeometryShader( const std::string& filename );

	/**
	 * Load of source file in a char buffer
	 * @param source_file file name
	 */
	char* loadSourceFile( const std::string& source_file );

	/**
	 * create the shader (attach and link shaders into program)
	 */
	bool create(GLint inputGeometryPrimitive=GL_TRIANGLES,GLint outputGeometryPrimitive=GL_TRIANGLES);

	/**
	 * get log after compiling
	 * @param obj what log do you want ?
	 * @return the log
	 */
	char* getInfoLog( GLhandleARB obj );
Pierre Kraemer's avatar
Pierre Kraemer committed
175 176

public:
177 178 179
	/**
	 * constructor
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
180 181
	GLSLShader();

182 183 184 185
	/**
	 * destructor
	 */
	virtual ~GLSLShader();
Pierre Kraemer's avatar
Pierre Kraemer committed
186

Sylvain Thery's avatar
Sylvain Thery committed
187 188
	static void setCurrentOGLVersion(unsigned int version);

189 190 191 192 193
	/*
	 * search file in different path
	 */
	static std::string findFile(const std::string filename);

194 195 196 197
	/**
	 * test support of shader
	 */
	static bool	areShadersSupported();
Pierre Kraemer's avatar
Pierre Kraemer committed
198

199 200 201 202 203 204 205 206 207
	/**
	 * test support of Vertex Buffer Object
	 */
	static bool	areVBOSupported();

	/**
	 * test support of geometry shader
	 */
	static bool	areGeometryShadersSupported();
Pierre Kraemer's avatar
Pierre Kraemer committed
208

209 210 211 212
	/**
	 * test support of gl3
	 */
	static bool	isGL3Supported();
Pierre Kraemer's avatar
Pierre Kraemer committed
213

214
	static bool init();
Pierre Kraemer's avatar
Pierre Kraemer committed
215

Pierre Kraemer's avatar
merge..  
Pierre Kraemer committed
216
	static void registerShader(void* ptr, GLSLShader* shader);
Pierre Kraemer's avatar
Pierre Kraemer committed
217

Pierre Kraemer's avatar
merge..  
Pierre Kraemer committed
218
	static void unregisterShader(void* ptr, GLSLShader* shader);
219 220 221

//	static void updateMatricesRunningShaders(const glm::mat4& projection, const glm::mat4& modelview);

222 223 224 225 226 227 228 229 230
	/**
	 * load shaders (compile and link)
	 * @param vs vertex shader source file
	 * @param fs fragment shader source file
	 */
	bool loadShaders(const std::string& vs, const std::string& fs);

	/**
	 * load shaders (compile and link)
Sylvain Thery's avatar
Sylvain Thery committed
231 232 233
	 * @param vs vertex shader source file name
	 * @param fs fragment shader source file name
	 * @param gs geometry shader source file name
234 235 236
	 * @param inputGeometryPrimitive primitives used in geometry shader as input
	 * @param outputGeometryPrimitive primitives generated in geometry shader as output
	 */
237
	bool loadShaders(const std::string& vs, const std::string& fs, const std::string& gs, GLint inputGeometryPrimitive=GL_TRIANGLES,GLint outputGeometryPrimitive=GL_TRIANGLE_STRIP);
Pierre Kraemer's avatar
Pierre Kraemer committed
238

Sylvain Thery's avatar
Sylvain Thery committed
239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257
	/**
	 * load shaders (compile and link)
	 * @param vs vertex shader source char* prt
	 * @param fs fragment shader source char* prt

	 * @param outputGeometryPrimitive primitives generated in geometry shader as output
	 */
	bool loadShadersFromMemory(const char* vs, const char* fs);

	/**
	 * load shaders (compile and link)
	 * @param vs vertex shader source char* prt
	 * @param fs fragment shader source char* prt
	 * @param fs geometry shader source char* prt
	 * @param inputGeometryPrimitive primitives used in geometry shader as input
	 * @param outputGeometryPrimitive primitives generated in geometry shader as output
	 */
	bool loadShadersFromMemory(const char* vs, const char* fs, const char* gs, GLint inputGeometryPrimitive,GLint outputGeometryPrimitive);

Pierre Kraemer's avatar
merge..  
Pierre Kraemer committed
258 259 260
	const char* getVertexShaderSrc() { return m_vertex_shader_source; }
	const char* getFragmentShaderSrc() { return m_fragment_shader_source; }
	const char* getGeometryShaderSrc() { return m_geom_shader_source; }
261 262 263 264 265 266 267 268 269

	bool reloadVertexShaderFromMemory(const char* vs);

	bool reloadFragmentShaderFromMemory(const char* fs);

	bool reloadGeometryShaderFromMemory(const char* gs);

	bool recompile();

270 271 272 273 274
	/**
	 * Link the shader do it just after binding the attributes
	 */
	bool link();

Pierre Kraemer's avatar
Pierre Kraemer committed
275
	inline bool		isCreated();
276

Pierre Kraemer's avatar
Pierre Kraemer committed
277 278
	bool			isBinded();

279 280 281
	virtual bool	bind() const;

	virtual void	unbind() const;
282

283 284 285
	/**
	 * restore all uniforms and vertex attributes after recompiling
	 */
286
	virtual void restoreUniformsAttribs() {CGoGNerr << "Warning restoreUniformsAttribs not implemented"<< CGoGNendl;}
Pierre Kraemer's avatar
Pierre Kraemer committed
287

288 289 290
	/**
	 *
	 */
Sylvain Thery's avatar
Sylvain Thery committed
291
//	GLuint 	getAttribIndex( char* attribName );
Pierre Kraemer's avatar
Pierre Kraemer committed
292
	
293 294 295 296 297
	/**
	 * get handler of program for external use og gl functions
	 */
	GLuint program_handler() { return m_program_object;}

298 299 300
	/**
	 * check shader validity width official GLSL syntax
	 */
301 302
	bool validateProgram();

303 304 305
	/**
	 * check program link status
	 */
306 307
	bool checkProgram();

308 309 310
	/**
	 * check shader compile status
	 */
311 312
	bool checkShader(int shaderType);

Pierre Kraemer's avatar
Pierre Kraemer committed
313
public:
314 315 316 317 318 319 320
	/**
	 * set uniform shader float variable
	 * @warning practical but less efficient that storing id (get with glGetUniformLocation) and use glUniform*fvARB
	 * @param NB template size of variable to set
	 * @param name name in shader
	 * @param pointer on data to copy
	 */
321
	template<unsigned int NB>
Sylvain Thery's avatar
Sylvain Thery committed
322
	void setuniformf( const char* name, const float* val);
323

324 325 326 327 328 329 330
	/**
	 * set uniform shader int variable
	 * @warning practical but less efficient that storing id (get with glGetUniformLocation) and use glUniform*ivARB
	 * @param NB template size of variable to set
	 * @param name name in shader
	 * @param pointer on data to copy
	 */
331
	template<unsigned int NB>
Sylvain Thery's avatar
Sylvain Thery committed
332
	void setuniformi( const char* name, const int* val);
333 334 335 336 337 338 339

	/**
	 * add search path for file
	 * @param path to add
	 */
	void addPathFileSeach(const std::string& path);

Sylvain Thery's avatar
Sylvain Thery committed
340 341 342 343 344 345 346 347 348 349 350 351
	/**
	 * remove VBO index from binding
	 */
	void unbindVBO(VBO* ptr);

	/**
	 * remove VBO index from binding
	 */
	void unbindVA(const std::string& name);

	/**
	 * associate an attribute name of shader with a vbo
352
	 * @return the index in vector of pair binding, negative if fail
Sylvain Thery's avatar
Sylvain Thery committed
353
	 */
354 355 356 357 358 359
	unsigned int bindVA_VBO(const std::string& name, VBO* vbo);

	/**
	 * change the vbo of id case of binding vector
	 */
	void changeVA_VBO(unsigned int id, VBO* vbo);
Sylvain Thery's avatar
Sylvain Thery committed
360 361 362 363

	/**
	 * get binding VA VBO
	 */
Pierre Kraemer's avatar
merge..  
Pierre Kraemer committed
364
	const std::vector<VAStr>& getVA_VBO_Bindings() { return m_va_vbo_binding; }
365

Sylvain Thery's avatar
Sylvain Thery committed
366 367 368 369 370 371
	void bindAttrib(unsigned int att, const char* name) const;

	/**
	 * update projection, modelview, ... matrices
	 */
	void updateMatrices(const glm::mat4& projection, const glm::mat4& modelview);
372 373 374 375 376 377 378 379 380 381 382

	/**
	 * bind, enable, and set all vertex attrib pointers
	 * @param stride: the stride parameter, number osf byte between two consecutive attributes
	 */
	void enableVertexAttribs(unsigned int stride=0) const;

	/**
	 * disenable all vertex attribs
	 */
	void disableVertexAttribs() const;
383 384 385 386 387 388 389 390 391 392 393 394
};


////////// INLINE FUNCTIONS //////////


inline bool GLSLShader::isCreated()
{
	return ( m_program_object != 0 );
}

template<unsigned int NB>
Sylvain Thery's avatar
Sylvain Thery committed
395
void GLSLShader::setuniformf( const char* name, const float* val)
396 397
{
	GLint uni = glGetUniformLocationARB(m_program_object,name);
Pierre Kraemer's avatar
merge..  
Pierre Kraemer committed
398
	if (uni >= 0)
399 400 401 402
	{
		switch(NB)
		{
		case 1:
Pierre Kraemer's avatar
merge..  
Pierre Kraemer committed
403
			glUniform1fvARB(uni, 1, val) ;
404 405
			break;
		case 2:
Pierre Kraemer's avatar
merge..  
Pierre Kraemer committed
406
			glUniform2fvARB(uni, 1, val) ;
407 408
			break;
		case 3:
Pierre Kraemer's avatar
merge..  
Pierre Kraemer committed
409
			glUniform3fvARB(uni, 1, val) ;
410 411
			break;
		case 4:
Pierre Kraemer's avatar
merge..  
Pierre Kraemer committed
412
			glUniform4fvARB(uni, 1, val) ;
413 414
			break;
		case 16:
Pierre Kraemer's avatar
merge..  
Pierre Kraemer committed
415
			glUniformMatrix4fv(uni, 1, false, val);
416 417 418
			break;
		}
	}
419
}
420

421
template<unsigned int NB>
Sylvain Thery's avatar
Sylvain Thery committed
422
void GLSLShader::setuniformi( const char* name, const int* val)
423 424 425
{
	GLint uni = glGetUniformLocationARB(m_program_object,name);
	if (uni>=0)
426 427 428 429
	{
		switch(NB)
		{
		case 1:
Pierre Kraemer's avatar
merge..  
Pierre Kraemer committed
430
			glUniform1ivARB(uni, 1, val) ;
431 432
			break;
		case 2:
Pierre Kraemer's avatar
merge..  
Pierre Kraemer committed
433
			glUniform2ivARB(uni, 1, val) ;
434 435
			break;
		case 3:
Pierre Kraemer's avatar
merge..  
Pierre Kraemer committed
436
			glUniform3ivARB(uni, 1, val) ;
437 438
			break;
		case 4:
Pierre Kraemer's avatar
merge..  
Pierre Kraemer committed
439
			glUniform4ivARB(uni, 1, val) ;
440 441 442
			break;
		}
	}
Pierre Kraemer's avatar
Pierre Kraemer committed
443 444
}

445
} //namespace Utils
Pierre Kraemer's avatar
Pierre Kraemer committed
446

Pierre Kraemer's avatar
merge..  
Pierre Kraemer committed
447
} //namespace CGoGN
Pierre Kraemer's avatar
Pierre Kraemer committed
448

Sylvain Thery's avatar
Sylvain Thery committed
449
#endif