1 // Copyright (C) 2002-2012 Nikolaus Gebhardt
\r
2 // This file is part of the "Irrlicht Engine".
\r
3 // For conditions of distribution and use, see copyright notice in irrlicht.h
\r
5 // This file was originally written by William Finlayson. I (Nikolaus
\r
6 // Gebhardt) did some minor modifications and changes to it and integrated it
\r
7 // into Irrlicht. Thanks a lot to William for his work on this and that he gave
\r
8 // me his permission to add it into Irrlicht using the zlib license.
\r
10 // After Irrlicht 0.12, Michael Zoech did some improvements to this renderer, I
\r
11 // merged this into Irrlicht 0.14, thanks to him for his work.
\r
13 #include "COpenGLSLMaterialRenderer.h"
\r
15 #ifdef _IRR_COMPILE_WITH_OPENGL_
\r
17 #include "IGPUProgrammingServices.h"
\r
18 #include "IShaderConstantSetCallBack.h"
\r
19 #include "IMaterialRendererServices.h"
\r
20 #include "IVideoDriver.h"
\r
23 #include "COpenGLDriver.h"
\r
24 #include "COpenGLCacheHandler.h"
\r
25 #include "COpenGLMaterialRenderer.h"
\r
27 #include "COpenGLCoreFeature.h"
\r
36 COpenGLSLMaterialRenderer::COpenGLSLMaterialRenderer(video::COpenGLDriver* driver,
\r
37 s32& outMaterialTypeNr, const c8* vertexShaderProgram,
\r
38 const c8* vertexShaderEntryPointName,
\r
39 E_VERTEX_SHADER_TYPE vsCompileTarget,
\r
40 const c8* pixelShaderProgram,
\r
41 const c8* pixelShaderEntryPointName,
\r
42 E_PIXEL_SHADER_TYPE psCompileTarget,
\r
43 const c8* geometryShaderProgram,
\r
44 const c8* geometryShaderEntryPointName,
\r
45 E_GEOMETRY_SHADER_TYPE gsCompileTarget,
\r
46 scene::E_PRIMITIVE_TYPE inType, scene::E_PRIMITIVE_TYPE outType,
\r
48 IShaderConstantSetCallBack* callback,
\r
49 E_MATERIAL_TYPE baseMaterial,
\r
51 : Driver(driver), CallBack(callback), Alpha(false), Blending(false), FixedBlending(false), AlphaTest(false), Program(0), Program2(0), UserData(userData)
\r
54 setDebugName("COpenGLSLMaterialRenderer");
\r
57 switch (baseMaterial)
\r
59 case EMT_TRANSPARENT_VERTEX_ALPHA:
\r
60 case EMT_TRANSPARENT_ALPHA_CHANNEL:
\r
61 case EMT_NORMAL_MAP_TRANSPARENT_VERTEX_ALPHA:
\r
62 case EMT_PARALLAX_MAP_TRANSPARENT_VERTEX_ALPHA:
\r
65 case EMT_TRANSPARENT_ADD_COLOR:
\r
66 case EMT_NORMAL_MAP_TRANSPARENT_ADD_COLOR:
\r
67 case EMT_PARALLAX_MAP_TRANSPARENT_ADD_COLOR:
\r
68 FixedBlending = true;
\r
70 case EMT_ONETEXTURE_BLEND:
\r
73 case EMT_TRANSPARENT_ALPHA_CHANNEL_REF:
\r
83 if (!Driver->queryFeature(EVDF_ARB_GLSL))
\r
86 init(outMaterialTypeNr, vertexShaderProgram, pixelShaderProgram, geometryShaderProgram);
\r
90 //! constructor only for use by derived classes who want to
\r
91 //! create a fall back material for example.
\r
92 COpenGLSLMaterialRenderer::COpenGLSLMaterialRenderer(COpenGLDriver* driver,
\r
93 IShaderConstantSetCallBack* callback,
\r
94 E_MATERIAL_TYPE baseMaterial, s32 userData)
\r
95 : Driver(driver), CallBack(callback), Alpha(false), Blending(false), FixedBlending(false), AlphaTest(false), Program(0), Program2(0), UserData(userData)
\r
97 switch (baseMaterial)
\r
99 case EMT_TRANSPARENT_VERTEX_ALPHA:
\r
100 case EMT_TRANSPARENT_ALPHA_CHANNEL:
\r
101 case EMT_NORMAL_MAP_TRANSPARENT_VERTEX_ALPHA:
\r
102 case EMT_PARALLAX_MAP_TRANSPARENT_VERTEX_ALPHA:
\r
105 case EMT_TRANSPARENT_ADD_COLOR:
\r
106 case EMT_NORMAL_MAP_TRANSPARENT_ADD_COLOR:
\r
107 case EMT_PARALLAX_MAP_TRANSPARENT_ADD_COLOR:
\r
108 FixedBlending = true;
\r
110 case EMT_ONETEXTURE_BLEND:
\r
113 case EMT_TRANSPARENT_ALPHA_CHANNEL_REF:
\r
126 COpenGLSLMaterialRenderer::~COpenGLSLMaterialRenderer()
\r
133 GLhandleARB shaders[8];
\r
135 Driver->extGlGetAttachedObjects(Program, 8, &count, shaders);
\r
136 // avoid bugs in some drivers, which return larger numbers
\r
137 // use int variable to avoid compiler problems with template
\r
138 int mincount=core::min_((int)count,8);
\r
139 for (int i=0; i<mincount; ++i)
\r
140 Driver->extGlDeleteObject(shaders[i]);
\r
141 Driver->extGlDeleteObject(Program);
\r
149 Driver->extGlGetAttachedShaders(Program2, 8, &count, shaders);
\r
150 // avoid bugs in some drivers, which return larger numbers
\r
151 // use int variable to avoid compiler problems with template
\r
152 int mincount=core::min_((int)count,8);
\r
153 for (int i=0; i<mincount; ++i)
\r
154 Driver->extGlDeleteShader(shaders[i]);
\r
155 Driver->extGlDeleteProgram(Program2);
\r
159 UniformInfo.clear();
\r
163 void COpenGLSLMaterialRenderer::init(s32& outMaterialTypeNr,
\r
164 const c8* vertexShaderProgram,
\r
165 const c8* pixelShaderProgram,
\r
166 const c8* geometryShaderProgram,
\r
167 scene::E_PRIMITIVE_TYPE inType, scene::E_PRIMITIVE_TYPE outType,
\r
170 outMaterialTypeNr = -1;
\r
172 if (!createProgram())
\r
175 #if defined(GL_ARB_vertex_shader) && defined (GL_ARB_fragment_shader)
\r
176 if (vertexShaderProgram)
\r
177 if (!createShader(GL_VERTEX_SHADER_ARB, vertexShaderProgram))
\r
180 if (pixelShaderProgram)
\r
181 if (!createShader(GL_FRAGMENT_SHADER_ARB, pixelShaderProgram))
\r
185 #if defined(GL_ARB_geometry_shader4) || defined(GL_EXT_geometry_shader4) || defined(GL_NV_geometry_program4) || defined(GL_NV_geometry_shader4)
\r
186 if (geometryShaderProgram && Driver->queryFeature(EVDF_GEOMETRY_SHADER))
\r
188 if (!createShader(GL_GEOMETRY_SHADER_EXT, geometryShaderProgram))
\r
190 #if defined(GL_ARB_geometry_shader4) || defined(GL_EXT_geometry_shader4) || defined(GL_NV_geometry_shader4)
\r
191 if (Program2) // Geometry shaders are supported only in OGL2.x+ drivers.
\r
193 Driver->extGlProgramParameteri(Program2, GL_GEOMETRY_INPUT_TYPE_EXT, Driver->primitiveTypeToGL(inType));
\r
194 Driver->extGlProgramParameteri(Program2, GL_GEOMETRY_OUTPUT_TYPE_EXT, Driver->primitiveTypeToGL(outType));
\r
195 if (verticesOut==0)
\r
196 Driver->extGlProgramParameteri(Program2, GL_GEOMETRY_VERTICES_OUT_EXT, Driver->MaxGeometryVerticesOut);
\r
198 Driver->extGlProgramParameteri(Program2, GL_GEOMETRY_VERTICES_OUT_EXT, core::min_(verticesOut, Driver->MaxGeometryVerticesOut));
\r
200 #elif defined(GL_NV_geometry_program4)
\r
201 if (verticesOut==0)
\r
202 Driver->extGlProgramVertexLimit(GL_GEOMETRY_PROGRAM_NV, Driver->MaxGeometryVerticesOut);
\r
204 Driver->extGlProgramVertexLimit(GL_GEOMETRY_PROGRAM_NV, core::min_(verticesOut, Driver->MaxGeometryVerticesOut));
\r
209 if (!linkProgram())
\r
212 // register myself as new material
\r
213 outMaterialTypeNr = Driver->addMaterialRenderer(this);
\r
217 bool COpenGLSLMaterialRenderer::OnRender(IMaterialRendererServices* service,
\r
218 E_VERTEX_TYPE vtxtype)
\r
220 // call callback to set shader constants
\r
221 if (CallBack && (Program||Program2))
\r
222 CallBack->OnSetConstants(this, UserData);
\r
228 void COpenGLSLMaterialRenderer::OnSetMaterial(const video::SMaterial& material,
\r
229 const video::SMaterial& lastMaterial,
\r
230 bool resetAllRenderstates,
\r
231 video::IMaterialRendererServices* services)
\r
233 if (Driver->getFixedPipelineState() == COpenGLDriver::EOFPS_ENABLE)
\r
234 Driver->setFixedPipelineState(COpenGLDriver::EOFPS_ENABLE_TO_DISABLE);
\r
236 Driver->setFixedPipelineState(COpenGLDriver::EOFPS_DISABLE);
\r
238 COpenGLCacheHandler* cacheHandler = Driver->getCacheHandler();
\r
240 if (material.MaterialType != lastMaterial.MaterialType || resetAllRenderstates)
\r
243 Driver->irrGlUseProgram(Program2);
\r
245 Driver->extGlUseProgramObject(Program);
\r
248 Driver->setBasicRenderStates(material, lastMaterial, resetAllRenderstates);
\r
252 cacheHandler->setBlend(true);
\r
253 cacheHandler->setBlendFunc(GL_SRC_ALPHA, GL_ONE_MINUS_SRC_ALPHA);
\r
255 else if (FixedBlending)
\r
257 cacheHandler->setBlendFunc(GL_ONE, GL_ONE_MINUS_SRC_COLOR);
\r
258 cacheHandler->setBlend(true);
\r
262 E_BLEND_FACTOR srcRGBFact,dstRGBFact,srcAlphaFact,dstAlphaFact;
\r
263 E_MODULATE_FUNC modulate;
\r
265 unpack_textureBlendFuncSeparate(srcRGBFact, dstRGBFact, srcAlphaFact, dstAlphaFact, modulate, alphaSource, material.MaterialTypeParam);
\r
267 if (Driver->queryFeature(EVDF_BLEND_SEPARATE))
\r
269 cacheHandler->setBlendFuncSeparate(Driver->getGLBlend(srcRGBFact), Driver->getGLBlend(dstRGBFact),
\r
270 Driver->getGLBlend(srcAlphaFact), Driver->getGLBlend(dstAlphaFact));
\r
274 cacheHandler->setBlendFunc(Driver->getGLBlend(srcRGBFact), Driver->getGLBlend(dstRGBFact));
\r
277 cacheHandler->setBlend(true);
\r
279 else if (AlphaTest)
\r
281 cacheHandler->setAlphaTest(true);
\r
282 cacheHandler->setAlphaFunc(GL_GREATER, 0.5f);
\r
286 CallBack->OnSetMaterial(material);
\r
290 void COpenGLSLMaterialRenderer::OnUnsetMaterial()
\r
293 Driver->extGlUseProgramObject(0);
\r
295 Driver->irrGlUseProgram(0);
\r
297 COpenGLCacheHandler* cacheHandler = Driver->getCacheHandler();
\r
298 if (Alpha || FixedBlending || Blending)
\r
300 cacheHandler->setBlend(false);
\r
302 else if (AlphaTest)
\r
304 cacheHandler->setAlphaTest(false);
\r
309 //! Returns if the material is transparent.
\r
310 bool COpenGLSLMaterialRenderer::isTransparent() const
\r
312 return (Alpha || Blending || FixedBlending);
\r
316 bool COpenGLSLMaterialRenderer::createProgram()
\r
318 if (Driver->Version>=200)
\r
319 Program2 = Driver->extGlCreateProgram();
\r
321 Program = Driver->extGlCreateProgramObject();
\r
326 bool COpenGLSLMaterialRenderer::createShader(GLenum shaderType, const char* shader)
\r
330 GLuint shaderHandle = Driver->extGlCreateShader(shaderType);
\r
331 Driver->extGlShaderSource(shaderHandle, 1, &shader, NULL);
\r
332 Driver->extGlCompileShader(shaderHandle);
\r
336 #ifdef GL_VERSION_2_0
\r
337 Driver->extGlGetShaderiv(shaderHandle, GL_COMPILE_STATUS, &status);
\r
340 if (status != GL_TRUE)
\r
342 core::stringc typeInfo("shaderType: ");
\r
343 typeInfo += core::stringc((unsigned long)shaderType);
\r
344 os::Printer::log("GLSL (> 2.x) shader failed to compile", typeInfo.c_str(), ELL_ERROR);
\r
345 // check error message and log it
\r
348 #ifdef GL_VERSION_2_0
\r
349 Driver->extGlGetShaderiv(shaderHandle, GL_INFO_LOG_LENGTH,
\r
354 GLchar *infoLog = new GLchar[maxLength];
\r
355 Driver->extGlGetShaderInfoLog(shaderHandle, maxLength, &length, infoLog);
\r
356 os::Printer::log(reinterpret_cast<const c8*>(infoLog), ELL_ERROR);
\r
363 Driver->extGlAttachShader(Program2, shaderHandle);
\r
367 GLhandleARB shaderHandle = Driver->extGlCreateShaderObject(shaderType);
\r
369 Driver->extGlShaderSourceARB(shaderHandle, 1, &shader, NULL);
\r
370 Driver->extGlCompileShaderARB(shaderHandle);
\r
374 #ifdef GL_ARB_shader_objects
\r
375 Driver->extGlGetObjectParameteriv(shaderHandle, GL_OBJECT_COMPILE_STATUS_ARB, &status);
\r
380 core::stringc typeInfo("shaderType: ");
\r
381 typeInfo += core::stringc((unsigned long)shaderType);
\r
382 os::Printer::log("GLSL shader failed to compile", typeInfo.c_str(), ELL_ERROR);
\r
383 // check error message and log it
\r
386 #ifdef GL_ARB_shader_objects
\r
387 Driver->extGlGetObjectParameteriv(shaderHandle,
\r
388 GL_OBJECT_INFO_LOG_LENGTH_ARB, &maxLength);
\r
392 GLcharARB *infoLog = new GLcharARB[maxLength];
\r
393 Driver->extGlGetInfoLog(shaderHandle, maxLength, &length, infoLog);
\r
394 os::Printer::log(reinterpret_cast<const c8*>(infoLog), ELL_ERROR);
\r
401 Driver->extGlAttachObject(Program, shaderHandle);
\r
407 bool COpenGLSLMaterialRenderer::linkProgram()
\r
411 Driver->extGlLinkProgram(Program2);
\r
415 #ifdef GL_VERSION_2_0
\r
416 Driver->extGlGetProgramiv(Program2, GL_LINK_STATUS, &status);
\r
421 os::Printer::log("GLSL (> 2.x) shader program failed to link", ELL_ERROR);
\r
422 // check error message and log it
\r
425 #ifdef GL_VERSION_2_0
\r
426 Driver->extGlGetProgramiv(Program2, GL_INFO_LOG_LENGTH, &maxLength);
\r
430 GLchar *infoLog = new GLchar[maxLength];
\r
431 Driver->extGlGetProgramInfoLog(Program2, maxLength, &length, infoLog);
\r
432 os::Printer::log(reinterpret_cast<const c8*>(infoLog), ELL_ERROR);
\r
439 // get uniforms information
\r
442 #ifdef GL_VERSION_2_0
\r
443 Driver->extGlGetProgramiv(Program2, GL_ACTIVE_UNIFORMS, &num);
\r
453 #ifdef GL_VERSION_2_0
\r
454 Driver->extGlGetProgramiv(Program2, GL_ACTIVE_UNIFORM_MAX_LENGTH, &maxlen);
\r
459 os::Printer::log("GLSL (> 2.x): failed to retrieve uniform information", ELL_ERROR);
\r
463 // seems that some implementations use an extra null terminator
\r
465 c8 *buf = new c8[maxlen];
\r
467 UniformInfo.clear();
\r
468 UniformInfo.reallocate(num);
\r
470 for (GLint i=0; i < num; ++i)
\r
473 memset(buf, 0, maxlen);
\r
476 Driver->extGlGetActiveUniform(Program2, i, maxlen, 0, &size, &ui.type, reinterpret_cast<GLchar*>(buf));
\r
478 ui.location = Driver->extGlGetUniformLocation(Program2, buf);
\r
480 UniformInfo.push_back(ui);
\r
487 Driver->extGlLinkProgramARB(Program);
\r
491 #ifdef GL_ARB_shader_objects
\r
492 Driver->extGlGetObjectParameteriv(Program, GL_OBJECT_LINK_STATUS_ARB, &status);
\r
497 os::Printer::log("GLSL shader program failed to link", ELL_ERROR);
\r
498 // check error message and log it
\r
501 #ifdef GL_ARB_shader_objects
\r
502 Driver->extGlGetObjectParameteriv(Program,
\r
503 GL_OBJECT_INFO_LOG_LENGTH_ARB, &maxLength);
\r
507 GLcharARB *infoLog = new GLcharARB[maxLength];
\r
508 Driver->extGlGetInfoLog(Program, maxLength, &length, infoLog);
\r
509 os::Printer::log(reinterpret_cast<const c8*>(infoLog), ELL_ERROR);
\r
516 // get uniforms information
\r
519 #ifdef GL_ARB_shader_objects
\r
520 Driver->extGlGetObjectParameteriv(Program, GL_OBJECT_ACTIVE_UNIFORMS_ARB, &num);
\r
530 #ifdef GL_ARB_shader_objects
\r
531 Driver->extGlGetObjectParameteriv(Program, GL_OBJECT_ACTIVE_UNIFORM_MAX_LENGTH_ARB, &maxlen);
\r
536 os::Printer::log("GLSL: failed to retrieve uniform information", ELL_ERROR);
\r
540 // seems that some implementations use an extra null terminator
\r
542 c8 *buf = new c8[maxlen];
\r
544 UniformInfo.clear();
\r
545 UniformInfo.reallocate(num);
\r
547 for (int i=0; i < num; ++i)
\r
550 memset(buf, 0, maxlen);
\r
553 Driver->extGlGetActiveUniformARB(Program, i, maxlen, 0, &size, &ui.type, reinterpret_cast<GLcharARB*>(buf));
\r
555 ui.location = Driver->extGlGetUniformLocationARB(Program, buf);
\r
557 UniformInfo.push_back(ui);
\r
567 void COpenGLSLMaterialRenderer::setBasicRenderStates(const SMaterial& material,
\r
568 const SMaterial& lastMaterial,
\r
569 bool resetAllRenderstates)
\r
572 Driver->setBasicRenderStates(material, lastMaterial, resetAllRenderstates);
\r
575 s32 COpenGLSLMaterialRenderer::getVertexShaderConstantID(const c8* name)
\r
577 return getPixelShaderConstantID(name);
\r
580 s32 COpenGLSLMaterialRenderer::getPixelShaderConstantID(const c8* name)
\r
582 for (u32 i = 0; i < UniformInfo.size(); ++i)
\r
584 if (UniformInfo[i].name == name)
\r
591 void COpenGLSLMaterialRenderer::setVertexShaderConstant(const f32* data, s32 startRegister, s32 constantAmount)
\r
593 os::Printer::log("Cannot set constant, please use high level shader call instead.", ELL_WARNING);
\r
596 void COpenGLSLMaterialRenderer::setPixelShaderConstant(const f32* data, s32 startRegister, s32 constantAmount)
\r
598 os::Printer::log("Cannot set constant, use high level shader call.", ELL_WARNING);
\r
601 bool COpenGLSLMaterialRenderer::setVertexShaderConstant(s32 index, const f32* floats, int count)
\r
603 return setPixelShaderConstant(index, floats, count);
\r
606 bool COpenGLSLMaterialRenderer::setVertexShaderConstant(s32 index, const s32* ints, int count)
\r
608 return setPixelShaderConstant(index, ints, count);
\r
611 bool COpenGLSLMaterialRenderer::setPixelShaderConstant(s32 index, const f32* floats, int count)
\r
613 #ifdef GL_ARB_shader_objects
\r
614 if(index < 0 || UniformInfo[index].location < 0)
\r
617 bool status = true;
\r
619 switch (UniformInfo[index].type)
\r
622 Driver->extGlUniform1fv(UniformInfo[index].location, count, floats);
\r
624 case GL_FLOAT_VEC2:
\r
625 Driver->extGlUniform2fv(UniformInfo[index].location, count/2, floats);
\r
627 case GL_FLOAT_VEC3:
\r
628 Driver->extGlUniform3fv(UniformInfo[index].location, count/3, floats);
\r
630 case GL_FLOAT_VEC4:
\r
631 Driver->extGlUniform4fv(UniformInfo[index].location, count/4, floats);
\r
633 case GL_FLOAT_MAT2:
\r
634 Driver->extGlUniformMatrix2fv(UniformInfo[index].location, count/4, false, floats);
\r
636 case GL_FLOAT_MAT2x3:
\r
637 Driver->extGlUniformMatrix2x3fv(UniformInfo[index].location, count/6, false, floats);
\r
639 case GL_FLOAT_MAT2x4:
\r
640 Driver->extGlUniformMatrix2x4fv(UniformInfo[index].location, count/8, false, floats);
\r
642 case GL_FLOAT_MAT3x2:
\r
643 Driver->extGlUniformMatrix3x2fv(UniformInfo[index].location, count/6, false, floats);
\r
645 case GL_FLOAT_MAT3:
\r
646 Driver->extGlUniformMatrix3fv(UniformInfo[index].location, count/9, false, floats);
\r
648 case GL_FLOAT_MAT3x4:
\r
649 Driver->extGlUniformMatrix3x4fv(UniformInfo[index].location, count/12, false, floats);
\r
651 case GL_FLOAT_MAT4x2:
\r
652 Driver->extGlUniformMatrix4x2fv(UniformInfo[index].location, count/8, false, floats);
\r
654 case GL_FLOAT_MAT4x3:
\r
655 Driver->extGlUniformMatrix4x3fv(UniformInfo[index].location, count/12, false, floats);
\r
657 case GL_FLOAT_MAT4:
\r
658 Driver->extGlUniformMatrix4fv(UniformInfo[index].location, count/16, false, floats);
\r
660 case GL_SAMPLER_1D:
\r
661 case GL_SAMPLER_2D:
\r
662 case GL_SAMPLER_3D:
\r
663 case GL_SAMPLER_CUBE:
\r
664 case GL_SAMPLER_1D_SHADOW:
\r
665 case GL_SAMPLER_2D_SHADOW:
\r
669 const GLint id = static_cast<GLint>(*floats);
\r
670 Driver->extGlUniform1iv(UniformInfo[index].location, 1, &id);
\r
686 bool COpenGLSLMaterialRenderer::setPixelShaderConstant(s32 index, const s32* ints, int count)
\r
688 #ifdef GL_ARB_shader_objects
\r
689 if(index < 0 || UniformInfo[index].location < 0)
\r
692 bool status = true;
\r
694 switch (UniformInfo[index].type)
\r
698 Driver->extGlUniform1iv(UniformInfo[index].location, count, reinterpret_cast<const GLint*>(ints));
\r
702 Driver->extGlUniform2iv(UniformInfo[index].location, count/2, reinterpret_cast<const GLint*>(ints));
\r
706 Driver->extGlUniform3iv(UniformInfo[index].location, count/3, reinterpret_cast<const GLint*>(ints));
\r
710 Driver->extGlUniform4iv(UniformInfo[index].location, count/4, reinterpret_cast<const GLint*>(ints));
\r
712 case GL_SAMPLER_1D:
\r
713 case GL_SAMPLER_2D:
\r
714 case GL_SAMPLER_3D:
\r
715 case GL_SAMPLER_CUBE:
\r
716 case GL_SAMPLER_1D_SHADOW:
\r
717 case GL_SAMPLER_2D_SHADOW:
\r
718 Driver->extGlUniform1iv(UniformInfo[index].location, 1, reinterpret_cast<const GLint*>(ints));
\r
730 IVideoDriver* COpenGLSLMaterialRenderer::getVideoDriver()
\r
735 } // end namespace video
\r
736 } // end namespace irr
\r