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