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