1 // Copyright (C) 2015 Patryk Nadrowski
\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 #ifndef __C_OGLCORE_CACHE_HANDLER_H_INCLUDED__
\r
6 #define __C_OGLCORE_CACHE_HANDLER_H_INCLUDED__
\r
9 #include "SMaterial.h"
\r
10 #include "ITexture.h"
\r
17 enum ESetTextureActive
\r
19 EST_ACTIVE_ALWAYS, // texture unit always active after set call
\r
20 EST_ACTIVE_ON_CHANGE // texture unit only active after call when texture changed in cache
\r
24 template <class TOpenGLDriver, class TOpenGLTexture>
\r
25 class COpenGLCoreCacheHandler
\r
30 STextureCache(COpenGLCoreCacheHandler& cacheHandler, E_DRIVER_TYPE driverType, u32 textureCount) :
\r
31 CacheHandler(cacheHandler), DriverType(driverType), TextureCount(textureCount)
\r
33 for (u32 i = 0; i < MATERIAL_MAX_TEXTURES; ++i)
\r
44 const TOpenGLTexture* operator[](int index) const
\r
46 if (static_cast<u32>(index) < MATERIAL_MAX_TEXTURES)
\r
47 return Texture[static_cast<u32>(index)];
\r
52 const TOpenGLTexture* get(u32 index) const
\r
54 if (index < MATERIAL_MAX_TEXTURES)
\r
55 return Texture[index];
\r
60 bool set(u32 index, const ITexture* texture, ESetTextureActive esa=EST_ACTIVE_ALWAYS)
\r
62 bool status = false;
\r
64 E_DRIVER_TYPE type = DriverType;
\r
66 if (index < MATERIAL_MAX_TEXTURES && index < TextureCount)
\r
68 if ( esa == EST_ACTIVE_ALWAYS )
\r
69 CacheHandler.setActiveTexture(GL_TEXTURE0 + index);
\r
71 const TOpenGLTexture* prevTexture = Texture[index];
\r
73 if (texture != prevTexture)
\r
75 if ( esa == EST_ACTIVE_ON_CHANGE )
\r
76 CacheHandler.setActiveTexture(GL_TEXTURE0 + index);
\r
80 type = texture->getDriverType();
\r
82 if (type == DriverType)
\r
86 const TOpenGLTexture* curTexture = static_cast<const TOpenGLTexture*>(texture);
\r
87 const GLenum curTextureType = curTexture->getOpenGLTextureType();
\r
88 const GLenum prevTextureType = (prevTexture) ? prevTexture->getOpenGLTextureType() : curTextureType;
\r
90 if (curTextureType != prevTextureType)
\r
92 glBindTexture(prevTextureType, 0);
\r
94 #if ( defined(IRR_COMPILE_GL_COMMON) || defined(IRR_COMPILE_GLES_COMMON) )
\r
95 glDisable(prevTextureType);
\r
96 glEnable(curTextureType);
\r
99 #if ( defined(IRR_COMPILE_GL_COMMON) || defined(IRR_COMPILE_GLES_COMMON) )
\r
100 else if (!prevTexture)
\r
101 glEnable(curTextureType);
\r
104 glBindTexture(curTextureType, static_cast<const TOpenGLTexture*>(texture)->getOpenGLTextureName());
\r
110 os::Printer::log("Fatal Error: Tried to set a texture not owned by this driver.", ELL_ERROR);
\r
111 os::Printer::log("Texture type", irr::core::stringc((int)type), ELL_ERROR);
\r
112 os::Printer::log("Driver (or cache handler) type", irr::core::stringc((int)DriverType), ELL_ERROR);
\r
116 if (!texture && prevTexture)
\r
118 const GLenum prevTextureType = prevTexture->getOpenGLTextureType();
\r
120 glBindTexture(prevTextureType, 0);
\r
122 #if ( defined(IRR_COMPILE_GL_COMMON) || defined(IRR_COMPILE_GLES_COMMON) )
\r
123 glDisable(prevTextureType);
\r
127 Texture[index] = static_cast<const TOpenGLTexture*>(texture);
\r
130 prevTexture->drop();
\r
136 return (status && type == DriverType);
\r
139 void remove(ITexture* texture)
\r
144 for (u32 i = 0; i < MATERIAL_MAX_TEXTURES; ++i)
\r
146 if (Texture[i] == texture)
\r
157 for (u32 i = 0; i < MATERIAL_MAX_TEXTURES; ++i)
\r
161 const TOpenGLTexture* prevTexture = Texture[i];
\r
165 prevTexture->drop();
\r
171 COpenGLCoreCacheHandler& CacheHandler;
\r
173 E_DRIVER_TYPE DriverType;
\r
175 const TOpenGLTexture* Texture[MATERIAL_MAX_TEXTURES];
\r
180 COpenGLCoreCacheHandler(TOpenGLDriver* driver) :
\r
182 #if defined(_MSC_VER)
\r
183 #pragma warning(push)
\r
184 #pragma warning(disable: 4355) // Warning: "'this' : used in base member initializer list. ". It's OK, we don't use the reference in STextureCache constructor.
\r
186 TextureCache(STextureCache(*this, driver->getDriverType(), driver->getFeature().MaxTextureUnits)),
\r
187 #if defined(_MSC_VER)
\r
188 #pragma warning(pop)
\r
190 FrameBufferCount(0), BlendEquation(0), BlendSourceRGB(0),
\r
191 BlendDestinationRGB(0), BlendSourceAlpha(0), BlendDestinationAlpha(0), Blend(0), BlendEquationInvalid(false), BlendFuncInvalid(false), BlendInvalid(false),
\r
192 ColorMask(0), ColorMaskInvalid(false), CullFaceMode(GL_BACK), CullFace(false), DepthFunc(GL_LESS), DepthMask(true), DepthTest(false), FrameBufferID(0),
\r
193 ProgramID(0), ActiveTexture(GL_TEXTURE0), ViewportX(0), ViewportY(0)
\r
195 const COpenGLCoreFeature& feature = Driver->getFeature();
\r
197 FrameBufferCount = core::max_(static_cast<GLuint>(1), static_cast<GLuint>(feature.MultipleRenderTarget));
\r
199 BlendEquation = new GLenum[FrameBufferCount];
\r
200 BlendSourceRGB = new GLenum[FrameBufferCount];
\r
201 BlendDestinationRGB = new GLenum[FrameBufferCount];
\r
202 BlendSourceAlpha = new GLenum[FrameBufferCount];
\r
203 BlendDestinationAlpha = new GLenum[FrameBufferCount];
\r
204 Blend = new bool[FrameBufferCount];
\r
205 ColorMask = new u8[FrameBufferCount];
\r
207 // Initial OpenGL values from specification.
\r
209 if (feature.BlendOperation)
\r
211 Driver->irrGlBlendEquation(GL_FUNC_ADD);
\r
214 for (u32 i = 0; i < FrameBufferCount; ++i)
\r
216 BlendEquation[i] = GL_FUNC_ADD;
\r
218 BlendSourceRGB[i] = GL_ONE;
\r
219 BlendDestinationRGB[i] = GL_ZERO;
\r
220 BlendSourceAlpha[i] = GL_ONE;
\r
221 BlendDestinationAlpha[i] = GL_ZERO;
\r
224 ColorMask[i] = ECP_ALL;
\r
227 glBlendFunc(GL_ONE, GL_ZERO);
\r
228 glDisable(GL_BLEND);
\r
230 glColorMask(GL_TRUE, GL_TRUE, GL_TRUE, GL_TRUE);
\r
232 glCullFace(CullFaceMode);
\r
233 glDisable(GL_CULL_FACE);
\r
235 glDepthFunc(DepthFunc);
\r
236 glDepthMask(GL_TRUE);
\r
237 glDisable(GL_DEPTH_TEST);
\r
239 Driver->irrGlActiveTexture(ActiveTexture);
\r
241 #if ( defined(IRR_COMPILE_GL_COMMON) || defined(IRR_COMPILE_GLES_COMMON) )
\r
242 glDisable(GL_TEXTURE_2D);
\r
245 const core::dimension2d<u32> ScreenSize = Driver->getScreenSize();
\r
246 ViewportWidth = ScreenSize.Width;
\r
247 ViewportHeight = ScreenSize.Height;
\r
248 glViewport(ViewportX, ViewportY, ViewportWidth, ViewportHeight);
\r
251 virtual ~COpenGLCoreCacheHandler()
\r
253 delete[] BlendEquation;
\r
254 delete[] BlendSourceRGB;
\r
255 delete[] BlendDestinationRGB;
\r
256 delete[] BlendSourceAlpha;
\r
257 delete[] BlendDestinationAlpha;
\r
260 delete[] ColorMask;
\r
263 E_DRIVER_TYPE getDriverType() const
\r
265 return Driver->getDriverType();
\r
268 STextureCache& getTextureCache()
\r
270 return TextureCache;
\r
275 void setBlendEquation(GLenum mode)
\r
277 if (BlendEquation[0] != mode || BlendEquationInvalid)
\r
279 Driver->irrGlBlendEquation(mode);
\r
281 for (GLuint i = 0; i < FrameBufferCount; ++i)
\r
282 BlendEquation[i] = mode;
\r
284 BlendEquationInvalid = false;
\r
288 void setBlendEquationIndexed(GLuint index, GLenum mode)
\r
290 if (index < FrameBufferCount && BlendEquation[index] != mode)
\r
292 Driver->irrGlBlendEquationIndexed(index, mode);
\r
294 BlendEquation[index] = mode;
\r
295 BlendEquationInvalid = true;
\r
299 void setBlendFunc(GLenum source, GLenum destination)
\r
301 if (BlendSourceRGB[0] != source || BlendDestinationRGB[0] != destination ||
\r
302 BlendSourceAlpha[0] != source || BlendDestinationAlpha[0] != destination ||
\r
305 glBlendFunc(source, destination);
\r
307 for (GLuint i = 0; i < FrameBufferCount; ++i)
\r
309 BlendSourceRGB[i] = source;
\r
310 BlendDestinationRGB[i] = destination;
\r
311 BlendSourceAlpha[i] = source;
\r
312 BlendDestinationAlpha[i] = destination;
\r
315 BlendFuncInvalid = false;
\r
319 void setBlendFuncSeparate(GLenum sourceRGB, GLenum destinationRGB, GLenum sourceAlpha, GLenum destinationAlpha)
\r
321 if (sourceRGB != sourceAlpha || destinationRGB != destinationAlpha)
\r
323 if (BlendSourceRGB[0] != sourceRGB || BlendDestinationRGB[0] != destinationRGB ||
\r
324 BlendSourceAlpha[0] != sourceAlpha || BlendDestinationAlpha[0] != destinationAlpha ||
\r
327 Driver->irrGlBlendFuncSeparate(sourceRGB, destinationRGB, sourceAlpha, destinationAlpha);
\r
329 for (GLuint i = 0; i < FrameBufferCount; ++i)
\r
331 BlendSourceRGB[i] = sourceRGB;
\r
332 BlendDestinationRGB[i] = destinationRGB;
\r
333 BlendSourceAlpha[i] = sourceAlpha;
\r
334 BlendDestinationAlpha[i] = destinationAlpha;
\r
337 BlendFuncInvalid = false;
\r
342 setBlendFunc(sourceRGB, destinationRGB);
\r
346 void setBlendFuncIndexed(GLuint index, GLenum source, GLenum destination)
\r
348 if (index < FrameBufferCount && (BlendSourceRGB[index] != source || BlendDestinationRGB[index] != destination ||
\r
349 BlendSourceAlpha[index] != source || BlendDestinationAlpha[index] != destination))
\r
351 Driver->irrGlBlendFuncIndexed(index, source, destination);
\r
353 BlendSourceRGB[index] = source;
\r
354 BlendDestinationRGB[index] = destination;
\r
355 BlendSourceAlpha[index] = source;
\r
356 BlendDestinationAlpha[index] = destination;
\r
357 BlendFuncInvalid = true;
\r
361 void setBlendFuncSeparateIndexed(GLuint index, GLenum sourceRGB, GLenum destinationRGB, GLenum sourceAlpha, GLenum destinationAlpha)
\r
363 if (sourceRGB != sourceAlpha || destinationRGB != destinationAlpha)
\r
365 if (index < FrameBufferCount && (BlendSourceRGB[index] != sourceRGB || BlendDestinationRGB[index] != destinationRGB ||
\r
366 BlendSourceAlpha[index] != sourceAlpha || BlendDestinationAlpha[index] != destinationAlpha))
\r
368 Driver->irrGlBlendFuncSeparateIndexed(index, sourceRGB, destinationRGB, sourceAlpha, destinationAlpha);
\r
370 BlendSourceRGB[index] = sourceRGB;
\r
371 BlendDestinationRGB[index] = destinationRGB;
\r
372 BlendSourceAlpha[index] = sourceAlpha;
\r
373 BlendDestinationAlpha[index] = destinationAlpha;
\r
374 BlendFuncInvalid = true;
\r
379 setBlendFuncIndexed(index, sourceRGB, destinationRGB);
\r
383 void setBlend(bool enable)
\r
385 if (Blend[0] != enable || BlendInvalid)
\r
388 glEnable(GL_BLEND);
\r
390 glDisable(GL_BLEND);
\r
392 for (GLuint i = 0; i < FrameBufferCount; ++i)
\r
395 BlendInvalid = false;
\r
399 void setBlendIndexed(GLuint index, bool enable)
\r
401 if (index < FrameBufferCount && Blend[index] != enable)
\r
404 Driver->irrGlEnableIndexed(GL_BLEND, index);
\r
406 Driver->irrGlDisableIndexed(GL_BLEND, index);
\r
408 Blend[index] = enable;
\r
409 BlendInvalid = true;
\r
415 void getColorMask(u8& mask)
\r
417 mask = ColorMask[0];
\r
420 void setColorMask(u8 mask)
\r
422 if (ColorMask[0] != mask || ColorMaskInvalid)
\r
424 glColorMask((mask & ECP_RED) ? GL_TRUE : GL_FALSE, (mask & ECP_GREEN) ? GL_TRUE : GL_FALSE, (mask & ECP_BLUE) ? GL_TRUE : GL_FALSE, (mask & ECP_ALPHA) ? GL_TRUE : GL_FALSE);
\r
426 for (GLuint i = 0; i < FrameBufferCount; ++i)
\r
427 ColorMask[i] = mask;
\r
429 ColorMaskInvalid = false;
\r
433 void setColorMaskIndexed(GLuint index, u8 mask)
\r
435 if (index < FrameBufferCount && ColorMask[index] != mask)
\r
437 Driver->irrGlColorMaskIndexed(index, (mask & ECP_RED) ? GL_TRUE : GL_FALSE, (mask & ECP_GREEN) ? GL_TRUE : GL_FALSE, (mask & ECP_BLUE) ? GL_TRUE : GL_FALSE, (mask & ECP_ALPHA) ? GL_TRUE : GL_FALSE);
\r
439 ColorMask[index] = mask;
\r
440 ColorMaskInvalid = true;
\r
444 // Cull face calls.
\r
446 void setCullFaceFunc(GLenum mode)
\r
448 if (CullFaceMode != mode)
\r
451 CullFaceMode = mode;
\r
455 void setCullFace(bool enable)
\r
457 if (CullFace != enable)
\r
460 glEnable(GL_CULL_FACE);
\r
462 glDisable(GL_CULL_FACE);
\r
470 void setDepthFunc(GLenum mode)
\r
472 if (DepthFunc != mode)
\r
479 void getDepthMask(bool& depth)
\r
484 void setDepthMask(bool enable)
\r
486 if (DepthMask != enable)
\r
489 glDepthMask(GL_TRUE);
\r
491 glDepthMask(GL_FALSE);
\r
493 DepthMask = enable;
\r
497 void getDepthTest(bool& enable)
\r
499 enable = DepthTest;
\r
502 void setDepthTest(bool enable)
\r
504 if (DepthTest != enable)
\r
507 glEnable(GL_DEPTH_TEST);
\r
509 glDisable(GL_DEPTH_TEST);
\r
511 DepthTest = enable;
\r
517 void getFBO(GLuint& frameBufferID) const
\r
519 frameBufferID = FrameBufferID;
\r
522 void setFBO(GLuint frameBufferID)
\r
524 if (FrameBufferID != frameBufferID)
\r
526 Driver->irrGlBindFramebuffer(GL_FRAMEBUFFER, frameBufferID);
\r
527 FrameBufferID = frameBufferID;
\r
533 void getProgram(GLuint& programID) const
\r
535 programID = ProgramID;
\r
538 void setProgram(GLuint programID)
\r
540 if (ProgramID != programID)
\r
542 Driver->irrGlUseProgram(programID);
\r
543 ProgramID = programID;
\r
549 void getActiveTexture(GLenum& texture) const
\r
551 texture = ActiveTexture;
\r
554 void setActiveTexture(GLenum texture)
\r
556 if (ActiveTexture != texture)
\r
558 Driver->irrGlActiveTexture(texture);
\r
559 ActiveTexture = texture;
\r
565 void getViewport(GLint& viewportX, GLint& viewportY, GLsizei& viewportWidth, GLsizei& viewportHeight) const
\r
567 viewportX = ViewportX;
\r
568 viewportY = ViewportY;
\r
569 viewportWidth = ViewportWidth;
\r
570 viewportHeight = ViewportHeight;
\r
573 void setViewport(GLint viewportX, GLint viewportY, GLsizei viewportWidth, GLsizei viewportHeight)
\r
575 if (ViewportX != viewportX || ViewportY != viewportY || ViewportWidth != viewportWidth || ViewportHeight != viewportHeight)
\r
577 glViewport(viewportX, viewportY, viewportWidth, viewportHeight);
\r
578 ViewportX = viewportX;
\r
579 ViewportY = viewportY;
\r
580 ViewportWidth = viewportWidth;
\r
581 ViewportHeight = viewportHeight;
\r
585 //! Compare material to current cache and update it when there are differences
\r
586 // Some material renderers do change the cache beyond the original material settings
\r
587 // This corrects the material to represent the current cache state again.
\r
588 void correctCacheMaterial(irr::video::SMaterial& material)
\r
590 // Fix textures which got removed
\r
591 for ( u32 i=0; i < MATERIAL_MAX_TEXTURES; ++i )
\r
593 if ( material.TextureLayer[i].Texture && !TextureCache[i] )
\r
595 material.TextureLayer[i].Texture = 0;
\r
601 TOpenGLDriver* Driver;
\r
603 STextureCache TextureCache;
\r
605 GLuint FrameBufferCount;
\r
607 GLenum* BlendEquation;
\r
608 GLenum* BlendSourceRGB;
\r
609 GLenum* BlendDestinationRGB;
\r
610 GLenum* BlendSourceAlpha;
\r
611 GLenum* BlendDestinationAlpha;
\r
613 bool BlendEquationInvalid;
\r
614 bool BlendFuncInvalid;
\r
619 bool ColorMaskInvalid;
\r
621 GLenum CullFaceMode;
\r
628 GLuint FrameBufferID;
\r
632 GLenum ActiveTexture;
\r
636 GLsizei ViewportWidth;
\r
637 GLsizei ViewportHeight;
\r