0025973: Visualization, TKOpenGl - support EAGLContext as alternative to NSOpenGLContext
[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_Drawable.hxx>
21 #include <Aspect_Display.hxx>
22 #include <Aspect_RenderingContext.hxx>
23 #include <Handle_OpenGl_Context.hxx>
24 #include <Handle_OpenGl_FrameBuffer.hxx>
25 #include <Handle_OpenGl_Sampler.hxx>
26 #include <Handle_OpenGl_ShaderManager.hxx>
27 #include <Handle_OpenGl_ShaderProgram.hxx>
28 #include <NCollection_DataMap.hxx>
29 #include <NCollection_Map.hxx>
30 #include <NCollection_Handle.hxx>
31 #include <NCollection_List.hxx>
32 #include <Message.hxx>
33 #include <OpenGl_Caps.hxx>
34 #include <OpenGl_Vec.hxx>
35 #include <OpenGl_Resource.hxx>
36 #include <Standard_Transient.hxx>
37 #include <TCollection_AsciiString.hxx>
38 #include <OpenGl_Clipping.hxx>
39 #include <OpenGl_GlCore11.hxx>
40 #include <OpenGl_Utils.hxx>
41
42 //! Forward declarations
43 #if defined(__APPLE__)
44   #import <TargetConditionals.h>
45   #if defined(TARGET_OS_IPHONE) && TARGET_OS_IPHONE
46     #ifdef __OBJC__
47       @class EAGLContext;
48     #else
49       struct EAGLContext;
50     #endif
51   #else
52     #ifdef __OBJC__
53       @class NSOpenGLContext;
54     #else
55       struct NSOpenGLContext;
56     #endif
57   #endif
58 #endif
59
60 struct OpenGl_GlFunctions;
61 struct OpenGl_ArbTBO;
62 struct OpenGl_ArbIns;
63 struct OpenGl_ArbDbg;
64 struct OpenGl_ArbFBO;
65 struct OpenGl_ArbFBOBlit;
66 struct OpenGl_ExtGS;
67 struct OpenGl_ArbTexBindless;
68
69 template<typename theBaseClass_t> struct OpenGl_TmplCore12;
70 typedef OpenGl_TmplCore12<OpenGl_GlCore11>     OpenGl_GlCore12;
71 typedef OpenGl_TmplCore12<OpenGl_GlCore11Fwd>  OpenGl_GlCore12Fwd;
72
73 struct OpenGl_GlCore13;
74 struct OpenGl_GlCore13Fwd;
75
76 template<typename theBaseClass_t> struct OpenGl_TmplCore14;
77 typedef OpenGl_TmplCore14<OpenGl_GlCore13>     OpenGl_GlCore14;
78 typedef OpenGl_TmplCore14<OpenGl_GlCore13Fwd>  OpenGl_GlCore14Fwd;
79
80 template<typename theBaseClass_t> struct OpenGl_TmplCore15;
81 typedef OpenGl_TmplCore15<OpenGl_GlCore14>     OpenGl_GlCore15;
82 typedef OpenGl_TmplCore15<OpenGl_GlCore14Fwd>  OpenGl_GlCore15Fwd;
83
84 template<typename theBaseClass_t> struct OpenGl_TmplCore20;
85 typedef OpenGl_TmplCore20<OpenGl_GlCore15>     OpenGl_GlCore20;
86 typedef OpenGl_TmplCore20<OpenGl_GlCore15Fwd>  OpenGl_GlCore20Fwd;
87
88 template<typename theBaseClass_t> struct OpenGl_TmplCore21;
89 typedef OpenGl_TmplCore21<OpenGl_GlCore20>     OpenGl_GlCore21;
90 typedef OpenGl_TmplCore21<OpenGl_GlCore20Fwd>  OpenGl_GlCore21Fwd;
91
92 template<typename theBaseClass_t> struct OpenGl_TmplCore30;
93 typedef OpenGl_TmplCore30<OpenGl_GlCore21>     OpenGl_GlCore30;
94 typedef OpenGl_TmplCore30<OpenGl_GlCore21Fwd>  OpenGl_GlCore30Fwd;
95
96 template<typename theBaseClass_t> struct OpenGl_TmplCore31;
97 typedef OpenGl_TmplCore31<OpenGl_GlCore30>     OpenGl_GlCore31Back;
98 typedef OpenGl_TmplCore31<OpenGl_GlCore30Fwd>  OpenGl_GlCore31;
99
100 template<typename theBaseClass_t> struct OpenGl_TmplCore32;
101 typedef OpenGl_TmplCore32<OpenGl_GlCore31Back> OpenGl_GlCore32Back;
102 typedef OpenGl_TmplCore32<OpenGl_GlCore31>     OpenGl_GlCore32;
103
104 template<typename theBaseClass_t> struct OpenGl_TmplCore33;
105 typedef OpenGl_TmplCore33<OpenGl_GlCore32Back> OpenGl_GlCore33Back;
106 typedef OpenGl_TmplCore33<OpenGl_GlCore32>     OpenGl_GlCore33;
107
108 template<typename theBaseClass_t> struct OpenGl_TmplCore40;
109 typedef OpenGl_TmplCore40<OpenGl_GlCore33Back> OpenGl_GlCore40Back;
110 typedef OpenGl_TmplCore40<OpenGl_GlCore33>     OpenGl_GlCore40;
111
112 template<typename theBaseClass_t> struct OpenGl_TmplCore41;
113 typedef OpenGl_TmplCore41<OpenGl_GlCore40Back> OpenGl_GlCore41Back;
114 typedef OpenGl_TmplCore41<OpenGl_GlCore40>     OpenGl_GlCore41;
115
116 template<typename theBaseClass_t> struct OpenGl_TmplCore42;
117 typedef OpenGl_TmplCore42<OpenGl_GlCore41Back> OpenGl_GlCore42Back;
118 typedef OpenGl_TmplCore42<OpenGl_GlCore41>     OpenGl_GlCore42;
119
120 template<typename theBaseClass_t> struct OpenGl_TmplCore43;
121 typedef OpenGl_TmplCore43<OpenGl_GlCore42Back> OpenGl_GlCore43Back;
122 typedef OpenGl_TmplCore43<OpenGl_GlCore42>     OpenGl_GlCore43;
123
124 template<typename theBaseClass_t> struct OpenGl_TmplCore44;
125 typedef OpenGl_TmplCore44<OpenGl_GlCore43Back> OpenGl_GlCore44Back;
126 typedef OpenGl_TmplCore44<OpenGl_GlCore43>     OpenGl_GlCore44;
127
128 //! This class generalize access to the GL context and available extensions.
129 //!
130 //! Functions related to specific OpenGL version or extension are grouped into structures which can be accessed as fields of this class.
131 //! The most simple way to check that required functionality is available - is NULL check for the group:
132 //! @code
133 //!   if (myContext->core20 != NULL)
134 //!   {
135 //!     myGlProgram = myContext->core20->glCreateProgram();
136 //!     .. do more stuff ..
137 //!   }
138 //!   else
139 //!   {
140 //!     .. compatibility with outdated configurations ..
141 //!   }
142 //! @endcode
143 //!
144 //! Current implementation provide access to OpenGL core functionality up to 4.4 version (core12, core13, core14, core15, fields core20)
145 //! as well as several extensions (arbTBO, arbFBO, etc.).
146 //!
147 //! OpenGL context might be initialized in Core Profile. In this case deprecated functionality become unavailable.
148 //! To make code easily adaptable to wide range of OpenGL versions, function sets related to each version has two kinds of suffixes:
149 //!  - "back" for version 3.2+.
150 //!     Represents function set for Backward-Compatible Profile.
151 //!     Function sets without this suffix represents core profile.
152 //!  - "fwd"  for version 3.0-.
153 //!     Represents non-deprecated function set of earlier OpenGL versions, which are still available within OpenGL 3.2 Core Profile.
154 //!     Function sets without this suffix represents complete list of functions related to specific OpenGL version.
155 //!
156 //! To select which core** function set should be used in specific case:
157 //!  - Determine the minimal OpenGL version required for implemented functionality and use it to access all functions.
158 //!    For example, if algorithm requires OpenGL 2.1+, it is better to write core20fwd->glEnable() rather than core11fwd->glEnable() for uniformity.
159 //!  - If functionality will work within Core Profile, use function sets with appropriate suffix.
160 //!  - Validate minimal requirements at initialization/creation time and omit checks within code where algorithm should be already initialized.
161 //!    Properly escape code incompatible with Core Profile. The simplest way to check Core Profile is "if (core11 == NULL)".
162 //!
163 //! Simplified extensions classification:
164 //!  - prefixed with NV, AMD, ATI are vendor-specific (however may be provided by other vendors in some cases);
165 //!  - prefixed with EXT are accepted by 2+ vendors;
166 //!  - prefixed with ARB are accepted by Architecture Review Board and are candidates
167 //!    for inclusion into GL core functionality.
168 //! Some functionality can be represented in several extensions simultaneously.
169 //! In this case developer should be careful because different specification may differ
170 //! in aspects (like enumeration values and error-handling).
171 //!
172 //! Notice that some systems provide mechanisms to simultaneously incorporate with GL contexts with different capabilities.
173 //! For this reason OpenGl_Context should be initialized and used for each GL context independently.
174 class OpenGl_Context : public Standard_Transient
175 {
176 public:
177
178   //! Function for getting power of to number larger or equal to input number.
179   //! @param theNumber    number to 'power of two'
180   //! @param theThreshold upper threshold
181   //! @return power of two number
182   inline static Standard_Integer GetPowerOfTwo (const Standard_Integer theNumber,
183                                                 const Standard_Integer theThreshold)
184   {
185     for (Standard_Integer p2 = 2; p2 <= theThreshold; p2 <<= 1)
186     {
187       if (theNumber <= p2)
188       {
189         return p2;
190       }
191     }
192     return theThreshold;
193   }
194
195 public:
196
197   //! Empty constructor. You should call Init() to perform initialization with bound GL context.
198   Standard_EXPORT OpenGl_Context (const Handle(OpenGl_Caps)& theCaps = NULL);
199
200   //! Destructor.
201   Standard_EXPORT virtual ~OpenGl_Context();
202
203   //! Release all resources, including shared ones
204   Standard_EXPORT void forcedRelease();
205
206   //! Share GL context resources.
207   //! theShareCtx - handle to context to retrieve handles to shared resources.
208   Standard_EXPORT void Share (const Handle(OpenGl_Context)& theShareCtx);
209
210   //! Initialize class from currently bound OpenGL context. Method should be called only once.
211   //! @return false if no GL context is bound to the current thread
212   Standard_EXPORT Standard_Boolean Init (const Standard_Boolean theIsCoreProfile = Standard_False);
213
214   //! @return true if this context is valid (has been initialized)
215   inline Standard_Boolean IsValid() const
216   {
217     return myIsInitialized;
218   }
219
220 #if defined(HAVE_EGL)
221   //! Initialize class from specified surface and rendering context. Method should be called only once.
222   //! @return false if OpenGL context can not be bound to specified surface
223   Standard_EXPORT Standard_Boolean Init (const Aspect_Drawable         theEglSurface,
224                                          const Aspect_Display          theEglDisplay,
225                                          const Aspect_RenderingContext theEglContext,
226                                          const Standard_Boolean        theIsCoreProfile = Standard_False);
227 #elif defined(_WIN32)
228   //! Initialize class from specified window and rendering context. Method should be called only once.
229   //! @return false if OpenGL context can not be bound to specified window
230   Standard_EXPORT Standard_Boolean Init (const Aspect_Handle           theWindow,
231                                          const Aspect_Handle           theWindowDC,
232                                          const Aspect_RenderingContext theGContext,
233                                          const Standard_Boolean        theIsCoreProfile = Standard_False);
234
235   //! @return the window handle (HWND) currently bound to this OpenGL context
236   inline Aspect_Handle Window() const
237   {
238     return myWindow;
239   }
240
241 #elif defined(__APPLE__) && !defined(MACOSX_USE_GLX)
242   #if defined(TARGET_OS_IPHONE) && TARGET_OS_IPHONE
243
244   //! Initialize class from specified OpenGL ES context (EAGLContext). Method should be called only once.
245   Standard_EXPORT Standard_Boolean Init (EAGLContext*                  theGContext,
246                                          const Standard_Boolean        theIsCoreProfile = Standard_False);
247   #else
248
249   //! Initialize class from specified OpenGL context (NSOpenGLContext). Method should be called only once.
250   Standard_EXPORT Standard_Boolean Init (NSOpenGLContext*              theGContext,
251                                          const Standard_Boolean        theIsCoreProfile = Standard_False);
252   #endif
253 #else
254
255   //! Initialize class from specified window and rendering context. Method should be called only once.
256   //! @return false if OpenGL context can not be bound to specified window
257   Standard_EXPORT Standard_Boolean Init (const Aspect_Drawable         theWindow,
258                                          const Aspect_Display          theDisplay,
259                                          const Aspect_RenderingContext theGContext,
260                                          const Standard_Boolean        theIsCoreProfile = Standard_False);
261
262   //! @return the window handle (GLXDrawable) currently bound to this OpenGL context
263   inline Aspect_Drawable Window() const
264   {
265     return myWindow;
266   }
267 #endif
268
269   //! Read OpenGL version information from active context.
270   Standard_EXPORT static void ReadGlVersion (Standard_Integer& theGlVerMajor,
271                                              Standard_Integer& theGlVerMinor);
272
273   //! Check if theExtName extension is supported by active GL context.
274   Standard_EXPORT Standard_Boolean CheckExtension (const char* theExtName) const;
275
276   //! Check if theExtName extension is in extensions string.
277   Standard_EXPORT static Standard_Boolean CheckExtension (const char* theExtString,
278                                                           const char* theExtName);
279
280   //! Auxiliary template to retrieve GL function pointer.
281   //! Pointer to function retrieved from library is statically casted
282   //! to requested type - there no way to check real signature of exported function.
283   //! The context should be bound before call.
284   template <typename FuncType_t>
285   Standard_Boolean FindProc (const char* theFuncName,
286                              FuncType_t& theFuncPtr)
287   {
288     theFuncPtr = (FuncType_t )findProc (theFuncName);
289     return (theFuncPtr != NULL);
290   }
291
292   //! @return true if detected GL version is greater or equal to requested one.
293   inline Standard_Boolean IsGlGreaterEqual (const Standard_Integer theVerMajor,
294                                             const Standard_Integer theVerMinor) const
295   {
296     return (myGlVerMajor >  theVerMajor)
297         || (myGlVerMajor == theVerMajor && myGlVerMinor >= theVerMinor);
298   }
299
300   //! Clean up errors stack for this GL context (glGetError() in loop).
301   Standard_EXPORT void ResetErrors();
302
303   //! This method uses system-dependent API to retrieve information
304   //! about GL context bound to the current thread.
305   //! @return true if current thread is bound to this GL context
306   Standard_EXPORT Standard_Boolean IsCurrent() const;
307
308   //! Activates current context.
309   //! Class should be initialized with appropriate info.
310   Standard_EXPORT Standard_Boolean MakeCurrent();
311
312   //! Swap front/back buffers for this GL context (should be activated before!).
313   Standard_EXPORT void SwapBuffers();
314
315   //! Return true if active mode is GL_RENDER (cached state)
316   Standard_Boolean IsRender() const
317   {
318   #if !defined(GL_ES_VERSION_2_0)
319     return myRenderMode == GL_RENDER;
320   #else
321     return Standard_True;
322   #endif
323   }
324
325   //! Return true if active mode is GL_FEEDBACK (cached state)
326   Standard_Boolean IsFeedback() const
327   {
328   #if !defined(GL_ES_VERSION_2_0)
329     return myRenderMode == GL_FEEDBACK;
330   #else
331     return Standard_False;
332   #endif
333   }
334
335   //! This function retrieves information from GL about free GPU memory that is:
336   //!  - OS-dependent. On some OS it is per-process and on others - for entire system.
337   //!  - Vendor-dependent. Currently available only on NVIDIA and AMD/ATi drivers only.
338   //!  - Numbers meaning may vary.
339   //! You should use this info only for diagnostics purposes.
340   //! @return free GPU dedicated memory in bytes.
341   Standard_EXPORT Standard_Size AvailableMemory() const;
342
343   //! This function retrieves information from GL about GPU memory
344   //! and contains more vendor-specific values than AvailableMemory().
345   Standard_EXPORT TCollection_AsciiString MemoryInfo() const;
346
347   //! Access shared resource by its name.
348   //! @param  theKey - unique identifier;
349   //! @return handle to shared resource or NULL.
350   Standard_EXPORT const Handle(OpenGl_Resource)& GetResource (const TCollection_AsciiString& theKey) const;
351
352   //! Access shared resource by its name.
353   //! @param  theKey   - unique identifier;
354   //! @param  theValue - handle to fill;
355   //! @return true if resource was shared.
356   template<typename TheHandleType>
357   Standard_Boolean GetResource (const TCollection_AsciiString& theKey,
358                                 TheHandleType&                 theValue) const
359   {
360     const Handle(OpenGl_Resource)& aResource = GetResource (theKey);
361     if (aResource.IsNull())
362     {
363       return Standard_False;
364     }
365
366     theValue = TheHandleType::DownCast (aResource);
367     return !theValue.IsNull();
368   }
369
370   //! Register shared resource.
371   //! Notice that after registration caller shouldn't release it by himself -
372   //! it will be automatically released on context destruction.
373   //! @param theKey      - unique identifier, shouldn't be empty;
374   //! @param theResource - new resource to register, shouldn't be NULL.
375   Standard_EXPORT Standard_Boolean ShareResource (const TCollection_AsciiString& theKey,
376                                                   const Handle(OpenGl_Resource)& theResource);
377
378   //! Release shared resource.
379   //! If there are more than one reference to this resource
380   //! (also used by some other existing object) then call will be ignored.
381   //! This means that current object itself should nullify handle before this call.
382   //! Notice that this is unrecommended operation at all and should be used
383   //! only in case of fat resources to release memory for other needs.
384   //! @param theKey     unique identifier
385   //! @param theToDelay postpone release until next redraw call
386   Standard_EXPORT void ReleaseResource (const TCollection_AsciiString& theKey,
387                                         const Standard_Boolean         theToDelay = Standard_False);
388
389   //! Append resource to queue for delayed clean up.
390   //! Resources in this queue will be released at next redraw call.
391   Standard_EXPORT void DelayedRelease (Handle(OpenGl_Resource)& theResource);
392
393   //! Clean up the delayed release queue.
394   Standard_EXPORT void ReleaseDelayed();
395
396   //! @return tool for management of clippings within this context.
397   inline OpenGl_Clipping& ChangeClipping() { return myClippingState; }
398
399   //! @return tool for management of clippings within this context.
400   inline const OpenGl_Clipping& Clipping() const { return myClippingState; }
401
402   //! @return tool for management of shader programs within this context.
403   inline const Handle(OpenGl_ShaderManager)& ShaderManager() const { return myShaderManager; }
404
405 public:
406
407   //! Either GL_CLAMP_TO_EDGE (1.2+) or GL_CLAMP (1.1).
408   Standard_Integer TextureWrapClamp() const { return myTexClamp; }
409
410   //! @return maximum degree of anisotropy texture filter
411   Standard_EXPORT Standard_Integer MaxDegreeOfAnisotropy() const;
412
413   //! @return value for GL_MAX_TEXTURE_SIZE
414   Standard_EXPORT Standard_Integer MaxTextureSize() const;
415
416   //! Get maximum number of clip planes supported by OpenGl.
417   //! This value is implementation dependent. At least 6
418   //! planes should be supported by OpenGl (see specs).
419   //! @return value for GL_MAX_CLIP_PLANES
420   Standard_EXPORT Standard_Integer MaxClipPlanes() const;
421
422   //! Returns true if VBO is supported and permitted.
423   inline bool ToUseVbo() const
424   {
425     return core15fwd != NULL
426        && !caps->vboDisable;
427   }
428
429   //! @return cached state of GL_NORMALIZE.
430   Standard_Boolean IsGlNormalizeEnabled() const { return myIsGlNormalizeEnabled; }
431
432   //! Sets GL_NORMALIZE enabled or disabled.
433   //! @return old value of the flag
434   Standard_EXPORT Standard_Boolean SetGlNormalizeEnabled (Standard_Boolean isEnabled);
435
436   //! Applies matrix stored in ModelWorldState to OpenGl.
437   void ApplyModelWorldMatrix();
438
439   //! Applies matrix stored in WorldViewState to OpenGl.
440   void ApplyWorldViewMatrix();
441
442   //! Applies combination of matrices stored in ModelWorldState and WorldViewState to OpenGl.
443   void ApplyModelViewMatrix();
444
445   //! Applies matrix stored in ProjectionState to OpenGl.
446   void ApplyProjectionMatrix();
447
448 public:
449
450   //! @return messenger instance
451   inline const Handle(Message_Messenger)& Messenger() const
452   {
453     return ::Message::DefaultMessenger();
454   }
455
456   //! Callback for GL_ARB_debug_output extension
457   //! @param theSource   message source   within GL_DEBUG_SOURCE_   enumeration
458   //! @param theType     message type     within GL_DEBUG_TYPE_     enumeration
459   //! @param theId       message ID       within source
460   //! @param theSeverity message severity within GL_DEBUG_SEVERITY_ enumeration
461   //! @param theMessage  the message itself
462   Standard_EXPORT void PushMessage (const unsigned int theSource,
463                                     const unsigned int theType,
464                                     const unsigned int theId,
465                                     const unsigned int theSeverity,
466                                     const TCollection_ExtendedString& theMessage);
467
468
469
470   //! @return true if OpenGl context supports left and
471   //! right rendering buffers.
472   Standard_Boolean HasStereoBuffers() const
473   {
474   #if !defined(GL_ES_VERSION_2_0)
475     return myIsStereoBuffers;
476   #else
477     return Standard_False;
478   #endif
479   }
480
481 public: //! @name methods to alter or retrieve current state
482
483   //! Switch to left stereographic rendering buffer.
484   //! This method can be used to keep unchanged choise
485   //! of front/back/both buffer rendering.
486   Standard_EXPORT void SetDrawBufferLeft();
487
488   //! Switch to right stereographic rendering buffer.
489   //! This method can be used to keep unchanged choise
490   //! of front/back/both buffer rendering.
491   Standard_EXPORT void SetDrawBufferRight();
492
493   //! Switch to non-stereographic rendering buffer.
494   //! This method can be used to keep unchanged choise
495   //! of front/back/both buffer rendering.
496   Standard_EXPORT void SetDrawBufferMono();
497
498   //! Fetch OpenGl context state. This class tracks value of several OpenGl
499   //! state variables. Consulting the cached values is quicker than
500   //! doing the same via OpenGl API. Call this method if any of the controlled
501   //! OpenGl state variables has a possibility of being out-of-date.
502   Standard_EXPORT void FetchState();
503
504   //! @return active GLSL program
505   const Handle(OpenGl_ShaderProgram)& ActiveProgram() const
506   {
507     return myActiveProgram;
508   }
509
510   //! @return OpenGL sampler object used to override default texture parameters
511   const Handle(OpenGl_Sampler)& TextureSampler()
512   {
513     return myTexSampler;
514   }
515
516   //! Bind specified program to current context,
517   //! or unbind previous one when NULL specified.
518   //! @return true if some program is bound to context
519   Standard_EXPORT Standard_Boolean BindProgram (const Handle(OpenGl_ShaderProgram)& theProgram);
520
521   //! Setup current color.
522   Standard_EXPORT void SetColor4fv (const OpenGl_Vec4& theColor);
523
524   //! Setup point size.
525   Standard_EXPORT void SetPointSize (const Standard_ShortReal theSize);
526
527   //! Bind default Vertex Array Object
528   Standard_EXPORT void BindDefaultVao();
529
530   //! Default Frame Buffer Object.
531   const Handle(OpenGl_FrameBuffer)& DefaultFrameBuffer() const
532   {
533     return myDefaultFbo;
534   }
535
536   //! Setup new Default Frame Buffer Object and return previously set.
537   //! This call doesn't change Active FBO!
538   Standard_EXPORT Handle(OpenGl_FrameBuffer) SetDefaultFrameBuffer (const Handle(OpenGl_FrameBuffer)& theFbo);
539
540   //! Return debug context initialization state.
541   Standard_Boolean IsDebugContext() const
542   {
543     return myIsGlDebugCtx;
544   }
545
546 private:
547
548   //! Wrapper to system function to retrieve GL function pointer by name.
549   Standard_EXPORT void* findProc (const char* theFuncName);
550
551   //! Print error if not all functions have been exported by context for reported version.
552   //! Note that this will never happen when using GLX, since returned functions can not be validated.
553   //! @param theGlVerMajor the OpenGL major version with missing functions
554   //! @param theGlVerMinor the OpenGL minor version with missing functions
555   Standard_EXPORT void checkWrongVersion (const Standard_Integer theGlVerMajor,
556                                           const Standard_Integer theGlVerMinor);
557
558   //! Private initialization function that should be called only once.
559   Standard_EXPORT void init (const Standard_Boolean theIsCoreProfile);
560
561 public: //! @name core profiles
562
563   OpenGl_GlCore11*     core11;     //!< OpenGL 1.1 core functionality
564   OpenGl_GlCore11Fwd*  core11fwd;  //!< OpenGL 1.1 without deprecated entry points
565   OpenGl_GlCore15*     core15;     //!< OpenGL 1.5 core functionality
566   OpenGl_GlCore15Fwd*  core15fwd;  //!< OpenGL 1.5 without deprecated entry points
567   OpenGl_GlCore20*     core20;     //!< OpenGL 2.0 core functionality (includes 1.5)
568   OpenGl_GlCore20Fwd*  core20fwd;  //!< OpenGL 2.0 without deprecated entry points
569   OpenGl_GlCore32*     core32;     //!< OpenGL 3.2 core profile
570   OpenGl_GlCore32Back* core32back; //!< OpenGL 3.2 backward compatibility profile
571   OpenGl_GlCore33*     core33;     //!< OpenGL 3.3 core profile
572   OpenGl_GlCore33Back* core33back; //!< OpenGL 3.3 backward compatibility profile
573   OpenGl_GlCore41*     core41;     //!< OpenGL 4.1 core profile
574   OpenGl_GlCore41Back* core41back; //!< OpenGL 4.1 backward compatibility profile
575   OpenGl_GlCore42*     core42;     //!< OpenGL 4.2 core profile
576   OpenGl_GlCore42Back* core42back; //!< OpenGL 4.2 backward compatibility profile
577   OpenGl_GlCore43*     core43;     //!< OpenGL 4.3 core profile
578   OpenGl_GlCore43Back* core43back; //!< OpenGL 4.3 backward compatibility profile
579   OpenGl_GlCore44*     core44;     //!< OpenGL 4.4 core profile
580   OpenGl_GlCore44Back* core44back; //!< OpenGL 4.4 backward compatibility profile
581
582   Handle(OpenGl_Caps) caps; //!< context options
583
584 public: //! @name extensions
585
586   Standard_Boolean       hasHighp;       //!< highp in GLSL ES fragment shader is supported
587   Standard_Boolean       hasTexRGBA8;    //!< always available on desktop; on OpenGL ES - since 3.0 or as extension GL_OES_rgb8_rgba8
588   Standard_Boolean       arbNPTW;        //!< GL_ARB_texture_non_power_of_two
589   Standard_Boolean       arbTexRG;       //!< GL_ARB_texture_rg
590   OpenGl_ArbTexBindless* arbTexBindless; //!< GL_ARB_bindless_texture
591   OpenGl_ArbTBO*         arbTBO;         //!< GL_ARB_texture_buffer_object
592   Standard_Boolean       arbTboRGB32;    //!< GL_ARB_texture_buffer_object_rgb32 (3-component TBO), in core since 4.0
593   OpenGl_ArbIns*         arbIns;         //!< GL_ARB_draw_instanced
594   OpenGl_ArbDbg*         arbDbg;         //!< GL_ARB_debug_output
595   OpenGl_ArbFBO*         arbFBO;         //!< GL_ARB_framebuffer_object
596   OpenGl_ArbFBOBlit*     arbFBOBlit;     //!< glBlitFramebuffer function, moved out from OpenGl_ArbFBO structure for compatibility with OpenGL ES 2.0
597   OpenGl_ExtGS*          extGS;          //!< GL_EXT_geometry_shader4
598   Standard_Boolean       extBgra;        //!< GL_EXT_bgra or GL_EXT_texture_format_BGRA8888 on OpenGL ES
599   Standard_Boolean       extAnis;        //!< GL_EXT_texture_filter_anisotropic
600   Standard_Boolean       extPDS;         //!< GL_EXT_packed_depth_stencil
601   Standard_Boolean       atiMem;         //!< GL_ATI_meminfo
602   Standard_Boolean       nvxMem;         //!< GL_NVX_gpu_memory_info
603
604 private: // system-dependent fields
605
606 #if defined(HAVE_EGL)
607   Aspect_Drawable         myWindow;   //!< EGL surface                   : EGLSurface
608   Aspect_Display          myDisplay;  //!< EGL connection to the Display : EGLDisplay
609   Aspect_RenderingContext myGContext; //!< EGL rendering context         : EGLContext
610 #elif defined(_WIN32)
611   Aspect_Handle           myWindow;   //!< window handle (owner of GL context) : HWND
612   Aspect_Handle           myWindowDC; //!< Device Descriptor handle : HDC
613   Aspect_RenderingContext myGContext; //!< Rendering Context handle : HGLRC
614 #elif defined(__APPLE__) && !defined(MACOSX_USE_GLX)
615   #if defined(TARGET_OS_IPHONE) && TARGET_OS_IPHONE
616   EAGLContext*            myGContext;    //!< Rendering Context handle
617   #else
618   NSOpenGLContext*        myGContext; //!< Rendering Context handle
619   #endif
620 #else
621   Aspect_Drawable         myWindow;   //!< window handle (owner of GL context) : GLXDrawable
622   Aspect_Display          myDisplay;  //!< connection to the X-server : Display*
623   Aspect_RenderingContext myGContext; //!< X-GLX rendering context : GLXContext
624 #endif
625
626 private: // context info
627
628   typedef NCollection_DataMap<TCollection_AsciiString, Standard_Integer> OpenGl_DelayReleaseMap;
629   typedef NCollection_Handle<OpenGl_DelayReleaseMap> Handle(OpenGl_DelayReleaseMap);
630   typedef NCollection_DataMap<TCollection_AsciiString, Handle(OpenGl_Resource)> OpenGl_ResourcesMap;
631   typedef NCollection_Handle<OpenGl_ResourcesMap> Handle(OpenGl_ResourcesMap);
632   typedef NCollection_List<Handle(OpenGl_Resource)> OpenGl_ResourcesStack;
633   typedef NCollection_Handle<OpenGl_ResourcesStack> Handle(OpenGl_ResourcesStack);
634
635   Handle(OpenGl_ResourcesMap)    mySharedResources; //!< shared resources with unique identification key
636   Handle(OpenGl_DelayReleaseMap) myDelayed;         //!< shared resources for delayed release
637   Handle(OpenGl_ResourcesStack)  myUnusedResources; //!< stack of resources for delayed clean up
638
639   OpenGl_Clipping myClippingState; //!< state of clip planes
640
641   void*            myGlLibHandle;          //!< optional handle to GL library
642   NCollection_Handle<OpenGl_GlFunctions>
643                    myFuncs;                //!< mega structure for all GL functions
644   Standard_Integer myAnisoMax;             //!< maximum level of anisotropy texture filter
645   Standard_Integer myTexClamp;             //!< either GL_CLAMP_TO_EDGE (1.2+) or GL_CLAMP (1.1)
646   Standard_Integer myMaxTexDim;            //!< value for GL_MAX_TEXTURE_SIZE
647   Standard_Integer myMaxClipPlanes;        //!< value for GL_MAX_CLIP_PLANES
648   Standard_Integer myGlVerMajor;           //!< cached GL version major number
649   Standard_Integer myGlVerMinor;           //!< cached GL version minor number
650   Standard_Boolean myIsInitialized;        //!< flag indicates initialization state
651   Standard_Boolean myIsStereoBuffers;      //!< context supports stereo buffering
652   Standard_Boolean myIsGlNormalizeEnabled; //!< GL_NORMALIZE flag
653                                            //!< Used to tell OpenGl that normals should be normalized
654
655   Handle(OpenGl_ShaderManager) myShaderManager; //! support object for managing shader programs
656
657 private: //! @name fields tracking current state
658
659   Handle(OpenGl_ShaderProgram) myActiveProgram; //!< currently active GLSL program
660   Handle(OpenGl_Sampler)       myTexSampler;    //!< currently active sampler object
661   Handle(OpenGl_FrameBuffer)   myDefaultFbo;    //!< default Frame Buffer Object
662   Standard_Integer             myRenderMode;    //!< value for active rendering mode
663   Standard_Integer             myDrawBuffer;    //!< current draw buffer
664   unsigned int                 myDefaultVao;    //!< default Vertex Array Object
665   Standard_Boolean             myIsGlDebugCtx;  //!< debug context initialization state
666
667 public:
668
669   OpenGl_Utils::MatrixState<Standard_ShortReal> ModelWorldState; //!< state of orientation matrix
670   OpenGl_Utils::MatrixState<Standard_ShortReal> WorldViewState;  //!< state of orientation matrix
671   OpenGl_Utils::MatrixState<Standard_ShortReal> ProjectionState; //!< state of projection  matrix
672
673 private:
674
675   //! Copying allowed only within Handles
676   OpenGl_Context            (const OpenGl_Context& );
677   OpenGl_Context& operator= (const OpenGl_Context& );
678
679 public:
680
681   DEFINE_STANDARD_RTTI(OpenGl_Context) // Type definition
682
683   friend class OpenGl_Window;
684
685 };
686
687 #endif // _OpenGl_Context_H__