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