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 #if defined(_IRR_COMPILE_WITH_OPENGL_) || defined(_IRR_COMPILE_WITH_OGLES1_) || defined(_IRR_COMPILE_WITH_OGLES2_)
\r
11 #include "SMaterial.h"
\r
12 #include "ITexture.h"
\r
19 enum ESetTextureActive
\r
21 EST_ACTIVE_ALWAYS, // texture unit always active after set call
\r
22 EST_ACTIVE_ON_CHANGE // texture unit only active after call when texture changed in cache
\r
26 template <class TOpenGLDriver, class TOpenGLTexture>
\r
27 class COpenGLCoreCacheHandler
\r
32 STextureCache(COpenGLCoreCacheHandler& cacheHandler, E_DRIVER_TYPE driverType, u32 textureCount) :
\r
33 CacheHandler(cacheHandler), DriverType(driverType), TextureCount(textureCount)
\r
35 for (u32 i = 0; i < MATERIAL_MAX_TEXTURES; ++i)
\r
46 const TOpenGLTexture* operator[](int index) const
\r
48 if (static_cast<u32>(index) < MATERIAL_MAX_TEXTURES)
\r
49 return Texture[static_cast<u32>(index)];
\r
54 const TOpenGLTexture* get(u32 index) const
\r
56 if (index < MATERIAL_MAX_TEXTURES)
\r
57 return Texture[index];
\r
62 bool set(u32 index, const ITexture* texture, ESetTextureActive esa=EST_ACTIVE_ALWAYS)
\r
64 bool status = false;
\r
66 E_DRIVER_TYPE type = DriverType;
\r
68 if (index < MATERIAL_MAX_TEXTURES && index < TextureCount)
\r
70 if ( esa == EST_ACTIVE_ALWAYS )
\r
71 CacheHandler.setActiveTexture(GL_TEXTURE0 + index);
\r
73 const TOpenGLTexture* prevTexture = Texture[index];
\r
75 if (texture != prevTexture)
\r
77 if ( esa == EST_ACTIVE_ON_CHANGE )
\r
78 CacheHandler.setActiveTexture(GL_TEXTURE0 + index);
\r
82 type = texture->getDriverType();
\r
84 if (type == DriverType)
\r
88 const TOpenGLTexture* curTexture = static_cast<const TOpenGLTexture*>(texture);
\r
89 const GLenum curTextureType = curTexture->getOpenGLTextureType();
\r
90 const GLenum prevTextureType = (prevTexture) ? prevTexture->getOpenGLTextureType() : curTextureType;
\r
92 if (curTextureType != prevTextureType)
\r
94 glBindTexture(prevTextureType, 0);
\r
96 #if ( defined(IRR_COMPILE_GL_COMMON) || defined(IRR_COMPILE_GLES_COMMON) )
\r
97 glDisable(prevTextureType);
\r
98 glEnable(curTextureType);
\r
101 #if ( defined(IRR_COMPILE_GL_COMMON) || defined(IRR_COMPILE_GLES_COMMON) )
\r
102 else if (!prevTexture)
\r
103 glEnable(curTextureType);
\r
106 glBindTexture(curTextureType, static_cast<const TOpenGLTexture*>(texture)->getOpenGLTextureName());
\r
112 os::Printer::log("Fatal Error: Tried to set a texture not owned by this driver.", ELL_ERROR);
\r
113 os::Printer::log("Texture type", irr::core::stringc((int)type), ELL_ERROR);
\r
114 os::Printer::log("Driver (or cache handler) type", irr::core::stringc((int)DriverType), ELL_ERROR);
\r
118 if (!texture && prevTexture)
\r
120 const GLenum prevTextureType = prevTexture->getOpenGLTextureType();
\r
122 glBindTexture(prevTextureType, 0);
\r
124 #if ( defined(IRR_COMPILE_GL_COMMON) || defined(IRR_COMPILE_GLES_COMMON) )
\r
125 glDisable(prevTextureType);
\r
129 Texture[index] = static_cast<const TOpenGLTexture*>(texture);
\r
132 prevTexture->drop();
\r
138 return (status && type == DriverType);
\r
141 void remove(ITexture* texture)
\r
146 for (u32 i = 0; i < MATERIAL_MAX_TEXTURES; ++i)
\r
148 if (Texture[i] == texture)
\r
159 for (u32 i = 0; i < MATERIAL_MAX_TEXTURES; ++i)
\r
163 const TOpenGLTexture* prevTexture = Texture[i];
\r
167 prevTexture->drop();
\r
173 COpenGLCoreCacheHandler& CacheHandler;
\r
175 E_DRIVER_TYPE DriverType;
\r
177 const TOpenGLTexture* Texture[MATERIAL_MAX_TEXTURES];
\r
182 COpenGLCoreCacheHandler(TOpenGLDriver* driver) :
\r
184 #if defined(_MSC_VER)
\r
185 #pragma warning(push)
\r
186 #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
188 TextureCache(STextureCache(*this, driver->getDriverType(), driver->getFeature().MaxTextureUnits)),
\r
189 #if defined(_MSC_VER)
\r
190 #pragma warning(pop)
\r
192 FrameBufferCount(0), BlendEquation(0), BlendSourceRGB(0),
\r
193 BlendDestinationRGB(0), BlendSourceAlpha(0), BlendDestinationAlpha(0), Blend(0), BlendEquationInvalid(false), BlendFuncInvalid(false), BlendInvalid(false),
\r
194 ColorMask(0), ColorMaskInvalid(false), CullFaceMode(GL_BACK), CullFace(false), DepthFunc(GL_LESS), DepthMask(true), DepthTest(false), FrameBufferID(0),
\r
195 ProgramID(0), ActiveTexture(GL_TEXTURE0), ViewportX(0), ViewportY(0)
\r
197 const COpenGLCoreFeature& feature = Driver->getFeature();
\r
199 FrameBufferCount = core::max_(static_cast<GLuint>(1), static_cast<GLuint>(feature.MultipleRenderTarget));
\r
201 BlendEquation = new GLenum[FrameBufferCount];
\r
202 BlendSourceRGB = new GLenum[FrameBufferCount];
\r
203 BlendDestinationRGB = new GLenum[FrameBufferCount];
\r
204 BlendSourceAlpha = new GLenum[FrameBufferCount];
\r
205 BlendDestinationAlpha = new GLenum[FrameBufferCount];
\r
206 Blend = new bool[FrameBufferCount];
\r
207 ColorMask = new u8[FrameBufferCount];
\r
209 // Initial OpenGL values from specification.
\r
211 if (feature.BlendOperation)
\r
213 Driver->irrGlBlendEquation(GL_FUNC_ADD);
\r
216 for (u32 i = 0; i < FrameBufferCount; ++i)
\r
218 BlendEquation[i] = GL_FUNC_ADD;
\r
220 BlendSourceRGB[i] = GL_ONE;
\r
221 BlendDestinationRGB[i] = GL_ZERO;
\r
222 BlendSourceAlpha[i] = GL_ONE;
\r
223 BlendDestinationAlpha[i] = GL_ZERO;
\r
226 ColorMask[i] = ECP_ALL;
\r
229 glBlendFunc(GL_ONE, GL_ZERO);
\r
230 glDisable(GL_BLEND);
\r
232 glColorMask(GL_TRUE, GL_TRUE, GL_TRUE, GL_TRUE);
\r
234 glCullFace(CullFaceMode);
\r
235 glDisable(GL_CULL_FACE);
\r
237 glDepthFunc(DepthFunc);
\r
238 glDepthMask(GL_TRUE);
\r
239 glDisable(GL_DEPTH_TEST);
\r
241 Driver->irrGlActiveTexture(ActiveTexture);
\r
243 #if ( defined(IRR_COMPILE_GL_COMMON) || defined(IRR_COMPILE_GLES_COMMON) )
\r
244 glDisable(GL_TEXTURE_2D);
\r
247 const core::dimension2d<u32> ScreenSize = Driver->getScreenSize();
\r
248 ViewportWidth = ScreenSize.Width;
\r
249 ViewportHeight = ScreenSize.Height;
\r
250 glViewport(ViewportX, ViewportY, ViewportWidth, ViewportHeight);
\r
253 virtual ~COpenGLCoreCacheHandler()
\r
255 delete[] BlendEquation;
\r
256 delete[] BlendSourceRGB;
\r
257 delete[] BlendDestinationRGB;
\r
258 delete[] BlendSourceAlpha;
\r
259 delete[] BlendDestinationAlpha;
\r
262 delete[] ColorMask;
\r
265 E_DRIVER_TYPE getDriverType() const
\r
267 return Driver->getDriverType();
\r
270 STextureCache& getTextureCache()
\r
272 return TextureCache;
\r
277 void setBlendEquation(GLenum mode)
\r
279 if (BlendEquation[0] != mode || BlendEquationInvalid)
\r
281 Driver->irrGlBlendEquation(mode);
\r
283 for (GLuint i = 0; i < FrameBufferCount; ++i)
\r
284 BlendEquation[i] = mode;
\r
286 BlendEquationInvalid = false;
\r
290 void setBlendEquationIndexed(GLuint index, GLenum mode)
\r
292 if (index < FrameBufferCount && BlendEquation[index] != mode)
\r
294 Driver->irrGlBlendEquationIndexed(index, mode);
\r
296 BlendEquation[index] = mode;
\r
297 BlendEquationInvalid = true;
\r
301 void setBlendFunc(GLenum source, GLenum destination)
\r
303 if (BlendSourceRGB[0] != source || BlendDestinationRGB[0] != destination ||
\r
304 BlendSourceAlpha[0] != source || BlendDestinationAlpha[0] != destination ||
\r
307 glBlendFunc(source, destination);
\r
309 for (GLuint i = 0; i < FrameBufferCount; ++i)
\r
311 BlendSourceRGB[i] = source;
\r
312 BlendDestinationRGB[i] = destination;
\r
313 BlendSourceAlpha[i] = source;
\r
314 BlendDestinationAlpha[i] = destination;
\r
317 BlendFuncInvalid = false;
\r
321 void setBlendFuncSeparate(GLenum sourceRGB, GLenum destinationRGB, GLenum sourceAlpha, GLenum destinationAlpha)
\r
323 if (sourceRGB != sourceAlpha || destinationRGB != destinationAlpha)
\r
325 if (BlendSourceRGB[0] != sourceRGB || BlendDestinationRGB[0] != destinationRGB ||
\r
326 BlendSourceAlpha[0] != sourceAlpha || BlendDestinationAlpha[0] != destinationAlpha ||
\r
329 Driver->irrGlBlendFuncSeparate(sourceRGB, destinationRGB, sourceAlpha, destinationAlpha);
\r
331 for (GLuint i = 0; i < FrameBufferCount; ++i)
\r
333 BlendSourceRGB[i] = sourceRGB;
\r
334 BlendDestinationRGB[i] = destinationRGB;
\r
335 BlendSourceAlpha[i] = sourceAlpha;
\r
336 BlendDestinationAlpha[i] = destinationAlpha;
\r
339 BlendFuncInvalid = false;
\r
344 setBlendFunc(sourceRGB, destinationRGB);
\r
348 void setBlendFuncIndexed(GLuint index, GLenum source, GLenum destination)
\r
350 if (index < FrameBufferCount && (BlendSourceRGB[index] != source || BlendDestinationRGB[index] != destination ||
\r
351 BlendSourceAlpha[index] != source || BlendDestinationAlpha[index] != destination))
\r
353 Driver->irrGlBlendFuncIndexed(index, source, destination);
\r
355 BlendSourceRGB[index] = source;
\r
356 BlendDestinationRGB[index] = destination;
\r
357 BlendSourceAlpha[index] = source;
\r
358 BlendDestinationAlpha[index] = destination;
\r
359 BlendFuncInvalid = true;
\r
363 void setBlendFuncSeparateIndexed(GLuint index, GLenum sourceRGB, GLenum destinationRGB, GLenum sourceAlpha, GLenum destinationAlpha)
\r
365 if (sourceRGB != sourceAlpha || destinationRGB != destinationAlpha)
\r
367 if (index < FrameBufferCount && (BlendSourceRGB[index] != sourceRGB || BlendDestinationRGB[index] != destinationRGB ||
\r
368 BlendSourceAlpha[index] != sourceAlpha || BlendDestinationAlpha[index] != destinationAlpha))
\r
370 Driver->irrGlBlendFuncSeparateIndexed(index, sourceRGB, destinationRGB, sourceAlpha, destinationAlpha);
\r
372 BlendSourceRGB[index] = sourceRGB;
\r
373 BlendDestinationRGB[index] = destinationRGB;
\r
374 BlendSourceAlpha[index] = sourceAlpha;
\r
375 BlendDestinationAlpha[index] = destinationAlpha;
\r
376 BlendFuncInvalid = true;
\r
381 setBlendFuncIndexed(index, sourceRGB, destinationRGB);
\r
385 void setBlend(bool enable)
\r
387 if (Blend[0] != enable || BlendInvalid)
\r
390 glEnable(GL_BLEND);
\r
392 glDisable(GL_BLEND);
\r
394 for (GLuint i = 0; i < FrameBufferCount; ++i)
\r
397 BlendInvalid = false;
\r
401 void setBlendIndexed(GLuint index, bool enable)
\r
403 if (index < FrameBufferCount && Blend[index] != enable)
\r
406 Driver->irrGlEnableIndexed(GL_BLEND, index);
\r
408 Driver->irrGlDisableIndexed(GL_BLEND, index);
\r
410 Blend[index] = enable;
\r
411 BlendInvalid = true;
\r
417 void getColorMask(u8& mask)
\r
419 mask = ColorMask[0];
\r
422 void setColorMask(u8 mask)
\r
424 if (ColorMask[0] != mask || ColorMaskInvalid)
\r
426 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
428 for (GLuint i = 0; i < FrameBufferCount; ++i)
\r
429 ColorMask[i] = mask;
\r
431 ColorMaskInvalid = false;
\r
435 void setColorMaskIndexed(GLuint index, u8 mask)
\r
437 if (index < FrameBufferCount && ColorMask[index] != mask)
\r
439 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
441 ColorMask[index] = mask;
\r
442 ColorMaskInvalid = true;
\r
446 // Cull face calls.
\r
448 void setCullFaceFunc(GLenum mode)
\r
450 if (CullFaceMode != mode)
\r
453 CullFaceMode = mode;
\r
457 void setCullFace(bool enable)
\r
459 if (CullFace != enable)
\r
462 glEnable(GL_CULL_FACE);
\r
464 glDisable(GL_CULL_FACE);
\r
472 void setDepthFunc(GLenum mode)
\r
474 if (DepthFunc != mode)
\r
481 void getDepthMask(bool& depth)
\r
486 void setDepthMask(bool enable)
\r
488 if (DepthMask != enable)
\r
491 glDepthMask(GL_TRUE);
\r
493 glDepthMask(GL_FALSE);
\r
495 DepthMask = enable;
\r
499 void getDepthTest(bool& enable)
\r
501 enable = DepthTest;
\r
504 void setDepthTest(bool enable)
\r
506 if (DepthTest != enable)
\r
509 glEnable(GL_DEPTH_TEST);
\r
511 glDisable(GL_DEPTH_TEST);
\r
513 DepthTest = enable;
\r
519 void getFBO(GLuint& frameBufferID) const
\r
521 frameBufferID = FrameBufferID;
\r
524 void setFBO(GLuint frameBufferID)
\r
526 if (FrameBufferID != frameBufferID)
\r
528 Driver->irrGlBindFramebuffer(GL_FRAMEBUFFER, frameBufferID);
\r
529 FrameBufferID = frameBufferID;
\r
535 void getProgram(GLuint& programID) const
\r
537 programID = ProgramID;
\r
540 void setProgram(GLuint programID)
\r
542 if (ProgramID != programID)
\r
544 Driver->irrGlUseProgram(programID);
\r
545 ProgramID = programID;
\r
551 void getActiveTexture(GLenum& texture) const
\r
553 texture = ActiveTexture;
\r
556 void setActiveTexture(GLenum texture)
\r
558 if (ActiveTexture != texture)
\r
560 Driver->irrGlActiveTexture(texture);
\r
561 ActiveTexture = texture;
\r
567 void getViewport(GLint& viewportX, GLint& viewportY, GLsizei& viewportWidth, GLsizei& viewportHeight) const
\r
569 viewportX = ViewportX;
\r
570 viewportY = ViewportY;
\r
571 viewportWidth = ViewportWidth;
\r
572 viewportHeight = ViewportHeight;
\r
575 void setViewport(GLint viewportX, GLint viewportY, GLsizei viewportWidth, GLsizei viewportHeight)
\r
577 if (ViewportX != viewportX || ViewportY != viewportY || ViewportWidth != viewportWidth || ViewportHeight != viewportHeight)
\r
579 glViewport(viewportX, viewportY, viewportWidth, viewportHeight);
\r
580 ViewportX = viewportX;
\r
581 ViewportY = viewportY;
\r
582 ViewportWidth = viewportWidth;
\r
583 ViewportHeight = viewportHeight;
\r
587 //! Compare material to current cache and update it when there are differences
\r
588 // Some material renderers do change the cache beyond the original material settings
\r
589 // This corrects the material to represent the current cache state again.
\r
590 void correctCacheMaterial(irr::video::SMaterial& material)
\r
592 // Fix textures which got removed
\r
593 for ( u32 i=0; i < MATERIAL_MAX_TEXTURES; ++i )
\r
595 if ( material.TextureLayer[i].Texture && !TextureCache[i] )
\r
597 material.TextureLayer[i].Texture = 0;
\r
603 TOpenGLDriver* Driver;
\r
605 STextureCache TextureCache;
\r
607 GLuint FrameBufferCount;
\r
609 GLenum* BlendEquation;
\r
610 GLenum* BlendSourceRGB;
\r
611 GLenum* BlendDestinationRGB;
\r
612 GLenum* BlendSourceAlpha;
\r
613 GLenum* BlendDestinationAlpha;
\r
615 bool BlendEquationInvalid;
\r
616 bool BlendFuncInvalid;
\r
621 bool ColorMaskInvalid;
\r
623 GLenum CullFaceMode;
\r
630 GLuint FrameBufferID;
\r
634 GLenum ActiveTexture;
\r
638 GLsizei ViewportWidth;
\r
639 GLsizei ViewportHeight;
\r