92a8f73e07970b41d65167c0f20aecec0baea961
[occt.git] / src / OpenGl / OpenGl_Context.hxx
1 // Created on: 2012-01-26
2 // Created by: Kirill GAVRILOV
3 // Copyright (c) 2012-2014 OPEN CASCADE SAS
4 //
5 // This file is part of Open CASCADE Technology software library.
6 //
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.
12 //
13 // Alternatively, this file may be used under the terms of Open CASCADE
14 // commercial license or contractual agreement.
15
16 #ifndef _OpenGl_Context_H__
17 #define _OpenGl_Context_H__
18
19 #include <Aspect_Handle.hxx>
20 #include <Aspect_HatchStyle.hxx>
21 #include <Aspect_Drawable.hxx>
22 #include <Aspect_Display.hxx>
23 #include <Aspect_RenderingContext.hxx>
24 #include <Aspect_TypeOfLine.hxx>
25 #include <NCollection_DataMap.hxx>
26 #include <Graphic3d_DiagnosticInfo.hxx>
27 #include <Graphic3d_TextureUnit.hxx>
28 #include <NCollection_Map.hxx>
29 #include <NCollection_Handle.hxx>
30 #include <NCollection_List.hxx>
31 #include <NCollection_SparseArray.hxx>
32 #include <Message.hxx>
33 #include <OpenGl_Caps.hxx>
34 #include <OpenGl_LineAttributes.hxx>
35 #include <OpenGl_Material.hxx>
36 #include <OpenGl_MatrixState.hxx>
37 #include <OpenGl_Vec.hxx>
38 #include <OpenGl_Resource.hxx>
39 #include <OpenGl_TextureSet.hxx>
40 #include <Standard_Transient.hxx>
41 #include <TColStd_IndexedDataMapOfStringString.hxx>
42 #include <TColStd_PackedMapOfInteger.hxx>
43 #include <OpenGl_Clipping.hxx>
44 #include <OpenGl_GlCore11.hxx>
45
46 #include <NCollection_Shared.hxx>
47
48 //! Forward declarations
49 #if defined(__APPLE__)
50   #import <TargetConditionals.h>
51   #if defined(TARGET_OS_IPHONE) && TARGET_OS_IPHONE
52     #ifdef __OBJC__
53       @class EAGLContext;
54     #else
55       struct EAGLContext;
56     #endif
57   #else
58     #ifdef __OBJC__
59       @class NSOpenGLContext;
60     #else
61       struct NSOpenGLContext;
62     #endif
63   #endif
64 #endif
65
66 struct OpenGl_GlFunctions;
67 struct OpenGl_ArbTBO;
68 struct OpenGl_ArbIns;
69 struct OpenGl_ArbDbg;
70 struct OpenGl_ArbFBO;
71 struct OpenGl_ArbFBOBlit;
72 struct OpenGl_ArbSamplerObject;
73 struct OpenGl_ArbTexBindless;
74 struct OpenGl_ExtGS;
75
76 struct OpenGl_GlCore12;
77 struct OpenGl_GlCore13;
78 struct OpenGl_GlCore14;
79 struct OpenGl_GlCore15;
80 struct OpenGl_GlCore20;
81 struct OpenGl_GlCore21;
82 struct OpenGl_GlCore30;
83 struct OpenGl_GlCore31;
84 struct OpenGl_GlCore32;
85 struct OpenGl_GlCore33;
86 struct OpenGl_GlCore40;
87 struct OpenGl_GlCore41;
88 struct OpenGl_GlCore42;
89 struct OpenGl_GlCore43;
90 struct OpenGl_GlCore44;
91 struct OpenGl_GlCore45;
92 struct OpenGl_GlCore46;
93
94 class Graphic3d_Camera;
95 class Graphic3d_PresentationAttributes;
96 class OpenGl_Aspects;
97 class OpenGl_FrameBuffer;
98 class OpenGl_Sampler;
99 class OpenGl_ShaderProgram;
100 class OpenGl_ShaderManager;
101 class OpenGl_FrameStats;
102
103 enum OpenGl_FeatureFlag
104 {
105   OpenGl_FeatureNotAvailable = 0, //!< Feature is not supported by OpenGl implementation.
106   OpenGl_FeatureInExtensions = 1, //!< Feature is supported as extension.
107   OpenGl_FeatureInCore       = 2  //!< Feature is supported as part of core profile.
108 };
109
110 DEFINE_STANDARD_HANDLE(OpenGl_Context, Standard_Transient)
111
112 //! This class generalize access to the GL context and available extensions.
113 //!
114 //! Functions related to specific OpenGL version or extension are grouped into structures which can be accessed as fields of this class.
115 //! The most simple way to check that required functionality is available - is NULL check for the group:
116 //! @code
117 //!   if (myContext->core20 != NULL)
118 //!   {
119 //!     myGlProgram = myContext->core20->glCreateProgram();
120 //!     .. do more stuff ..
121 //!   }
122 //!   else
123 //!   {
124 //!     .. compatibility with outdated configurations ..
125 //!   }
126 //! @endcode
127 //!
128 //! Current implementation provide access to OpenGL core functionality up to 4.6 version (core12, core13, core14, etc.)
129 //! as well as several extensions (arbTBO, arbFBO, etc.).
130 //!
131 //! OpenGL context might be initialized in Core Profile. In this case deprecated functionality become unavailable.
132 //! To select which core** function set should be used in specific case:
133 //!  - Determine the minimal OpenGL version required for implemented functionality and use it to access all functions.
134 //!    For example, if algorithm requires OpenGL 2.1+, it is better to write core20fwd->glEnable() rather than core11fwd->glEnable() for uniformity.
135 //!  - Validate minimal requirements at initialization/creation time and omit checks within code where algorithm should be already initialized.
136 //!    Properly escape code incompatible with Core Profile. The simplest way to check Core Profile is "if (core11ffp == NULL)".
137 //!
138 //! Simplified extensions classification:
139 //!  - prefixed with NV, AMD, ATI are vendor-specific (however may be provided by other vendors in some cases);
140 //!  - prefixed with EXT are accepted by 2+ vendors;
141 //!  - prefixed with ARB are accepted by Architecture Review Board and are candidates
142 //!    for inclusion into GL core functionality.
143 //! Some functionality can be represented in several extensions simultaneously.
144 //! In this case developer should be careful because different specification may differ
145 //! in aspects (like enumeration values and error-handling).
146 //!
147 //! Notice that some systems provide mechanisms to simultaneously incorporate with GL contexts with different capabilities.
148 //! For this reason OpenGl_Context should be initialized and used for each GL context independently.
149 //!
150 //! Matrices of OpenGl transformations:
151 //! model -> world -> view -> projection
152 //! These matrices might be changed for local transformation, transform persistent using direct access to
153 //! current matrix of ModelWorldState, WorldViewState and ProjectionState
154 //! After, these matrices should be applied using ApplyModelWorldMatrix, ApplyWorldViewMatrix,
155 //! ApplyModelViewMatrix or ApplyProjectionMatrix.
156 class OpenGl_Context : public Standard_Transient
157 {
158   DEFINE_STANDARD_RTTIEXT(OpenGl_Context, Standard_Transient)
159   friend class OpenGl_Window;
160   friend struct OpenGl_GlFunctions;
161 public:
162
163   typedef NCollection_Shared< NCollection_DataMap<TCollection_AsciiString, Handle(OpenGl_Resource)> > OpenGl_ResourcesMap;
164
165   //! Function for getting power of to number larger or equal to input number.
166   //! @param theNumber    number to 'power of two'
167   //! @param theThreshold upper threshold
168   //! @return power of two number
169   inline static Standard_Integer GetPowerOfTwo (const Standard_Integer theNumber,
170                                                 const Standard_Integer theThreshold)
171   {
172     for (Standard_Integer p2 = 2; p2 <= theThreshold; p2 <<= 1)
173     {
174       if (theNumber <= p2)
175       {
176         return p2;
177       }
178     }
179     return theThreshold;
180   }
181
182   //! Format GL constant as hex value 0xABCD.
183   Standard_EXPORT static TCollection_AsciiString FormatGlEnumHex (int theGlEnum);
184
185   //! Format pointer as hex value 0xABCD.
186   Standard_EXPORT static TCollection_AsciiString FormatPointer (const void* thePtr);
187
188   //! Format size value.
189   Standard_EXPORT static TCollection_AsciiString FormatSize (Standard_Size theSize);
190
191   //! Return text description of GL error.
192   Standard_EXPORT static TCollection_AsciiString FormatGlError (int theGlError);
193
194 public:
195
196   //! Empty constructor. You should call Init() to perform initialization with bound GL context.
197   Standard_EXPORT OpenGl_Context (const Handle(OpenGl_Caps)& theCaps = NULL);
198
199   //! Destructor.
200   Standard_EXPORT virtual ~OpenGl_Context();
201
202   //! Release all resources, including shared ones
203   Standard_EXPORT void forcedRelease();
204
205   //! Share GL context resources.
206   //! theShareCtx - handle to context to retrieve handles to shared resources.
207   Standard_EXPORT void Share (const Handle(OpenGl_Context)& theShareCtx);
208
209   //! Initialize class from currently bound OpenGL context. Method should be called only once.
210   //! @return false if no GL context is bound to the current thread
211   Standard_EXPORT Standard_Boolean Init (const Standard_Boolean theIsCoreProfile = Standard_False);
212
213   //! @return true if this context is valid (has been initialized)
214   inline Standard_Boolean IsValid() const
215   {
216     return myIsInitialized;
217   }
218
219 #if defined(HAVE_EGL)
220   //! Initialize class from specified surface and rendering context. Method should be called only once.
221   //! @return false if OpenGL context can not be bound to specified surface
222   Standard_EXPORT Standard_Boolean Init (const Aspect_Drawable         theEglSurface,
223                                          const Aspect_Display          theEglDisplay,
224                                          const Aspect_RenderingContext theEglContext,
225                                          const Standard_Boolean        theIsCoreProfile = Standard_False);
226 #elif defined(_WIN32)
227   //! Initialize class from specified window and rendering context. Method should be called only once.
228   //! @return false if OpenGL context can not be bound to specified window
229   Standard_EXPORT Standard_Boolean Init (const Aspect_Handle           theWindow,
230                                          const Aspect_Handle           theWindowDC,
231                                          const Aspect_RenderingContext theGContext,
232                                          const Standard_Boolean        theIsCoreProfile = Standard_False);
233
234   //! @return the window handle (HWND) currently bound to this OpenGL context
235   inline Aspect_Handle Window() const
236   {
237     return myWindow;
238   }
239
240 #elif defined(__APPLE__) && !defined(MACOSX_USE_GLX)
241   #if defined(TARGET_OS_IPHONE) && TARGET_OS_IPHONE
242
243   //! Initialize class from specified OpenGL ES context (EAGLContext). Method should be called only once.
244   Standard_EXPORT Standard_Boolean Init (EAGLContext*                  theGContext,
245                                          const Standard_Boolean        theIsCoreProfile = Standard_False);
246   #else
247
248   //! Initialize class from specified OpenGL context (NSOpenGLContext). Method should be called only once.
249   Standard_EXPORT Standard_Boolean Init (NSOpenGLContext*              theGContext,
250                                          const Standard_Boolean        theIsCoreProfile = Standard_False);
251   #endif
252 #else
253
254   //! Initialize class from specified window and rendering context. Method should be called only once.
255   //! @return false if OpenGL context can not be bound to specified window
256   Standard_EXPORT Standard_Boolean Init (const Aspect_Drawable         theWindow,
257                                          const Aspect_Display          theDisplay,
258                                          const Aspect_RenderingContext theGContext,
259                                          const Standard_Boolean        theIsCoreProfile = Standard_False);
260
261   //! @return the window handle (GLXDrawable) currently bound to this OpenGL context
262   inline Aspect_Drawable Window() const
263   {
264     return myWindow;
265   }
266 #endif
267
268   //! Read OpenGL version information from active context.
269   Standard_EXPORT static void ReadGlVersion (Standard_Integer& theGlVerMajor,
270                                              Standard_Integer& theGlVerMinor);
271
272   //! Check if theExtName extension is supported by active GL context.
273   Standard_EXPORT Standard_Boolean CheckExtension (const char* theExtName) const;
274
275   //! Check if theExtName extension is in extensions string.
276   Standard_EXPORT static Standard_Boolean CheckExtension (const char* theExtString,
277                                                           const char* theExtName);
278
279   //! Auxiliary template to retrieve GL function pointer.
280   //! Pointer to function retrieved from library is statically casted
281   //! to requested type - there no way to check real signature of exported function.
282   //! The context should be bound before call.
283   //! @param theLastFailFuncName [out] set to theFuncName in case of failure, unmodified on success
284   //! @param theFuncName [in] function name to find
285   //! @param theFuncPtr [out] retrieved function pointer
286   //! @return TRUE on success
287   template <typename FuncType_t>
288   Standard_Boolean FindProcVerbose (const char*& theLastFailFuncName,
289                                     const char* theFuncName,
290                                     FuncType_t& theFuncPtr)
291   {
292     theFuncPtr = (FuncType_t )findProc (theFuncName);
293     if (theFuncPtr == NULL)
294     {
295       theLastFailFuncName = theFuncName;
296       return Standard_False;
297     }
298     return Standard_True;
299   }
300
301   //! Auxiliary template to retrieve GL function pointer.
302   //! Same as FindProcVerbose() but without auxiliary last function name argument.
303   template <typename FuncType_t>
304   Standard_Boolean FindProc (const char* theFuncName,
305                              FuncType_t& theFuncPtr)
306   {
307     theFuncPtr = (FuncType_t )findProc (theFuncName);
308     return (theFuncPtr != NULL);
309   }
310
311   //! @return true if detected GL version is greater or equal to requested one.
312   inline Standard_Boolean IsGlGreaterEqual (const Standard_Integer theVerMajor,
313                                             const Standard_Integer theVerMinor) const
314   {
315     return (myGlVerMajor >  theVerMajor)
316         || (myGlVerMajor == theVerMajor && myGlVerMinor >= theVerMinor);
317   }
318
319   //! Return cached GL version major number.
320   Standard_Integer VersionMajor() const { return myGlVerMajor; }
321
322   //! Return cached GL version minor number.
323   Standard_Integer VersionMinor() const { return myGlVerMinor; }
324
325   //! Access entire map of loaded OpenGL functions.
326   const OpenGl_GlFunctions* Functions() const { return myFuncs.operator->(); }
327
328   //! Clean up errors stack for this GL context (glGetError() in loop).
329   //! @return true if some error has been cleared
330   Standard_EXPORT bool ResetErrors (const bool theToPrintErrors = false);
331
332   //! This method uses system-dependent API to retrieve information
333   //! about GL context bound to the current thread.
334   //! @return true if current thread is bound to this GL context
335   Standard_EXPORT Standard_Boolean IsCurrent() const;
336
337   //! Activates current context.
338   //! Class should be initialized with appropriate info.
339   Standard_EXPORT Standard_Boolean MakeCurrent();
340
341   //! Swap front/back buffers for this GL context (should be activated before!).
342   Standard_EXPORT void SwapBuffers();
343
344   //! Setup swap interval (VSync).
345   Standard_EXPORT Standard_Boolean SetSwapInterval (const Standard_Integer theInterval);
346
347   //! Return true if active mode is GL_RENDER (cached state)
348   Standard_Boolean IsRender() const
349   {
350   #if !defined(GL_ES_VERSION_2_0)
351     return myRenderMode == GL_RENDER;
352   #else
353     return Standard_True;
354   #endif
355   }
356
357   //! Return true if active mode is GL_FEEDBACK (cached state)
358   Standard_Boolean IsFeedback() const
359   {
360   #if !defined(GL_ES_VERSION_2_0)
361     return myRenderMode == GL_FEEDBACK;
362   #else
363     return Standard_False;
364   #endif
365   }
366
367   //! This function retrieves information from GL about free GPU memory that is:
368   //!  - OS-dependent. On some OS it is per-process and on others - for entire system.
369   //!  - Vendor-dependent. Currently available only on NVIDIA and AMD/ATi drivers only.
370   //!  - Numbers meaning may vary.
371   //! You should use this info only for diagnostics purposes.
372   //! @return free GPU dedicated memory in bytes.
373   Standard_EXPORT Standard_Size AvailableMemory() const;
374
375   //! This function retrieves information from GL about GPU memory
376   //! and contains more vendor-specific values than AvailableMemory().
377   Standard_EXPORT TCollection_AsciiString MemoryInfo() const;
378
379   //! This function retrieves information from GL about GPU memory.
380   Standard_EXPORT void MemoryInfo (TColStd_IndexedDataMapOfStringString& theDict) const;
381
382   //! Fill in the dictionary with OpenGL info.
383   //! Should be called with bound context.
384   Standard_EXPORT void DiagnosticInformation (TColStd_IndexedDataMapOfStringString& theDict,
385                                               Graphic3d_DiagnosticInfo theFlags) const;
386
387   //! Access shared resource by its name.
388   //! @param  theKey - unique identifier;
389   //! @return handle to shared resource or NULL.
390   Standard_EXPORT const Handle(OpenGl_Resource)& GetResource (const TCollection_AsciiString& theKey) const;
391
392   //! Access shared resource by its name.
393   //! @param  theKey   - unique identifier;
394   //! @param  theValue - handle to fill;
395   //! @return true if resource was shared.
396   template<typename TheHandleType>
397   Standard_Boolean GetResource (const TCollection_AsciiString& theKey,
398                                 TheHandleType&                 theValue) const
399   {
400     const Handle(OpenGl_Resource)& aResource = GetResource (theKey);
401     if (aResource.IsNull())
402     {
403       return Standard_False;
404     }
405
406     theValue = TheHandleType::DownCast (aResource);
407     return !theValue.IsNull();
408   }
409
410   //! Register shared resource.
411   //! Notice that after registration caller shouldn't release it by himself -
412   //! it will be automatically released on context destruction.
413   //! @param theKey      - unique identifier, shouldn't be empty;
414   //! @param theResource - new resource to register, shouldn't be NULL.
415   Standard_EXPORT Standard_Boolean ShareResource (const TCollection_AsciiString& theKey,
416                                                   const Handle(OpenGl_Resource)& theResource);
417
418   //! Release shared resource.
419   //! If there are more than one reference to this resource
420   //! (also used by some other existing object) then call will be ignored.
421   //! This means that current object itself should nullify handle before this call.
422   //! Notice that this is unrecommended operation at all and should be used
423   //! only in case of fat resources to release memory for other needs.
424   //! @param theKey     unique identifier
425   //! @param theToDelay postpone release until next redraw call
426   Standard_EXPORT void ReleaseResource (const TCollection_AsciiString& theKey,
427                                         const Standard_Boolean         theToDelay = Standard_False);
428
429   //! Append resource to queue for delayed clean up.
430   //! Resources in this queue will be released at next redraw call.
431   template <class T>
432   void DelayedRelease (Handle(T)& theResource)
433   {
434     myUnusedResources->Prepend (theResource);
435     theResource.Nullify();
436   }
437
438   //! Clean up the delayed release queue.
439   Standard_EXPORT void ReleaseDelayed();
440
441   //! Return map of shared resources.
442   const OpenGl_ResourcesMap& SharedResources() const { return *mySharedResources; }
443
444   //! @return tool for management of clippings within this context.
445   inline OpenGl_Clipping& ChangeClipping() { return myClippingState; }
446
447   //! @return tool for management of clippings within this context.
448   inline const OpenGl_Clipping& Clipping() const { return myClippingState; }
449
450   //! @return tool for management of shader programs within this context.
451   inline const Handle(OpenGl_ShaderManager)& ShaderManager() const { return myShaderManager; }
452
453 public:
454
455   //! Either GL_CLAMP_TO_EDGE (1.2+) or GL_CLAMP (1.1).
456   Standard_Integer TextureWrapClamp() const { return myTexClamp; }
457
458   //! @return true if texture parameters GL_TEXTURE_BASE_LEVEL/GL_TEXTURE_MAX_LEVEL are supported.
459   Standard_Boolean HasTextureBaseLevel() const
460   {
461   #if !defined(GL_ES_VERSION_2_0)
462     return IsGlGreaterEqual (1, 2);
463   #else
464     return IsGlGreaterEqual (3, 0);
465   #endif
466   }
467
468   //! Return map of supported texture formats.
469   const Handle(Image_SupportedFormats)& SupportedTextureFormats() const { return mySupportedFormats; }
470
471   //! @return maximum degree of anisotropy texture filter
472   Standard_Integer MaxDegreeOfAnisotropy() const { return myAnisoMax; }
473
474   //! @return value for GL_MAX_TEXTURE_SIZE
475   Standard_Integer MaxTextureSize() const { return myMaxTexDim; }
476
477   //! @return value for GL_MAX_COMBINED_TEXTURE_IMAGE_UNITS
478   Standard_Integer MaxCombinedTextureUnits() const { return myMaxTexCombined; }
479
480   //! This method returns the multi-texture limit for obsolete fixed-function pipeline.
481   //! Use MaxCombinedTextureUnits() instead for limits for using programmable pipeline.
482   //! @return value for GL_MAX_TEXTURE_UNITS
483   Standard_Integer MaxTextureUnitsFFP() const { return myMaxTexUnitsFFP; }
484
485   //! Return texture unit to be used for sprites (Graphic3d_TextureUnit_PointSprite by default).
486   Graphic3d_TextureUnit SpriteTextureUnit() const { return mySpriteTexUnit; }
487
488   //! @return value for GL_MAX_SAMPLES
489   Standard_Integer MaxMsaaSamples() const { return myMaxMsaaSamples; }
490
491   //! @return maximum FBO width for image dump
492   Standard_Integer MaxDumpSizeX() const { return myMaxDumpSizeX; }
493
494   //! @return maximum FBO height for image dump
495   Standard_Integer MaxDumpSizeY() const { return myMaxDumpSizeY; }
496
497   //! @return value for GL_MAX_DRAW_BUFFERS
498   Standard_Integer MaxDrawBuffers() const { return myMaxDrawBuffers; }
499
500   //! @return value for GL_MAX_COLOR_ATTACHMENTS
501   Standard_Integer MaxColorAttachments() const { return myMaxColorAttachments; }
502
503   //! Get maximum number of clip planes supported by OpenGl.
504   //! This value is implementation dependent. At least 6
505   //! planes should be supported by OpenGl (see specs).
506   //! @return value for GL_MAX_CLIP_PLANES
507   Standard_Integer MaxClipPlanes() const { return myMaxClipPlanes; }
508
509   //! @return TRUE if ray tracing mode is supported
510   Standard_Boolean HasRayTracing() const { return myHasRayTracing; }
511
512   //! @return TRUE if textures in ray tracing mode are supported
513   Standard_Boolean HasRayTracingTextures() const { return myHasRayTracingTextures; }
514
515   //! @return TRUE if adaptive screen sampling in ray tracing mode is supported
516   Standard_Boolean HasRayTracingAdaptiveSampling() const { return myHasRayTracingAdaptiveSampling; }
517
518   //! @return TRUE if atomic adaptive screen sampling in ray tracing mode is supported
519   Standard_Boolean HasRayTracingAdaptiveSamplingAtomic() const { return myHasRayTracingAdaptiveSamplingAtomic; }
520
521   //! Returns TRUE if sRGB rendering is supported.
522   bool HasSRGB() const
523   {
524     return hasTexSRGB
525        &&  hasFboSRGB;
526   }
527
528   //! Returns TRUE if sRGB rendering is supported and permitted.
529   bool ToRenderSRGB() const
530   {
531     return HasSRGB()
532        && !caps->sRGBDisable
533        && !caps->ffpEnable;
534   }
535
536   //! Returns TRUE if window/surface buffer is sRGB-ready.
537   //!
538   //! When offscreen FBOs are created in sRGB, but window is not sRGB-ready,
539   //! blitting into window should be done with manual gamma correction.
540   //!
541   //! In desktop OpenGL, window buffer can be considered as sRGB-ready by default,
542   //! even when application has NOT requested sRGB-ready pixel format,
543   //! and rendering is managed via GL_FRAMEBUFFER_SRGB state.
544   //!
545   //! In OpenGL ES, sRGB-ready window surface should be explicitly requested on construction,
546   //! and cannot be disabled/enabled without GL_EXT_sRGB_write_control extension afterwards
547   //! (GL_FRAMEBUFFER_SRGB can be considered as always tuned ON).
548   bool IsWindowSRGB() const { return myIsSRgbWindow; }
549
550   //! Overrides if window/surface buffer is sRGB-ready or not (initialized with the context).
551   void SetWindowSRGB (bool theIsSRgb) { myIsSRgbWindow = theIsSRgb; }
552
553   //! Convert Quantity_ColorRGBA into vec4
554   //! with conversion or no conversion into non-linear sRGB
555   //! basing on ToRenderSRGB() flag.
556   OpenGl_Vec4 Vec4FromQuantityColor (const OpenGl_Vec4& theColor) const
557   {
558     return myIsSRgbActive
559          ? Vec4LinearFromQuantityColor(theColor)
560          : Vec4sRGBFromQuantityColor  (theColor);
561   }
562
563   //! Convert Quantity_ColorRGBA into vec4.
564   //! Quantity_Color is expected to be linear RGB, hence conversion is NOT required
565   const OpenGl_Vec4& Vec4LinearFromQuantityColor (const OpenGl_Vec4& theColor) const { return theColor; }
566
567   //! Convert Quantity_ColorRGBA (linear RGB) into non-linear sRGB vec4.
568   OpenGl_Vec4 Vec4sRGBFromQuantityColor (const OpenGl_Vec4& theColor) const
569   {
570     return Quantity_ColorRGBA::Convert_LinearRGB_To_sRGB (theColor);
571   }
572
573   //! Returns TRUE if PBR shading model is supported.
574   //! Basically, feature requires OpenGL 3.0+ / OpenGL ES 3.0+ hardware; more precisely:
575   //! - Graphics hardware with moderate capabilities for compiling long enough GLSL program.
576   //! - FBO (e.g. for baking environment).
577   //! - Multi-texturing with >= 4 units (LUT and IBL textures).
578   //! - GL_RG32F texture format (arbTexRG + arbTexFloat)
579   //! - Cubemap texture lookup textureCubeLod()/textureLod() with LOD index within Fragment Shader,
580   //!   which requires GLSL OpenGL 3.0+ / OpenGL ES 3.0+ or OpenGL 2.1 + GL_EXT_gpu_shader4 extension.
581   Standard_Boolean HasPBR() const { return myHasPBR; }
582
583   //! Returns texture unit where Environment Lookup Table is expected to be bound, or 0 if PBR is unavailable.
584   Graphic3d_TextureUnit PBREnvLUTTexUnit() const { return myPBREnvLUTTexUnit; }
585
586   //! Returns texture unit where Diffuse (irradiance) IBL map's spherical harmonics coefficients is expected to be bound, or 0 if PBR is unavailable.
587   Graphic3d_TextureUnit PBRDiffIBLMapSHTexUnit() const { return myPBRDiffIBLMapSHTexUnit; }
588
589   //! Returns texture unit where Specular IBL map is expected to be bound, or 0 if PBR is unavailable.
590   Graphic3d_TextureUnit PBRSpecIBLMapTexUnit() const { return myPBRSpecIBLMapTexUnit; }
591
592   //! Returns texture unit where shadow map is expected to be bound, or 0 if unavailable.
593   Graphic3d_TextureUnit ShadowMapTexUnit() const { return myShadowMapTexUnit; }
594
595   //! Returns texture unit for occDepthPeelingDepth within enabled Depth Peeling.
596   Graphic3d_TextureUnit DepthPeelingDepthTexUnit() const { return myDepthPeelingDepthTexUnit; }
597
598   //! Returns texture unit for occDepthPeelingFrontColor within enabled Depth Peeling.
599   Graphic3d_TextureUnit DepthPeelingFrontColorTexUnit() const { return myDepthPeelingFrontColorTexUnit; }
600
601   //! Returns true if VBO is supported and permitted.
602   inline bool ToUseVbo() const
603   {
604     return core15fwd != NULL
605        && !caps->vboDisable;
606   }
607
608   //! @return cached state of GL_NORMALIZE.
609   Standard_Boolean IsGlNormalizeEnabled() const { return myIsGlNormalizeEnabled; }
610
611   //! Sets GL_NORMALIZE enabled or disabled.
612   //! @return old value of the flag
613   Standard_EXPORT Standard_Boolean SetGlNormalizeEnabled (Standard_Boolean isEnabled);
614
615   //! @return cached state of polygon rasterization mode (glPolygonMode()).
616   Standard_Integer PolygonMode() const { return myPolygonMode; }
617
618   //! Sets polygon rasterization mode (glPolygonMode() function).
619   //! @return old value of the rasterization mode.
620   Standard_EXPORT Standard_Integer SetPolygonMode (const Standard_Integer theMode);
621
622   //! @return cached enabled state of polygon hatching rasterization.
623   bool IsPolygonHatchEnabled() const { return myHatchIsEnabled; }
624
625   //! Sets enabled state of polygon hatching rasterization
626   //! without affecting currently selected hatching pattern.
627   //! @return previous state of polygon hatching mode.
628   Standard_EXPORT bool SetPolygonHatchEnabled (const bool theIsEnabled);
629
630   //! @return cached state of polygon hatch type.
631   Standard_Integer PolygonHatchStyle() const { return myActiveHatchType; }
632
633   //! Sets polygon hatch pattern.
634   //! Zero-index value is a default alias for solid filling.
635   //! @param the type of hatch supported by base implementation of
636   //! OpenGl_LineAttributes (Aspect_HatchStyle) or the type supported by custom
637   //! implementation derived from OpenGl_LineAttributes class.
638   //! @return old type of hatch.
639   Standard_EXPORT Standard_Integer SetPolygonHatchStyle (const Handle(Graphic3d_HatchStyle)& theStyle);
640
641   //! Sets and applies current polygon offset.
642   Standard_EXPORT void SetPolygonOffset (const Graphic3d_PolygonOffset& theOffset);
643
644   //! Returns currently applied polygon offset parameters.
645   const Graphic3d_PolygonOffset& PolygonOffset() const { return myPolygonOffset; }
646
647   //! Returns camera object.
648   const Handle(Graphic3d_Camera)& Camera() const { return myCamera; }
649
650   //! Sets camera object to the context and update matrices.
651   Standard_EXPORT void SetCamera (const Handle(Graphic3d_Camera)& theCamera);
652
653   //! Applies matrix into shader manager stored in ModelWorldState to OpenGl.
654   //! In "model -> world -> view -> projection" it performs:
655   //!     model -> world
656   Standard_EXPORT void ApplyModelWorldMatrix();
657
658   //! Applies matrix stored in WorldViewState to OpenGl.
659   //! In "model -> world -> view -> projection" it performs:
660   //!     model -> world -> view,
661   //! where model -> world is identical matrix
662   Standard_EXPORT void ApplyWorldViewMatrix();
663
664   //! Applies combination of matrices stored in ModelWorldState and WorldViewState to OpenGl.
665   //! In "model -> world -> view -> projection" it performs:
666   //!     model -> world -> view
667   Standard_EXPORT void ApplyModelViewMatrix();
668
669   //! Applies matrix stored in ProjectionState to OpenGl.
670   //! In "model -> world -> view -> projection" it performs:
671   //!                       view -> projection
672   Standard_EXPORT void ApplyProjectionMatrix();
673
674 public:
675
676   //! @return messenger instance
677   inline const Handle(Message_Messenger)& Messenger() const
678   {
679     return ::Message::DefaultMessenger();
680   }
681
682   //! Callback for GL_ARB_debug_output extension
683   //! @param theSource   message source   within GL_DEBUG_SOURCE_   enumeration
684   //! @param theType     message type     within GL_DEBUG_TYPE_     enumeration
685   //! @param theId       message ID       within source
686   //! @param theSeverity message severity within GL_DEBUG_SEVERITY_ enumeration
687   //! @param theMessage  the message itself
688   Standard_EXPORT void PushMessage (const unsigned int theSource,
689                                     const unsigned int theType,
690                                     const unsigned int theId,
691                                     const unsigned int theSeverity,
692                                     const TCollection_ExtendedString& theMessage);
693
694   //! Adds a filter for messages with theId and theSource (GL_DEBUG_SOURCE_)
695   Standard_EXPORT Standard_Boolean ExcludeMessage (const unsigned int theSource,
696                                                    const unsigned int theId);
697
698   //! Removes a filter for messages with theId and theSource (GL_DEBUG_SOURCE_)
699   Standard_EXPORT Standard_Boolean IncludeMessage (const unsigned int theSource,
700                                                    const unsigned int theId);
701
702   //! @return true if OpenGl context supports left and
703   //! right rendering buffers.
704   Standard_Boolean HasStereoBuffers() const
705   {
706   #if !defined(GL_ES_VERSION_2_0)
707     return myIsStereoBuffers;
708   #else
709     return Standard_False;
710   #endif
711   }
712
713 public: //! @name methods to alter or retrieve current state
714
715   //! Return structure holding frame statistics.
716   const Handle(OpenGl_FrameStats)& FrameStats() const { return myFrameStats; }
717
718   //! Set structure holding frame statistics.
719   //! This call makes sense only if application defines OpenGl_FrameStats sub-class.
720   void SetFrameStats (const Handle(OpenGl_FrameStats)& theStats) { myFrameStats = theStats; }
721
722   //! Return cached viewport definition (x, y, width, height).
723   const Standard_Integer* Viewport() const { return myViewport; }
724
725   //! Resize the viewport (alias for glViewport).
726   //! @param theRect viewport definition (x, y, width, height)
727   Standard_EXPORT void ResizeViewport (const Standard_Integer theRect[4]);
728
729   //! Return virtual viewport definition (x, y, width, height).
730   const Standard_Integer* VirtualViewport() const { return myViewportVirt; }
731
732   //! Return active read buffer.
733   Standard_Integer ReadBuffer() { return myReadBuffer; }
734
735   //! Switch read buffer, wrapper for ::glReadBuffer().
736   Standard_EXPORT void SetReadBuffer (const Standard_Integer theReadBuffer);
737
738   //! Return active draw buffer attached to a render target referred by index (layout location).
739   Standard_Integer DrawBuffer (Standard_Integer theIndex = 0) const
740   {
741     return theIndex >= myDrawBuffers.Lower()
742         && theIndex <= myDrawBuffers.Upper()
743          ? myDrawBuffers.Value (theIndex)
744          : GL_NONE;
745   }
746
747   //! Switch draw buffer, wrapper for ::glDrawBuffer().
748   Standard_EXPORT void SetDrawBuffer (const Standard_Integer theDrawBuffer);
749
750   //! Switch draw buffer, wrapper for ::glDrawBuffers (GLsizei, const GLenum*).
751   Standard_EXPORT void SetDrawBuffers (const Standard_Integer theNb, const Standard_Integer* theDrawBuffers);
752
753   //! Switch read/draw buffers.
754   void SetReadDrawBuffer (const Standard_Integer theBuffer)
755   {
756     SetReadBuffer (theBuffer);
757     SetDrawBuffer (theBuffer);
758   }
759
760   //! Returns cached GL_FRAMEBUFFER_SRGB state.
761   //! If TRUE, GLSL program is expected to write linear RGB color.
762   //! Otherwise, GLSL program might need manually converting result color into sRGB color space.
763   bool IsFrameBufferSRGB() const { return myIsSRgbActive; }
764
765   //! Enables/disables GL_FRAMEBUFFER_SRGB flag.
766   //! This flag can be set to:
767   //! - TRUE when writing into offscreen FBO (always expected to be in sRGB or RGBF formats).
768   //! - TRUE when writing into sRGB-ready window buffer (might require choosing proper pixel format on window creation).
769   //! - FALSE if sRGB rendering is not supported or sRGB-not-ready window buffer is used for drawing.
770   //! @param theIsFbo [in] flag indicating writing into offscreen FBO (always expected sRGB-ready when sRGB FBO is supported)
771   //!                      or into window buffer (FALSE, sRGB-readiness might vary).
772   //! @param theIsSRgb [in] flag indicating off-screen FBO is sRGB-ready
773   Standard_EXPORT void SetFrameBufferSRGB (bool theIsFbo, bool theIsFboSRgb = true);
774
775   //! Return cached flag indicating writing into color buffer is enabled or disabled (glColorMask).
776   const NCollection_Vec4<bool>& ColorMaskRGBA() const { return myColorMask; }
777
778   //! Enable/disable writing into color buffer (wrapper for glColorMask).
779   Standard_EXPORT void SetColorMaskRGBA (const NCollection_Vec4<bool>& theToWriteColor);
780
781   //! Return cached flag indicating writing into color buffer is enabled or disabled (glColorMask).
782   bool ColorMask() const { return myColorMask.r(); }
783
784   //! Enable/disable writing into color buffer (wrapper for glColorMask).
785   //! Alpha component writes will be disabled unconditionally in case of caps->buffersOpaqueAlpha.
786   Standard_EXPORT bool SetColorMask (bool theToWriteColor);
787
788   //! Return TRUE if GL_SAMPLE_ALPHA_TO_COVERAGE usage is allowed.
789   bool AllowSampleAlphaToCoverage() const { return myAllowAlphaToCov; }
790
791   //! Allow GL_SAMPLE_ALPHA_TO_COVERAGE usage.
792   void SetAllowSampleAlphaToCoverage (bool theToEnable) { myAllowAlphaToCov = theToEnable; }
793
794   //! Return GL_SAMPLE_ALPHA_TO_COVERAGE state.
795   bool SampleAlphaToCoverage() const { return myAlphaToCoverage; }
796
797   //! Enable/disable GL_SAMPLE_ALPHA_TO_COVERAGE.
798   Standard_EXPORT bool SetSampleAlphaToCoverage (bool theToEnable);
799
800   //! Return back face culling state.
801   bool ToCullBackFaces() const { return myToCullBackFaces; }
802
803   //! Enable or disable back face culling (glEnable (GL_CULL_FACE)).
804   Standard_EXPORT void SetCullBackFaces (bool theToEnable);
805
806   //! Fetch OpenGl context state. This class tracks value of several OpenGl
807   //! state variables. Consulting the cached values is quicker than
808   //! doing the same via OpenGl API. Call this method if any of the controlled
809   //! OpenGl state variables has a possibility of being out-of-date.
810   Standard_EXPORT void FetchState();
811
812   //! @return active textures
813   const Handle(OpenGl_TextureSet)& ActiveTextures() const { return myActiveTextures; }
814
815   //! Bind specified texture set to current context taking into account active GLSL program.
816   Standard_DEPRECATED("BindTextures() with explicit GLSL program should be used instead")
817   Handle(OpenGl_TextureSet) BindTextures (const Handle(OpenGl_TextureSet)& theTextures)
818   {
819     return BindTextures (theTextures, myActiveProgram);
820   }
821
822   //! Bind specified texture set to current context, or unbind previous one when NULL specified.
823   //! @param theTextures [in] texture set to bind
824   //! @param theProgram  [in] program attributes; when not NULL,
825   //!                         mock textures will be bound to texture units expected by GLSL program, but undefined by texture set
826   //! @return previous texture set
827   Standard_EXPORT Handle(OpenGl_TextureSet) BindTextures (const Handle(OpenGl_TextureSet)& theTextures,
828                                                           const Handle(OpenGl_ShaderProgram)& theProgram);
829
830   //! @return active GLSL program
831   const Handle(OpenGl_ShaderProgram)& ActiveProgram() const
832   {
833     return myActiveProgram;
834   }
835
836   //! Bind specified program to current context,
837   //! or unbind previous one when NULL specified.
838   //! @return true if some program is bound to context
839   Standard_EXPORT Standard_Boolean BindProgram (const Handle(OpenGl_ShaderProgram)& theProgram);
840
841   //! Setup current shading material.
842   Standard_EXPORT void SetShadingMaterial (const OpenGl_Aspects* theAspect,
843                                            const Handle(Graphic3d_PresentationAttributes)& theHighlight);
844
845   //! Checks if transparency is required for the given aspect and highlight style.
846   Standard_EXPORT static Standard_Boolean CheckIsTransparent (const OpenGl_Aspects* theAspect,
847                                                               const Handle(Graphic3d_PresentationAttributes)& theHighlight,
848                                                               Standard_ShortReal& theAlphaFront,
849                                                               Standard_ShortReal& theAlphaBack);
850
851   //! Checks if transparency is required for the given aspect and highlight style.
852   static Standard_Boolean CheckIsTransparent (const OpenGl_Aspects* theAspect,
853                                               const Handle(Graphic3d_PresentationAttributes)& theHighlight)
854   {
855     Standard_ShortReal anAlphaFront = 1.0f, anAlphaBack = 1.0f;
856     return CheckIsTransparent (theAspect, theHighlight, anAlphaFront, anAlphaBack);
857   }
858
859   //! Setup current color.
860   Standard_EXPORT void SetColor4fv (const OpenGl_Vec4& theColor);
861
862   //! Setup type of line.
863   Standard_EXPORT void SetTypeOfLine (const Aspect_TypeOfLine  theType,
864                                       const Standard_ShortReal theFactor = 1.0f);
865
866   //! Setup stipple line pattern with 1.0f factor; wrapper for glLineStipple().
867   void SetLineStipple (const uint16_t thePattern) { SetLineStipple (1.0f, thePattern); }
868
869   //! Setup type of line; wrapper for glLineStipple().
870   Standard_EXPORT void SetLineStipple (const Standard_ShortReal theFactor,
871                                        const uint16_t thePattern);
872
873   //! Setup width of line.
874   Standard_EXPORT void SetLineWidth (const Standard_ShortReal theWidth);
875
876   //! Setup point size.
877   Standard_EXPORT void SetPointSize (const Standard_ShortReal theSize);
878
879   //! Setup point sprite origin using GL_POINT_SPRITE_COORD_ORIGIN state:
880   //! - GL_UPPER_LEFT when GLSL program is active;
881   //!   flipping should be handled in GLSL program for compatibility with OpenGL ES
882   //! - GL_LOWER_LEFT for FFP
883   Standard_EXPORT void SetPointSpriteOrigin();
884
885   //! Setup texture matrix to active GLSL program or to FFP global state using glMatrixMode (GL_TEXTURE).
886   //! @param theParams    [in] texture parameters
887   //! @param theIsTopDown [in] texture top-down flag
888   Standard_EXPORT void SetTextureMatrix (const Handle(Graphic3d_TextureParams)& theParams,
889                                          const Standard_Boolean theIsTopDown);
890
891   //! Bind default Vertex Array Object
892   Standard_EXPORT void BindDefaultVao();
893
894   //! Default Frame Buffer Object.
895   const Handle(OpenGl_FrameBuffer)& DefaultFrameBuffer() const
896   {
897     return myDefaultFbo;
898   }
899
900   //! Setup new Default Frame Buffer Object and return previously set.
901   //! This call doesn't change Active FBO!
902   Standard_EXPORT Handle(OpenGl_FrameBuffer) SetDefaultFrameBuffer (const Handle(OpenGl_FrameBuffer)& theFbo);
903
904   //! Return debug context initialization state.
905   Standard_Boolean IsDebugContext() const
906   {
907     return myIsGlDebugCtx;
908   }
909
910   Standard_EXPORT void EnableFeatures() const;
911
912   Standard_EXPORT void DisableFeatures() const;
913
914   //! Return resolution for rendering text.
915   unsigned int Resolution() const { return myResolution; }
916
917   //! Resolution scale factor (rendered resolution to standard resolution).
918   //! This scaling factor for parameters like text size to be properly displayed on device (screen / printer).
919   Standard_ShortReal ResolutionRatio() const { return myResolutionRatio; }
920
921   //! Rendering scale factor (rendering viewport height to real window buffer height).
922   Standard_ShortReal RenderScale() const { return myRenderScale; }
923
924   //! Return TRUE if rendering scale factor is not 1.
925   Standard_Boolean HasRenderScale() const { return Abs (myRenderScale - 1.0f) > 0.0001f; }
926
927   //! Rendering scale factor (inverted value).
928   Standard_ShortReal RenderScaleInv() const { return myRenderScaleInv; }
929
930   //! Return scale factor for line width.
931   Standard_ShortReal LineWidthScale() const { return myLineWidthScale; }
932
933   //! Set resolution ratio.
934   //! Note that this method rounds @theRatio to nearest integer.
935   void SetResolution (unsigned int theResolution,
936                       Standard_ShortReal theRatio,
937                       Standard_ShortReal theScale)
938   {
939     myResolution      = (unsigned int )(theScale * theResolution + 0.5f);
940     myRenderScale     = theScale;
941     myRenderScaleInv  = 1.0f / theScale;
942     SetResolutionRatio (theRatio * theScale);
943   }
944
945   //! Set resolution ratio.
946   //! Note that this method rounds @theRatio to nearest integer.
947   void SetResolutionRatio (const Standard_ShortReal theRatio)
948   {
949     myResolutionRatio = theRatio;
950     myLineWidthScale  = Max (1.0f, std::floor (theRatio + 0.5f));
951   }
952
953   //! Return line feater width in pixels.
954   Standard_ShortReal LineFeather() const { return myLineFeather; }
955
956   //! Set line feater width.
957   void SetLineFeather(Standard_ShortReal theValue) { myLineFeather = theValue; }
958
959   //! Wrapper over glGetBufferSubData(), implemented as:
960   //! - OpenGL 1.5+ (desktop) via glGetBufferSubData();
961   //! - OpenGL ES 3.0+ via glMapBufferRange();
962   //! - WebGL 2.0+ via gl.getBufferSubData().
963   //! @param theTarget [in] target buffer to map
964   //! @param theOffset [in] offset to the beginning of sub-data
965   //! @param theSize   [in] number of bytes to read
966   //! @param theData  [out] destination pointer to fill
967   //! @return FALSE if functionality is unavailable
968   Standard_EXPORT bool GetBufferSubData (GLenum theTarget, GLintptr theOffset, GLsizeiptr theSize, void* theData);
969
970   //! Return Graphics Driver's vendor.
971   const TCollection_AsciiString& Vendor() const { return myVendor; }
972
973   //! Dumps the content of me into the stream
974   Standard_EXPORT void DumpJson (Standard_OStream& theOStream, Standard_Integer theDepth = -1) const;
975     
976   //! Dumps the content of openGL state into the stream
977   Standard_EXPORT static void DumpJsonOpenGlState (Standard_OStream& theOStream, Standard_Integer theDepth = -1);
978
979   //! Set GL_SHADE_MODEL value.
980   Standard_EXPORT void SetShadeModel (Graphic3d_TypeOfShadingModel theModel);
981
982 private:
983
984   //! Wrapper to system function to retrieve GL function pointer by name.
985   Standard_EXPORT void* findProc (const char* theFuncName);
986
987   //! Print error if not all functions have been exported by context for reported version.
988   //! Note that this will never happen when using GLX, since returned functions can not be validated.
989   //! @param theGlVerMajor the OpenGL major version with missing functions
990   //! @param theGlVerMinor the OpenGL minor version with missing functions
991   //! @param theLastFailedProc function name which cannot be found
992   Standard_EXPORT void checkWrongVersion (Standard_Integer theGlVerMajor, Standard_Integer theGlVerMinor,
993                                           const char* theLastFailedProc);
994
995   //! Private initialization function that should be called only once.
996   Standard_EXPORT void init (const Standard_Boolean theIsCoreProfile);
997
998 public: //! @name core profiles
999
1000   OpenGl_GlCore11*     core11ffp;  //!< OpenGL 1.1 core functionality
1001   OpenGl_GlCore11Fwd*  core11fwd;  //!< OpenGL 1.1 without deprecated entry points
1002   OpenGl_GlCore15*     core15;     //!< OpenGL 1.5 without deprecated entry points
1003   OpenGl_GlCore20*     core20;     //!< OpenGL 2.0 without deprecated entry points
1004   OpenGl_GlCore30*     core30;     //!< OpenGL 3.0 without deprecated entry points
1005   OpenGl_GlCore32*     core32;     //!< OpenGL 3.2 core profile
1006   OpenGl_GlCore33*     core33;     //!< OpenGL 3.3 core profile
1007   OpenGl_GlCore41*     core41;     //!< OpenGL 4.1 core profile
1008   OpenGl_GlCore42*     core42;     //!< OpenGL 4.2 core profile
1009   OpenGl_GlCore43*     core43;     //!< OpenGL 4.3 core profile
1010   OpenGl_GlCore44*     core44;     //!< OpenGL 4.4 core profile
1011   OpenGl_GlCore45*     core45;     //!< OpenGL 4.5 core profile
1012   OpenGl_GlCore46*     core46;     //!< OpenGL 4.6 core profile
1013
1014   OpenGl_GlCore15*     core15fwd;  //!< obsolete entry left for code portability; core15 should be used instead
1015   OpenGl_GlCore20*     core20fwd;  //!< obsolete entry left for code portability; core20 should be used instead
1016
1017   Handle(OpenGl_Caps) caps; //!< context options
1018
1019 public: //! @name extensions
1020
1021   Standard_Boolean       hasGetBufferData;   //!< flag indicating if GetBufferSubData() is supported
1022   Standard_Boolean       hasPackRowLength;   //!< supporting of GL_PACK_ROW_LENGTH   parameters (any desktop OpenGL; OpenGL ES 3.0)
1023   Standard_Boolean       hasUnpackRowLength; //!< supporting of GL_UNPACK_ROW_LENGTH parameters (any desktop OpenGL; OpenGL ES 3.0)
1024   Standard_Boolean       hasHighp;           //!< highp in GLSL ES fragment shader is supported
1025   Standard_Boolean       hasUintIndex;       //!< GLuint for index buffer is supported (always available on desktop; on OpenGL ES - since 3.0 or as extension GL_OES_element_index_uint)
1026   Standard_Boolean       hasTexRGBA8;        //!< always available on desktop; on OpenGL ES - since 3.0 or as extension GL_OES_rgb8_rgba8
1027   Standard_Boolean       hasTexFloatLinear;  //!< texture-filterable state for 32-bit floating texture formats (always on desktop, GL_OES_texture_float_linear within OpenGL ES)
1028   Standard_Boolean       hasTexSRGB;         //!< sRGB texture    formats (desktop OpenGL 2.1, OpenGL ES 3.0 or GL_EXT_texture_sRGB)
1029   Standard_Boolean       hasFboSRGB;         //!< sRGB FBO render targets (desktop OpenGL 2.1, OpenGL ES 3.0)
1030   Standard_Boolean       hasSRGBControl;     //!< sRGB write control (any desktop OpenGL, OpenGL ES + GL_EXT_sRGB_write_control extension)
1031   Standard_Boolean       hasFboRenderMipmap; //!< FBO render target could be non-zero mipmap level of texture
1032   OpenGl_FeatureFlag     hasFlatShading;     //!< Complex flag indicating support of Flat shading (Graphic3d_TOSM_FACET) (always available on desktop; on OpenGL ES - since 3.0 or as extension GL_OES_standard_derivatives)
1033   OpenGl_FeatureFlag     hasGlslBitwiseOps;  //!< GLSL supports bitwise operations; OpenGL 3.0 / OpenGL ES 3.0 (GLSL 130 / GLSL ES 300) or OpenGL 2.1 + GL_EXT_gpu_shader4
1034   OpenGl_FeatureFlag     hasDrawBuffers;     //!< Complex flag indicating support of multiple draw buffers (desktop OpenGL 2.0, OpenGL ES 3.0, GL_ARB_draw_buffers, GL_EXT_draw_buffers)
1035   OpenGl_FeatureFlag     hasFloatBuffer;     //!< Complex flag indicating support of float color buffer format (desktop OpenGL 3.0, GL_ARB_color_buffer_float, GL_EXT_color_buffer_float)
1036   OpenGl_FeatureFlag     hasHalfFloatBuffer; //!< Complex flag indicating support of half-float color buffer format (desktop OpenGL 3.0, GL_ARB_color_buffer_float, GL_EXT_color_buffer_half_float)
1037   OpenGl_FeatureFlag     hasSampleVariables; //!< Complex flag indicating support of MSAA variables in GLSL shader (desktop OpenGL 4.0, GL_ARB_sample_shading)
1038   OpenGl_FeatureFlag     hasGeometryStage;   //!< Complex flag indicating support of Geometry shader (desktop OpenGL 3.2, OpenGL ES 3.2, GL_EXT_geometry_shader)
1039   Standard_Boolean       arbDrawBuffers;     //!< GL_ARB_draw_buffers
1040   Standard_Boolean       arbNPTW;            //!< GL_ARB_texture_non_power_of_two
1041   Standard_Boolean       arbTexRG;           //!< GL_ARB_texture_rg
1042   Standard_Boolean       arbTexFloat;        //!< GL_ARB_texture_float (on desktop OpenGL - since 3.0 or as extension GL_ARB_texture_float; on OpenGL ES - since 3.0); @sa hasTexFloatLinear for linear filtering support
1043   OpenGl_ArbSamplerObject* arbSamplerObject; //!< GL_ARB_sampler_objects (on desktop OpenGL - since 3.3 or as extension GL_ARB_sampler_objects; on OpenGL ES - since 3.0)
1044   OpenGl_ArbTexBindless* arbTexBindless;     //!< GL_ARB_bindless_texture
1045   OpenGl_ArbTBO*         arbTBO;             //!< GL_ARB_texture_buffer_object (on desktop OpenGL - since 3.1 or as extension GL_ARB_texture_buffer_object; on OpenGL ES - since 3.2)
1046   Standard_Boolean       arbTboRGB32;        //!< GL_ARB_texture_buffer_object_rgb32 (3-component TBO), in core since 4.0 (on OpenGL ES - since 3.2)
1047   Standard_Boolean       arbClipControl;     //!< GL_ARB_clip_control, in core since 4.5
1048   OpenGl_ArbIns*         arbIns;             //!< GL_ARB_draw_instanced (on desktop OpenGL - since 3.1 or as extension GL_ARB_draw_instanced; on OpenGL ES - since 3.0 or as extension GL_ANGLE_instanced_arrays to WebGL 1.0)
1049   OpenGl_ArbDbg*         arbDbg;             //!< GL_ARB_debug_output (on desktop OpenGL - since 4.3 or as extension GL_ARB_debug_output; on OpenGL ES - since 3.2 or as extension GL_KHR_debug)
1050   OpenGl_ArbFBO*         arbFBO;             //!< GL_ARB_framebuffer_object
1051   OpenGl_ArbFBOBlit*     arbFBOBlit;         //!< glBlitFramebuffer function, moved out from OpenGl_ArbFBO structure for compatibility with OpenGL ES 2.0
1052   Standard_Boolean       arbSampleShading;   //!< GL_ARB_sample_shading
1053   Standard_Boolean       arbDepthClamp;      //!< GL_ARB_depth_clamp (on desktop OpenGL - since 3.2 or as extensions GL_ARB_depth_clamp,NV_depth_clamp; unavailable on OpenGL ES)
1054   Standard_Boolean       extFragDepth;       //!< GL_EXT_frag_depth on OpenGL ES 2.0 (gl_FragDepthEXT built-in variable, before OpenGL ES 3.0)
1055   Standard_Boolean       extDrawBuffers;     //!< GL_EXT_draw_buffers
1056   OpenGl_ExtGS*          extGS;              //!< GL_EXT_geometry_shader4
1057   Standard_Boolean       extBgra;            //!< GL_EXT_bgra or GL_EXT_texture_format_BGRA8888 on OpenGL ES
1058   Standard_Boolean       extAnis;            //!< GL_EXT_texture_filter_anisotropic
1059   Standard_Boolean       extPDS;             //!< GL_EXT_packed_depth_stencil
1060   Standard_Boolean       atiMem;             //!< GL_ATI_meminfo
1061   Standard_Boolean       nvxMem;             //!< GL_NVX_gpu_memory_info
1062   Standard_Boolean       oesSampleVariables; //!< GL_OES_sample_variables
1063   Standard_Boolean       oesStdDerivatives;  //!< GL_OES_standard_derivatives
1064
1065 public: //! @name public properties tracking current state
1066
1067   OpenGl_MatrixState<Standard_ShortReal> ModelWorldState; //!< state of orientation matrix
1068   OpenGl_MatrixState<Standard_ShortReal> WorldViewState;  //!< state of orientation matrix
1069   OpenGl_MatrixState<Standard_ShortReal> ProjectionState; //!< state of projection  matrix
1070
1071 private: // system-dependent fields
1072
1073 #if defined(HAVE_EGL)
1074   Aspect_Drawable         myWindow;   //!< EGL surface                   : EGLSurface
1075   Aspect_Display          myDisplay;  //!< EGL connection to the Display : EGLDisplay
1076   Aspect_RenderingContext myGContext; //!< EGL rendering context         : EGLContext
1077 #elif defined(_WIN32)
1078   Aspect_Handle           myWindow;   //!< window handle (owner of GL context) : HWND
1079   Aspect_Handle           myWindowDC; //!< Device Descriptor handle : HDC
1080   Aspect_RenderingContext myGContext; //!< Rendering Context handle : HGLRC
1081 #elif defined(__APPLE__) && !defined(MACOSX_USE_GLX)
1082   #if defined(TARGET_OS_IPHONE) && TARGET_OS_IPHONE
1083   EAGLContext*            myGContext;    //!< Rendering Context handle
1084   #else
1085   NSOpenGLContext*        myGContext; //!< Rendering Context handle
1086   #endif
1087 #else
1088   Aspect_Drawable         myWindow;   //!< window handle (owner of GL context) : GLXDrawable
1089   Aspect_Display          myDisplay;  //!< connection to the X-server : Display*
1090   Aspect_RenderingContext myGContext; //!< X-GLX rendering context : GLXContext
1091 #endif
1092
1093 private: // context info
1094
1095   typedef NCollection_Shared< NCollection_DataMap<TCollection_AsciiString, Standard_Integer> > OpenGl_DelayReleaseMap;
1096   typedef NCollection_Shared< NCollection_List<Handle(OpenGl_Resource)> > OpenGl_ResourcesStack;
1097
1098   Handle(OpenGl_ResourcesMap)    mySharedResources; //!< shared resources with unique identification key
1099   Handle(OpenGl_DelayReleaseMap) myDelayed;         //!< shared resources for delayed release
1100   Handle(OpenGl_ResourcesStack)  myUnusedResources; //!< stack of resources for delayed clean up
1101
1102   OpenGl_Clipping myClippingState; //!< state of clip planes
1103
1104   void*            myGlLibHandle;          //!< optional handle to GL library
1105   NCollection_Handle<OpenGl_GlFunctions>
1106                    myFuncs;                //!< mega structure for all GL functions
1107   Handle(Image_SupportedFormats)
1108                    mySupportedFormats;     //!< map of supported texture formats
1109   Standard_Integer myAnisoMax;             //!< maximum level of anisotropy texture filter
1110   Standard_Integer myTexClamp;             //!< either GL_CLAMP_TO_EDGE (1.2+) or GL_CLAMP (1.1)
1111   Standard_Integer myMaxTexDim;            //!< value for GL_MAX_TEXTURE_SIZE
1112   Standard_Integer myMaxTexCombined;       //!< value for GL_MAX_COMBINED_TEXTURE_IMAGE_UNITS
1113   Standard_Integer myMaxTexUnitsFFP;       //!< value for GL_MAX_TEXTURE_UNITS (fixed-function pipeline only)
1114   Standard_Integer myMaxDumpSizeX;         //!< maximum FBO width  for image dump
1115   Standard_Integer myMaxDumpSizeY;         //!< maximum FBO height for image dump
1116   Standard_Integer myMaxClipPlanes;        //!< value for GL_MAX_CLIP_PLANES
1117   Standard_Integer myMaxMsaaSamples;       //!< value for GL_MAX_SAMPLES
1118   Standard_Integer myMaxDrawBuffers;       //!< value for GL_MAX_DRAW_BUFFERS
1119   Standard_Integer myMaxColorAttachments;  //!< value for GL_MAX_COLOR_ATTACHMENTS
1120   Standard_Integer myGlVerMajor;           //!< cached GL version major number
1121   Standard_Integer myGlVerMinor;           //!< cached GL version minor number
1122   Standard_Boolean myIsInitialized;        //!< flag indicates initialization state
1123   Standard_Boolean myIsStereoBuffers;      //!< context supports stereo buffering
1124   Standard_Boolean myIsGlNormalizeEnabled; //!< GL_NORMALIZE flag
1125                                            //!< Used to tell OpenGl that normals should be normalized
1126   Graphic3d_TextureUnit mySpriteTexUnit;   //!< sampler2D occSamplerPointSprite, texture unit for point sprite texture
1127
1128   Standard_Boolean myHasRayTracing;                 //! indicates whether ray tracing mode is supported
1129   Standard_Boolean myHasRayTracingTextures;         //! indicates whether textures in ray tracing mode are supported
1130   Standard_Boolean myHasRayTracingAdaptiveSampling; //! indicates whether adaptive screen sampling in ray tracing mode is supported
1131   Standard_Boolean myHasRayTracingAdaptiveSamplingAtomic; //! indicates whether atomic adaptive screen sampling in ray tracing mode is supported
1132
1133   Standard_Boolean myHasPBR;                      //!< indicates whether PBR shading model is supported
1134   Graphic3d_TextureUnit myPBREnvLUTTexUnit;       //!< sampler2D occEnvLUT, texture unit where environment lookup table is expected to be binded (0 if PBR is not supported)
1135   Graphic3d_TextureUnit myPBRDiffIBLMapSHTexUnit; //!< sampler2D occDiffIBLMapSHCoeffs, texture unit where diffuse (irradiance) IBL map's spherical harmonics coefficients is expected to  be binded
1136                                                   //!  (0 if PBR is not supported)
1137   Graphic3d_TextureUnit myPBRSpecIBLMapTexUnit;   //!< samplerCube occSpecIBLMap, texture unit where specular IBL map is expected to  be binded (0 if PBR is not supported)
1138   Graphic3d_TextureUnit myShadowMapTexUnit;       //!< sampler2D occShadowMapSampler
1139
1140   Graphic3d_TextureUnit myDepthPeelingDepthTexUnit;      //!< sampler2D occDepthPeelingDepth, texture unit for Depth Peeling lookups
1141   Graphic3d_TextureUnit myDepthPeelingFrontColorTexUnit; //!< sampler2D occDepthPeelingFrontColor, texture unit for Depth Peeling lookups
1142
1143   Handle(OpenGl_ShaderManager) myShaderManager; //! support object for managing shader programs
1144
1145 private: //! @name fields tracking current state
1146
1147   Handle(Graphic3d_Camera)      myCamera;          //!< active camera object
1148   Handle(OpenGl_FrameStats)     myFrameStats;      //!< structure accumulating frame statistics
1149   Handle(OpenGl_ShaderProgram)  myActiveProgram;   //!< currently active GLSL program
1150   Handle(OpenGl_TextureSet)     myActiveTextures;  //!< currently bound textures
1151                                                    //!< currently active sampler objects
1152   Standard_Integer              myActiveMockTextures; //!< currently active mock sampler objects
1153   Handle(OpenGl_FrameBuffer)    myDefaultFbo;      //!< default Frame Buffer Object
1154   Handle(OpenGl_LineAttributes) myHatchStyles;     //!< resource holding predefined hatch styles patterns
1155   Standard_Integer              myActiveHatchType; //!< currently activated type of polygon hatch
1156   Standard_Boolean              myHatchIsEnabled;  //!< current enabled state of polygon hatching rasterization
1157   Handle(OpenGl_Texture)        myTextureRgbaBlack;//!< mock black texture returning (0, 0, 0, 0)
1158   Handle(OpenGl_Texture)        myTextureRgbaWhite;//!< mock white texture returning (1, 1, 1, 1)
1159   Standard_Integer              myViewport[4];     //!< current viewport
1160   Standard_Integer              myViewportVirt[4]; //!< virtual viewport
1161   Standard_Integer              myPointSpriteOrig; //!< GL_POINT_SPRITE_COORD_ORIGIN state (GL_UPPER_LEFT by default)
1162   Standard_Integer              myRenderMode;      //!< value for active rendering mode
1163   Standard_Integer              myShadeModel;      //!< currently used shade model (glShadeModel)
1164   Standard_Integer              myPolygonMode;     //!< currently used polygon rasterization mode (glPolygonMode)
1165   Graphic3d_PolygonOffset       myPolygonOffset;   //!< currently applied polygon offset
1166   bool                          myToCullBackFaces; //!< back face culling mode enabled state (glIsEnabled (GL_CULL_FACE))
1167   Standard_Integer              myReadBuffer;      //!< current read buffer
1168   NCollection_Array1<Standard_Integer>
1169                                 myDrawBuffers;     //!< current draw buffers
1170   unsigned int                  myDefaultVao;      //!< default Vertex Array Object
1171   NCollection_Vec4<bool>        myColorMask;       //!< flag indicating writing into color buffer is enabled or disabled (glColorMask)
1172   Standard_Boolean              myAllowAlphaToCov; //!< flag allowing   GL_SAMPLE_ALPHA_TO_COVERAGE usage
1173   Standard_Boolean              myAlphaToCoverage; //!< flag indicating GL_SAMPLE_ALPHA_TO_COVERAGE state
1174   Standard_Boolean              myIsGlDebugCtx;    //!< debug context initialization state
1175   Standard_Boolean              myIsSRgbWindow;    //!< indicates that window buffer is sRGB-ready
1176   Standard_Boolean              myIsSRgbActive;    //!< flag indicating GL_FRAMEBUFFER_SRGB state
1177   TCollection_AsciiString       myVendor;          //!< Graphics Driver's vendor
1178   TColStd_PackedMapOfInteger    myFilters[6];      //!< messages suppressing filter (for sources from GL_DEBUG_SOURCE_API_ARB to GL_DEBUG_SOURCE_OTHER_ARB)
1179   unsigned int                  myResolution;      //!< Pixels density (PPI), defines scaling factor for parameters like text size
1180   Standard_ShortReal            myResolutionRatio; //!< scaling factor for parameters like text size
1181                                                    //!  to be properly displayed on device (screen / printer)
1182   Standard_ShortReal            myLineWidthScale;  //!< scaling factor for line width
1183   Standard_ShortReal            myLineFeather;     //!< line feater width in pixels
1184   Standard_ShortReal            myRenderScale;     //!< scaling factor for rendering resolution
1185   Standard_ShortReal            myRenderScaleInv;  //!< scaling factor for rendering resolution (inverted value)
1186   OpenGl_Material               myMaterial;        //!< current front/back material state (cached to reduce GL context updates)
1187
1188 private:
1189
1190   //! Copying allowed only within Handles
1191   OpenGl_Context            (const OpenGl_Context& );
1192   OpenGl_Context& operator= (const OpenGl_Context& );
1193
1194 };
1195
1196 #endif // _OpenGl_Context_H__