0028738: Data Exchange, XCAFPrs_Style - add transparency property
[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 <NCollection_Map.hxx>
28 #include <NCollection_Handle.hxx>
29 #include <NCollection_List.hxx>
30 #include <NCollection_SparseArray.hxx>
31 #include <Message.hxx>
32 #include <OpenGl_Caps.hxx>
33 #include <OpenGl_LineAttributes.hxx>
34 #include <OpenGl_Material.hxx>
35 #include <OpenGl_MatrixState.hxx>
36 #include <OpenGl_Vec.hxx>
37 #include <OpenGl_Resource.hxx>
38 #include <Standard_Transient.hxx>
39 #include <TColStd_IndexedDataMapOfStringString.hxx>
40 #include <TColStd_PackedMapOfInteger.hxx>
41 #include <OpenGl_Clipping.hxx>
42 #include <OpenGl_GlCore11.hxx>
43 #include <OpenGl_ShaderProgram.hxx>
44
45 #include <NCollection_Shared.hxx>
46
47 //! Forward declarations
48 #if defined(__APPLE__)
49   #import <TargetConditionals.h>
50   #if defined(TARGET_OS_IPHONE) && TARGET_OS_IPHONE
51     #ifdef __OBJC__
52       @class EAGLContext;
53     #else
54       struct EAGLContext;
55     #endif
56   #else
57     #ifdef __OBJC__
58       @class NSOpenGLContext;
59     #else
60       struct NSOpenGLContext;
61     #endif
62   #endif
63 #endif
64
65 struct OpenGl_GlFunctions;
66 struct OpenGl_ArbTBO;
67 struct OpenGl_ArbIns;
68 struct OpenGl_ArbDbg;
69 struct OpenGl_ArbFBO;
70 struct OpenGl_ArbFBOBlit;
71 struct OpenGl_ExtGS;
72 struct OpenGl_ArbTexBindless;
73
74 template<typename theBaseClass_t> struct OpenGl_TmplCore12;
75 typedef OpenGl_TmplCore12<OpenGl_GlCore11>     OpenGl_GlCore12;
76 typedef OpenGl_TmplCore12<OpenGl_GlCore11Fwd>  OpenGl_GlCore12Fwd;
77
78 struct OpenGl_GlCore13;
79 struct OpenGl_GlCore13Fwd;
80
81 template<typename theBaseClass_t> struct OpenGl_TmplCore14;
82 typedef OpenGl_TmplCore14<OpenGl_GlCore13>     OpenGl_GlCore14;
83 typedef OpenGl_TmplCore14<OpenGl_GlCore13Fwd>  OpenGl_GlCore14Fwd;
84
85 template<typename theBaseClass_t> struct OpenGl_TmplCore15;
86 typedef OpenGl_TmplCore15<OpenGl_GlCore14>     OpenGl_GlCore15;
87 typedef OpenGl_TmplCore15<OpenGl_GlCore14Fwd>  OpenGl_GlCore15Fwd;
88
89 template<typename theBaseClass_t> struct OpenGl_TmplCore20;
90 typedef OpenGl_TmplCore20<OpenGl_GlCore15>     OpenGl_GlCore20;
91 typedef OpenGl_TmplCore20<OpenGl_GlCore15Fwd>  OpenGl_GlCore20Fwd;
92
93 template<typename theBaseClass_t> struct OpenGl_TmplCore21;
94 typedef OpenGl_TmplCore21<OpenGl_GlCore20>     OpenGl_GlCore21;
95 typedef OpenGl_TmplCore21<OpenGl_GlCore20Fwd>  OpenGl_GlCore21Fwd;
96
97 template<typename theBaseClass_t> struct OpenGl_TmplCore30;
98 typedef OpenGl_TmplCore30<OpenGl_GlCore21>     OpenGl_GlCore30;
99 typedef OpenGl_TmplCore30<OpenGl_GlCore21Fwd>  OpenGl_GlCore30Fwd;
100
101 template<typename theBaseClass_t> struct OpenGl_TmplCore31;
102 typedef OpenGl_TmplCore31<OpenGl_GlCore30>     OpenGl_GlCore31Back;
103 typedef OpenGl_TmplCore31<OpenGl_GlCore30Fwd>  OpenGl_GlCore31;
104
105 template<typename theBaseClass_t> struct OpenGl_TmplCore32;
106 typedef OpenGl_TmplCore32<OpenGl_GlCore31Back> OpenGl_GlCore32Back;
107 typedef OpenGl_TmplCore32<OpenGl_GlCore31>     OpenGl_GlCore32;
108
109 template<typename theBaseClass_t> struct OpenGl_TmplCore33;
110 typedef OpenGl_TmplCore33<OpenGl_GlCore32Back> OpenGl_GlCore33Back;
111 typedef OpenGl_TmplCore33<OpenGl_GlCore32>     OpenGl_GlCore33;
112
113 template<typename theBaseClass_t> struct OpenGl_TmplCore40;
114 typedef OpenGl_TmplCore40<OpenGl_GlCore33Back> OpenGl_GlCore40Back;
115 typedef OpenGl_TmplCore40<OpenGl_GlCore33>     OpenGl_GlCore40;
116
117 template<typename theBaseClass_t> struct OpenGl_TmplCore41;
118 typedef OpenGl_TmplCore41<OpenGl_GlCore40Back> OpenGl_GlCore41Back;
119 typedef OpenGl_TmplCore41<OpenGl_GlCore40>     OpenGl_GlCore41;
120
121 template<typename theBaseClass_t> struct OpenGl_TmplCore42;
122 typedef OpenGl_TmplCore42<OpenGl_GlCore41Back> OpenGl_GlCore42Back;
123 typedef OpenGl_TmplCore42<OpenGl_GlCore41>     OpenGl_GlCore42;
124
125 template<typename theBaseClass_t> struct OpenGl_TmplCore43;
126 typedef OpenGl_TmplCore43<OpenGl_GlCore42Back> OpenGl_GlCore43Back;
127 typedef OpenGl_TmplCore43<OpenGl_GlCore42>     OpenGl_GlCore43;
128
129 template<typename theBaseClass_t> struct OpenGl_TmplCore44;
130 typedef OpenGl_TmplCore44<OpenGl_GlCore43Back> OpenGl_GlCore44Back;
131 typedef OpenGl_TmplCore44<OpenGl_GlCore43>     OpenGl_GlCore44;
132
133 class OpenGl_ShaderManager;
134 class OpenGl_Sampler;
135 class OpenGl_FrameBuffer;
136 class OpenGl_AspectFace;
137 class Graphic3d_PresentationAttributes;
138
139 enum OpenGl_FeatureFlag
140 {
141   OpenGl_FeatureNotAvailable = 0, //!< Feature is not supported by OpenGl implementation.
142   OpenGl_FeatureInExtensions = 1, //!< Feature is supported as extension.
143   OpenGl_FeatureInCore       = 2  //!< Feature is supported as part of core profile.
144 };
145
146 DEFINE_STANDARD_HANDLE(OpenGl_Context, Standard_Transient)
147
148 //! This class generalize access to the GL context and available extensions.
149 //!
150 //! Functions related to specific OpenGL version or extension are grouped into structures which can be accessed as fields of this class.
151 //! The most simple way to check that required functionality is available - is NULL check for the group:
152 //! @code
153 //!   if (myContext->core20 != NULL)
154 //!   {
155 //!     myGlProgram = myContext->core20->glCreateProgram();
156 //!     .. do more stuff ..
157 //!   }
158 //!   else
159 //!   {
160 //!     .. compatibility with outdated configurations ..
161 //!   }
162 //! @endcode
163 //!
164 //! Current implementation provide access to OpenGL core functionality up to 4.4 version (core12, core13, core14, core15, fields core20)
165 //! as well as several extensions (arbTBO, arbFBO, etc.).
166 //!
167 //! OpenGL context might be initialized in Core Profile. In this case deprecated functionality become unavailable.
168 //! To make code easily adaptable to wide range of OpenGL versions, function sets related to each version has two kinds of suffixes:
169 //!  - "back" for version 3.2+.
170 //!     Represents function set for Backward-Compatible Profile.
171 //!     Function sets without this suffix represents core profile.
172 //!  - "fwd"  for version 3.0-.
173 //!     Represents non-deprecated function set of earlier OpenGL versions, which are still available within OpenGL 3.2 Core Profile.
174 //!     Function sets without this suffix represents complete list of functions related to specific OpenGL version.
175 //!
176 //! To select which core** function set should be used in specific case:
177 //!  - Determine the minimal OpenGL version required for implemented functionality and use it to access all functions.
178 //!    For example, if algorithm requires OpenGL 2.1+, it is better to write core20fwd->glEnable() rather than core11fwd->glEnable() for uniformity.
179 //!  - If functionality will work within Core Profile, use function sets with appropriate suffix.
180 //!  - Validate minimal requirements at initialization/creation time and omit checks within code where algorithm should be already initialized.
181 //!    Properly escape code incompatible with Core Profile. The simplest way to check Core Profile is "if (core11 == NULL)".
182 //!
183 //! Simplified extensions classification:
184 //!  - prefixed with NV, AMD, ATI are vendor-specific (however may be provided by other vendors in some cases);
185 //!  - prefixed with EXT are accepted by 2+ vendors;
186 //!  - prefixed with ARB are accepted by Architecture Review Board and are candidates
187 //!    for inclusion into GL core functionality.
188 //! Some functionality can be represented in several extensions simultaneously.
189 //! In this case developer should be careful because different specification may differ
190 //! in aspects (like enumeration values and error-handling).
191 //!
192 //! Notice that some systems provide mechanisms to simultaneously incorporate with GL contexts with different capabilities.
193 //! For this reason OpenGl_Context should be initialized and used for each GL context independently.
194 class OpenGl_Context : public Standard_Transient
195 {
196   DEFINE_STANDARD_RTTIEXT(OpenGl_Context, Standard_Transient)
197   friend class OpenGl_Window;
198 public:
199
200   //! Function for getting power of to number larger or equal to input number.
201   //! @param theNumber    number to 'power of two'
202   //! @param theThreshold upper threshold
203   //! @return power of two number
204   inline static Standard_Integer GetPowerOfTwo (const Standard_Integer theNumber,
205                                                 const Standard_Integer theThreshold)
206   {
207     for (Standard_Integer p2 = 2; p2 <= theThreshold; p2 <<= 1)
208     {
209       if (theNumber <= p2)
210       {
211         return p2;
212       }
213     }
214     return theThreshold;
215   }
216
217 public:
218
219   //! Empty constructor. You should call Init() to perform initialization with bound GL context.
220   Standard_EXPORT OpenGl_Context (const Handle(OpenGl_Caps)& theCaps = NULL);
221
222   //! Destructor.
223   Standard_EXPORT virtual ~OpenGl_Context();
224
225   //! Release all resources, including shared ones
226   Standard_EXPORT void forcedRelease();
227
228   //! Share GL context resources.
229   //! theShareCtx - handle to context to retrieve handles to shared resources.
230   Standard_EXPORT void Share (const Handle(OpenGl_Context)& theShareCtx);
231
232   //! Initialize class from currently bound OpenGL context. Method should be called only once.
233   //! @return false if no GL context is bound to the current thread
234   Standard_EXPORT Standard_Boolean Init (const Standard_Boolean theIsCoreProfile = Standard_False);
235
236   //! @return true if this context is valid (has been initialized)
237   inline Standard_Boolean IsValid() const
238   {
239     return myIsInitialized;
240   }
241
242 #if defined(HAVE_EGL)
243   //! Initialize class from specified surface and rendering context. Method should be called only once.
244   //! @return false if OpenGL context can not be bound to specified surface
245   Standard_EXPORT Standard_Boolean Init (const Aspect_Drawable         theEglSurface,
246                                          const Aspect_Display          theEglDisplay,
247                                          const Aspect_RenderingContext theEglContext,
248                                          const Standard_Boolean        theIsCoreProfile = Standard_False);
249 #elif defined(_WIN32)
250   //! Initialize class from specified window and rendering context. Method should be called only once.
251   //! @return false if OpenGL context can not be bound to specified window
252   Standard_EXPORT Standard_Boolean Init (const Aspect_Handle           theWindow,
253                                          const Aspect_Handle           theWindowDC,
254                                          const Aspect_RenderingContext theGContext,
255                                          const Standard_Boolean        theIsCoreProfile = Standard_False);
256
257   //! @return the window handle (HWND) currently bound to this OpenGL context
258   inline Aspect_Handle Window() const
259   {
260     return myWindow;
261   }
262
263 #elif defined(__APPLE__) && !defined(MACOSX_USE_GLX)
264   #if defined(TARGET_OS_IPHONE) && TARGET_OS_IPHONE
265
266   //! Initialize class from specified OpenGL ES context (EAGLContext). Method should be called only once.
267   Standard_EXPORT Standard_Boolean Init (EAGLContext*                  theGContext,
268                                          const Standard_Boolean        theIsCoreProfile = Standard_False);
269   #else
270
271   //! Initialize class from specified OpenGL context (NSOpenGLContext). Method should be called only once.
272   Standard_EXPORT Standard_Boolean Init (NSOpenGLContext*              theGContext,
273                                          const Standard_Boolean        theIsCoreProfile = Standard_False);
274   #endif
275 #else
276
277   //! Initialize class from specified window and rendering context. Method should be called only once.
278   //! @return false if OpenGL context can not be bound to specified window
279   Standard_EXPORT Standard_Boolean Init (const Aspect_Drawable         theWindow,
280                                          const Aspect_Display          theDisplay,
281                                          const Aspect_RenderingContext theGContext,
282                                          const Standard_Boolean        theIsCoreProfile = Standard_False);
283
284   //! @return the window handle (GLXDrawable) currently bound to this OpenGL context
285   inline Aspect_Drawable Window() const
286   {
287     return myWindow;
288   }
289 #endif
290
291   //! Read OpenGL version information from active context.
292   Standard_EXPORT static void ReadGlVersion (Standard_Integer& theGlVerMajor,
293                                              Standard_Integer& theGlVerMinor);
294
295   //! Check if theExtName extension is supported by active GL context.
296   Standard_EXPORT Standard_Boolean CheckExtension (const char* theExtName) const;
297
298   //! Check if theExtName extension is in extensions string.
299   Standard_EXPORT static Standard_Boolean CheckExtension (const char* theExtString,
300                                                           const char* theExtName);
301
302   //! Auxiliary template to retrieve GL function pointer.
303   //! Pointer to function retrieved from library is statically casted
304   //! to requested type - there no way to check real signature of exported function.
305   //! The context should be bound before call.
306   template <typename FuncType_t>
307   Standard_Boolean FindProc (const char* theFuncName,
308                              FuncType_t& theFuncPtr)
309   {
310     theFuncPtr = (FuncType_t )findProc (theFuncName);
311     return (theFuncPtr != NULL);
312   }
313
314   //! @return true if detected GL version is greater or equal to requested one.
315   inline Standard_Boolean IsGlGreaterEqual (const Standard_Integer theVerMajor,
316                                             const Standard_Integer theVerMinor) const
317   {
318     return (myGlVerMajor >  theVerMajor)
319         || (myGlVerMajor == theVerMajor && myGlVerMinor >= theVerMinor);
320   }
321
322   //! Return cached GL version major number.
323   Standard_Integer VersionMajor() const { return myGlVerMajor; }
324
325   //! Return cached GL version minor number.
326   Standard_Integer VersionMinor() const { return myGlVerMinor; }
327
328   //! Access entire map of loaded OpenGL functions.
329   const OpenGl_GlFunctions* Functions() const { return myFuncs.operator->(); }
330
331   //! Clean up errors stack for this GL context (glGetError() in loop).
332   //! @return true if some error has been cleared
333   Standard_EXPORT bool ResetErrors (const bool theToPrintErrors = false);
334
335   //! This method uses system-dependent API to retrieve information
336   //! about GL context bound to the current thread.
337   //! @return true if current thread is bound to this GL context
338   Standard_EXPORT Standard_Boolean IsCurrent() const;
339
340   //! Activates current context.
341   //! Class should be initialized with appropriate info.
342   Standard_EXPORT Standard_Boolean MakeCurrent();
343
344   //! Swap front/back buffers for this GL context (should be activated before!).
345   Standard_EXPORT void SwapBuffers();
346
347   //! Setup swap interval (VSync).
348   Standard_EXPORT Standard_Boolean SetSwapInterval (const Standard_Integer theInterval);
349
350   //! Return true if active mode is GL_RENDER (cached state)
351   Standard_Boolean IsRender() const
352   {
353   #if !defined(GL_ES_VERSION_2_0)
354     return myRenderMode == GL_RENDER;
355   #else
356     return Standard_True;
357   #endif
358   }
359
360   //! Return true if active mode is GL_FEEDBACK (cached state)
361   Standard_Boolean IsFeedback() const
362   {
363   #if !defined(GL_ES_VERSION_2_0)
364     return myRenderMode == GL_FEEDBACK;
365   #else
366     return Standard_False;
367   #endif
368   }
369
370   //! This function retrieves information from GL about free GPU memory that is:
371   //!  - OS-dependent. On some OS it is per-process and on others - for entire system.
372   //!  - Vendor-dependent. Currently available only on NVIDIA and AMD/ATi drivers only.
373   //!  - Numbers meaning may vary.
374   //! You should use this info only for diagnostics purposes.
375   //! @return free GPU dedicated memory in bytes.
376   Standard_EXPORT Standard_Size AvailableMemory() const;
377
378   //! This function retrieves information from GL about GPU memory
379   //! and contains more vendor-specific values than AvailableMemory().
380   Standard_EXPORT TCollection_AsciiString MemoryInfo() const;
381
382   //! This function retrieves information from GL about GPU memory.
383   Standard_EXPORT void MemoryInfo (TColStd_IndexedDataMapOfStringString& theDict) const;
384
385   //! Fill in the dictionary with OpenGL info.
386   //! Should be called with bound context.
387   Standard_EXPORT void DiagnosticInformation (TColStd_IndexedDataMapOfStringString& theDict,
388                                               Graphic3d_DiagnosticInfo theFlags) const;
389
390   //! Access shared resource by its name.
391   //! @param  theKey - unique identifier;
392   //! @return handle to shared resource or NULL.
393   Standard_EXPORT const Handle(OpenGl_Resource)& GetResource (const TCollection_AsciiString& theKey) const;
394
395   //! Access shared resource by its name.
396   //! @param  theKey   - unique identifier;
397   //! @param  theValue - handle to fill;
398   //! @return true if resource was shared.
399   template<typename TheHandleType>
400   Standard_Boolean GetResource (const TCollection_AsciiString& theKey,
401                                 TheHandleType&                 theValue) const
402   {
403     const Handle(OpenGl_Resource)& aResource = GetResource (theKey);
404     if (aResource.IsNull())
405     {
406       return Standard_False;
407     }
408
409     theValue = TheHandleType::DownCast (aResource);
410     return !theValue.IsNull();
411   }
412
413   //! Register shared resource.
414   //! Notice that after registration caller shouldn't release it by himself -
415   //! it will be automatically released on context destruction.
416   //! @param theKey      - unique identifier, shouldn't be empty;
417   //! @param theResource - new resource to register, shouldn't be NULL.
418   Standard_EXPORT Standard_Boolean ShareResource (const TCollection_AsciiString& theKey,
419                                                   const Handle(OpenGl_Resource)& theResource);
420
421   //! Release shared resource.
422   //! If there are more than one reference to this resource
423   //! (also used by some other existing object) then call will be ignored.
424   //! This means that current object itself should nullify handle before this call.
425   //! Notice that this is unrecommended operation at all and should be used
426   //! only in case of fat resources to release memory for other needs.
427   //! @param theKey     unique identifier
428   //! @param theToDelay postpone release until next redraw call
429   Standard_EXPORT void ReleaseResource (const TCollection_AsciiString& theKey,
430                                         const Standard_Boolean         theToDelay = Standard_False);
431
432   //! Append resource to queue for delayed clean up.
433   //! Resources in this queue will be released at next redraw call.
434   template <class T>
435   void DelayedRelease (Handle(T)& theResource)
436   {
437     myUnusedResources->Prepend (theResource);
438     theResource.Nullify();
439   }
440
441   //! Clean up the delayed release queue.
442   Standard_EXPORT void ReleaseDelayed();
443
444   //! @return tool for management of clippings within this context.
445   inline OpenGl_Clipping& ChangeClipping() { return myClippingState; }
446
447   //! @return tool for management of clippings within this context.
448   inline const OpenGl_Clipping& Clipping() const { return myClippingState; }
449
450   //! @return tool for management of shader programs within this context.
451   inline const Handle(OpenGl_ShaderManager)& ShaderManager() const { return myShaderManager; }
452
453 public:
454
455   //! Either GL_CLAMP_TO_EDGE (1.2+) or GL_CLAMP (1.1).
456   Standard_Integer TextureWrapClamp() const { return myTexClamp; }
457
458   //! @return maximum degree of anisotropy texture filter
459   Standard_Integer MaxDegreeOfAnisotropy() const { return myAnisoMax; }
460
461   //! @return value for GL_MAX_TEXTURE_SIZE
462   Standard_Integer MaxTextureSize() const { return myMaxTexDim; }
463
464   //! @return value for GL_MAX_SAMPLES
465   Standard_Integer MaxMsaaSamples() const { return myMaxMsaaSamples; }
466
467   //! @return value for GL_MAX_DRAW_BUFFERS
468   Standard_Integer MaxDrawBuffers() const { return myMaxDrawBuffers; }
469
470   //! @return value for GL_MAX_COLOR_ATTACHMENTS
471   Standard_Integer MaxColorAttachments() const { return myMaxColorAttachments; }
472
473   //! Get maximum number of clip planes supported by OpenGl.
474   //! This value is implementation dependent. At least 6
475   //! planes should be supported by OpenGl (see specs).
476   //! @return value for GL_MAX_CLIP_PLANES
477   Standard_Integer MaxClipPlanes() const { return myMaxClipPlanes; }
478
479   //! @return TRUE if ray tracing mode is supported
480   Standard_Boolean HasRayTracing() const { return myHasRayTracing; }
481
482   //! @return TRUE if textures in ray tracing mode are supported
483   Standard_Boolean HasRayTracingTextures() const { return myHasRayTracingTextures; }
484
485   //! @return TRUE if adaptive screen sampling in ray tracing mode is supported
486   Standard_Boolean HasRayTracingAdaptiveSampling() const { return myHasRayTracingAdaptiveSampling; }
487
488   //! Returns true if VBO is supported and permitted.
489   inline bool ToUseVbo() const
490   {
491     return core15fwd != NULL
492        && !caps->vboDisable;
493   }
494
495   //! @return cached state of GL_NORMALIZE.
496   Standard_Boolean IsGlNormalizeEnabled() const { return myIsGlNormalizeEnabled; }
497
498   //! Sets GL_NORMALIZE enabled or disabled.
499   //! @return old value of the flag
500   Standard_EXPORT Standard_Boolean SetGlNormalizeEnabled (Standard_Boolean isEnabled);
501
502   //! @return cached state of polygon rasterization mode (glPolygonMode()).
503   Standard_Integer PolygonMode() const { return myPolygonMode; }
504
505   //! Sets polygon rasterization mode (glPolygonMode() function).
506   //! @return old value of the rasterization mode.
507   Standard_EXPORT Standard_Integer SetPolygonMode (const Standard_Integer theMode);
508
509   //! @return cached enabled state of polygon hatching rasterization.
510   bool IsPolygonHatchEnabled() const
511   {
512     return !myHatchStyles.IsNull() && myHatchStyles->TypeOfHatch() != 0;
513   }
514
515   //! Sets enabled state of polygon hatching rasterization
516   //! without affecting currently selected hatching pattern.
517   //! @return previous state of polygon hatching mode.
518   Standard_EXPORT bool SetPolygonHatchEnabled (const bool theIsEnabled);
519
520   //! @return cached state of polygon hatch type.
521   Standard_Integer PolygonHatchStyle() const
522   {
523     return myHatchStyles.IsNull() ? Aspect_HS_SOLID : myHatchStyles->TypeOfHatch();
524   }
525
526   //! Sets polygon hatch pattern.
527   //! Zero-index value is a default alias for solid filling.
528   //! @param the type of hatch supported by base implementation of
529   //! OpenGl_LineAttributes (Aspect_HatchStyle) or the type supported by custom
530   //! implementation derived from OpenGl_LineAttributes class.
531   //! @return old type of hatch.
532   Standard_EXPORT Standard_Integer SetPolygonHatchStyle (const Handle(Graphic3d_HatchStyle)& theStyle);
533
534   //! Applies matrix stored in ModelWorldState to OpenGl.
535   Standard_EXPORT void ApplyModelWorldMatrix();
536
537   //! Applies matrix stored in WorldViewState to OpenGl.
538   Standard_EXPORT void ApplyWorldViewMatrix();
539
540   //! Applies combination of matrices stored in ModelWorldState and WorldViewState to OpenGl.
541   Standard_EXPORT void ApplyModelViewMatrix();
542
543   //! Applies matrix stored in ProjectionState to OpenGl.
544   Standard_EXPORT void ApplyProjectionMatrix();
545
546 public:
547
548   //! @return messenger instance
549   inline const Handle(Message_Messenger)& Messenger() const
550   {
551     return ::Message::DefaultMessenger();
552   }
553
554   //! Callback for GL_ARB_debug_output extension
555   //! @param theSource   message source   within GL_DEBUG_SOURCE_   enumeration
556   //! @param theType     message type     within GL_DEBUG_TYPE_     enumeration
557   //! @param theId       message ID       within source
558   //! @param theSeverity message severity within GL_DEBUG_SEVERITY_ enumeration
559   //! @param theMessage  the message itself
560   Standard_EXPORT void PushMessage (const unsigned int theSource,
561                                     const unsigned int theType,
562                                     const unsigned int theId,
563                                     const unsigned int theSeverity,
564                                     const TCollection_ExtendedString& theMessage);
565
566   //! Adds a filter for messages with theId and theSource (GL_DEBUG_SOURCE_)
567   Standard_EXPORT Standard_Boolean ExcludeMessage (const unsigned int theSource,
568                                                    const unsigned int theId);
569
570   //! Removes a filter for messages with theId and theSource (GL_DEBUG_SOURCE_)
571   Standard_EXPORT Standard_Boolean IncludeMessage (const unsigned int theSource,
572                                                    const unsigned int theId);
573
574   //! @return true if OpenGl context supports left and
575   //! right rendering buffers.
576   Standard_Boolean HasStereoBuffers() const
577   {
578   #if !defined(GL_ES_VERSION_2_0)
579     return myIsStereoBuffers;
580   #else
581     return Standard_False;
582   #endif
583   }
584
585 public: //! @name methods to alter or retrieve current state
586
587   //! Return cached viewport definition (x, y, width, height).
588   const Standard_Integer* Viewport() const { return myViewport; }
589
590   //! Resize the viewport (alias for glViewport).
591   //! @param theRect viewport definition (x, y, width, height)
592   Standard_EXPORT void ResizeViewport (const Standard_Integer theRect[4]);
593
594   //! Return virtual viewport definition (x, y, width, height).
595   const Standard_Integer* VirtualViewport() const { return myViewportVirt; }
596
597   //! Return active read buffer.
598   Standard_Integer ReadBuffer() { return myReadBuffer; }
599
600   //! Switch read buffer, wrapper for ::glReadBuffer().
601   Standard_EXPORT void SetReadBuffer (const Standard_Integer theReadBuffer);
602
603   //! Return active draw buffer attached to a render target referred by index (layout location).
604   Standard_Integer DrawBuffer (const Standard_Integer theIndex = 0)
605   {
606     return myDrawBuffers.IsBound (theIndex) ? myDrawBuffers.Value (theIndex) : GL_NONE;
607   }
608
609   //! Switch draw buffer, wrapper for ::glDrawBuffer().
610   Standard_EXPORT void SetDrawBuffer (const Standard_Integer theDrawBuffer);
611
612   //! Switch draw buffer, wrapper for ::glDrawBuffers (GLsizei, const GLenum*).
613   Standard_EXPORT void SetDrawBuffers (const Standard_Integer theNb, const Standard_Integer* theDrawBuffers);
614
615   //! Switch read/draw buffers.
616   void SetReadDrawBuffer (const Standard_Integer theBuffer)
617   {
618     SetReadBuffer (theBuffer);
619     SetDrawBuffer (theBuffer);
620   }
621
622   //! Return back face culling state.
623   bool ToCullBackFaces() const { return myToCullBackFaces; }
624
625   //! Enable or disable back face culling (glEnable (GL_CULL_FACE)).
626   Standard_EXPORT void SetCullBackFaces (bool theToEnable);
627
628   //! Fetch OpenGl context state. This class tracks value of several OpenGl
629   //! state variables. Consulting the cached values is quicker than
630   //! doing the same via OpenGl API. Call this method if any of the controlled
631   //! OpenGl state variables has a possibility of being out-of-date.
632   Standard_EXPORT void FetchState();
633
634   //! @return active GLSL program
635   const Handle(OpenGl_ShaderProgram)& ActiveProgram() const
636   {
637     return myActiveProgram;
638   }
639
640   //! @return OpenGL sampler object used to override default texture parameters
641   const Handle(OpenGl_Sampler)& TextureSampler()
642   {
643     return myTexSampler;
644   }
645
646   //! Bind specified program to current context,
647   //! or unbind previous one when NULL specified.
648   //! @return true if some program is bound to context
649   Standard_EXPORT Standard_Boolean BindProgram (const Handle(OpenGl_ShaderProgram)& theProgram);
650
651   //! Setup current shading material.
652   Standard_EXPORT void SetShadingMaterial (const OpenGl_AspectFace* theAspect,
653                                            const Handle(Graphic3d_PresentationAttributes)& theHighlight);
654
655   //! Checks if transparency is required for the given aspect and highlight style.
656   Standard_EXPORT static Standard_Boolean CheckIsTransparent (const OpenGl_AspectFace* theAspect,
657                                                               const Handle(Graphic3d_PresentationAttributes)& theHighlight,
658                                                               Standard_ShortReal& theAlphaFront,
659                                                               Standard_ShortReal& theAlphaBack);
660
661   //! Checks if transparency is required for the given aspect and highlight style.
662   static Standard_Boolean CheckIsTransparent (const OpenGl_AspectFace* theAspect,
663                                               const Handle(Graphic3d_PresentationAttributes)& theHighlight)
664   {
665     Standard_ShortReal anAlphaFront = 1.0f, anAlphaBack = 1.0f;
666     return CheckIsTransparent (theAspect, theHighlight, anAlphaFront, anAlphaBack);
667   }
668
669   //! Setup current color.
670   Standard_EXPORT void SetColor4fv (const OpenGl_Vec4& theColor);
671
672   //! Setup type of line.
673   Standard_EXPORT void SetTypeOfLine (const Aspect_TypeOfLine  theType,
674                                       const Standard_ShortReal theFactor = 1.0f);
675
676   //! Setup width of line.
677   Standard_EXPORT void SetLineWidth (const Standard_ShortReal theWidth);
678
679   //! Setup point size.
680   Standard_EXPORT void SetPointSize (const Standard_ShortReal theSize);
681
682   //! Setup point sprite origin using GL_POINT_SPRITE_COORD_ORIGIN state:
683   //! - GL_UPPER_LEFT when GLSL program is active;
684   //!   flipping should be handled in GLSL program for compatibility with OpenGL ES
685   //! - GL_LOWER_LEFT for FFP
686   Standard_EXPORT void SetPointSpriteOrigin();
687
688   //! Setup texture matrix to active GLSL program or to FFP global state using glMatrixMode (GL_TEXTURE).
689   Standard_EXPORT void SetTextureMatrix (const Handle(Graphic3d_TextureParams)& theParams);
690
691   //! Bind default Vertex Array Object
692   Standard_EXPORT void BindDefaultVao();
693
694   //! Default Frame Buffer Object.
695   const Handle(OpenGl_FrameBuffer)& DefaultFrameBuffer() const
696   {
697     return myDefaultFbo;
698   }
699
700   //! Setup new Default Frame Buffer Object and return previously set.
701   //! This call doesn't change Active FBO!
702   Standard_EXPORT Handle(OpenGl_FrameBuffer) SetDefaultFrameBuffer (const Handle(OpenGl_FrameBuffer)& theFbo);
703
704   //! Return debug context initialization state.
705   Standard_Boolean IsDebugContext() const
706   {
707     return myIsGlDebugCtx;
708   }
709
710   Standard_EXPORT void EnableFeatures() const;
711
712   Standard_EXPORT void DisableFeatures() const;
713
714   //! Return resolution for rendering text.
715   unsigned int Resolution() const { return myResolution; }
716
717   //! Resolution scale factor (rendered resolution to standard resolution).
718   //! This scaling factor for parameters like text size to be properly displayed on device (screen / printer).
719   Standard_ShortReal ResolutionRatio() const { return myResolutionRatio; }
720
721   //! Rendering scale factor (rendering viewport height to real window buffer height).
722   Standard_ShortReal RenderScale() const { return myRenderScale; }
723
724   //! Return TRUE if rendering scale factor is not 1.
725   Standard_Boolean HasRenderScale() const { return Abs (myRenderScale - 1.0f) > 0.0001f; }
726
727   //! Rendering scale factor (inverted value).
728   Standard_ShortReal RenderScaleInv() const { return myRenderScaleInv; }
729
730   //! Set resolution ratio.
731   //! Note that this method rounds @theRatio to nearest integer.
732   void SetResolution (unsigned int theResolution,
733                       Standard_ShortReal theRatio,
734                       Standard_ShortReal theScale)
735   {
736     myResolution      = (unsigned int )(theScale * theResolution + 0.5f);
737     myRenderScale     = theScale;
738     myRenderScaleInv  = 1.0f / theScale;
739     SetResolutionRatio (theRatio * theScale);
740   }
741
742   //! Set resolution ratio.
743   //! Note that this method rounds @theRatio to nearest integer.
744   void SetResolutionRatio (const Standard_ShortReal theRatio)
745   {
746     myResolutionRatio = theRatio;
747     myLineWidthScale  = Max (1.0f, std::floor (theRatio + 0.5f));
748   }
749
750 private:
751
752   //! Wrapper to system function to retrieve GL function pointer by name.
753   Standard_EXPORT void* findProc (const char* theFuncName);
754
755   //! Print error if not all functions have been exported by context for reported version.
756   //! Note that this will never happen when using GLX, since returned functions can not be validated.
757   //! @param theGlVerMajor the OpenGL major version with missing functions
758   //! @param theGlVerMinor the OpenGL minor version with missing functions
759   Standard_EXPORT void checkWrongVersion (const Standard_Integer theGlVerMajor,
760                                           const Standard_Integer theGlVerMinor);
761
762   //! Private initialization function that should be called only once.
763   Standard_EXPORT void init (const Standard_Boolean theIsCoreProfile);
764
765 public: //! @name core profiles
766
767   OpenGl_GlCore11*     core11;     //!< OpenGL 1.1 core functionality
768   OpenGl_GlCore11Fwd*  core11fwd;  //!< OpenGL 1.1 without deprecated entry points
769   OpenGl_GlCore15*     core15;     //!< OpenGL 1.5 core functionality
770   OpenGl_GlCore15Fwd*  core15fwd;  //!< OpenGL 1.5 without deprecated entry points
771   OpenGl_GlCore20*     core20;     //!< OpenGL 2.0 core functionality (includes 1.5)
772   OpenGl_GlCore20Fwd*  core20fwd;  //!< OpenGL 2.0 without deprecated entry points
773   OpenGl_GlCore32*     core32;     //!< OpenGL 3.2 core profile
774   OpenGl_GlCore32Back* core32back; //!< OpenGL 3.2 backward compatibility profile
775   OpenGl_GlCore33*     core33;     //!< OpenGL 3.3 core profile
776   OpenGl_GlCore33Back* core33back; //!< OpenGL 3.3 backward compatibility profile
777   OpenGl_GlCore41*     core41;     //!< OpenGL 4.1 core profile
778   OpenGl_GlCore41Back* core41back; //!< OpenGL 4.1 backward compatibility profile
779   OpenGl_GlCore42*     core42;     //!< OpenGL 4.2 core profile
780   OpenGl_GlCore42Back* core42back; //!< OpenGL 4.2 backward compatibility profile
781   OpenGl_GlCore43*     core43;     //!< OpenGL 4.3 core profile
782   OpenGl_GlCore43Back* core43back; //!< OpenGL 4.3 backward compatibility profile
783   OpenGl_GlCore44*     core44;     //!< OpenGL 4.4 core profile
784   OpenGl_GlCore44Back* core44back; //!< OpenGL 4.4 backward compatibility profile
785
786   Handle(OpenGl_Caps) caps; //!< context options
787
788 public: //! @name extensions
789
790   Standard_Boolean       hasHighp;           //!< highp in GLSL ES fragment shader is supported
791   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)
792   Standard_Boolean       hasTexRGBA8;        //!< always available on desktop; on OpenGL ES - since 3.0 or as extension GL_OES_rgb8_rgba8
793   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)
794   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)
795   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)
796   OpenGl_FeatureFlag     hasSampleVariables; //!< Complex flag indicating support of MSAA variables in GLSL shader (desktop OpenGL 4.0, GL_ARB_sample_shading)
797   Standard_Boolean       arbDrawBuffers;     //!< GL_ARB_draw_buffers
798   Standard_Boolean       arbNPTW;            //!< GL_ARB_texture_non_power_of_two
799   Standard_Boolean       arbTexRG;           //!< GL_ARB_texture_rg
800   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)
801   OpenGl_ArbTexBindless* arbTexBindless;     //!< GL_ARB_bindless_texture
802   OpenGl_ArbTBO*         arbTBO;             //!< GL_ARB_texture_buffer_object
803   Standard_Boolean       arbTboRGB32;        //!< GL_ARB_texture_buffer_object_rgb32 (3-component TBO), in core since 4.0
804   OpenGl_ArbIns*         arbIns;             //!< GL_ARB_draw_instanced
805   OpenGl_ArbDbg*         arbDbg;             //!< GL_ARB_debug_output
806   OpenGl_ArbFBO*         arbFBO;             //!< GL_ARB_framebuffer_object
807   OpenGl_ArbFBOBlit*     arbFBOBlit;         //!< glBlitFramebuffer function, moved out from OpenGl_ArbFBO structure for compatibility with OpenGL ES 2.0
808   Standard_Boolean       arbSampleShading;   //!< GL_ARB_sample_shading
809   Standard_Boolean       extFragDepth;       //!< GL_EXT_frag_depth on OpenGL ES 2.0 (gl_FragDepthEXT built-in variable, before OpenGL ES 3.0)
810   Standard_Boolean       extDrawBuffers;     //!< GL_EXT_draw_buffers
811   OpenGl_ExtGS*          extGS;              //!< GL_EXT_geometry_shader4
812   Standard_Boolean       extBgra;            //!< GL_EXT_bgra or GL_EXT_texture_format_BGRA8888 on OpenGL ES
813   Standard_Boolean       extAnis;            //!< GL_EXT_texture_filter_anisotropic
814   Standard_Boolean       extPDS;             //!< GL_EXT_packed_depth_stencil
815   Standard_Boolean       atiMem;             //!< GL_ATI_meminfo
816   Standard_Boolean       nvxMem;             //!< GL_NVX_gpu_memory_info
817   Standard_Boolean       oesSampleVariables; //!< GL_OES_sample_variables
818
819 public: //! @name public properties tracking current state
820
821   OpenGl_MatrixState<Standard_ShortReal> ModelWorldState; //!< state of orientation matrix
822   OpenGl_MatrixState<Standard_ShortReal> WorldViewState;  //!< state of orientation matrix
823   OpenGl_MatrixState<Standard_ShortReal> ProjectionState; //!< state of projection  matrix
824
825 private: // system-dependent fields
826
827 #if defined(HAVE_EGL)
828   Aspect_Drawable         myWindow;   //!< EGL surface                   : EGLSurface
829   Aspect_Display          myDisplay;  //!< EGL connection to the Display : EGLDisplay
830   Aspect_RenderingContext myGContext; //!< EGL rendering context         : EGLContext
831 #elif defined(_WIN32)
832   Aspect_Handle           myWindow;   //!< window handle (owner of GL context) : HWND
833   Aspect_Handle           myWindowDC; //!< Device Descriptor handle : HDC
834   Aspect_RenderingContext myGContext; //!< Rendering Context handle : HGLRC
835 #elif defined(__APPLE__) && !defined(MACOSX_USE_GLX)
836   #if defined(TARGET_OS_IPHONE) && TARGET_OS_IPHONE
837   EAGLContext*            myGContext;    //!< Rendering Context handle
838   #else
839   NSOpenGLContext*        myGContext; //!< Rendering Context handle
840   #endif
841 #else
842   Aspect_Drawable         myWindow;   //!< window handle (owner of GL context) : GLXDrawable
843   Aspect_Display          myDisplay;  //!< connection to the X-server : Display*
844   Aspect_RenderingContext myGContext; //!< X-GLX rendering context : GLXContext
845 #endif
846
847 private: // context info
848
849   typedef NCollection_Shared< NCollection_DataMap<TCollection_AsciiString, Standard_Integer> > OpenGl_DelayReleaseMap;
850   typedef NCollection_Shared< NCollection_DataMap<TCollection_AsciiString, Handle(OpenGl_Resource)> > OpenGl_ResourcesMap;
851   typedef NCollection_Shared< NCollection_List<Handle(OpenGl_Resource)> > OpenGl_ResourcesStack;
852   typedef NCollection_SparseArray<Standard_Integer> OpenGl_DrawBuffers;
853
854   Handle(OpenGl_ResourcesMap)    mySharedResources; //!< shared resources with unique identification key
855   Handle(OpenGl_DelayReleaseMap) myDelayed;         //!< shared resources for delayed release
856   Handle(OpenGl_ResourcesStack)  myUnusedResources; //!< stack of resources for delayed clean up
857
858   OpenGl_Clipping myClippingState; //!< state of clip planes
859
860   void*            myGlLibHandle;          //!< optional handle to GL library
861   NCollection_Handle<OpenGl_GlFunctions>
862                    myFuncs;                //!< mega structure for all GL functions
863   Standard_Integer myAnisoMax;             //!< maximum level of anisotropy texture filter
864   Standard_Integer myTexClamp;             //!< either GL_CLAMP_TO_EDGE (1.2+) or GL_CLAMP (1.1)
865   Standard_Integer myMaxTexDim;            //!< value for GL_MAX_TEXTURE_SIZE
866   Standard_Integer myMaxClipPlanes;        //!< value for GL_MAX_CLIP_PLANES
867   Standard_Integer myMaxMsaaSamples;       //!< value for GL_MAX_SAMPLES
868   Standard_Integer myMaxDrawBuffers;       //!< value for GL_MAX_DRAW_BUFFERS
869   Standard_Integer myMaxColorAttachments;  //!< value for GL_MAX_COLOR_ATTACHMENTS
870   Standard_Integer myGlVerMajor;           //!< cached GL version major number
871   Standard_Integer myGlVerMinor;           //!< cached GL version minor number
872   Standard_Boolean myIsInitialized;        //!< flag indicates initialization state
873   Standard_Boolean myIsStereoBuffers;      //!< context supports stereo buffering
874   Standard_Boolean myIsGlNormalizeEnabled; //!< GL_NORMALIZE flag
875                                            //!< Used to tell OpenGl that normals should be normalized
876
877   Standard_Boolean myHasRayTracing;                 //! indicates whether ray tracing mode is supported 
878   Standard_Boolean myHasRayTracingTextures;         //! indicates whether textures in ray tracing mode are supported 
879   Standard_Boolean myHasRayTracingAdaptiveSampling; //! indicates whether adaptive screen sampling in ray tracing mode is supported 
880
881   Handle(OpenGl_ShaderManager) myShaderManager; //! support object for managing shader programs
882
883 private: //! @name fields tracking current state
884
885   Handle(OpenGl_ShaderProgram)  myActiveProgram;   //!< currently active GLSL program
886   Handle(OpenGl_Sampler)        myTexSampler;      //!< currently active sampler object
887   Handle(OpenGl_FrameBuffer)    myDefaultFbo;      //!< default Frame Buffer Object
888   Handle(OpenGl_LineAttributes) myHatchStyles;     //!< resource holding predefined hatch styles patterns
889   Standard_Integer              myViewport[4];     //!< current viewport
890   Standard_Integer              myViewportVirt[4]; //!< virtual viewport
891   Standard_Integer              myPointSpriteOrig; //!< GL_POINT_SPRITE_COORD_ORIGIN state (GL_UPPER_LEFT by default)
892   Standard_Integer              myRenderMode;      //!< value for active rendering mode
893   Standard_Integer              myPolygonMode;     //!< currently used polygon rasterization mode (glPolygonMode)
894   bool                          myToCullBackFaces; //!< back face culling mode enabled state (glIsEnabled (GL_CULL_FACE))
895   Standard_Integer              myReadBuffer;      //!< current read buffer
896   OpenGl_DrawBuffers            myDrawBuffers;     //!< current draw buffers
897   unsigned int                  myDefaultVao;      //!< default Vertex Array Object
898   Standard_Boolean              myIsGlDebugCtx;    //!< debug context initialization state
899   TCollection_AsciiString       myVendor;          //!< Graphics Driver's vendor
900   TColStd_PackedMapOfInteger    myFilters[6];      //!< messages suppressing filter (for sources from GL_DEBUG_SOURCE_API_ARB to GL_DEBUG_SOURCE_OTHER_ARB)
901   unsigned int                  myResolution;      //!< Pixels density (PPI), defines scaling factor for parameters like text size
902   Standard_ShortReal            myResolutionRatio; //!< scaling factor for parameters like text size
903                                                    //!  to be properly displayed on device (screen / printer)
904   Standard_ShortReal            myLineWidthScale;  //!< scaling factor for line width
905   Standard_ShortReal            myRenderScale;     //!< scaling factor for rendering resolution
906   Standard_ShortReal            myRenderScaleInv;  //!< scaling factor for rendering resolution (inverted value)
907   OpenGl_Material               myMatFront;        //!< current front material state (cached to reduce GL context updates)
908   OpenGl_Material               myMatBack;         //!< current back  material state
909
910 private:
911
912   //! Copying allowed only within Handles
913   OpenGl_Context            (const OpenGl_Context& );
914   OpenGl_Context& operator= (const OpenGl_Context& );
915
916 };
917
918 #endif // _OpenGl_Context_H__