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