1 // Created on: 2012-01-26
2 // Created by: Kirill GAVRILOV
3 // Copyright (c) 2012-2014 OPEN CASCADE SAS
5 // This file is part of Open CASCADE Technology software library.
7 // This library is free software; you can redistribute it and/or modify it under
8 // the terms of the GNU Lesser General Public License version 2.1 as published
9 // by the Free Software Foundation, with special exception defined in the file
10 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
11 // distribution for complete text of the license and disclaimer of any warranty.
13 // Alternatively, this file may be used under the terms of Open CASCADE
14 // commercial license or contractual agreement.
20 #include <OpenGl_Context.hxx>
22 #include <OpenGl_ArbTBO.hxx>
23 #include <OpenGl_ArbIns.hxx>
24 #include <OpenGl_ArbDbg.hxx>
25 #include <OpenGl_ArbFBO.hxx>
26 #include <OpenGl_ExtGS.hxx>
27 #include <OpenGl_ArbSamplerObject.hxx>
28 #include <OpenGl_ArbTexBindless.hxx>
29 #include <OpenGl_GlCore45.hxx>
30 #include <OpenGl_FrameBuffer.hxx>
31 #include <OpenGl_FrameStats.hxx>
32 #include <OpenGl_Sampler.hxx>
33 #include <OpenGl_ShaderManager.hxx>
34 #include <OpenGl_TextureSetPairIterator.hxx>
35 #include <OpenGl_Workspace.hxx>
36 #include <OpenGl_Aspects.hxx>
38 #include <Graphic3d_TransformUtils.hxx>
39 #include <Graphic3d_RenderingParams.hxx>
40 #include <Image_SupportedFormats.hxx>
41 #include <Message_Messenger.hxx>
42 #include <NCollection_Vector.hxx>
43 #include <Standard_ProgramError.hxx>
44 #include <Standard_WarningDisableFunctionCast.hxx>
46 #if defined(_WIN32) && defined(max)
51 IMPLEMENT_STANDARD_RTTIEXT(OpenGl_Context,Standard_Transient)
56 #pragma comment(lib, "libEGL.lib")
60 #elif defined(__APPLE__) && !defined(MACOSX_USE_GLX)
62 #if defined(TARGET_OS_IPHONE) && TARGET_OS_IPHONE
65 #include <OpenGL/OpenGL.h>
66 #include <CoreGraphics/CoreGraphics.h>
69 #include <GL/glx.h> // glXGetProcAddress()
73 #include <emscripten.h>
74 #include <emscripten/html5.h>
76 //! Check if WebGL extension is available and activate it
77 //! (usage of extension without activation will generate errors).
78 static bool checkEnableWebGlExtension (const OpenGl_Context& theCtx,
79 const char* theExtName)
81 if (!theCtx.CheckExtension (theExtName))
85 if (EMSCRIPTEN_WEBGL_CONTEXT_HANDLE aWebGlCtx = emscripten_webgl_get_current_context())
87 if (emscripten_webgl_enable_extension (aWebGlCtx, theExtName))
98 static const Handle(OpenGl_Resource) NULL_GL_RESOURCE;
99 static const OpenGl_Mat4 THE_IDENTITY_MATRIX;
101 //! Add key-value pair to the dictionary.
102 static void addInfo (TColStd_IndexedDataMapOfStringString& theDict,
103 const TCollection_AsciiString& theKey,
104 const TCollection_AsciiString& theValue)
106 theDict.ChangeFromIndex (theDict.Add (theKey, theValue)) = theValue;
109 //! Add key-value pair to the dictionary.
110 static void addInfo (TColStd_IndexedDataMapOfStringString& theDict,
111 const TCollection_AsciiString& theKey,
112 const char* theValue)
114 TCollection_AsciiString aValue (theValue != NULL ? theValue : "");
115 theDict.ChangeFromIndex (theDict.Add (theKey, aValue)) = aValue;
119 // =======================================================================
120 // function : OpenGl_Context
122 // =======================================================================
123 OpenGl_Context::OpenGl_Context (const Handle(OpenGl_Caps)& theCaps)
146 caps (!theCaps.IsNull() ? theCaps : new OpenGl_Caps()),
147 hasGetBufferData (Standard_False),
148 #if defined(GL_ES_VERSION_2_0)
149 hasPackRowLength (Standard_False),
150 hasUnpackRowLength (Standard_False),
151 hasHighp (Standard_False),
152 hasUintIndex(Standard_False),
153 hasTexRGBA8(Standard_False),
155 hasPackRowLength (Standard_True),
156 hasUnpackRowLength (Standard_True),
157 hasHighp (Standard_True),
158 hasUintIndex(Standard_True),
159 hasTexRGBA8(Standard_True),
161 hasTexFloatLinear (Standard_False),
162 hasTexSRGB (Standard_False),
163 hasFboSRGB (Standard_False),
164 hasSRGBControl (Standard_False),
165 hasFboRenderMipmap (Standard_False),
166 #if defined(GL_ES_VERSION_2_0)
167 hasFlatShading (OpenGl_FeatureNotAvailable),
169 hasFlatShading (OpenGl_FeatureInCore),
171 hasGlslBitwiseOps (OpenGl_FeatureNotAvailable),
172 hasDrawBuffers (OpenGl_FeatureNotAvailable),
173 hasFloatBuffer (OpenGl_FeatureNotAvailable),
174 hasHalfFloatBuffer (OpenGl_FeatureNotAvailable),
175 hasSampleVariables (OpenGl_FeatureNotAvailable),
176 hasGeometryStage (OpenGl_FeatureNotAvailable),
177 arbDrawBuffers (Standard_False),
178 arbNPTW (Standard_False),
179 arbTexRG (Standard_False),
180 arbTexFloat (Standard_False),
181 arbSamplerObject (NULL),
182 arbTexBindless (NULL),
184 arbTboRGB32 (Standard_False),
189 arbSampleShading (Standard_False),
190 arbDepthClamp (Standard_False),
191 extFragDepth (Standard_False),
192 extDrawBuffers (Standard_False),
194 extBgra(Standard_False),
195 extAnis(Standard_False),
196 extPDS (Standard_False),
197 atiMem (Standard_False),
198 nvxMem (Standard_False),
199 oesSampleVariables (Standard_False),
200 oesStdDerivatives (Standard_False),
201 mySharedResources (new OpenGl_ResourcesMap()),
202 myDelayed (new OpenGl_DelayReleaseMap()),
203 myUnusedResources (new OpenGl_ResourcesStack()),
205 myGlLibHandle (NULL),
206 myFuncs (new OpenGl_GlFunctions()),
207 mySupportedFormats (new Image_SupportedFormats()),
209 myTexClamp (GL_CLAMP_TO_EDGE),
211 myMaxTexCombined (1),
212 myMaxTexUnitsFFP (1),
213 myMaxDumpSizeX (1024),
214 myMaxDumpSizeY (1024),
217 myMaxDrawBuffers (1),
218 myMaxColorAttachments (1),
221 myIsInitialized (Standard_False),
222 myIsStereoBuffers (Standard_False),
223 myIsGlNormalizeEnabled (Standard_False),
224 mySpriteTexUnit (Graphic3d_TextureUnit_PointSprite),
225 myHasRayTracing (Standard_False),
226 myHasRayTracingTextures (Standard_False),
227 myHasRayTracingAdaptiveSampling (Standard_False),
228 myHasRayTracingAdaptiveSamplingAtomic (Standard_False),
229 myHasPBR (Standard_False),
230 myPBREnvLUTTexUnit (Graphic3d_TextureUnit_PbrEnvironmentLUT),
231 myPBRDiffIBLMapSHTexUnit (Graphic3d_TextureUnit_PbrIblDiffuseSH),
232 myPBRSpecIBLMapTexUnit (Graphic3d_TextureUnit_PbrIblSpecular),
233 myShadowMapTexUnit (Graphic3d_TextureUnit_ShadowMap),
234 myDepthPeelingDepthTexUnit (Graphic3d_TextureUnit_DepthPeelingDepth),
235 myDepthPeelingFrontColorTexUnit (Graphic3d_TextureUnit_DepthPeelingFrontColor),
236 myFrameStats (new OpenGl_FrameStats()),
237 myActiveMockTextures (0),
238 myActiveHatchType (Aspect_HS_SOLID),
239 myHatchIsEnabled (false),
240 #if !defined(GL_ES_VERSION_2_0)
241 myPointSpriteOrig (GL_UPPER_LEFT),
242 myRenderMode (GL_RENDER),
243 myShadeModel (GL_SMOOTH),
244 myPolygonMode (GL_FILL),
246 myPointSpriteOrig (0),
251 myToCullBackFaces (false),
253 myDrawBuffers (0, 7),
256 myAlphaToCoverage (false),
257 myIsGlDebugCtx (false),
258 myIsSRgbWindow (false),
259 myResolution (Graphic3d_RenderingParams::THE_DEFAULT_RESOLUTION),
260 myResolutionRatio (1.0f),
261 myLineWidthScale (1.0f),
262 myLineFeather (1.0f),
263 myRenderScale (1.0f),
264 myRenderScaleInv (1.0f)
270 myViewportVirt[0] = 0;
271 myViewportVirt[1] = 0;
272 myViewportVirt[2] = 0;
273 myViewportVirt[3] = 0;
275 myPolygonOffset.Mode = Aspect_POM_Off;
276 myPolygonOffset.Factor = 0.0f;
277 myPolygonOffset.Units = 0.0f;
279 // system-dependent fields
280 #if defined(HAVE_EGL)
281 myDisplay = (Aspect_Display )EGL_NO_DISPLAY;
282 myWindow = (Aspect_Drawable )EGL_NO_SURFACE;
283 myGContext = (Aspect_RenderingContext )EGL_NO_CONTEXT;
284 #elif defined(_WIN32)
288 #elif defined(__APPLE__) && !defined(MACOSX_USE_GLX)
289 // Vendors can not extend functionality on this system
290 // and developers are limited to OpenGL support provided by Mac OS X SDK.
291 // We retrieve function pointers from system library
292 // to generalize extensions support on all platforms.
293 // In this way we also reach binary compatibility benefit between OS releases
294 // if some newest functionality is optionally used.
295 // Notice that GL version / extension availability checks are required
296 // because function pointers may be available but not functionality itself
297 // (depends on renderer).
298 #if defined(TARGET_OS_IPHONE) && TARGET_OS_IPHONE
300 myGlLibHandle = dlopen ("/System/Library/Frameworks/OpenGLES.framework/OpenGLES", RTLD_LAZY);
303 myGlLibHandle = dlopen ("/System/Library/Frameworks/OpenGL.framework/Versions/Current/OpenGL", RTLD_LAZY);
311 memset (myFuncs.operator->(), 0, sizeof(OpenGl_GlFunctions));
312 myShaderManager = new OpenGl_ShaderManager (this);
315 // =======================================================================
316 // function : ~OpenGl_Context
318 // =======================================================================
319 OpenGl_Context::~OpenGl_Context()
321 // release clean up queue
324 #if !defined(GL_ES_VERSION_2_0)
325 // release default VAO
326 if (myDefaultVao != 0
330 core32->glDeleteVertexArrays (1, &myDefaultVao);
335 // release mock textures
336 if (!myTextureRgbaBlack.IsNull())
338 myTextureRgbaBlack->Release (this);
339 myTextureRgbaBlack.Nullify();
341 if (!myTextureRgbaWhite.IsNull())
343 myTextureRgbaWhite->Release (this);
344 myTextureRgbaWhite.Nullify();
347 // release default FBO
348 if (!myDefaultFbo.IsNull())
350 myDefaultFbo->Release (this);
351 myDefaultFbo.Nullify();
354 // release shared resources if any
355 if (mySharedResources->GetRefCount() <= 1)
357 myShaderManager.Nullify();
358 for (NCollection_DataMap<TCollection_AsciiString, Handle(OpenGl_Resource)>::Iterator anIter (*mySharedResources);
359 anIter.More(); anIter.Next())
361 anIter.Value()->Release (this);
364 // release delayed resources added during deletion of shared resources
365 while (!myUnusedResources->IsEmpty())
367 myUnusedResources->First()->Release (this);
368 myUnusedResources->RemoveFirst();
371 else if (myShaderManager->IsSameContext (this))
373 myShaderManager->SetContext (NULL);
375 mySharedResources.Nullify();
383 #if !defined(GL_ES_VERSION_2_0)
385 glGetPointerv (GL_DEBUG_CALLBACK_USER_PARAM, &aPtr);
389 arbDbg->glDebugMessageCallback (NULL, NULL);
391 myIsGlDebugCtx = Standard_False;
395 // =======================================================================
396 // function : forcedRelease
398 // =======================================================================
399 void OpenGl_Context::forcedRelease()
402 for (NCollection_DataMap<TCollection_AsciiString, Handle(OpenGl_Resource)>::Iterator anIter (*mySharedResources);
403 anIter.More(); anIter.Next())
405 anIter.Value()->Release (this);
407 mySharedResources->Clear();
408 myShaderManager->clear();
409 myShaderManager->SetContext (NULL);
411 // release delayed resources added during deletion of shared resources
412 while (!myUnusedResources->IsEmpty())
414 myUnusedResources->First()->Release (this);
415 myUnusedResources->RemoveFirst();
419 // =======================================================================
420 // function : ResizeViewport
422 // =======================================================================
423 void OpenGl_Context::ResizeViewport (const Standard_Integer* theRect)
425 core11fwd->glViewport (theRect[0], theRect[1], theRect[2], theRect[3]);
426 myViewport[0] = theRect[0];
427 myViewport[1] = theRect[1];
428 myViewport[2] = theRect[2];
429 myViewport[3] = theRect[3];
430 if (HasRenderScale())
432 myViewportVirt[0] = Standard_Integer(theRect[0] * myRenderScaleInv);
433 myViewportVirt[1] = Standard_Integer(theRect[1] * myRenderScaleInv);
434 myViewportVirt[2] = Standard_Integer(theRect[2] * myRenderScaleInv);
435 myViewportVirt[3] = Standard_Integer(theRect[3] * myRenderScaleInv);
439 myViewportVirt[0] = theRect[0];
440 myViewportVirt[1] = theRect[1];
441 myViewportVirt[2] = theRect[2];
442 myViewportVirt[3] = theRect[3];
446 #if !defined(GL_ES_VERSION_2_0)
447 inline Standard_Integer stereoToMonoBuffer (const Standard_Integer theBuffer)
463 // =======================================================================
464 // function : SetReadBuffer
466 // =======================================================================
467 void OpenGl_Context::SetReadBuffer (const Standard_Integer theReadBuffer)
469 #if !defined(GL_ES_VERSION_2_0)
470 myReadBuffer = !myIsStereoBuffers ? stereoToMonoBuffer (theReadBuffer) : theReadBuffer;
471 if (myReadBuffer < GL_COLOR_ATTACHMENT0
474 arbFBO->glBindFramebuffer (GL_FRAMEBUFFER, OpenGl_FrameBuffer::NO_FRAMEBUFFER);
476 ::glReadBuffer (myReadBuffer);
478 (void )theReadBuffer;
482 // =======================================================================
483 // function : SetDrawBuffer
485 // =======================================================================
486 void OpenGl_Context::SetDrawBuffer (const Standard_Integer theDrawBuffer)
488 #if !defined(GL_ES_VERSION_2_0)
489 const Standard_Integer aDrawBuffer = !myIsStereoBuffers ? stereoToMonoBuffer (theDrawBuffer) : theDrawBuffer;
490 if (aDrawBuffer < GL_COLOR_ATTACHMENT0
493 arbFBO->glBindFramebuffer (GL_FRAMEBUFFER, OpenGl_FrameBuffer::NO_FRAMEBUFFER);
495 ::glDrawBuffer (aDrawBuffer);
497 myDrawBuffers.Init (GL_NONE);
498 myDrawBuffers.SetValue (0, aDrawBuffer);
500 (void )theDrawBuffer;
504 // =======================================================================
505 // function : SetDrawBuffers
507 // =======================================================================
508 void OpenGl_Context::SetDrawBuffers (const Standard_Integer theNb, const Standard_Integer* theDrawBuffers)
510 Standard_ASSERT_RETURN (hasDrawBuffers, "Multiple draw buffers feature is not supported by the context", Standard_ASSERT_DO_NOTHING());
512 if (myDrawBuffers.Length() < theNb)
514 // should actually never happen here
515 myDrawBuffers.Resize (0, theNb - 1, false);
517 myDrawBuffers.Init (GL_NONE);
519 Standard_Boolean useDefaultFbo = Standard_False;
520 for (Standard_Integer anI = 0; anI < theNb; ++anI)
522 if (theDrawBuffers[anI] < GL_COLOR_ATTACHMENT0 && theDrawBuffers[anI] != GL_NONE)
524 useDefaultFbo = Standard_True;
528 myDrawBuffers.SetValue (anI, theDrawBuffers[anI]);
531 if (arbFBO != NULL && useDefaultFbo)
533 arbFBO->glBindFramebuffer (GL_FRAMEBUFFER, OpenGl_FrameBuffer::NO_FRAMEBUFFER);
536 myFuncs->glDrawBuffers (theNb, (const GLenum*)theDrawBuffers);
539 // =======================================================================
540 // function : SetFrameBufferSRGB
542 // =======================================================================
543 void OpenGl_Context::SetFrameBufferSRGB (bool theIsFbo, bool theIsFboSRgb)
547 myIsSRgbActive = false;
550 myIsSRgbActive = ToRenderSRGB()
551 && (theIsFbo || myIsSRgbWindow)
560 core11fwd->glEnable (GL_FRAMEBUFFER_SRGB);
564 core11fwd->glDisable (GL_FRAMEBUFFER_SRGB);
568 // =======================================================================
569 // function : SetCullBackFaces
571 // =======================================================================
572 void OpenGl_Context::SetCullBackFaces (bool theToEnable)
574 if (myToCullBackFaces == theToEnable)
579 myToCullBackFaces = theToEnable;
582 //glCullFace (GL_BACK); GL_BACK by default
583 core11fwd->glEnable (GL_CULL_FACE);
587 core11fwd->glDisable (GL_CULL_FACE);
591 // =======================================================================
592 // function : FetchState
594 // =======================================================================
595 void OpenGl_Context::FetchState()
597 #if !defined(GL_ES_VERSION_2_0)
598 // cache feedback mode state
601 ::glGetIntegerv (GL_RENDER_MODE, &myRenderMode);
602 ::glGetIntegerv (GL_SHADE_MODEL, &myShadeModel);
605 // cache read buffers state
606 ::glGetIntegerv (GL_READ_BUFFER, &myReadBuffer);
608 // cache draw buffers state
609 if (myDrawBuffers.Length() < myMaxDrawBuffers)
611 myDrawBuffers.Resize (0, myMaxDrawBuffers - 1, false);
613 myDrawBuffers.Init (GL_NONE);
615 Standard_Integer aDrawBuffer = GL_NONE;
616 if (myMaxDrawBuffers == 1)
618 ::glGetIntegerv (GL_DRAW_BUFFER, &aDrawBuffer);
619 myDrawBuffers.SetValue (0, aDrawBuffer);
623 for (Standard_Integer anI = 0; anI < myMaxDrawBuffers; ++anI)
625 ::glGetIntegerv (GL_DRAW_BUFFER0 + anI, &aDrawBuffer);
626 myDrawBuffers.SetValue (anI, aDrawBuffer);
632 // =======================================================================
635 // =======================================================================
636 void OpenGl_Context::Share (const Handle(OpenGl_Context)& theShareCtx)
638 if (!theShareCtx.IsNull())
640 mySharedResources = theShareCtx->mySharedResources;
641 myDelayed = theShareCtx->myDelayed;
642 myUnusedResources = theShareCtx->myUnusedResources;
643 myShaderManager = theShareCtx->myShaderManager;
647 #if !defined(__APPLE__) || defined(MACOSX_USE_GLX)
649 // =======================================================================
650 // function : IsCurrent
652 // =======================================================================
653 Standard_Boolean OpenGl_Context::IsCurrent() const
655 #if defined(HAVE_EGL)
656 if ((EGLDisplay )myDisplay == EGL_NO_DISPLAY
657 || (EGLContext )myGContext == EGL_NO_CONTEXT)
659 return Standard_False;
662 return (((EGLDisplay )myDisplay == eglGetCurrentDisplay())
663 && ((EGLContext )myGContext == eglGetCurrentContext())
664 && ((EGLSurface )myWindow == eglGetCurrentSurface (EGL_DRAW)));
665 #elif defined(_WIN32)
666 if (myWindowDC == NULL || myGContext == NULL)
668 return Standard_False;
670 return (( (HDC )myWindowDC == wglGetCurrentDC())
671 && ((HGLRC )myGContext == wglGetCurrentContext()));
673 if (myDisplay == NULL || myWindow == 0 || myGContext == 0)
675 return Standard_False;
678 return ( ((Display* )myDisplay == glXGetCurrentDisplay())
679 && ((GLXContext )myGContext == glXGetCurrentContext())
680 && ((GLXDrawable )myWindow == glXGetCurrentDrawable()));
684 // =======================================================================
685 // function : MakeCurrent
687 // =======================================================================
688 Standard_Boolean OpenGl_Context::MakeCurrent()
690 #if defined(HAVE_EGL)
691 if ((EGLDisplay )myDisplay == EGL_NO_DISPLAY
692 || (EGLContext )myGContext == EGL_NO_CONTEXT)
694 Standard_ProgramError_Raise_if (myIsInitialized, "OpenGl_Context::Init() should be called before!");
695 return Standard_False;
698 if (eglMakeCurrent ((EGLDisplay )myDisplay, (EGLSurface )myWindow, (EGLSurface )myWindow, (EGLContext )myGContext) != EGL_TRUE)
700 // if there is no current context it might be impossible to use glGetError() correctly
701 PushMessage (GL_DEBUG_SOURCE_WINDOW_SYSTEM, GL_DEBUG_TYPE_ERROR, 0, GL_DEBUG_SEVERITY_HIGH,
702 "eglMakeCurrent() has failed!");
703 myIsInitialized = Standard_False;
704 return Standard_False;
706 #elif defined(_WIN32)
707 if (myWindowDC == NULL || myGContext == NULL)
709 Standard_ProgramError_Raise_if (myIsInitialized, "OpenGl_Context::Init() should be called before!");
710 return Standard_False;
713 // technically it should be safe to activate already bound GL context
714 // however some drivers (Intel etc.) may FAIL doing this for unknown reason
717 myShaderManager->SetContext (this);
718 return Standard_True;
720 else if (wglMakeCurrent ((HDC )myWindowDC, (HGLRC )myGContext) != TRUE)
722 // notice that glGetError() couldn't be used here!
723 wchar_t* aMsgBuff = NULL;
724 DWORD anErrorCode = GetLastError();
725 FormatMessageW (FORMAT_MESSAGE_ALLOCATE_BUFFER | FORMAT_MESSAGE_FROM_SYSTEM | FORMAT_MESSAGE_IGNORE_INSERTS,
726 NULL, anErrorCode, MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT), (wchar_t* )&aMsgBuff, 0, NULL);
727 TCollection_ExtendedString aMsg ("wglMakeCurrent() has failed. ");
728 if (aMsgBuff != NULL)
730 aMsg += (Standard_ExtString )aMsgBuff;
731 LocalFree (aMsgBuff);
733 PushMessage (GL_DEBUG_SOURCE_WINDOW_SYSTEM, GL_DEBUG_TYPE_ERROR, (unsigned int )anErrorCode, GL_DEBUG_SEVERITY_HIGH, aMsg);
734 myIsInitialized = Standard_False;
735 return Standard_False;
738 if (myDisplay == NULL || myWindow == 0 || myGContext == 0)
740 Standard_ProgramError_Raise_if (myIsInitialized, "OpenGl_Context::Init() should be called before!");
741 return Standard_False;
744 if (!glXMakeCurrent ((Display* )myDisplay, (GLXDrawable )myWindow, (GLXContext )myGContext))
746 // if there is no current context it might be impossible to use glGetError() correctly
747 PushMessage (GL_DEBUG_SOURCE_WINDOW_SYSTEM, GL_DEBUG_TYPE_ERROR, 0, GL_DEBUG_SEVERITY_HIGH,
748 "glXMakeCurrent() has failed!");
749 myIsInitialized = Standard_False;
750 return Standard_False;
753 myShaderManager->SetContext (this);
754 return Standard_True;
757 // =======================================================================
758 // function : SwapBuffers
760 // =======================================================================
761 void OpenGl_Context::SwapBuffers()
763 #if defined(HAVE_EGL)
764 if ((EGLSurface )myWindow != EGL_NO_SURFACE)
766 eglSwapBuffers ((EGLDisplay )myDisplay, (EGLSurface )myWindow);
768 #elif defined(_WIN32)
769 if ((HDC )myWindowDC != NULL)
771 ::SwapBuffers ((HDC )myWindowDC);
775 if ((Display* )myDisplay != NULL)
777 glXSwapBuffers ((Display* )myDisplay, (GLXDrawable )myWindow);
784 // =======================================================================
785 // function : SetSwapInterval
787 // =======================================================================
788 Standard_Boolean OpenGl_Context::SetSwapInterval (const Standard_Integer theInterval)
790 #if defined(HAVE_EGL)
791 if (::eglSwapInterval ((EGLDisplay )myDisplay, theInterval) == EGL_TRUE)
793 return Standard_True;
795 #elif defined(_WIN32)
796 if (myFuncs->wglSwapIntervalEXT != NULL)
798 myFuncs->wglSwapIntervalEXT (theInterval);
799 return Standard_True;
801 #elif defined(TARGET_OS_IPHONE) && TARGET_OS_IPHONE
802 (void )theInterval; // vsync cannot be turned OFF on iOS
803 #elif defined(__APPLE__)
804 if (::CGLSetParameter (CGLGetCurrentContext(), kCGLCPSwapInterval, &theInterval) == kCGLNoError)
806 return Standard_True;
809 if (theInterval == -1
810 && myFuncs->glXSwapIntervalEXT != NULL)
812 typedef int (*glXSwapIntervalEXT_t_x)(Display* theDisplay, GLXDrawable theDrawable, int theInterval);
813 glXSwapIntervalEXT_t_x aFuncPtr = (glXSwapIntervalEXT_t_x )myFuncs->glXSwapIntervalEXT;
814 aFuncPtr ((Display* )myDisplay, (GLXDrawable )myWindow, theInterval);
815 return Standard_True;
817 else if (myFuncs->glXSwapIntervalSGI != NULL)
819 myFuncs->glXSwapIntervalSGI (theInterval);
820 return Standard_True;
823 return Standard_False;
826 // =======================================================================
827 // function : findProc
829 // =======================================================================
830 void* OpenGl_Context::findProc (const char* theFuncName)
832 #if defined(HAVE_EGL)
833 return (void* )eglGetProcAddress (theFuncName);
834 #elif defined(_WIN32)
835 return (void* )wglGetProcAddress (theFuncName);
836 #elif defined(__APPLE__) && !defined(MACOSX_USE_GLX)
837 return (myGlLibHandle != NULL) ? dlsym (myGlLibHandle, theFuncName) : NULL;
839 return (void* )glXGetProcAddress ((const GLubyte* )theFuncName);
843 // =======================================================================
844 // function : CheckExtension
846 // =======================================================================
847 Standard_Boolean OpenGl_Context::CheckExtension (const char* theExtName) const
849 if (theExtName == NULL)
852 std::cerr << "CheckExtension called with NULL string!\n";
854 return Standard_False;
856 else if (caps->contextNoExtensions)
858 return Standard_False;
861 #if !defined(GL_ES_VERSION_2_0)
862 // available since OpenGL 3.0
863 // and the ONLY way to check extensions with OpenGL 3.1+ core profile
864 if (IsGlGreaterEqual (3, 0)
865 && myFuncs->glGetStringi != NULL)
868 ::glGetIntegerv (GL_NUM_EXTENSIONS, &anExtNb);
869 const size_t anExtNameLen = strlen (theExtName);
870 for (GLint anIter = 0; anIter < anExtNb; ++anIter)
872 const char* anExtension = (const char* )myFuncs->glGetStringi (GL_EXTENSIONS, (GLuint )anIter);
873 const size_t aTestExtNameLen = strlen (anExtension);
874 if (aTestExtNameLen == anExtNameLen
875 && strncmp (anExtension, theExtName, anExtNameLen) == 0)
877 return Standard_True;
880 return Standard_False;
884 // use old way with huge string for all extensions
885 const char* anExtString = (const char* )glGetString (GL_EXTENSIONS);
886 if (anExtString == NULL)
888 Messenger()->Send ("TKOpenGL: glGetString (GL_EXTENSIONS) has returned NULL! No GL context?", Message_Warning);
889 return Standard_False;
891 return CheckExtension (anExtString, theExtName);
894 // =======================================================================
895 // function : CheckExtension
897 // =======================================================================
898 Standard_Boolean OpenGl_Context::CheckExtension (const char* theExtString,
899 const char* theExtName)
901 if (theExtString == NULL)
903 return Standard_False;
906 // Search for theExtName in the extensions string.
907 // Use of strstr() is not sufficient because extension names can be prefixes of other extension names.
908 char* aPtrIter = (char* )theExtString;
909 const char* aPtrEnd = aPtrIter + strlen (theExtString);
910 const size_t anExtNameLen = strlen (theExtName);
911 while (aPtrIter < aPtrEnd)
913 const size_t n = strcspn (aPtrIter, " ");
914 if ((n == anExtNameLen) && (strncmp (aPtrIter, theExtName, anExtNameLen) == 0))
916 return Standard_True;
920 return Standard_False;
923 #if !defined(__APPLE__) || defined(MACOSX_USE_GLX)
925 // =======================================================================
928 // =======================================================================
929 Standard_Boolean OpenGl_Context::Init (const Standard_Boolean theIsCoreProfile)
933 return Standard_True;
936 #if defined(HAVE_EGL)
937 myDisplay = (Aspect_Display )eglGetCurrentDisplay();
938 myGContext = (Aspect_RenderingContext )eglGetCurrentContext();
939 myWindow = (Aspect_Drawable )eglGetCurrentSurface(EGL_DRAW);
940 #elif defined(_WIN32)
941 myWindowDC = (Aspect_Handle )wglGetCurrentDC();
942 myGContext = (Aspect_RenderingContext )wglGetCurrentContext();
944 myDisplay = (Aspect_Display )glXGetCurrentDisplay();
945 myGContext = (Aspect_RenderingContext )glXGetCurrentContext();
946 myWindow = (Aspect_Drawable )glXGetCurrentDrawable();
948 if (myGContext == NULL)
950 return Standard_False;
953 init (theIsCoreProfile);
954 myIsInitialized = Standard_True;
955 return Standard_True;
960 // =======================================================================
963 // =======================================================================
964 #if defined(HAVE_EGL)
965 Standard_Boolean OpenGl_Context::Init (const Aspect_Drawable theEglSurface,
966 const Aspect_Display theEglDisplay,
967 const Aspect_RenderingContext theEglContext,
968 const Standard_Boolean theIsCoreProfile)
969 #elif defined(_WIN32)
970 Standard_Boolean OpenGl_Context::Init (const Aspect_Handle theWindow,
971 const Aspect_Handle theWindowDC,
972 const Aspect_RenderingContext theGContext,
973 const Standard_Boolean theIsCoreProfile)
974 #elif defined(__APPLE__) && !defined(MACOSX_USE_GLX)
976 #if defined(TARGET_OS_IPHONE) && TARGET_OS_IPHONE
977 Standard_Boolean OpenGl_Context::Init (EAGLContext* theGContext,
978 const Standard_Boolean theIsCoreProfile)
980 Standard_Boolean OpenGl_Context::Init (NSOpenGLContext* theGContext,
981 const Standard_Boolean theIsCoreProfile)
985 Standard_Boolean OpenGl_Context::Init (const Aspect_Drawable theWindow,
986 const Aspect_Display theDisplay,
987 const Aspect_RenderingContext theGContext,
988 const Standard_Boolean theIsCoreProfile)
991 Standard_ProgramError_Raise_if (myIsInitialized, "OpenGl_Context::Init() should be called only once!");
992 #if defined(HAVE_EGL)
993 myWindow = theEglSurface;
994 myGContext = theEglContext;
995 myDisplay = theEglDisplay;
996 #elif defined(_WIN32)
997 myWindow = theWindow;
998 myGContext = theGContext;
999 myWindowDC = theWindowDC;
1000 #elif defined(__APPLE__) && !defined(MACOSX_USE_GLX)
1001 myGContext = theGContext;
1003 myWindow = theWindow;
1004 myGContext = theGContext;
1005 myDisplay = theDisplay;
1007 if (myGContext == NULL || !MakeCurrent())
1009 return Standard_False;
1012 init (theIsCoreProfile);
1013 myIsInitialized = Standard_True;
1014 return Standard_True;
1017 // =======================================================================
1018 // function : FormatGlEnumHex
1020 // =======================================================================
1021 TCollection_AsciiString OpenGl_Context::FormatGlEnumHex (int theGlEnum)
1024 Sprintf (aBuff, theGlEnum < (int )std::numeric_limits<uint16_t>::max()
1026 : "0x%08X", theGlEnum);
1030 // =======================================================================
1031 // function : FormatSize
1033 // =======================================================================
1034 TCollection_AsciiString OpenGl_Context::FormatSize (Standard_Size theSize)
1037 Sprintf (aBuff, "%" PRIu64, (uint64_t )theSize);
1041 // =======================================================================
1042 // function : FormatPointer
1044 // =======================================================================
1045 TCollection_AsciiString OpenGl_Context::FormatPointer (const void* thePtr)
1048 Sprintf (aBuff, "0x%" PRIXPTR, (uintptr_t )thePtr);
1052 // =======================================================================
1053 // function : FormatGlError
1055 // =======================================================================
1056 TCollection_AsciiString OpenGl_Context::FormatGlError (int theGlError)
1060 case GL_INVALID_ENUM: return "GL_INVALID_ENUM";
1061 case GL_INVALID_VALUE: return "GL_INVALID_VALUE";
1062 case GL_INVALID_OPERATION: return "GL_INVALID_OPERATION";
1063 #ifdef GL_STACK_OVERFLOW
1064 case GL_STACK_OVERFLOW: return "GL_STACK_OVERFLOW";
1065 case GL_STACK_UNDERFLOW: return "GL_STACK_UNDERFLOW";
1067 case GL_OUT_OF_MEMORY: return "GL_OUT_OF_MEMORY";
1068 case GL_INVALID_FRAMEBUFFER_OPERATION: return "GL_INVALID_FRAMEBUFFER_OPERATION";
1070 return FormatGlEnumHex (theGlError);
1073 // =======================================================================
1074 // function : ResetErrors
1076 // =======================================================================
1077 bool OpenGl_Context::ResetErrors (const bool theToPrintErrors)
1080 int anErr = ::glGetError();
1081 const bool hasError = anErr != GL_NO_ERROR;
1082 if (!theToPrintErrors)
1084 for (; anErr != GL_NO_ERROR && aPrevErr != anErr; aPrevErr = anErr, anErr = ::glGetError())
1091 for (; anErr != GL_NO_ERROR && aPrevErr != anErr; aPrevErr = anErr, anErr = ::glGetError())
1093 const TCollection_ExtendedString aMsg = TCollection_ExtendedString ("Unhandled GL error: ") + FormatGlError (anErr);
1094 PushMessage (GL_DEBUG_SOURCE_APPLICATION, GL_DEBUG_TYPE_OTHER, 0, GL_DEBUG_SEVERITY_LOW, aMsg);
1099 // =======================================================================
1100 // function : debugPrintError
1102 // =======================================================================
1103 bool OpenGl_GlFunctions::debugPrintError (const char* theName) const
1105 const int anErr = ::glGetError();
1106 if (anErr != GL_NO_ERROR)
1108 Message::SendFail() << theName << "(), unhandled GL error: " << OpenGl_Context::FormatGlError (anErr);
1109 // there is no glSetError(), just emulate non-clear state
1112 case GL_INVALID_VALUE:
1114 ::glLineWidth(-1.0f);
1115 ::glLineWidth( 1.0f);
1119 case GL_INVALID_ENUM:
1121 ::glEnable (0xFFFF);
1126 return anErr != GL_NO_ERROR;
1129 // =======================================================================
1130 // function : ReadGlVersion
1132 // =======================================================================
1133 void OpenGl_Context::ReadGlVersion (Standard_Integer& theGlVerMajor,
1134 Standard_Integer& theGlVerMinor)
1140 bool toCheckVer3 = true;
1141 #if defined(__EMSCRIPTEN__)
1142 // WebGL 1.0 prints annoying invalid enumeration warnings to console.
1143 toCheckVer3 = false;
1144 if (EMSCRIPTEN_WEBGL_CONTEXT_HANDLE aWebGlCtx = emscripten_webgl_get_current_context())
1146 EmscriptenWebGLContextAttributes anAttribs = {};
1147 if (emscripten_webgl_get_context_attributes (aWebGlCtx, &anAttribs) == EMSCRIPTEN_RESULT_SUCCESS)
1149 toCheckVer3 = anAttribs.majorVersion >= 2;
1154 // Available since OpenGL 3.0 and OpenGL ES 3.0.
1157 GLint aMajor = 0, aMinor = 0;
1158 glGetIntegerv (GL_MAJOR_VERSION, &aMajor);
1159 glGetIntegerv (GL_MINOR_VERSION, &aMinor);
1160 // glGetError() sometimes does not report an error here even if
1161 // GL does not know GL_MAJOR_VERSION and GL_MINOR_VERSION constants.
1162 // This happens on some renderers like e.g. Cygwin MESA.
1163 // Thus checking additionally if GL has put anything to
1164 // the output variables.
1165 if (::glGetError() == GL_NO_ERROR && aMajor != 0 && aMinor != 0)
1167 theGlVerMajor = aMajor;
1168 theGlVerMinor = aMinor;
1171 for (GLenum anErr = ::glGetError(), aPrevErr = GL_NO_ERROR;; aPrevErr = anErr, anErr = ::glGetError())
1173 if (anErr == GL_NO_ERROR
1174 || anErr == aPrevErr)
1181 // Read version string.
1182 // Notice that only first two numbers split by point '2.1 XXXXX' are significant.
1183 // Following trash (after space) is vendor-specific.
1184 // New drivers also returns micro version of GL like '3.3.0' which has no meaning
1185 // and should be considered as vendor-specific too.
1186 const char* aVerStr = (const char* )glGetString (GL_VERSION);
1187 if (aVerStr == NULL || *aVerStr == '\0')
1189 // invalid GL context
1193 //#if defined(GL_ES_VERSION_2_0)
1194 // skip "OpenGL ES-** " section
1195 for (; *aVerStr != '\0'; ++aVerStr)
1197 if (*aVerStr >= '0' && *aVerStr <= '9')
1204 // parse string for major number
1207 size_t aMajIter = 0;
1208 while (aVerStr[aMajIter] >= '0' && aVerStr[aMajIter] <= '9')
1212 if (aMajIter == 0 || aMajIter >= sizeof(aMajorStr))
1216 memcpy (aMajorStr, aVerStr, aMajIter);
1217 aMajorStr[aMajIter] = '\0';
1219 // parse string for minor number
1220 aVerStr += aMajIter + 1;
1221 size_t aMinIter = 0;
1222 while (aVerStr[aMinIter] >= '0' && aVerStr[aMinIter] <= '9')
1226 if (aMinIter == 0 || aMinIter >= sizeof(aMinorStr))
1230 memcpy (aMinorStr, aVerStr, aMinIter);
1231 aMinorStr[aMinIter] = '\0';
1234 theGlVerMajor = atoi (aMajorStr);
1235 theGlVerMinor = atoi (aMinorStr);
1236 #if defined(__EMSCRIPTEN__)
1237 if (theGlVerMajor >= 3)
1240 || ::strstr (aVerStr, "WebGL 1.0") != NULL)
1242 Message::SendWarning() << "Warning! OpenGL context reports version " << theGlVerMajor << "." << theGlVerMinor
1243 << " but WebGL 2.0 was unavailable\n"
1244 << "Fallback to OpenGL ES 2.0 will be used instead of reported version";
1251 if (theGlVerMajor <= 0)
1258 static Standard_CString THE_DBGMSG_UNKNOWN = "UNKNOWN";
1259 static Standard_CString THE_DBGMSG_SOURCES[] =
1261 ".OpenGL", // GL_DEBUG_SOURCE_API
1262 ".WinSystem", // GL_DEBUG_SOURCE_WINDOW_SYSTEM
1263 ".GLSL", // GL_DEBUG_SOURCE_SHADER_COMPILER
1264 ".3rdParty", // GL_DEBUG_SOURCE_THIRD_PARTY
1265 "", // GL_DEBUG_SOURCE_APPLICATION
1266 ".Other" // GL_DEBUG_SOURCE_OTHER
1269 static Standard_CString THE_DBGMSG_TYPES[] =
1271 "Error", // GL_DEBUG_TYPE_ERROR
1272 "Deprecated", // GL_DEBUG_TYPE_DEPRECATED_BEHAVIOR
1273 "Undef. behavior", // GL_DEBUG_TYPE_UNDEFINED_BEHAVIOR
1274 "Portability", // GL_DEBUG_TYPE_PORTABILITY
1275 "Performance", // GL_DEBUG_TYPE_PERFORMANCE
1276 "Other" // GL_DEBUG_TYPE_OTHER
1279 static Standard_CString THE_DBGMSG_SEV_HIGH = "High"; // GL_DEBUG_SEVERITY_HIGH
1280 static Standard_CString THE_DBGMSG_SEV_MEDIUM = "Medium"; // GL_DEBUG_SEVERITY_MEDIUM
1281 static Standard_CString THE_DBGMSG_SEV_LOW = "Low"; // GL_DEBUG_SEVERITY_LOW
1283 //! Callback for GL_ARB_debug_output extension
1284 static void APIENTRY debugCallbackWrap(unsigned int theSource,
1285 unsigned int theType,
1287 unsigned int theSeverity,
1289 const char* theMessage,
1290 const void* theUserParam)
1292 OpenGl_Context* aCtx = (OpenGl_Context* )theUserParam;
1293 aCtx->PushMessage (theSource, theType, theId, theSeverity, theMessage);
1296 // =======================================================================
1297 // function : PushMessage
1299 // =======================================================================
1300 void OpenGl_Context::PushMessage (const unsigned int theSource,
1301 const unsigned int theType,
1302 const unsigned int theId,
1303 const unsigned int theSeverity,
1304 const TCollection_ExtendedString& theMessage)
1306 if (caps->suppressExtraMsg
1307 && theSource >= GL_DEBUG_SOURCE_API
1308 && theSource <= GL_DEBUG_SOURCE_OTHER
1309 && myFilters[theSource - GL_DEBUG_SOURCE_API].Contains (theId))
1314 Standard_CString& aSrc = (theSource >= GL_DEBUG_SOURCE_API
1315 && theSource <= GL_DEBUG_SOURCE_OTHER)
1316 ? THE_DBGMSG_SOURCES[theSource - GL_DEBUG_SOURCE_API]
1317 : THE_DBGMSG_UNKNOWN;
1318 Standard_CString& aType = (theType >= GL_DEBUG_TYPE_ERROR
1319 && theType <= GL_DEBUG_TYPE_OTHER)
1320 ? THE_DBGMSG_TYPES[theType - GL_DEBUG_TYPE_ERROR]
1321 : THE_DBGMSG_UNKNOWN;
1322 Standard_CString& aSev = theSeverity == GL_DEBUG_SEVERITY_HIGH
1323 ? THE_DBGMSG_SEV_HIGH
1324 : (theSeverity == GL_DEBUG_SEVERITY_MEDIUM
1325 ? THE_DBGMSG_SEV_MEDIUM
1326 : THE_DBGMSG_SEV_LOW);
1327 Message_Gravity aGrav = theSeverity == GL_DEBUG_SEVERITY_HIGH
1329 : (theSeverity == GL_DEBUG_SEVERITY_MEDIUM
1333 TCollection_ExtendedString aMsg;
1334 aMsg += "TKOpenGl"; aMsg += aSrc;
1335 aMsg += " | Type: "; aMsg += aType;
1336 aMsg += " | ID: "; aMsg += (Standard_Integer )theId;
1337 aMsg += " | Severity: "; aMsg += aSev;
1338 aMsg += " | Message:\n ";
1340 Messenger()->Send (aMsg, aGrav);
1343 // =======================================================================
1344 // function : ExcludeMessage
1346 // ======================================================================
1347 Standard_Boolean OpenGl_Context::ExcludeMessage (const unsigned int theSource,
1348 const unsigned int theId)
1350 return theSource >= GL_DEBUG_SOURCE_API
1351 && theSource <= GL_DEBUG_SOURCE_OTHER
1352 && myFilters[theSource - GL_DEBUG_SOURCE_API].Add (theId);
1355 // =======================================================================
1356 // function : IncludeMessage
1358 // ======================================================================
1359 Standard_Boolean OpenGl_Context::IncludeMessage (const unsigned int theSource,
1360 const unsigned int theId)
1362 return theSource >= GL_DEBUG_SOURCE_API
1363 && theSource <= GL_DEBUG_SOURCE_OTHER
1364 && myFilters[theSource - GL_DEBUG_SOURCE_API].Remove (theId);
1367 // =======================================================================
1368 // function : checkWrongVersion
1370 // ======================================================================
1371 void OpenGl_Context::checkWrongVersion (Standard_Integer theGlVerMajor, Standard_Integer theGlVerMinor,
1372 const char* theLastFailedProc)
1374 if (!IsGlGreaterEqual (theGlVerMajor, theGlVerMinor))
1379 PushMessage (GL_DEBUG_SOURCE_APPLICATION, GL_DEBUG_TYPE_ERROR, 0, GL_DEBUG_SEVERITY_HIGH,
1380 TCollection_AsciiString()
1381 + "Error! OpenGL context reports version "
1382 + myGlVerMajor + "." + myGlVerMinor
1383 + " but does not export required functions for " + theGlVerMajor + "." + theGlVerMinor
1384 + " (" + (theLastFailedProc != NULL ? theLastFailedProc : "") + ")\n"
1385 + "Please report this issue to OpenGL driver vendor '" + myVendor + "'");
1387 // lower internal version
1388 if (theGlVerMinor > 0)
1390 myGlVerMajor = theGlVerMajor;
1391 myGlVerMinor = theGlVerMinor - 1;
1394 #if defined(GL_ES_VERSION_2_0)
1395 switch (theGlVerMajor)
1397 case 3: myGlVerMajor = 2; myGlVerMinor = 0; return;
1400 switch (theGlVerMajor)
1402 case 2: myGlVerMajor = 1; myGlVerMinor = 5; return;
1403 case 3: myGlVerMajor = 2; myGlVerMinor = 1; return;
1404 case 4: myGlVerMajor = 3; myGlVerMinor = 3; return;
1409 // =======================================================================
1412 // =======================================================================
1413 void OpenGl_Context::init (const Standard_Boolean theIsCoreProfile)
1418 myMaxMsaaSamples = 0;
1419 myMaxDrawBuffers = 1;
1420 myMaxColorAttachments = 1;
1422 ReadGlVersion (myGlVerMajor, myGlVerMinor);
1423 myVendor = (const char* )::glGetString (GL_VENDOR);
1424 myVendor.LowerCase();
1425 mySupportedFormats->Clear();
1427 if (caps->contextMajorVersionUpper != -1)
1429 // synthetically restrict OpenGL version for testing
1430 Standard_Integer aCtxVer[2] = { myGlVerMajor, myGlVerMinor };
1431 bool isLowered = false;
1432 if (myGlVerMajor > caps->contextMajorVersionUpper)
1435 myGlVerMajor = caps->contextMajorVersionUpper;
1436 #if defined(GL_ES_VERSION_2_0)
1437 switch (myGlVerMajor)
1439 case 2: myGlVerMinor = 0; break;
1442 switch (myGlVerMajor)
1444 case 1: myGlVerMinor = 5; break;
1445 case 2: myGlVerMinor = 1; break;
1446 case 3: myGlVerMinor = 3; break;
1450 if (caps->contextMinorVersionUpper != -1
1451 && myGlVerMinor > caps->contextMinorVersionUpper)
1454 myGlVerMinor = caps->contextMinorVersionUpper;
1458 PushMessage (GL_DEBUG_SOURCE_APPLICATION, GL_DEBUG_TYPE_PORTABILITY, 0, GL_DEBUG_SEVERITY_MEDIUM,
1459 TCollection_AsciiString ("OpenGL version ") + aCtxVer[0] + "." + aCtxVer[1]
1460 + " has been lowered to " + myGlVerMajor + "." + myGlVerMinor);
1464 if (!caps->ffpEnable
1465 && !IsGlGreaterEqual (2, 0))
1467 caps->ffpEnable = true;
1468 TCollection_ExtendedString aMsg =
1469 TCollection_ExtendedString("OpenGL driver is too old! Context info:\n")
1470 + " Vendor: " + (const char* )::glGetString (GL_VENDOR) + "\n"
1471 + " Renderer: " + (const char* )::glGetString (GL_RENDERER) + "\n"
1472 + " Version: " + (const char* )::glGetString (GL_VERSION) + "\n"
1473 + " Fallback using deprecated fixed-function pipeline.\n"
1474 + " Visualization might work incorrectly.\n"
1475 " Consider upgrading the graphics driver.";
1476 PushMessage (GL_DEBUG_SOURCE_APPLICATION, GL_DEBUG_TYPE_PORTABILITY, 0, GL_DEBUG_SEVERITY_HIGH, aMsg);
1479 #if defined(GL_ES_VERSION_2_0)
1480 (void )theIsCoreProfile;
1481 const bool isCoreProfile = false;
1484 if (myVendor.Search ("nvidia") != -1)
1486 // Buffer detailed info: Buffer object 1 (bound to GL_ARRAY_BUFFER_ARB, usage hint is GL_STATIC_DRAW)
1487 // will use VIDEO memory as the source for buffer object operations.
1488 ExcludeMessage (GL_DEBUG_SOURCE_API, 131185);
1490 if (IsGlGreaterEqual (3, 0))
1492 // retrieve auxiliary function in advance
1493 FindProc ("glGetStringi", myFuncs->glGetStringi);
1496 bool isCoreProfile = false;
1497 if (IsGlGreaterEqual (3, 2))
1499 isCoreProfile = (theIsCoreProfile == Standard_True);
1501 // detect Core profile
1505 ::glGetIntegerv (GL_CONTEXT_PROFILE_MASK, &aProfile);
1506 isCoreProfile = (aProfile & GL_CONTEXT_CORE_PROFILE_BIT) != 0;
1511 myFuncs->load (*this, isCoreProfile);
1513 // initialize debug context extension
1515 && caps->contextDebug)
1517 // setup default callback
1518 myIsGlDebugCtx = Standard_True;
1519 arbDbg->glDebugMessageCallback (debugCallbackWrap, this);
1520 #if defined(GL_ES_VERSION_2_0)
1521 ::glEnable (GL_DEBUG_OUTPUT);
1525 ::glEnable (GL_DEBUG_OUTPUT);
1528 if (caps->contextSyncDebug)
1530 // note that some broken implementations (e.g. simulators) might generate error message on this call
1531 ::glEnable (GL_DEBUG_OUTPUT_SYNCHRONOUS);
1537 glGetIntegerv (GL_MAX_DRAW_BUFFERS, &myMaxDrawBuffers);
1538 glGetIntegerv (GL_MAX_COLOR_ATTACHMENTS, &myMaxColorAttachments);
1539 if (myDrawBuffers.Length() < myMaxDrawBuffers)
1541 myDrawBuffers.Resize (0, myMaxDrawBuffers - 1, false);
1545 glGetIntegerv (GL_MAX_TEXTURE_SIZE, &myMaxTexDim);
1546 #if !defined(GL_ES_VERSION_2_0)
1547 if (IsGlGreaterEqual (1, 3) && core11 != NULL)
1549 // this is a maximum of texture units for FFP functionality,
1550 // usually smaller than combined texture units available for GLSL
1551 glGetIntegerv (GL_MAX_TEXTURE_UNITS, &myMaxTexUnitsFFP);
1552 myMaxTexCombined = myMaxTexUnitsFFP;
1555 if (IsGlGreaterEqual (2, 0))
1557 glGetIntegerv (GL_MAX_COMBINED_TEXTURE_IMAGE_UNITS, &myMaxTexCombined);
1559 mySpriteTexUnit = myMaxTexCombined >= 2
1560 ? Graphic3d_TextureUnit_PointSprite
1561 : Graphic3d_TextureUnit_0;
1563 GLint aMaxVPortSize[2] = {0, 0};
1564 glGetIntegerv (GL_MAX_VIEWPORT_DIMS, aMaxVPortSize);
1565 myMaxDumpSizeX = Min (aMaxVPortSize[0], myMaxTexDim);
1566 myMaxDumpSizeY = Min (aMaxVPortSize[1], myMaxTexDim);
1567 if (myVendor == "intel")
1569 // Intel drivers have known bug with empty dump for images with width>=5462
1570 myMaxDumpSizeX = Min (myMaxDumpSizeX, 4096);
1575 glGetIntegerv (GL_MAX_TEXTURE_MAX_ANISOTROPY_EXT, &myAnisoMax);
1578 myClippingState.Init();
1580 #if defined(GL_ES_VERSION_2_0)
1581 if (IsGlGreaterEqual (3, 1)
1582 && myFuncs->glTexStorage2DMultisample != NULL)
1584 // MSAA RenderBuffers have been defined in OpenGL ES 3.0,
1585 // but MSAA Textures - only in OpenGL ES 3.1+
1586 ::glGetIntegerv (GL_MAX_SAMPLES, &myMaxMsaaSamples);
1589 if (core30fwd != NULL)
1591 // MSAA RenderBuffers have been defined in OpenGL 3.0,
1592 // but MSAA Textures - only in OpenGL 3.2+
1595 ::glGetIntegerv (GL_MAX_SAMPLES, &myMaxMsaaSamples);
1597 else if (CheckExtension ("GL_ARB_texture_multisample")
1598 && myFuncs->glTexImage2DMultisample != NULL)
1600 GLint aNbColorSamples = 0, aNbDepthSamples = 0;
1601 ::glGetIntegerv (GL_MAX_COLOR_TEXTURE_SAMPLES, &aNbColorSamples);
1602 ::glGetIntegerv (GL_MAX_DEPTH_TEXTURE_SAMPLES, &aNbDepthSamples);
1603 myMaxMsaaSamples = Min (aNbColorSamples, aNbDepthSamples);
1608 #if !defined(GL_ES_VERSION_2_0)
1609 if (core32 != NULL && isCoreProfile)
1611 core32->glGenVertexArrays (1, &myDefaultVao);
1614 myTexClamp = IsGlGreaterEqual (1, 2) ? GL_CLAMP_TO_EDGE : GL_CLAMP;
1616 GLint aStereo = GL_FALSE;
1617 glGetIntegerv (GL_STEREO, &aStereo);
1618 myIsStereoBuffers = aStereo == 1;
1620 // get number of maximum clipping planes
1621 glGetIntegerv (GL_MAX_CLIP_PLANES, &myMaxClipPlanes);
1623 // check whether ray tracing mode is supported
1624 myHasRayTracing = IsGlGreaterEqual (3, 1)
1626 && arbFBOBlit != NULL;
1628 // check whether textures in ray tracing mode are supported
1629 myHasRayTracingTextures = myHasRayTracing
1630 && arbTexBindless != NULL;
1632 // check whether adaptive screen sampling in ray tracing mode is supported
1633 myHasRayTracingAdaptiveSampling = myHasRayTracing
1635 myHasRayTracingAdaptiveSamplingAtomic = myHasRayTracingAdaptiveSampling
1636 && CheckExtension ("GL_NV_shader_atomic_float");
1642 // Detect if window buffer is considered by OpenGL as sRGB-ready
1643 // (linear RGB color written by shader is automatically converted into sRGB)
1644 // or not (offscreen FBO should be blit into window buffer with gamma correction).
1645 const GLenum aDefWinBuffer =
1646 #if !defined(GL_ES_VERSION_2_0)
1651 GLint aWinColorEncoding = 0; // GL_LINEAR
1652 arbFBO->glGetFramebufferAttachmentParameteriv (GL_FRAMEBUFFER, aDefWinBuffer, GL_FRAMEBUFFER_ATTACHMENT_COLOR_ENCODING, &aWinColorEncoding);
1654 myIsSRgbWindow = aWinColorEncoding == GL_SRGB;
1656 // On desktop OpenGL, pixel formats are almost always sRGB-ready, even when not requested;
1657 // it is safe behavior on desktop where GL_FRAMEBUFFER_SRGB is disabled by default
1658 // (contrary to OpenGL ES, where it is enabled by default).
1659 // NVIDIA drivers, however, always return GL_LINEAR even for sRGB-ready pixel formats on Windows platform,
1660 // while AMD and Intel report GL_SRGB as expected.
1661 // macOS drivers seems to be also report GL_LINEAR even for [NSColorSpace sRGBColorSpace].
1662 #if !defined(GL_ES_VERSION_2_0)
1664 myIsSRgbWindow = true;
1667 && myVendor.Search ("nvidia") != -1)
1669 myIsSRgbWindow = true;
1673 if (!myIsSRgbWindow)
1675 Message::SendTrace ("OpenGl_Context, warning: window buffer is not sRGB-ready.\n"
1676 "Check OpenGL window creation parameters for optimal performance.");
1681 mySupportedFormats->Add (Image_Format_Gray);
1682 mySupportedFormats->Add (Image_Format_Alpha);
1683 mySupportedFormats->Add (Image_Format_RGB);
1684 mySupportedFormats->Add (Image_Format_RGB32);
1685 mySupportedFormats->Add (Image_Format_RGBA);
1688 #if !defined(GL_ES_VERSION_2_0)
1689 // no BGR on OpenGL ES - only BGRA as extension
1690 mySupportedFormats->Add (Image_Format_BGR);
1692 mySupportedFormats->Add (Image_Format_BGR32);
1693 mySupportedFormats->Add (Image_Format_BGRA);
1697 mySupportedFormats->Add (Image_Format_GrayF);
1698 mySupportedFormats->Add (Image_Format_AlphaF);
1699 mySupportedFormats->Add (Image_Format_RGBF);
1700 mySupportedFormats->Add (Image_Format_RGBAF);
1701 if (hasHalfFloatBuffer)
1703 mySupportedFormats->Add (Image_Format_RGBAF_half);
1707 mySupportedFormats->Add (Image_Format_RGF);
1708 if (hasHalfFloatBuffer)
1710 mySupportedFormats->Add (Image_Format_RGF_half);
1715 #if !defined(GL_ES_VERSION_2_0)
1716 mySupportedFormats->Add (Image_Format_BGRF);
1718 mySupportedFormats->Add (Image_Format_BGRAF);
1722 #ifdef __EMSCRIPTEN__
1723 if (checkEnableWebGlExtension (*this, "GL_WEBGL_compressed_texture_s3tc")) // GL_WEBGL_compressed_texture_s3tc_srgb for sRGB formats
1725 mySupportedFormats->Add (Image_CompressedFormat_RGB_S3TC_DXT1);
1726 mySupportedFormats->Add (Image_CompressedFormat_RGBA_S3TC_DXT1);
1727 mySupportedFormats->Add (Image_CompressedFormat_RGBA_S3TC_DXT3);
1728 mySupportedFormats->Add (Image_CompressedFormat_RGBA_S3TC_DXT5);
1731 && checkEnableWebGlExtension (*this, "GL_WEBGL_depth_texture"))
1733 extPDS = true; // WebGL 1.0 extension (in WebGL 2.0 core)
1736 if (CheckExtension ("GL_EXT_texture_compression_s3tc")) // GL_EXT_texture_sRGB for sRGB formats
1738 mySupportedFormats->Add (Image_CompressedFormat_RGB_S3TC_DXT1);
1739 mySupportedFormats->Add (Image_CompressedFormat_RGBA_S3TC_DXT1);
1740 mySupportedFormats->Add (Image_CompressedFormat_RGBA_S3TC_DXT3);
1741 mySupportedFormats->Add (Image_CompressedFormat_RGBA_S3TC_DXT5);
1745 if (CheckExtension ("GL_EXT_texture_compression_dxt1"))
1747 mySupportedFormats->Add (Image_CompressedFormat_RGB_S3TC_DXT1);
1748 mySupportedFormats->Add (Image_CompressedFormat_RGBA_S3TC_DXT1);
1750 if (CheckExtension ("GL_ANGLE_texture_compression_dxt3"))
1752 mySupportedFormats->Add (Image_CompressedFormat_RGBA_S3TC_DXT3);
1754 if (CheckExtension ("GL_ANGLE_texture_compression_dxt5"))
1756 mySupportedFormats->Add (Image_CompressedFormat_RGBA_S3TC_DXT5);
1761 // check whether PBR shading model is supported
1762 myHasPBR = arbFBO != NULL
1763 && myMaxTexCombined >= 4
1765 && (IsGlGreaterEqual (3, 0)
1766 #if defined(GL_ES_VERSION_2_0)
1768 // || CheckExtension ("GL_EXT_shader_texture_lod") fallback is used when extension is unavailable
1770 || (IsGlGreaterEqual (2, 1) && CheckExtension ("GL_EXT_gpu_shader4"))
1774 myDepthPeelingDepthTexUnit = static_cast<Graphic3d_TextureUnit>(myMaxTexCombined + Graphic3d_TextureUnit_DepthPeelingDepth); // -6
1775 myDepthPeelingFrontColorTexUnit = static_cast<Graphic3d_TextureUnit>(myMaxTexCombined + Graphic3d_TextureUnit_DepthPeelingFrontColor); // -5
1776 myShadowMapTexUnit = static_cast<Graphic3d_TextureUnit>(myMaxTexCombined + Graphic3d_TextureUnit_ShadowMap); // -4
1777 myPBREnvLUTTexUnit = static_cast<Graphic3d_TextureUnit>(myMaxTexCombined + Graphic3d_TextureUnit_PbrEnvironmentLUT); // -3
1778 myPBRDiffIBLMapSHTexUnit = static_cast<Graphic3d_TextureUnit>(myMaxTexCombined + Graphic3d_TextureUnit_PbrIblDiffuseSH); // -2
1779 myPBRSpecIBLMapTexUnit = static_cast<Graphic3d_TextureUnit>(myMaxTexCombined + Graphic3d_TextureUnit_PbrIblSpecular); // -1
1782 myDepthPeelingDepthTexUnit = static_cast<Graphic3d_TextureUnit>(myDepthPeelingDepthTexUnit + 3);
1783 myDepthPeelingFrontColorTexUnit = static_cast<Graphic3d_TextureUnit>(myDepthPeelingFrontColorTexUnit + 3);
1784 myShadowMapTexUnit = static_cast<Graphic3d_TextureUnit>(myShadowMapTexUnit + 3);
1788 // =======================================================================
1789 // function : MemoryInfo
1791 // =======================================================================
1792 Standard_Size OpenGl_Context::AvailableMemory() const
1794 #if !defined(GL_ES_VERSION_2_0)
1797 // this is actually information for VBO pool
1798 // however because pools are mostly shared
1799 // it can be used for total GPU memory estimations
1802 glGetIntegerv (GL_VBO_FREE_MEMORY_ATI, aMemInfo);
1803 // returned value is in KiB, however this maybe changed in future
1804 return Standard_Size(aMemInfo[0]) * 1024;
1808 // current available dedicated video memory (in KiB), currently unused GPU memory
1810 glGetIntegerv (GL_GPU_MEMORY_INFO_CURRENT_AVAILABLE_VIDMEM_NVX, &aMemInfo);
1811 return Standard_Size(aMemInfo) * 1024;
1817 // =======================================================================
1818 // function : MemoryInfo
1820 // =======================================================================
1821 TCollection_AsciiString OpenGl_Context::MemoryInfo() const
1823 TColStd_IndexedDataMapOfStringString aDict;
1826 TCollection_AsciiString aText;
1827 for (TColStd_IndexedDataMapOfStringString::Iterator anIter (aDict); anIter.More(); anIter.Next())
1829 if (!aText.IsEmpty())
1833 aText += TCollection_AsciiString(" ") + anIter.Key() + ": " + anIter.Value();
1838 // =======================================================================
1839 // function : MemoryInfo
1841 // =======================================================================
1842 void OpenGl_Context::MemoryInfo (TColStd_IndexedDataMapOfStringString& theDict) const
1844 #if defined(GL_ES_VERSION_2_0)
1846 #elif defined(__APPLE__) && !defined(MACOSX_USE_GLX)
1847 GLint aGlRendId = 0;
1848 CGLGetParameter (CGLGetCurrentContext(), kCGLCPCurrentRendererID, &aGlRendId);
1850 CGLRendererInfoObj aRendObj = NULL;
1851 CGOpenGLDisplayMask aDispMask = CGDisplayIDToOpenGLDisplayMask (kCGDirectMainDisplay);
1853 CGLQueryRendererInfo (aDispMask, &aRendObj, &aRendNb);
1854 for (GLint aRendIter = 0; aRendIter < aRendNb; ++aRendIter)
1857 if (CGLDescribeRenderer (aRendObj, aRendIter, kCGLRPRendererID, &aRendId) != kCGLNoError
1858 || aRendId != aGlRendId)
1863 //kCGLRPVideoMemoryMegabytes = 131;
1864 //kCGLRPTextureMemoryMegabytes = 132;
1866 #if MAC_OS_X_VERSION_MIN_REQUIRED >= 1070
1867 if (CGLDescribeRenderer(aRendObj, aRendIter, kCGLRPVideoMemoryMegabytes, &aVMem) == kCGLNoError)
1869 addInfo (theDict, "GPU memory", TCollection_AsciiString() + aVMem + " MiB");
1871 if (CGLDescribeRenderer(aRendObj, aRendIter, kCGLRPTextureMemoryMegabytes, &aVMem) == kCGLNoError)
1873 addInfo (theDict, "GPU Texture memory", TCollection_AsciiString() + aVMem + " MiB");
1876 if (CGLDescribeRenderer(aRendObj, aRendIter, kCGLRPVideoMemory, &aVMem) == kCGLNoError)
1878 addInfo (theDict, "GPU memory", TCollection_AsciiString() + (aVMem / (1024 * 1024)) + " MiB");
1880 if (CGLDescribeRenderer(aRendObj, aRendIter, kCGLRPTextureMemory, &aVMem) == kCGLNoError)
1882 addInfo (theDict, "GPU Texture memory", TCollection_AsciiString() + (aVMem / (1024 * 1024)) + " MiB");
1888 #if !defined(GL_ES_VERSION_2_0)
1892 memset (aValues, 0, sizeof(aValues));
1893 glGetIntegerv (GL_VBO_FREE_MEMORY_ATI, aValues);
1895 // total memory free in the pool
1896 addInfo (theDict, "GPU free memory", TCollection_AsciiString() + (aValues[0] / 1024) + " MiB");
1898 if (aValues[1] != aValues[0])
1900 // largest available free block in the pool
1901 addInfo (theDict, "Largest free block", TCollection_AsciiString() + (aValues[1] / 1024) + " MiB");
1903 if (aValues[2] != aValues[0])
1905 // total auxiliary memory free
1906 addInfo (theDict, "Free auxiliary memory", TCollection_AsciiString() + (aValues[2] / 1024) + " MiB");
1911 //current available dedicated video memory (in KiB), currently unused GPU memory
1913 glGetIntegerv (GL_GPU_MEMORY_INFO_CURRENT_AVAILABLE_VIDMEM_NVX, &aValue);
1914 addInfo (theDict, "GPU free memory", TCollection_AsciiString() + (aValue / 1024) + " MiB");
1916 // dedicated video memory, total size (in KiB) of the GPU memory
1917 GLint aDedicated = 0;
1918 glGetIntegerv (GL_GPU_MEMORY_INFO_DEDICATED_VIDMEM_NVX, &aDedicated);
1919 addInfo (theDict, "GPU memory", TCollection_AsciiString() + (aDedicated / 1024) + " MiB");
1921 // total available memory, total size (in KiB) of the memory available for allocations
1922 glGetIntegerv (GL_GPU_MEMORY_INFO_TOTAL_AVAILABLE_MEMORY_NVX, &aValue);
1923 if (aValue != aDedicated)
1925 // different only for special configurations
1926 addInfo (theDict, "Total memory", TCollection_AsciiString() + (aValue / 1024) + " MiB");
1930 else if (myFuncs->wglGetGPUInfoAMD != NULL
1931 && myFuncs->wglGetContextGPUIDAMD != NULL)
1933 GLuint aTotalMemMiB = 0;
1934 UINT anAmdId = myFuncs->wglGetContextGPUIDAMD ((HGLRC )myGContext);
1937 if (myFuncs->wglGetGPUInfoAMD (anAmdId, WGL_GPU_RAM_AMD, GL_UNSIGNED_INT, sizeof(aTotalMemMiB), &aTotalMemMiB) > 0)
1939 addInfo (theDict, "GPU memory", TCollection_AsciiString() + (int )aTotalMemMiB + " MiB");
1946 #if !defined(GL_ES_VERSION_2_0) && !defined(__APPLE__) && !defined(_WIN32)
1947 // GLX_RENDERER_VENDOR_ID_MESA
1948 if (myFuncs->glXQueryCurrentRendererIntegerMESA != NULL)
1950 unsigned int aVMemMiB = 0;
1951 if (myFuncs->glXQueryCurrentRendererIntegerMESA (GLX_RENDERER_VIDEO_MEMORY_MESA, &aVMemMiB) != False)
1953 addInfo (theDict, "GPU memory", TCollection_AsciiString() + int(aVMemMiB) + " MiB");
1959 // =======================================================================
1960 // function : DiagnosticInfo
1962 // =======================================================================
1963 void OpenGl_Context::DiagnosticInformation (TColStd_IndexedDataMapOfStringString& theDict,
1964 Graphic3d_DiagnosticInfo theFlags) const
1966 if ((theFlags & Graphic3d_DiagnosticInfo_NativePlatform) != 0)
1968 #if defined(HAVE_EGL)
1969 addInfo (theDict, "EGLVersion", ::eglQueryString ((EGLDisplay )myDisplay, EGL_VERSION));
1970 addInfo (theDict, "EGLVendor", ::eglQueryString ((EGLDisplay )myDisplay, EGL_VENDOR));
1971 addInfo (theDict, "EGLClientAPIs", ::eglQueryString ((EGLDisplay )myDisplay, EGL_CLIENT_APIS));
1972 if ((theFlags & Graphic3d_DiagnosticInfo_Extensions) != 0)
1974 addInfo (theDict, "EGLExtensions", ::eglQueryString ((EGLDisplay )myDisplay, EGL_EXTENSIONS));
1976 #elif defined(_WIN32)
1977 if ((theFlags & Graphic3d_DiagnosticInfo_Extensions) != 0
1978 && myFuncs->wglGetExtensionsStringARB != NULL)
1980 const char* aWglExts = myFuncs->wglGetExtensionsStringARB ((HDC )myWindowDC);
1981 addInfo (theDict, "WGLExtensions", aWglExts);
1983 #elif defined(__APPLE__)
1986 Display* aDisplay = (Display*)myDisplay;
1987 const int aScreen = DefaultScreen(aDisplay);
1988 addInfo (theDict, "GLXDirectRendering", ::glXIsDirect (aDisplay, (GLXContext )myGContext) ? "Yes" : "No");
1989 addInfo (theDict, "GLXVendor", ::glXQueryServerString (aDisplay, aScreen, GLX_VENDOR));
1990 addInfo (theDict, "GLXVersion", ::glXQueryServerString (aDisplay, aScreen, GLX_VERSION));
1991 if ((theFlags & Graphic3d_DiagnosticInfo_Extensions) != 0)
1993 const char* aGlxExts = ::glXQueryExtensionsString (aDisplay, aScreen);
1994 addInfo(theDict, "GLXExtensions", aGlxExts);
1997 addInfo (theDict, "GLXClientVendor", ::glXGetClientString (aDisplay, GLX_VENDOR));
1998 addInfo (theDict, "GLXClientVersion", ::glXGetClientString (aDisplay, GLX_VERSION));
1999 if ((theFlags & Graphic3d_DiagnosticInfo_Extensions) != 0)
2001 addInfo (theDict, "GLXClientExtensions", ::glXGetClientString (aDisplay, GLX_EXTENSIONS));
2006 if ((theFlags & Graphic3d_DiagnosticInfo_Device) != 0)
2008 Standard_Integer aDriverVer[2] = {};
2009 ReadGlVersion (aDriverVer[0], aDriverVer[1]);
2010 addInfo (theDict, "GLvendor", (const char*)::glGetString (GL_VENDOR));
2011 addInfo (theDict, "GLdevice", (const char*)::glGetString (GL_RENDERER));
2012 #ifdef __EMSCRIPTEN__
2013 if (checkEnableWebGlExtension (*this, "GL_WEBGL_debug_renderer_info"))
2015 if (const char* aVendor = (const char*)::glGetString (0x9245))
2017 addInfo (theDict, "GLunmaskedVendor", aVendor);
2019 if (const char* aDevice = (const char*)::glGetString (0x9246))
2021 addInfo (theDict, "GLunmaskedDevice", aDevice);
2026 addInfo (theDict, "GLversion", (const char*)::glGetString (GL_VERSION));
2027 if (myGlVerMajor != aDriverVer[0]
2028 || myGlVerMinor != aDriverVer[1])
2030 addInfo (theDict, "GLversionOcct", TCollection_AsciiString (myGlVerMajor) + "." + TCollection_AsciiString (myGlVerMinor));
2032 if (IsGlGreaterEqual (2, 0))
2034 addInfo (theDict, "GLSLversion", (const char*)::glGetString (GL_SHADING_LANGUAGE_VERSION));
2038 addInfo (theDict, "GLdebug", "ON");
2042 if ((theFlags & Graphic3d_DiagnosticInfo_Limits) != 0)
2044 addInfo (theDict, "Max texture size", TCollection_AsciiString(myMaxTexDim));
2045 addInfo (theDict, "Max FBO dump size", TCollection_AsciiString() + myMaxDumpSizeX + "x" + myMaxDumpSizeY);
2046 addInfo (theDict, "Max combined texture units", TCollection_AsciiString(myMaxTexCombined));
2047 addInfo (theDict, "Max MSAA samples", TCollection_AsciiString(myMaxMsaaSamples));
2050 if ((theFlags & Graphic3d_DiagnosticInfo_FrameBuffer) != 0)
2052 GLint aViewport[4] = {};
2053 ::glGetIntegerv (GL_VIEWPORT, aViewport);
2054 addInfo (theDict, "Viewport", TCollection_AsciiString() + aViewport[2] + "x" + aViewport[3]);
2057 if ((theFlags & Graphic3d_DiagnosticInfo_Memory) != 0)
2059 MemoryInfo (theDict);
2062 if ((theFlags & Graphic3d_DiagnosticInfo_Extensions) != 0)
2064 #if !defined(GL_ES_VERSION_2_0)
2065 if (IsGlGreaterEqual (3, 0)
2066 && myFuncs->glGetStringi != NULL)
2068 TCollection_AsciiString anExtList;
2070 ::glGetIntegerv (GL_NUM_EXTENSIONS, &anExtNb);
2071 for (GLint anIter = 0; anIter < anExtNb; ++anIter)
2073 const char* anExtension = (const char*)myFuncs->glGetStringi (GL_EXTENSIONS, (GLuint)anIter);
2074 if (!anExtList.IsEmpty())
2078 anExtList += anExtension;
2080 addInfo(theDict, "GLextensions", anExtList);
2085 addInfo (theDict, "GLextensions", (const char*)::glGetString (GL_EXTENSIONS));
2090 // =======================================================================
2091 // function : GetResource
2093 // =======================================================================
2094 const Handle(OpenGl_Resource)& OpenGl_Context::GetResource (const TCollection_AsciiString& theKey) const
2096 return mySharedResources->IsBound (theKey) ? mySharedResources->Find (theKey) : NULL_GL_RESOURCE;
2099 // =======================================================================
2100 // function : ShareResource
2102 // =======================================================================
2103 Standard_Boolean OpenGl_Context::ShareResource (const TCollection_AsciiString& theKey,
2104 const Handle(OpenGl_Resource)& theResource)
2106 if (theKey.IsEmpty() || theResource.IsNull())
2108 return Standard_False;
2110 return mySharedResources->Bind (theKey, theResource);
2113 // =======================================================================
2114 // function : ReleaseResource
2116 // =======================================================================
2117 void OpenGl_Context::ReleaseResource (const TCollection_AsciiString& theKey,
2118 const Standard_Boolean theToDelay)
2120 if (!mySharedResources->IsBound (theKey))
2124 const Handle(OpenGl_Resource)& aRes = mySharedResources->Find (theKey);
2125 if (aRes->GetRefCount() > 1)
2132 myDelayed->Bind (theKey, 1);
2136 aRes->Release (this);
2137 mySharedResources->UnBind (theKey);
2141 // =======================================================================
2142 // function : ReleaseDelayed
2144 // =======================================================================
2145 void OpenGl_Context::ReleaseDelayed()
2147 // release queued elements
2148 while (!myUnusedResources->IsEmpty())
2150 myUnusedResources->First()->Release (this);
2151 myUnusedResources->RemoveFirst();
2154 // release delayed shared resources
2155 NCollection_Vector<TCollection_AsciiString> aDeadList;
2156 for (NCollection_DataMap<TCollection_AsciiString, Standard_Integer>::Iterator anIter (*myDelayed);
2157 anIter.More(); anIter.Next())
2159 if (++anIter.ChangeValue() <= 2)
2161 continue; // postpone release one more frame to ensure noone use it periodically
2164 const TCollection_AsciiString& aKey = anIter.Key();
2165 if (!mySharedResources->IsBound (aKey))
2167 // mixed unshared strategy delayed/undelayed was used!
2168 aDeadList.Append (aKey);
2172 const Handle(OpenGl_Resource)& aRes = mySharedResources->ChangeFind (aKey);
2173 if (aRes->GetRefCount() > 1)
2175 // should be only 1 instance in mySharedResources
2176 // if not - resource was reused again
2177 aDeadList.Append (aKey);
2181 // release resource if no one requiested it more than 2 redraw calls
2182 aRes->Release (this);
2183 mySharedResources->UnBind (aKey);
2184 aDeadList.Append (aKey);
2187 for (Standard_Integer anIter = 0; anIter < aDeadList.Length(); ++anIter)
2189 myDelayed->UnBind (aDeadList.Value (anIter));
2193 // =======================================================================
2194 // function : BindTextures
2196 // =======================================================================
2197 Handle(OpenGl_TextureSet) OpenGl_Context::BindTextures (const Handle(OpenGl_TextureSet)& theTextures,
2198 const Handle(OpenGl_ShaderProgram)& theProgram)
2200 const Standard_Integer aTextureSetBits = !theTextures.IsNull() ? theTextures->TextureSetBits() : 0;
2201 const Standard_Integer aProgramBits = !theProgram.IsNull() ? theProgram->TextureSetBits() : 0;
2202 Standard_Integer aMissingBits = aProgramBits & ~aTextureSetBits;
2203 if (aMissingBits != 0
2204 && myTextureRgbaBlack.IsNull())
2206 // allocate mock textures
2207 myTextureRgbaBlack = new OpenGl_Texture();
2208 myTextureRgbaWhite = new OpenGl_Texture();
2209 Image_PixMap anImage;
2210 anImage.InitZero (Image_Format_RGBA, 2, 2, 0, (Standard_Byte )0);
2211 if (!myTextureRgbaBlack->Init (this, OpenGl_TextureFormat::Create<GLubyte, 4>(), Graphic3d_Vec2i (2, 2), Graphic3d_TOT_2D, &anImage))
2213 PushMessage (GL_DEBUG_SOURCE_APPLICATION, GL_DEBUG_TYPE_PORTABILITY, 0, GL_DEBUG_SEVERITY_HIGH,
2214 "Error: unable to create unit mock PBR texture map.");
2216 anImage.InitZero (Image_Format_RGBA, 2, 2, 0, (Standard_Byte )255);
2217 if (!myTextureRgbaWhite->Init (this, OpenGl_TextureFormat::Create<GLubyte, 4>(), Graphic3d_Vec2i (2, 2), Graphic3d_TOT_2D, &anImage))
2219 PushMessage (GL_DEBUG_SOURCE_APPLICATION, GL_DEBUG_TYPE_PORTABILITY, 0, GL_DEBUG_SEVERITY_HIGH,
2220 "Error: unable to create normal mock PBR texture map.");
2224 Handle(OpenGl_TextureSet) anOldTextures = myActiveTextures;
2225 if (myActiveTextures != theTextures)
2227 Handle(OpenGl_Context) aThisCtx (this);
2228 for (OpenGl_TextureSetPairIterator aSlotIter (myActiveTextures, theTextures); aSlotIter.More(); aSlotIter.Next())
2230 const Graphic3d_TextureUnit aTexUnit = aSlotIter.Unit();
2231 const OpenGl_Texture* aTextureOld = aSlotIter.Texture1();
2232 const OpenGl_Texture* aTextureNew = aSlotIter.Texture2();
2233 if (aTextureNew == aTextureOld)
2238 if (aTextureNew != NULL
2239 && aTextureNew->IsValid())
2241 if (aTexUnit >= myMaxTexCombined)
2243 PushMessage (GL_DEBUG_SOURCE_APPLICATION, GL_DEBUG_TYPE_ERROR, 0, GL_DEBUG_SEVERITY_HIGH,
2244 TCollection_AsciiString("Texture unit ") + aTexUnit + " for " + aTextureNew->ResourceId() + " exceeds hardware limit " + myMaxTexCombined);
2248 aTextureNew->Bind (aThisCtx, aTexUnit);
2249 if (aTextureNew->Sampler()->ToUpdateParameters())
2251 if (aTextureNew->Sampler()->IsImmutable())
2253 aTextureNew->Sampler()->Init (aThisCtx, *aTextureNew);
2257 OpenGl_Sampler::applySamplerParams (aThisCtx, aTextureNew->Sampler()->Parameters(), aTextureNew->Sampler().get(), aTextureNew->GetTarget(), aTextureNew->MaxMipmapLevel());
2260 #if !defined(GL_ES_VERSION_2_0)
2263 OpenGl_Sampler::applyGlobalTextureParams (aThisCtx, *aTextureNew, aTextureNew->Sampler()->Parameters());
2267 else if (aTextureOld != NULL
2268 && aTextureOld->IsValid())
2270 aTextureOld->Unbind (aThisCtx, aTexUnit);
2271 #if !defined(GL_ES_VERSION_2_0)
2274 OpenGl_Sampler::resetGlobalTextureParams (aThisCtx, *aTextureOld, aTextureOld->Sampler()->Parameters());
2279 myActiveTextures = theTextures;
2282 if (myActiveMockTextures != aMissingBits)
2284 myActiveMockTextures = aMissingBits;
2285 for (Standard_Integer aBitIter = 0; aMissingBits != 0; ++aBitIter)
2287 Standard_Integer aUnitMask = 1 << aBitIter;
2288 if ((aUnitMask & aMissingBits) != 0)
2290 aMissingBits = aMissingBits & ~aUnitMask;
2291 if (aBitIter == Graphic3d_TextureUnit_Normal)
2293 myTextureRgbaBlack->Bind (this, static_cast<Graphic3d_TextureUnit>(aBitIter));
2297 myTextureRgbaWhite->Bind (this, static_cast<Graphic3d_TextureUnit>(aBitIter));
2303 return anOldTextures;
2306 // =======================================================================
2307 // function : BindProgram
2309 // =======================================================================
2310 Standard_Boolean OpenGl_Context::BindProgram (const Handle(OpenGl_ShaderProgram)& theProgram)
2312 if (core20fwd == NULL)
2314 return Standard_False;
2316 else if (myActiveProgram == theProgram)
2318 return Standard_True;
2321 if (theProgram.IsNull()
2322 || !theProgram->IsValid())
2324 if (!myActiveProgram.IsNull())
2326 core20fwd->glUseProgram (OpenGl_ShaderProgram::NO_PROGRAM);
2327 myActiveProgram.Nullify();
2329 return Standard_False;
2332 myActiveProgram = theProgram;
2333 core20fwd->glUseProgram (theProgram->ProgramId());
2334 return Standard_True;
2337 // =======================================================================
2338 // function : BindDefaultVao
2340 // =======================================================================
2341 void OpenGl_Context::BindDefaultVao()
2343 #if !defined(GL_ES_VERSION_2_0)
2344 if (myDefaultVao == 0
2350 core32->glBindVertexArray (myDefaultVao);
2354 // =======================================================================
2355 // function : SetDefaultFrameBuffer
2357 // =======================================================================
2358 Handle(OpenGl_FrameBuffer) OpenGl_Context::SetDefaultFrameBuffer (const Handle(OpenGl_FrameBuffer)& theFbo)
2360 Handle(OpenGl_FrameBuffer) aFbo = myDefaultFbo;
2361 myDefaultFbo = theFbo;
2365 // =======================================================================
2366 // function : SetShadingMaterial
2368 // =======================================================================
2369 void OpenGl_Context::SetShadingMaterial (const OpenGl_Aspects* theAspect,
2370 const Handle(Graphic3d_PresentationAttributes)& theHighlight)
2372 const Handle(Graphic3d_Aspects)& anAspect = (!theHighlight.IsNull() && !theHighlight->BasicFillAreaAspect().IsNull())
2373 ? (const Handle(Graphic3d_Aspects)& )theHighlight->BasicFillAreaAspect()
2374 : theAspect->Aspect();
2376 const bool toDistinguish = anAspect->Distinguish();
2377 const bool toMapTexture = anAspect->ToMapTexture();
2378 const Graphic3d_MaterialAspect& aMatFrontSrc = anAspect->FrontMaterial();
2379 const Graphic3d_MaterialAspect& aMatBackSrc = toDistinguish
2380 ? anAspect->BackMaterial()
2382 const Quantity_Color& aFrontIntColor = anAspect->InteriorColor();
2383 const Quantity_Color& aBackIntColor = toDistinguish
2384 ? anAspect->BackInteriorColor()
2387 myMatFront.Init (*this, aMatFrontSrc, aFrontIntColor);
2390 myMatBack.Init (*this, aMatBackSrc, aBackIntColor);
2394 myMatBack = myMatFront;
2397 if (!theHighlight.IsNull()
2398 && theHighlight->BasicFillAreaAspect().IsNull())
2400 myMatFront.SetColor (theHighlight->ColorRGBA());
2401 myMatBack .SetColor (theHighlight->ColorRGBA());
2404 Standard_ShortReal anAlphaFront = 1.0f;
2405 Standard_ShortReal anAlphaBack = 1.0f;
2406 if (CheckIsTransparent (theAspect, theHighlight, anAlphaFront, anAlphaBack))
2408 myMatFront.Common.Diffuse.a() = anAlphaFront;
2409 myMatBack .Common.Diffuse.a() = anAlphaBack;
2411 myMatFront.Pbr.BaseColor.a() = anAlphaFront;
2412 myMatBack .Pbr.BaseColor.a() = anAlphaBack;
2415 // do not update material properties in case of zero reflection mode,
2416 // because GL lighting will be disabled by OpenGl_PrimitiveArray::DrawArray() anyway.
2417 const OpenGl_MaterialState& aMatState = myShaderManager->MaterialState();
2418 float anAlphaCutoff = anAspect->AlphaMode() == Graphic3d_AlphaMode_Mask
2419 ? anAspect->AlphaCutoff()
2421 if (anAspect->ToDrawEdges())
2423 if (anAspect->InteriorStyle() == Aspect_IS_EMPTY
2424 || (anAspect->InteriorStyle() == Aspect_IS_SOLID
2425 && anAspect->EdgeColorRGBA().Alpha() < 1.0f))
2427 anAlphaCutoff = 0.285f;
2430 if (theAspect->ShadingModel() == Graphic3d_TOSM_UNLIT)
2432 if (anAlphaCutoff == aMatState.AlphaCutoff())
2437 else if (myMatFront == aMatState.FrontMaterial()
2438 && myMatBack == aMatState.BackMaterial()
2439 && toDistinguish == aMatState.ToDistinguish()
2440 && toMapTexture == aMatState.ToMapTexture()
2441 && anAlphaCutoff == aMatState.AlphaCutoff())
2446 myShaderManager->UpdateMaterialStateTo (myMatFront, myMatBack, anAlphaCutoff, toDistinguish, toMapTexture);
2449 // =======================================================================
2450 // function : CheckIsTransparent
2452 // =======================================================================
2453 Standard_Boolean OpenGl_Context::CheckIsTransparent (const OpenGl_Aspects* theAspect,
2454 const Handle(Graphic3d_PresentationAttributes)& theHighlight,
2455 Standard_ShortReal& theAlphaFront,
2456 Standard_ShortReal& theAlphaBack)
2458 const Handle(Graphic3d_Aspects)& anAspect = (!theHighlight.IsNull() && !theHighlight->BasicFillAreaAspect().IsNull())
2459 ? (const Handle(Graphic3d_Aspects)& )theHighlight->BasicFillAreaAspect()
2460 : theAspect->Aspect();
2462 const bool toDistinguish = anAspect->Distinguish();
2463 const Graphic3d_MaterialAspect& aMatFrontSrc = anAspect->FrontMaterial();
2464 const Graphic3d_MaterialAspect& aMatBackSrc = toDistinguish
2465 ? anAspect->BackMaterial()
2468 // handling transparency
2469 if (!theHighlight.IsNull()
2470 && theHighlight->BasicFillAreaAspect().IsNull())
2472 theAlphaFront = theHighlight->ColorRGBA().Alpha();
2473 theAlphaBack = theHighlight->ColorRGBA().Alpha();
2477 theAlphaFront = aMatFrontSrc.Alpha();
2478 theAlphaBack = aMatBackSrc .Alpha();
2481 if (anAspect->AlphaMode() == Graphic3d_AlphaMode_BlendAuto)
2483 return theAlphaFront < 1.0f
2484 || theAlphaBack < 1.0f;
2486 return anAspect->AlphaMode() == Graphic3d_AlphaMode_Blend;
2489 // =======================================================================
2490 // function : SetColor4fv
2492 // =======================================================================
2493 void OpenGl_Context::SetColor4fv (const OpenGl_Vec4& theColor)
2495 if (!myActiveProgram.IsNull())
2497 if (const OpenGl_ShaderUniformLocation& aLoc = myActiveProgram->GetStateLocation (OpenGl_OCCT_COLOR))
2499 myActiveProgram->SetUniform (this, aLoc, Vec4FromQuantityColor (theColor));
2502 #if !defined(GL_ES_VERSION_2_0)
2503 else if (core11 != NULL)
2505 core11->glColor4fv (theColor.GetData());
2510 // =======================================================================
2511 // function : SetTypeOfLine
2513 // =======================================================================
2514 void OpenGl_Context::SetTypeOfLine (const Aspect_TypeOfLine theType,
2515 const Standard_ShortReal theFactor)
2517 SetLineStipple (theFactor, Graphic3d_Aspects::DefaultLinePatternForType (theType));
2520 // =======================================================================
2521 // function : SetLineStipple
2523 // =======================================================================
2524 void OpenGl_Context::SetLineStipple (const Standard_ShortReal theFactor,
2525 const uint16_t thePattern)
2527 if (!myActiveProgram.IsNull())
2529 if (const OpenGl_ShaderUniformLocation aPatternLoc = myActiveProgram->GetStateLocation (OpenGl_OCCT_LINE_STIPPLE_PATTERN))
2531 if (hasGlslBitwiseOps != OpenGl_FeatureNotAvailable)
2533 myActiveProgram->SetUniform (this, aPatternLoc, (Standard_Integer )thePattern);
2537 Standard_Integer aPatArr[16] = {};
2538 for (unsigned int aBit = 0; aBit < 16; ++aBit)
2540 aPatArr[aBit] = ((unsigned int)(thePattern) & (1U << aBit)) != 0 ? 1 : 0;
2542 myActiveProgram->SetUniform (this, aPatternLoc, 16, aPatArr);
2544 myActiveProgram->SetUniform (this, myActiveProgram->GetStateLocation (OpenGl_OCCT_LINE_STIPPLE_FACTOR), theFactor);
2549 #if !defined(GL_ES_VERSION_2_0)
2550 if (thePattern != 0xFFFF)
2554 core11fwd->glEnable (GL_LINE_STIPPLE);
2556 core11->glLineStipple (static_cast<GLint> (theFactor),
2557 static_cast<GLushort> (thePattern));
2564 core11fwd->glDisable (GL_LINE_STIPPLE);
2570 // =======================================================================
2571 // function : SetLineWidth
2573 // =======================================================================
2574 void OpenGl_Context::SetLineWidth (const Standard_ShortReal theWidth)
2578 // glLineWidth() is still defined within Core Profile, but has no effect with values != 1.0f
2579 core11fwd->glLineWidth (theWidth * myLineWidthScale);
2583 // =======================================================================
2584 // function : SetTextureMatrix
2586 // =======================================================================
2587 void OpenGl_Context::SetTextureMatrix (const Handle(Graphic3d_TextureParams)& theParams,
2588 const Standard_Boolean theIsTopDown)
2590 if (theParams.IsNull())
2595 const Graphic3d_Vec2& aScale = theParams->Scale();
2596 const Graphic3d_Vec2& aTrans = theParams->Translation();
2597 if (!myActiveProgram.IsNull())
2599 const GLint aUniLoc = myActiveProgram->GetStateLocation (OpenGl_OCCT_TEXTURE_TRSF2D);
2600 if (aUniLoc == OpenGl_ShaderProgram::INVALID_LOCATION)
2605 // pack transformation parameters
2606 OpenGl_Vec4 aTrsf[2] =
2608 OpenGl_Vec4 (-aTrans.x(), -aTrans.y(), aScale.x(), aScale.y()),
2609 OpenGl_Vec4 (static_cast<float> (std::sin (-theParams->Rotation() * M_PI / 180.0)),
2610 static_cast<float> (std::cos (-theParams->Rotation() * M_PI / 180.0)),
2613 if (caps->isTopDownTextureUV != theIsTopDown)
2616 aTrsf[0].y() = -aTrans.y() + 1.0f / aScale.y();
2617 aTrsf[0].w() = -aScale.y();
2619 myActiveProgram->SetUniform (this, aUniLoc, 2, aTrsf);
2623 #if !defined(GL_ES_VERSION_2_0)
2626 GLint aMatrixMode = GL_TEXTURE;
2627 ::glGetIntegerv (GL_MATRIX_MODE, &aMatrixMode);
2629 core11->glMatrixMode (GL_TEXTURE);
2630 OpenGl_Mat4 aTextureMat;
2631 if (caps->isTopDownTextureUV != theIsTopDown)
2634 Graphic3d_TransformUtils::Scale (aTextureMat, aScale.x(), -aScale.y(), 1.0f);
2635 Graphic3d_TransformUtils::Translate (aTextureMat, -aTrans.x(), -aTrans.y() + 1.0f / aScale.y(), 0.0f);
2639 Graphic3d_TransformUtils::Scale (aTextureMat, aScale.x(), aScale.y(), 1.0f);
2640 Graphic3d_TransformUtils::Translate (aTextureMat, -aTrans.x(), -aTrans.y(), 0.0f);
2642 Graphic3d_TransformUtils::Rotate (aTextureMat, -theParams->Rotation(), 0.0f, 0.0f, 1.0f);
2643 core11->glLoadMatrixf (aTextureMat);
2644 core11->glMatrixMode (aMatrixMode);
2649 // =======================================================================
2650 // function : SetPointSize
2652 // =======================================================================
2653 void OpenGl_Context::SetPointSize (const Standard_ShortReal theSize)
2655 if (!myActiveProgram.IsNull())
2657 myActiveProgram->SetUniform (this, myActiveProgram->GetStateLocation (OpenGl_OCCT_POINT_SIZE), theSize);
2658 #if !defined(GL_ES_VERSION_2_0)
2659 //myContext->core11fwd->glEnable (GL_VERTEX_PROGRAM_POINT_SIZE);
2662 #if !defined(GL_ES_VERSION_2_0)
2665 core11fwd->glPointSize (theSize);
2666 if (core20fwd != NULL)
2668 //myContext->core11fwd->glDisable (GL_VERTEX_PROGRAM_POINT_SIZE);
2674 // =======================================================================
2675 // function : SetPointSpriteOrigin
2677 // =======================================================================
2678 void OpenGl_Context::SetPointSpriteOrigin()
2680 #if !defined(GL_ES_VERSION_2_0)
2681 if (core15fwd == NULL)
2686 const int aNewState = !myActiveProgram.IsNull() ? GL_UPPER_LEFT : GL_LOWER_LEFT;
2687 if (myPointSpriteOrig != aNewState)
2689 myPointSpriteOrig = aNewState;
2690 core15fwd->glPointParameteri (GL_POINT_SPRITE_COORD_ORIGIN, aNewState);
2695 // =======================================================================
2696 // function : SetGlNormalizeEnabled
2698 // =======================================================================
2699 Standard_Boolean OpenGl_Context::SetGlNormalizeEnabled (Standard_Boolean isEnabled)
2701 if (isEnabled == myIsGlNormalizeEnabled)
2703 return myIsGlNormalizeEnabled;
2706 Standard_Boolean anOldGlNormalize = myIsGlNormalizeEnabled;
2708 myIsGlNormalizeEnabled = isEnabled;
2710 #if !defined(GL_ES_VERSION_2_0)
2715 ::glEnable (GL_NORMALIZE);
2719 ::glDisable (GL_NORMALIZE);
2724 return anOldGlNormalize;
2727 // =======================================================================
2728 // function : SetShadeModel
2730 // =======================================================================
2731 void OpenGl_Context::SetShadeModel (Graphic3d_TypeOfShadingModel theModel)
2733 #if !defined(GL_ES_VERSION_2_0)
2736 const Standard_Integer aModel = theModel == Graphic3d_TOSM_FACET
2737 || theModel == Graphic3d_TOSM_PBR_FACET ? GL_FLAT : GL_SMOOTH;
2738 if (myShadeModel == aModel)
2742 myShadeModel = aModel;
2743 core11->glShadeModel (aModel);
2750 // =======================================================================
2751 // function : SetPolygonMode
2753 // =======================================================================
2754 Standard_Integer OpenGl_Context::SetPolygonMode (const Standard_Integer theMode)
2756 if (myPolygonMode == theMode)
2758 return myPolygonMode;
2761 const Standard_Integer anOldPolygonMode = myPolygonMode;
2763 myPolygonMode = theMode;
2765 #if !defined(GL_ES_VERSION_2_0)
2766 ::glPolygonMode (GL_FRONT_AND_BACK, (GLenum)theMode);
2769 return anOldPolygonMode;
2772 // =======================================================================
2773 // function : SetPolygonHatchEnabled
2775 // =======================================================================
2776 bool OpenGl_Context::SetPolygonHatchEnabled (const bool theIsEnabled)
2782 else if (myHatchIsEnabled == theIsEnabled)
2784 return theIsEnabled;
2787 const bool anOldIsEnabled = myHatchIsEnabled;
2788 #if !defined(GL_ES_VERSION_2_0)
2790 && myActiveHatchType != Aspect_HS_SOLID)
2792 core11fwd->glEnable (GL_POLYGON_STIPPLE);
2796 core11fwd->glDisable (GL_POLYGON_STIPPLE);
2799 myHatchIsEnabled = theIsEnabled;
2800 return anOldIsEnabled;
2803 // =======================================================================
2804 // function : SetPolygonHatchStyle
2806 // =======================================================================
2807 Standard_Integer OpenGl_Context::SetPolygonHatchStyle (const Handle(Graphic3d_HatchStyle)& theStyle)
2809 const Standard_Integer aNewStyle = !theStyle.IsNull() ? theStyle->HatchType() : Aspect_HS_SOLID;
2810 if (myActiveHatchType == aNewStyle
2813 return myActiveHatchType;
2816 #if !defined(GL_ES_VERSION_2_0)
2817 if (aNewStyle == Aspect_HS_SOLID)
2819 if (myHatchIsEnabled)
2821 core11fwd->glDisable (GL_POLYGON_STIPPLE);
2823 return myActiveHatchType;
2826 if (myHatchStyles.IsNull()
2827 && !GetResource ("OpenGl_LineAttributes", myHatchStyles))
2829 // share and register for release once the resource is no longer used
2830 myHatchStyles = new OpenGl_LineAttributes();
2831 ShareResource ("OpenGl_LineAttributes", myHatchStyles);
2834 const Standard_Integer anOldType = myActiveHatchType;
2835 myActiveHatchType = aNewStyle;
2836 myHatchStyles->SetTypeOfHatch (this, theStyle);
2837 if (myHatchIsEnabled
2838 && anOldType == Aspect_HS_SOLID)
2840 core11fwd->glEnable (GL_POLYGON_STIPPLE);
2844 return myActiveHatchType;
2848 // =======================================================================
2849 // function : SetPolygonOffset
2851 // =======================================================================
2852 void OpenGl_Context::SetPolygonOffset (const Graphic3d_PolygonOffset& theOffset)
2854 const bool toFillOld = (myPolygonOffset.Mode & Aspect_POM_Fill) == Aspect_POM_Fill;
2855 const bool toFillNew = (theOffset.Mode & Aspect_POM_Fill) == Aspect_POM_Fill;
2856 if (toFillNew != toFillOld)
2860 glEnable (GL_POLYGON_OFFSET_FILL);
2864 glDisable (GL_POLYGON_OFFSET_FILL);
2868 #if !defined(GL_ES_VERSION_2_0)
2869 const bool toLineOld = (myPolygonOffset.Mode & Aspect_POM_Line) == Aspect_POM_Line;
2870 const bool toLineNew = (theOffset.Mode & Aspect_POM_Line) == Aspect_POM_Line;
2871 if (toLineNew != toLineOld)
2875 glEnable (GL_POLYGON_OFFSET_LINE);
2879 glDisable (GL_POLYGON_OFFSET_LINE);
2883 const bool toPointOld = (myPolygonOffset.Mode & Aspect_POM_Point) == Aspect_POM_Point;
2884 const bool toPointNew = (theOffset.Mode & Aspect_POM_Point) == Aspect_POM_Point;
2885 if (toPointNew != toPointOld)
2889 glEnable (GL_POLYGON_OFFSET_POINT);
2893 glDisable (GL_POLYGON_OFFSET_POINT);
2898 if (myPolygonOffset.Factor != theOffset.Factor
2899 || myPolygonOffset.Units != theOffset.Units)
2901 glPolygonOffset (theOffset.Factor, theOffset.Units);
2903 myPolygonOffset = theOffset;
2906 // =======================================================================
2907 // function : SetCamera
2909 // =======================================================================
2910 void OpenGl_Context::SetCamera (const Handle(Graphic3d_Camera)& theCamera)
2912 myCamera = theCamera;
2913 if (!theCamera.IsNull())
2915 ProjectionState.SetCurrent (theCamera->ProjectionMatrixF());
2916 WorldViewState .SetCurrent (theCamera->OrientationMatrixF());
2917 ApplyProjectionMatrix();
2918 ApplyWorldViewMatrix();
2922 // =======================================================================
2923 // function : ApplyModelWorldMatrix
2925 // =======================================================================
2926 void OpenGl_Context::ApplyModelWorldMatrix()
2928 if (myShaderManager->ModelWorldState().ModelWorldMatrix() != ModelWorldState.Current())
2930 myShaderManager->UpdateModelWorldStateTo (ModelWorldState.Current());
2934 // =======================================================================
2935 // function : ApplyWorldViewMatrix
2937 // =======================================================================
2938 void OpenGl_Context::ApplyWorldViewMatrix()
2940 if (myShaderManager->ModelWorldState().ModelWorldMatrix() != THE_IDENTITY_MATRIX)
2942 myShaderManager->UpdateModelWorldStateTo (THE_IDENTITY_MATRIX);
2944 if (myShaderManager->WorldViewState().WorldViewMatrix() != WorldViewState.Current())
2946 myShaderManager->UpdateWorldViewStateTo (WorldViewState.Current());
2950 // =======================================================================
2951 // function : ApplyModelViewMatrix
2953 // =======================================================================
2954 void OpenGl_Context::ApplyModelViewMatrix()
2956 if (myShaderManager->ModelWorldState().ModelWorldMatrix() != ModelWorldState.Current())
2958 myShaderManager->UpdateModelWorldStateTo (ModelWorldState.Current());
2960 if (myShaderManager->WorldViewState().WorldViewMatrix() != WorldViewState.Current())
2962 myShaderManager->UpdateWorldViewStateTo (WorldViewState.Current());
2966 // =======================================================================
2967 // function : ApplyProjectionMatrix
2969 // =======================================================================
2970 void OpenGl_Context::ApplyProjectionMatrix()
2972 if (myShaderManager->ProjectionState().ProjectionMatrix() != ProjectionState.Current())
2974 myShaderManager->UpdateProjectionStateTo (ProjectionState.Current());
2978 // =======================================================================
2979 // function : EnableFeatures
2981 // =======================================================================
2982 void OpenGl_Context::EnableFeatures() const
2987 // =======================================================================
2988 // function : DisableFeatures
2990 // =======================================================================
2991 void OpenGl_Context::DisableFeatures() const
2993 // Disable stuff that's likely to slow down glDrawPixels.
2994 glDisable(GL_DITHER);
2995 glDisable(GL_BLEND);
2996 glDisable(GL_DEPTH_TEST);
2997 glDisable(GL_STENCIL_TEST);
2999 #if !defined(GL_ES_VERSION_2_0)
3005 glDisable(GL_TEXTURE_1D);
3006 glDisable(GL_TEXTURE_2D);
3008 glDisable(GL_LIGHTING);
3009 glDisable(GL_ALPHA_TEST);
3011 glDisable(GL_LOGIC_OP);
3013 glPixelTransferi(GL_MAP_COLOR, GL_FALSE);
3014 glPixelTransferi(GL_RED_SCALE, 1);
3015 glPixelTransferi(GL_RED_BIAS, 0);
3016 glPixelTransferi(GL_GREEN_SCALE, 1);
3017 glPixelTransferi(GL_GREEN_BIAS, 0);
3018 glPixelTransferi(GL_BLUE_SCALE, 1);
3019 glPixelTransferi(GL_BLUE_BIAS, 0);
3020 glPixelTransferi(GL_ALPHA_SCALE, 1);
3021 glPixelTransferi(GL_ALPHA_BIAS, 0);
3023 if ((myGlVerMajor >= 1) && (myGlVerMinor >= 2))
3025 if (CheckExtension ("GL_CONVOLUTION_1D_EXT"))
3026 glDisable(GL_CONVOLUTION_1D_EXT);
3028 if (CheckExtension ("GL_CONVOLUTION_2D_EXT"))
3029 glDisable(GL_CONVOLUTION_2D_EXT);
3031 if (CheckExtension ("GL_SEPARABLE_2D_EXT"))
3032 glDisable(GL_SEPARABLE_2D_EXT);
3034 if (CheckExtension ("GL_SEPARABLE_2D_EXT"))
3035 glDisable(GL_HISTOGRAM_EXT);
3037 if (CheckExtension ("GL_MINMAX_EXT"))
3038 glDisable(GL_MINMAX_EXT);
3040 if (CheckExtension ("GL_TEXTURE_3D_EXT"))
3041 glDisable(GL_TEXTURE_3D_EXT);
3046 // =======================================================================
3047 // function : SetColorMaskRGBA
3049 // =======================================================================
3050 void OpenGl_Context::SetColorMaskRGBA (const NCollection_Vec4<bool>& theVal)
3052 glColorMask (theVal.r() ? GL_TRUE : GL_FALSE,
3053 theVal.g() ? GL_TRUE : GL_FALSE,
3054 theVal.b() ? GL_TRUE : GL_FALSE,
3055 theVal.a() ? GL_TRUE : GL_FALSE);
3056 myColorMask = theVal;
3059 // =======================================================================
3060 // function : SetColorMask
3062 // =======================================================================
3063 bool OpenGl_Context::SetColorMask (bool theToWriteColor)
3065 const bool anOldValue = myColorMask.r();
3066 myColorMask.SetValues (theToWriteColor, theToWriteColor, theToWriteColor, caps->buffersOpaqueAlpha ? false : theToWriteColor);
3067 const GLboolean toWrite = theToWriteColor ? GL_TRUE : GL_FALSE;
3068 glColorMask (toWrite, toWrite, toWrite, myColorMask.a() ? GL_TRUE : GL_FALSE);
3072 // =======================================================================
3073 // function : SetSampleAlphaToCoverage
3075 // =======================================================================
3076 bool OpenGl_Context::SetSampleAlphaToCoverage (bool theToEnable)
3078 bool toEnable = myAllowAlphaToCov && theToEnable;
3079 if (myAlphaToCoverage == toEnable)
3081 return myAlphaToCoverage;
3084 if (core15fwd != NULL)
3088 //core15fwd->core15fwd->glSampleCoverage (1.0f, GL_FALSE);
3089 core15fwd->glEnable (GL_SAMPLE_ALPHA_TO_COVERAGE);
3093 core15fwd->glDisable (GL_SAMPLE_ALPHA_TO_COVERAGE);
3097 const bool anOldValue = myAlphaToCoverage;
3098 myAlphaToCoverage = toEnable;
3102 // =======================================================================
3103 // function : GetBufferSubData
3105 // =======================================================================
3106 bool OpenGl_Context::GetBufferSubData (GLenum theTarget, GLintptr theOffset, GLsizeiptr theSize, void* theData)
3108 if (!hasGetBufferData)
3112 #ifdef __EMSCRIPTEN__
3115 Module.ctx.getBufferSubData($0, $1, HEAPU8.subarray($2, $2 + $3));
3116 }, theTarget, theOffset, theData, theSize);
3118 #elif defined(GL_ES_VERSION_2_0)
3119 if (void* aData = core30fwd->glMapBufferRange (theTarget, theOffset, theSize, GL_MAP_READ_BIT))
3121 memcpy (theData, aData, theSize);
3122 core30fwd->glUnmapBuffer (theTarget);
3127 core15fwd->glGetBufferSubData (theTarget, theOffset, theSize, theData);
3132 // =======================================================================
3133 // function : DumpJson
3135 // =======================================================================
3136 void OpenGl_Context::DumpJson (Standard_OStream& theOStream, Standard_Integer theDepth) const
3138 OCCT_DUMP_TRANSIENT_CLASS_BEGIN (theOStream)
3140 OCCT_DUMP_FIELD_VALUE_NUMERICAL (theOStream, myAnisoMax)
3141 OCCT_DUMP_FIELD_VALUE_NUMERICAL (theOStream, myTexClamp)
3142 OCCT_DUMP_FIELD_VALUE_NUMERICAL (theOStream, myMaxTexDim)
3143 OCCT_DUMP_FIELD_VALUE_NUMERICAL (theOStream, myMaxTexCombined)
3144 OCCT_DUMP_FIELD_VALUE_NUMERICAL (theOStream, myMaxDumpSizeX)
3145 OCCT_DUMP_FIELD_VALUE_NUMERICAL (theOStream, myMaxDumpSizeY)
3146 OCCT_DUMP_FIELD_VALUE_NUMERICAL (theOStream, myMaxClipPlanes)
3147 OCCT_DUMP_FIELD_VALUE_NUMERICAL (theOStream, myMaxMsaaSamples)
3148 OCCT_DUMP_FIELD_VALUE_NUMERICAL (theOStream, myMaxDrawBuffers)
3149 OCCT_DUMP_FIELD_VALUE_NUMERICAL (theOStream, myMaxColorAttachments)
3150 OCCT_DUMP_FIELD_VALUE_NUMERICAL (theOStream, myGlVerMajor)
3151 OCCT_DUMP_FIELD_VALUE_NUMERICAL (theOStream, myGlVerMinor)
3152 OCCT_DUMP_FIELD_VALUE_NUMERICAL (theOStream, myIsInitialized)
3153 OCCT_DUMP_FIELD_VALUE_NUMERICAL (theOStream, myIsStereoBuffers)
3154 OCCT_DUMP_FIELD_VALUE_NUMERICAL (theOStream, myIsGlNormalizeEnabled)
3156 OCCT_DUMP_FIELD_VALUE_NUMERICAL (theOStream, myHasRayTracing)
3157 OCCT_DUMP_FIELD_VALUE_NUMERICAL (theOStream, myHasRayTracingTextures)
3158 OCCT_DUMP_FIELD_VALUE_NUMERICAL (theOStream, myHasRayTracingAdaptiveSampling)
3159 OCCT_DUMP_FIELD_VALUE_NUMERICAL (theOStream, myHasRayTracingAdaptiveSamplingAtomic)
3161 for (int i = 0; i < 4; i++)
3163 OCCT_DUMP_FIELD_VALUE_NUMERICAL (theOStream, myViewport[i])
3166 for (int i = 0; i < 4; i++)
3168 OCCT_DUMP_FIELD_VALUE_NUMERICAL (theOStream, myViewportVirt[i])
3171 OCCT_DUMP_FIELD_VALUE_NUMERICAL (theOStream, myPointSpriteOrig)
3172 OCCT_DUMP_FIELD_VALUE_NUMERICAL (theOStream, myRenderMode)
3173 OCCT_DUMP_FIELD_VALUE_NUMERICAL (theOStream, myPolygonMode)
3174 OCCT_DUMP_FIELD_VALUES_DUMPED (theOStream, theDepth, &myPolygonOffset)
3175 OCCT_DUMP_FIELD_VALUE_NUMERICAL (theOStream, myToCullBackFaces)
3176 OCCT_DUMP_FIELD_VALUE_NUMERICAL (theOStream, myReadBuffer)
3178 OCCT_DUMP_FIELD_VALUE_NUMERICAL (theOStream, myDefaultVao)
3179 OCCT_DUMP_FIELD_VALUE_NUMERICAL (theOStream, myColorMask)
3180 OCCT_DUMP_FIELD_VALUE_NUMERICAL (theOStream, myAllowAlphaToCov)
3181 OCCT_DUMP_FIELD_VALUE_NUMERICAL (theOStream, myAlphaToCoverage)
3182 OCCT_DUMP_FIELD_VALUE_NUMERICAL (theOStream, myIsGlDebugCtx)
3184 OCCT_DUMP_FIELD_VALUE_NUMERICAL (theOStream, myResolution)
3185 OCCT_DUMP_FIELD_VALUE_NUMERICAL (theOStream, myResolutionRatio)
3187 OCCT_DUMP_FIELD_VALUE_NUMERICAL (theOStream, myLineWidthScale)
3188 OCCT_DUMP_FIELD_VALUE_NUMERICAL (theOStream, myLineFeather)
3189 OCCT_DUMP_FIELD_VALUE_NUMERICAL (theOStream, myRenderScale)
3190 OCCT_DUMP_FIELD_VALUE_NUMERICAL (theOStream, myRenderScaleInv)
3192 OCCT_DUMP_FIELD_VALUES_DUMPED (theOStream, theDepth, &ModelWorldState)
3193 OCCT_DUMP_FIELD_VALUES_DUMPED (theOStream, theDepth, &WorldViewState)
3194 OCCT_DUMP_FIELD_VALUES_DUMPED (theOStream, theDepth, &ProjectionState)
3197 // =======================================================================
3198 // function : DumpJsonOpenGlState
3200 // =======================================================================
3201 void OpenGl_Context::DumpJsonOpenGlState (Standard_OStream& theOStream, Standard_Integer)
3203 GLboolean isEnableBlend = glIsEnabled (GL_BLEND);
3204 GLboolean isEnableCullFace = glIsEnabled (GL_CULL_FACE);
3205 GLboolean isEnableDepthTest = glIsEnabled (GL_DEPTH_TEST);
3207 OCCT_DUMP_FIELD_VALUE_NUMERICAL (theOStream, isEnableBlend)
3208 OCCT_DUMP_FIELD_VALUE_NUMERICAL (theOStream, isEnableCullFace)
3209 OCCT_DUMP_FIELD_VALUE_NUMERICAL (theOStream, isEnableDepthTest)