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