0031313: Foundation Classes - Dump improvement for classes
[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.
bc73b006 202//!
203//! Matrices of OpenGl transformations:
204//! model -> world -> view -> projection
205//! These matrices might be changed for local transformation, transform persistent using direct access to
206//! current matrix of ModelWorldState, WorldViewState and ProjectionState
207//! After, these matrices should be applyed using ApplyModelWorldMatrix, ApplyWorldViewMatrix,
208//! ApplyModelViewMatrix or ApplyProjectionMatrix.
2166f0fa
SK
209class OpenGl_Context : public Standard_Transient
210{
8613985b 211 DEFINE_STANDARD_RTTIEXT(OpenGl_Context, Standard_Transient)
212 friend class OpenGl_Window;
2166f0fa
SK
213public:
214
15669413 215 typedef NCollection_Shared< NCollection_DataMap<TCollection_AsciiString, Handle(OpenGl_Resource)> > OpenGl_ResourcesMap;
216
a174a3c5 217 //! Function for getting power of to number larger or equal to input number.
218 //! @param theNumber number to 'power of two'
219 //! @param theThreshold upper threshold
220 //! @return power of two number
221 inline static Standard_Integer GetPowerOfTwo (const Standard_Integer theNumber,
222 const Standard_Integer theThreshold)
223 {
224 for (Standard_Integer p2 = 2; p2 <= theThreshold; p2 <<= 1)
225 {
226 if (theNumber <= p2)
227 {
228 return p2;
229 }
230 }
231 return theThreshold;
232 }
233
234public:
235
5f8b738e 236 //! Empty constructor. You should call Init() to perform initialization with bound GL context.
58655684 237 Standard_EXPORT OpenGl_Context (const Handle(OpenGl_Caps)& theCaps = NULL);
5f8b738e 238
239 //! Destructor.
240 Standard_EXPORT virtual ~OpenGl_Context();
2166f0fa 241
05e2200b 242 //! Release all resources, including shared ones
243 Standard_EXPORT void forcedRelease();
244
5e27df78 245 //! Share GL context resources.
246 //! theShareCtx - handle to context to retrieve handles to shared resources.
247 Standard_EXPORT void Share (const Handle(OpenGl_Context)& theShareCtx);
248
7e7c2f0b 249 //! Initialize class from currently bound OpenGL context. Method should be called only once.
250 //! @return false if no GL context is bound to the current thread
4e1523ef 251 Standard_EXPORT Standard_Boolean Init (const Standard_Boolean theIsCoreProfile = Standard_False);
2166f0fa 252
fd4a6963 253 //! @return true if this context is valid (has been initialized)
254 inline Standard_Boolean IsValid() const
255 {
256 return myIsInitialized;
257 }
258
da8bb41d 259#if defined(HAVE_EGL)
260 //! Initialize class from specified surface and rendering context. Method should be called only once.
261 //! @return false if OpenGL context can not be bound to specified surface
262 Standard_EXPORT Standard_Boolean Init (const Aspect_Drawable theEglSurface,
263 const Aspect_Display theEglDisplay,
4e1523ef 264 const Aspect_RenderingContext theEglContext,
265 const Standard_Boolean theIsCoreProfile = Standard_False);
da8bb41d 266#elif defined(_WIN32)
7e7c2f0b 267 //! Initialize class from specified window and rendering context. Method should be called only once.
268 //! @return false if OpenGL context can not be bound to specified window
f0430952 269 Standard_EXPORT Standard_Boolean Init (const Aspect_Handle theWindow,
270 const Aspect_Handle theWindowDC,
4e1523ef 271 const Aspect_RenderingContext theGContext,
272 const Standard_Boolean theIsCoreProfile = Standard_False);
7e7c2f0b 273
274 //! @return the window handle (HWND) currently bound to this OpenGL context
275 inline Aspect_Handle Window() const
276 {
277 return myWindow;
278 }
279
4fe56619 280#elif defined(__APPLE__) && !defined(MACOSX_USE_GLX)
a2e4f780 281 #if defined(TARGET_OS_IPHONE) && TARGET_OS_IPHONE
282
283 //! Initialize class from specified OpenGL ES context (EAGLContext). Method should be called only once.
284 Standard_EXPORT Standard_Boolean Init (EAGLContext* theGContext,
285 const Standard_Boolean theIsCoreProfile = Standard_False);
286 #else
287
7e7c2f0b 288 //! Initialize class from specified OpenGL context (NSOpenGLContext). Method should be called only once.
a2e4f780 289 Standard_EXPORT Standard_Boolean Init (NSOpenGLContext* theGContext,
4e1523ef 290 const Standard_Boolean theIsCoreProfile = Standard_False);
a2e4f780 291 #endif
2bd4c032 292#else
a2e4f780 293
7e7c2f0b 294 //! Initialize class from specified window and rendering context. Method should be called only once.
295 //! @return false if OpenGL context can not be bound to specified window
f0430952 296 Standard_EXPORT Standard_Boolean Init (const Aspect_Drawable theWindow,
297 const Aspect_Display theDisplay,
4e1523ef 298 const Aspect_RenderingContext theGContext,
299 const Standard_Boolean theIsCoreProfile = Standard_False);
7e7c2f0b 300
301 //! @return the window handle (GLXDrawable) currently bound to this OpenGL context
302 inline Aspect_Drawable Window() const
303 {
304 return myWindow;
305 }
2bd4c032 306#endif
307
4e1523ef 308 //! Read OpenGL version information from active context.
309 Standard_EXPORT static void ReadGlVersion (Standard_Integer& theGlVerMajor,
310 Standard_Integer& theGlVerMinor);
311
5f8b738e 312 //! Check if theExtName extension is supported by active GL context.
2bd4c032 313 Standard_EXPORT Standard_Boolean CheckExtension (const char* theExtName) const;
2166f0fa 314
58655684 315 //! Check if theExtName extension is in extensions string.
316 Standard_EXPORT static Standard_Boolean CheckExtension (const char* theExtString,
317 const char* theExtName);
318
2166f0fa 319 //! Auxiliary template to retrieve GL function pointer.
5f8b738e 320 //! Pointer to function retrieved from library is statically casted
321 //! to requested type - there no way to check real signature of exported function.
2166f0fa 322 //! The context should be bound before call.
0ae9ac21 323 //! @param theLastFailFuncName [out] set to theFuncName in case of failure, unmodified on success
324 //! @param theFuncName [in] function name to find
325 //! @param theFuncPtr [out] retrieved function pointer
326 //! @return TRUE on success
327 template <typename FuncType_t>
328 Standard_Boolean FindProcVerbose (const char*& theLastFailFuncName,
329 const char* theFuncName,
330 FuncType_t& theFuncPtr)
331 {
332 theFuncPtr = (FuncType_t )findProc (theFuncName);
333 if (theFuncPtr == NULL)
334 {
335 theLastFailFuncName = theFuncName;
336 return Standard_False;
337 }
338 return Standard_True;
339 }
340
341 //! Auxiliary template to retrieve GL function pointer.
342 //! Same as FindProcVerbose() but without auxiliary last function name argument.
2166f0fa 343 template <typename FuncType_t>
5f8b738e 344 Standard_Boolean FindProc (const char* theFuncName,
345 FuncType_t& theFuncPtr)
2166f0fa 346 {
5f8b738e 347 theFuncPtr = (FuncType_t )findProc (theFuncName);
2166f0fa
SK
348 return (theFuncPtr != NULL);
349 }
350
2bd4c032 351 //! @return true if detected GL version is greater or equal to requested one.
352 inline Standard_Boolean IsGlGreaterEqual (const Standard_Integer theVerMajor,
7e7c2f0b 353 const Standard_Integer theVerMinor) const
5f8b738e 354 {
355 return (myGlVerMajor > theVerMajor)
356 || (myGlVerMajor == theVerMajor && myGlVerMinor >= theVerMinor);
357 }
358
26d9c835 359 //! Return cached GL version major number.
360 Standard_Integer VersionMajor() const { return myGlVerMajor; }
361
362 //! Return cached GL version minor number.
363 Standard_Integer VersionMinor() const { return myGlVerMinor; }
364
f978241f 365 //! Access entire map of loaded OpenGL functions.
366 const OpenGl_GlFunctions* Functions() const { return myFuncs.operator->(); }
367
5f8b738e 368 //! Clean up errors stack for this GL context (glGetError() in loop).
f9f740d6 369 //! @return true if some error has been cleared
370 Standard_EXPORT bool ResetErrors (const bool theToPrintErrors = false);
5f8b738e 371
86fa64d9 372 //! This method uses system-dependent API to retrieve information
373 //! about GL context bound to the current thread.
374 //! @return true if current thread is bound to this GL context
375 Standard_EXPORT Standard_Boolean IsCurrent() const;
376
2bd4c032 377 //! Activates current context.
378 //! Class should be initialized with appropriate info.
379 Standard_EXPORT Standard_Boolean MakeCurrent();
380
5e27df78 381 //! Swap front/back buffers for this GL context (should be activated before!).
382 Standard_EXPORT void SwapBuffers();
383
f978241f 384 //! Setup swap interval (VSync).
385 Standard_EXPORT Standard_Boolean SetSwapInterval (const Standard_Integer theInterval);
386
b5ac8292 387 //! Return true if active mode is GL_RENDER (cached state)
388 Standard_Boolean IsRender() const
389 {
ca3c13d1 390 #if !defined(GL_ES_VERSION_2_0)
b5ac8292 391 return myRenderMode == GL_RENDER;
ca3c13d1 392 #else
393 return Standard_True;
394 #endif
b5ac8292 395 }
664cae74 396
b5ac8292 397 //! Return true if active mode is GL_FEEDBACK (cached state)
398 Standard_Boolean IsFeedback() const
399 {
ca3c13d1 400 #if !defined(GL_ES_VERSION_2_0)
b5ac8292 401 return myRenderMode == GL_FEEDBACK;
ca3c13d1 402 #else
403 return Standard_False;
404 #endif
b5ac8292 405 }
664cae74 406
f0430952 407 //! This function retrieves information from GL about free GPU memory that is:
408 //! - OS-dependent. On some OS it is per-process and on others - for entire system.
409 //! - Vendor-dependent. Currently available only on NVIDIA and AMD/ATi drivers only.
410 //! - Numbers meaning may vary.
411 //! You should use this info only for diagnostics purposes.
412 //! @return free GPU dedicated memory in bytes.
413 Standard_EXPORT Standard_Size AvailableMemory() const;
414
415 //! This function retrieves information from GL about GPU memory
416 //! and contains more vendor-specific values than AvailableMemory().
417 Standard_EXPORT TCollection_AsciiString MemoryInfo() const;
418
26d9c835 419 //! This function retrieves information from GL about GPU memory.
420 Standard_EXPORT void MemoryInfo (TColStd_IndexedDataMapOfStringString& theDict) const;
421
422 //! Fill in the dictionary with OpenGL info.
423 //! Should be called with bound context.
424 Standard_EXPORT void DiagnosticInformation (TColStd_IndexedDataMapOfStringString& theDict,
425 Graphic3d_DiagnosticInfo theFlags) const;
426
5e27df78 427 //! Access shared resource by its name.
428 //! @param theKey - unique identifier;
429 //! @return handle to shared resource or NULL.
430 Standard_EXPORT const Handle(OpenGl_Resource)& GetResource (const TCollection_AsciiString& theKey) const;
431
432 //! Access shared resource by its name.
433 //! @param theKey - unique identifier;
434 //! @param theValue - handle to fill;
435 //! @return true if resource was shared.
436 template<typename TheHandleType>
437 Standard_Boolean GetResource (const TCollection_AsciiString& theKey,
438 TheHandleType& theValue) const
439 {
440 const Handle(OpenGl_Resource)& aResource = GetResource (theKey);
441 if (aResource.IsNull())
442 {
443 return Standard_False;
444 }
445
446 theValue = TheHandleType::DownCast (aResource);
447 return !theValue.IsNull();
448 }
449
450 //! Register shared resource.
451 //! Notice that after registration caller shouldn't release it by himself -
452 //! it will be automatically released on context destruction.
453 //! @param theKey - unique identifier, shouldn't be empty;
454 //! @param theResource - new resource to register, shouldn't be NULL.
455 Standard_EXPORT Standard_Boolean ShareResource (const TCollection_AsciiString& theKey,
456 const Handle(OpenGl_Resource)& theResource);
457
458 //! Release shared resource.
459 //! If there are more than one reference to this resource
460 //! (also used by some other existing object) then call will be ignored.
461 //! This means that current object itself should nullify handle before this call.
462 //! Notice that this is unrecommended operation at all and should be used
463 //! only in case of fat resources to release memory for other needs.
a174a3c5 464 //! @param theKey unique identifier
465 //! @param theToDelay postpone release until next redraw call
466 Standard_EXPORT void ReleaseResource (const TCollection_AsciiString& theKey,
467 const Standard_Boolean theToDelay = Standard_False);
5e27df78 468
469 //! Append resource to queue for delayed clean up.
470 //! Resources in this queue will be released at next redraw call.
aa00364d 471 template <class T>
472 void DelayedRelease (Handle(T)& theResource)
473 {
474 myUnusedResources->Prepend (theResource);
475 theResource.Nullify();
476 }
5e27df78 477
478 //! Clean up the delayed release queue.
479 Standard_EXPORT void ReleaseDelayed();
480
15669413 481 //! Return map of shared resources.
482 const OpenGl_ResourcesMap& SharedResources() const { return *mySharedResources; }
483
4269bd1b 484 //! @return tool for management of clippings within this context.
30f0ad28 485 inline OpenGl_Clipping& ChangeClipping() { return myClippingState; }
4269bd1b 486
487 //! @return tool for management of clippings within this context.
30f0ad28 488 inline const OpenGl_Clipping& Clipping() const { return myClippingState; }
489
490 //! @return tool for management of shader programs within this context.
491 inline const Handle(OpenGl_ShaderManager)& ShaderManager() const { return myShaderManager; }
4269bd1b 492
493public:
494
ca3c13d1 495 //! Either GL_CLAMP_TO_EDGE (1.2+) or GL_CLAMP (1.1).
496 Standard_Integer TextureWrapClamp() const { return myTexClamp; }
497
bf75be98 498 //! @return maximum degree of anisotropy texture filter
3c4b62a4 499 Standard_Integer MaxDegreeOfAnisotropy() const { return myAnisoMax; }
bf75be98 500
501 //! @return value for GL_MAX_TEXTURE_SIZE
3c4b62a4 502 Standard_Integer MaxTextureSize() const { return myMaxTexDim; }
503
cc8cbabe 504 //! @return value for GL_MAX_COMBINED_TEXTURE_IMAGE_UNITS
505 Standard_Integer MaxCombinedTextureUnits() const { return myMaxTexCombined; }
506
5c225e8e 507 //! This method returns the multi-texture limit for obsolete fixed-function pipeline.
508 //! Use MaxCombinedTextureUnits() instead for limits for using programmable pipeline.
509 //! @return value for GL_MAX_TEXTURE_UNITS
510 Standard_Integer MaxTextureUnitsFFP() const { return myMaxTexUnitsFFP; }
511
72f6dc61 512 //! Return texture unit to be used for sprites (Graphic3d_TextureUnit_PointSprite by default).
737e9a8d 513 Graphic3d_TextureUnit SpriteTextureUnit() const { return mySpriteTexUnit; }
514
3c4b62a4 515 //! @return value for GL_MAX_SAMPLES
516 Standard_Integer MaxMsaaSamples() const { return myMaxMsaaSamples; }
bf75be98 517
6997ff1c 518 //! @return maximum FBO width for image dump
519 Standard_Integer MaxDumpSizeX() const { return myMaxDumpSizeX; }
520
521 //! @return maximum FBO height for image dump
522 Standard_Integer MaxDumpSizeY() const { return myMaxDumpSizeY; }
523
a1073ae2 524 //! @return value for GL_MAX_DRAW_BUFFERS
525 Standard_Integer MaxDrawBuffers() const { return myMaxDrawBuffers; }
526
527 //! @return value for GL_MAX_COLOR_ATTACHMENTS
528 Standard_Integer MaxColorAttachments() const { return myMaxColorAttachments; }
529
4269bd1b 530 //! Get maximum number of clip planes supported by OpenGl.
7e7c2f0b 531 //! This value is implementation dependent. At least 6
4269bd1b 532 //! planes should be supported by OpenGl (see specs).
533 //! @return value for GL_MAX_CLIP_PLANES
3c4b62a4 534 Standard_Integer MaxClipPlanes() const { return myMaxClipPlanes; }
4269bd1b 535
3a9b5dc8 536 //! @return TRUE if ray tracing mode is supported
537 Standard_Boolean HasRayTracing() const { return myHasRayTracing; }
538
539 //! @return TRUE if textures in ray tracing mode are supported
540 Standard_Boolean HasRayTracingTextures() const { return myHasRayTracingTextures; }
541
542 //! @return TRUE if adaptive screen sampling in ray tracing mode is supported
543 Standard_Boolean HasRayTracingAdaptiveSampling() const { return myHasRayTracingAdaptiveSampling; }
544
e084dbbc 545 //! @return TRUE if atomic adaptive screen sampling in ray tracing mode is supported
546 Standard_Boolean HasRayTracingAdaptiveSamplingAtomic() const { return myHasRayTracingAdaptiveSamplingAtomic; }
547
ba00aab7 548 //! Returns TRUE if sRGB rendering is supported.
549 bool HasSRGB() const
550 {
551 return hasTexSRGB
552 && hasFboSRGB;
553 }
554
555 //! Returns TRUE if sRGB rendering is supported and permitted.
556 bool ToRenderSRGB() const
557 {
558 return HasSRGB()
559 && !caps->sRGBDisable
560 && !caps->ffpEnable;
561 }
562
563 //! Returns TRUE if window/surface buffer is sRGB-ready.
564 //!
565 //! When offscreen FBOs are created in sRGB, but window is not sRGB-ready,
566 //! blitting into window should be done with manual gamma correction.
567 //!
568 //! In desktop OpenGL, window buffer can be considered as sRGB-ready by default,
569 //! even when application has NOT requested sRGB-ready pixel format,
570 //! and rendering is managed via GL_FRAMEBUFFER_SRGB state.
571 //!
572 //! In OpenGL ES, sRGB-ready window surface should be explicitly requested on construction,
573 //! and cannot be disabled/enabled without GL_EXT_sRGB_write_control extension afterwards
574 //! (GL_FRAMEBUFFER_SRGB can be considered as always tuned ON).
575 bool IsWindowSRGB() const { return myIsSRgbWindow; }
576
577 //! Convert Quantity_ColorRGBA into vec4
578 //! with conversion or no conversion into non-linear sRGB
579 //! basing on ToRenderSRGB() flag.
580 OpenGl_Vec4 Vec4FromQuantityColor (const OpenGl_Vec4& theColor) const
581 {
565baee6 582 return myIsSRgbActive
ba00aab7 583 ? Vec4LinearFromQuantityColor(theColor)
584 : Vec4sRGBFromQuantityColor (theColor);
585 }
586
587 //! Convert Quantity_ColorRGBA into vec4.
588 //! Quantity_Color is expected to be linear RGB, hence conversion is NOT required
589 const OpenGl_Vec4& Vec4LinearFromQuantityColor (const OpenGl_Vec4& theColor) const { return theColor; }
590
591 //! Convert Quantity_ColorRGBA (linear RGB) into non-linear sRGB vec4.
592 OpenGl_Vec4 Vec4sRGBFromQuantityColor (const OpenGl_Vec4& theColor) const
593 {
594 return Quantity_ColorRGBA::Convert_LinearRGB_To_sRGB (theColor);
595 }
596
67312b79 597 //! Returns TRUE if PBR shading model is supported.
598 //! Basically, feature requires OpenGL 3.0+ / OpenGL ES 3.0+ hardware; more precisely:
599 //! - Graphics hardware with moderate capabilities for compiling long enough GLSL program.
600 //! - FBO (e.g. for baking environment).
601 //! - Multi-texturing with >= 4 units (LUT and IBL textures).
602 //! - GL_RG32F texture format (arbTexRG + arbTexFloat)
603 //! - Cubemap texture lookup textureCubeLod()/textureLod() with LOD index within Fragment Shader,
604 //! which requires GLSL OpenGL 3.0+ / OpenGL ES 3.0+ or OpenGL 2.1 + GL_EXT_gpu_shader4 extension.
605 Standard_Boolean HasPBR() const { return myHasPBR; }
606
607 //! Returns texture unit where Environment Lookup Table is expected to be bound, or 0 if PBR is unavailable.
608 Graphic3d_TextureUnit PBREnvLUTTexUnit() const { return myPBREnvLUTTexUnit; }
609
610 //! Returns texture unit where Diffuse (irradiance) IBL map's spherical harmonics coefficients is expected to be bound, or 0 if PBR is unavailable.
611 Graphic3d_TextureUnit PBRDiffIBLMapSHTexUnit() const { return myPBRDiffIBLMapSHTexUnit; }
612
613 //! Returns texture unit where Specular IBL map is expected to be bound, or 0 if PBR is unavailable.
614 Graphic3d_TextureUnit PBRSpecIBLMapTexUnit() const { return myPBRSpecIBLMapTexUnit; }
615
7d3e64ef 616 //! Returns true if VBO is supported and permitted.
617 inline bool ToUseVbo() const
618 {
619 return core15fwd != NULL
620 && !caps->vboDisable;
621 }
622
7d9e854b 623 //! @return cached state of GL_NORMALIZE.
624 Standard_Boolean IsGlNormalizeEnabled() const { return myIsGlNormalizeEnabled; }
625
626 //! Sets GL_NORMALIZE enabled or disabled.
627 //! @return old value of the flag
628 Standard_EXPORT Standard_Boolean SetGlNormalizeEnabled (Standard_Boolean isEnabled);
629
6d0e6be5 630 //! @return cached state of polygon rasterization mode (glPolygonMode()).
631 Standard_Integer PolygonMode() const { return myPolygonMode; }
632
633 //! Sets polygon rasterization mode (glPolygonMode() function).
634 //! @return old value of the rasterization mode.
635 Standard_EXPORT Standard_Integer SetPolygonMode (const Standard_Integer theMode);
636
637 //! @return cached enabled state of polygon hatching rasterization.
638 bool IsPolygonHatchEnabled() const
639 {
640 return !myHatchStyles.IsNull() && myHatchStyles->TypeOfHatch() != 0;
641 }
642
643 //! Sets enabled state of polygon hatching rasterization
644 //! without affecting currently selected hatching pattern.
645 //! @return previous state of polygon hatching mode.
646 Standard_EXPORT bool SetPolygonHatchEnabled (const bool theIsEnabled);
647
648 //! @return cached state of polygon hatch type.
649 Standard_Integer PolygonHatchStyle() const
650 {
651 return myHatchStyles.IsNull() ? Aspect_HS_SOLID : myHatchStyles->TypeOfHatch();
652 }
653
654 //! Sets polygon hatch pattern.
655 //! Zero-index value is a default alias for solid filling.
656 //! @param the type of hatch supported by base implementation of
657 //! OpenGl_LineAttributes (Aspect_HatchStyle) or the type supported by custom
658 //! implementation derived from OpenGl_LineAttributes class.
659 //! @return old type of hatch.
640d5fe2 660 Standard_EXPORT Standard_Integer SetPolygonHatchStyle (const Handle(Graphic3d_HatchStyle)& theStyle);
6d0e6be5 661
8d1a539c 662 //! Sets and applies current polygon offset.
663 Standard_EXPORT void SetPolygonOffset (const Graphic3d_PolygonOffset& theOffset);
664
665 //! Returns currently applied polygon offset parameters.
666 const Graphic3d_PolygonOffset& PolygonOffset() const { return myPolygonOffset; }
667
bc73b006 668 //! Applies matrix into shader manager stored in ModelWorldState to OpenGl.
669 //! In "model -> world -> view -> projection" it performs:
670 //! model -> world
5e94009d 671 Standard_EXPORT void ApplyModelWorldMatrix();
c827ea3a 672
673 //! Applies matrix stored in WorldViewState to OpenGl.
bc73b006 674 //! In "model -> world -> view -> projection" it performs:
675 //! model -> world -> view,
676 //! where model -> world is identical matrix
5e94009d 677 Standard_EXPORT void ApplyWorldViewMatrix();
c827ea3a 678
679 //! Applies combination of matrices stored in ModelWorldState and WorldViewState to OpenGl.
bc73b006 680 //! In "model -> world -> view -> projection" it performs:
681 //! model -> world -> view
5e94009d 682 Standard_EXPORT void ApplyModelViewMatrix();
c827ea3a 683
684 //! Applies matrix stored in ProjectionState to OpenGl.
bc73b006 685 //! In "model -> world -> view -> projection" it performs:
686 //! view -> projection
5e94009d 687 Standard_EXPORT void ApplyProjectionMatrix();
c827ea3a 688
cbf18624 689public:
690
7e7c2f0b 691 //! @return messenger instance
857ffd5e 692 inline const Handle(Message_Messenger)& Messenger() const
cbf18624 693 {
8fa64b52 694 return ::Message::DefaultMessenger();
cbf18624 695 }
696
697 //! Callback for GL_ARB_debug_output extension
698 //! @param theSource message source within GL_DEBUG_SOURCE_ enumeration
699 //! @param theType message type within GL_DEBUG_TYPE_ enumeration
700 //! @param theId message ID within source
701 //! @param theSeverity message severity within GL_DEBUG_SEVERITY_ enumeration
702 //! @param theMessage the message itself
703 Standard_EXPORT void PushMessage (const unsigned int theSource,
704 const unsigned int theType,
705 const unsigned int theId,
706 const unsigned int theSeverity,
707 const TCollection_ExtendedString& theMessage);
708
c87535af 709 //! Adds a filter for messages with theId and theSource (GL_DEBUG_SOURCE_)
710 Standard_EXPORT Standard_Boolean ExcludeMessage (const unsigned int theSource,
711 const unsigned int theId);
b5ac8292 712
c87535af 713 //! Removes a filter for messages with theId and theSource (GL_DEBUG_SOURCE_)
714 Standard_EXPORT Standard_Boolean IncludeMessage (const unsigned int theSource,
715 const unsigned int theId);
b5ac8292 716
717 //! @return true if OpenGl context supports left and
718 //! right rendering buffers.
719 Standard_Boolean HasStereoBuffers() const
720 {
ca3c13d1 721 #if !defined(GL_ES_VERSION_2_0)
b5ac8292 722 return myIsStereoBuffers;
ca3c13d1 723 #else
724 return Standard_False;
725 #endif
b5ac8292 726 }
727
7d3e64ef 728public: //! @name methods to alter or retrieve current state
729
15669413 730 //! Return structure holding frame statistics.
731 const Handle(OpenGl_FrameStats)& FrameStats() const { return myFrameStats; }
732
5e30547b 733 //! Set structure holding frame statistics.
734 //! This call makes sense only if application defines OpenGl_FrameStats sub-class.
735 void SetFrameStats (const Handle(OpenGl_FrameStats)& theStats) { myFrameStats = theStats; }
736
3bffef55 737 //! Return cached viewport definition (x, y, width, height).
738 const Standard_Integer* Viewport() const { return myViewport; }
739
740 //! Resize the viewport (alias for glViewport).
741 //! @param theRect viewport definition (x, y, width, height)
742 Standard_EXPORT void ResizeViewport (const Standard_Integer theRect[4]);
743
56689b27 744 //! Return virtual viewport definition (x, y, width, height).
745 const Standard_Integer* VirtualViewport() const { return myViewportVirt; }
746
38a0206f 747 //! Return active read buffer.
748 Standard_Integer ReadBuffer() { return myReadBuffer; }
b5ac8292 749
38a0206f 750 //! Switch read buffer, wrapper for ::glReadBuffer().
751 Standard_EXPORT void SetReadBuffer (const Standard_Integer theReadBuffer);
b5ac8292 752
a1073ae2 753 //! Return active draw buffer attached to a render target referred by index (layout location).
c3487460 754 Standard_Integer DrawBuffer (Standard_Integer theIndex = 0) const
a1073ae2 755 {
c3487460 756 return theIndex >= myDrawBuffers.Lower()
757 && theIndex <= myDrawBuffers.Upper()
758 ? myDrawBuffers.Value (theIndex)
759 : GL_NONE;
a1073ae2 760 }
38a0206f 761
762 //! Switch draw buffer, wrapper for ::glDrawBuffer().
763 Standard_EXPORT void SetDrawBuffer (const Standard_Integer theDrawBuffer);
764
a1073ae2 765 //! Switch draw buffer, wrapper for ::glDrawBuffers (GLsizei, const GLenum*).
766 Standard_EXPORT void SetDrawBuffers (const Standard_Integer theNb, const Standard_Integer* theDrawBuffers);
767
38a0206f 768 //! Switch read/draw buffers.
769 void SetReadDrawBuffer (const Standard_Integer theBuffer)
770 {
771 SetReadBuffer (theBuffer);
772 SetDrawBuffer (theBuffer);
773 }
b5ac8292 774
ba00aab7 775 //! Returns cached GL_FRAMEBUFFER_SRGB state.
776 //! If TRUE, GLSL program is expected to write linear RGB color.
777 //! Otherwise, GLSL program might need manually converting result color into sRGB color space.
778 bool IsFrameBufferSRGB() const { return myIsSRgbActive; }
779
780 //! Enables/disables GL_FRAMEBUFFER_SRGB flag.
781 //! This flag can be set to:
782 //! - TRUE when writing into offscreen FBO (always expected to be in sRGB or RGBF formats).
783 //! - TRUE when writing into sRGB-ready window buffer (might require choosing proper pixel format on window creation).
784 //! - FALSE if sRGB rendering is not supported or sRGB-not-ready window buffer is used for drawing.
785 //! @param theIsFbo [in] flag indicating writing into offscreen FBO (always expected sRGB-ready when sRGB FBO is supported)
786 //! or into window buffer (FALSE, sRGB-readiness might vary).
787 Standard_EXPORT void SetFrameBufferSRGB (bool theIsFbo);
788
f88457e6 789 //! Return cached flag indicating writing into color buffer is enabled or disabled (glColorMask).
790 bool ColorMask() const { return myColorMask; }
791
792 //! Enable/disable writing into color buffer (wrapper for glColorMask).
793 Standard_EXPORT bool SetColorMask (bool theToWriteColor);
794
2a332745 795 //! Return TRUE if GL_SAMPLE_ALPHA_TO_COVERAGE usage is allowed.
796 bool AllowSampleAlphaToCoverage() const { return myAllowAlphaToCov; }
797
798 //! Allow GL_SAMPLE_ALPHA_TO_COVERAGE usage.
799 void SetAllowSampleAlphaToCoverage (bool theToEnable) { myAllowAlphaToCov = theToEnable; }
800
c40eb6b9 801 //! Return GL_SAMPLE_ALPHA_TO_COVERAGE state.
802 bool SampleAlphaToCoverage() const { return myAlphaToCoverage; }
803
804 //! Enable/disable GL_SAMPLE_ALPHA_TO_COVERAGE.
805 Standard_EXPORT bool SetSampleAlphaToCoverage (bool theToEnable);
806
b6472664 807 //! Return back face culling state.
808 bool ToCullBackFaces() const { return myToCullBackFaces; }
809
810 //! Enable or disable back face culling (glEnable (GL_CULL_FACE)).
811 Standard_EXPORT void SetCullBackFaces (bool theToEnable);
812
b5ac8292 813 //! Fetch OpenGl context state. This class tracks value of several OpenGl
814 //! state variables. Consulting the cached values is quicker than
815 //! doing the same via OpenGl API. Call this method if any of the controlled
816 //! OpenGl state variables has a possibility of being out-of-date.
817 Standard_EXPORT void FetchState();
818
cc8cbabe 819 //! @return active textures
820 const Handle(OpenGl_TextureSet)& ActiveTextures() const { return myActiveTextures; }
821
72f6dc61 822 //! Bind specified texture set to current context taking into account active GLSL program.
823 Standard_DEPRECATED("BindTextures() with explicit GLSL program should be used instead")
824 Handle(OpenGl_TextureSet) BindTextures (const Handle(OpenGl_TextureSet)& theTextures)
825 {
826 return BindTextures (theTextures, myActiveProgram);
827 }
828
829 //! Bind specified texture set to current context, or unbind previous one when NULL specified.
830 //! @param theTextures [in] texture set to bind
831 //! @param theProgram [in] program attributes; when not NULL,
832 //! mock textures will be bound to texture units expected by GLSL program, but undefined by texture set
833 //! @return previous texture set
834 Standard_EXPORT Handle(OpenGl_TextureSet) BindTextures (const Handle(OpenGl_TextureSet)& theTextures,
835 const Handle(OpenGl_ShaderProgram)& theProgram);
cc8cbabe 836
7d3e64ef 837 //! @return active GLSL program
838 const Handle(OpenGl_ShaderProgram)& ActiveProgram() const
839 {
840 return myActiveProgram;
841 }
842
843 //! Bind specified program to current context,
844 //! or unbind previous one when NULL specified.
8625ef7e 845 //! @return true if some program is bound to context
846 Standard_EXPORT Standard_Boolean BindProgram (const Handle(OpenGl_ShaderProgram)& theProgram);
847
299e0ab9 848 //! Setup current shading material.
bf5f0ca2 849 Standard_EXPORT void SetShadingMaterial (const OpenGl_Aspects* theAspect,
a1073ae2 850 const Handle(Graphic3d_PresentationAttributes)& theHighlight);
851
852 //! Checks if transparency is required for the given aspect and highlight style.
bf5f0ca2 853 Standard_EXPORT static Standard_Boolean CheckIsTransparent (const OpenGl_Aspects* theAspect,
a1073ae2 854 const Handle(Graphic3d_PresentationAttributes)& theHighlight,
a71a71de 855 Standard_ShortReal& theAlphaFront,
856 Standard_ShortReal& theAlphaBack);
857
858 //! Checks if transparency is required for the given aspect and highlight style.
bf5f0ca2 859 static Standard_Boolean CheckIsTransparent (const OpenGl_Aspects* theAspect,
a71a71de 860 const Handle(Graphic3d_PresentationAttributes)& theHighlight)
861 {
862 Standard_ShortReal anAlphaFront = 1.0f, anAlphaBack = 1.0f;
863 return CheckIsTransparent (theAspect, theHighlight, anAlphaFront, anAlphaBack);
864 }
299e0ab9 865
8625ef7e 866 //! Setup current color.
867 Standard_EXPORT void SetColor4fv (const OpenGl_Vec4& theColor);
868
ac116c22 869 //! Setup type of line.
870 Standard_EXPORT void SetTypeOfLine (const Aspect_TypeOfLine theType,
871 const Standard_ShortReal theFactor = 1.0f);
872
3f1675c9 873 //! Setup stipple line pattern with 1.0f factor; wrapper for glLineStipple().
874 void SetLineStipple (const uint16_t thePattern) { SetLineStipple (1.0f, thePattern); }
875
876 //! Setup type of line; wrapper for glLineStipple().
877 Standard_EXPORT void SetLineStipple (const Standard_ShortReal theFactor,
878 const uint16_t thePattern);
879
ac116c22 880 //! Setup width of line.
881 Standard_EXPORT void SetLineWidth (const Standard_ShortReal theWidth);
882
8625ef7e 883 //! Setup point size.
884 Standard_EXPORT void SetPointSize (const Standard_ShortReal theSize);
7d3e64ef 885
fd59283a 886 //! Setup point sprite origin using GL_POINT_SPRITE_COORD_ORIGIN state:
887 //! - GL_UPPER_LEFT when GLSL program is active;
888 //! flipping should be handled in GLSL program for compatibility with OpenGL ES
889 //! - GL_LOWER_LEFT for FFP
890 Standard_EXPORT void SetPointSpriteOrigin();
891
79f4f036 892 //! Setup texture matrix to active GLSL program or to FFP global state using glMatrixMode (GL_TEXTURE).
893 Standard_EXPORT void SetTextureMatrix (const Handle(Graphic3d_TextureParams)& theParams);
894
4e1523ef 895 //! Bind default Vertex Array Object
896 Standard_EXPORT void BindDefaultVao();
897
a2e4f780 898 //! Default Frame Buffer Object.
899 const Handle(OpenGl_FrameBuffer)& DefaultFrameBuffer() const
900 {
901 return myDefaultFbo;
902 }
903
904 //! Setup new Default Frame Buffer Object and return previously set.
905 //! This call doesn't change Active FBO!
906 Standard_EXPORT Handle(OpenGl_FrameBuffer) SetDefaultFrameBuffer (const Handle(OpenGl_FrameBuffer)& theFbo);
907
4e1523ef 908 //! Return debug context initialization state.
909 Standard_Boolean IsDebugContext() const
910 {
911 return myIsGlDebugCtx;
912 }
913
c357e426 914 Standard_EXPORT void EnableFeatures() const;
915
916 Standard_EXPORT void DisableFeatures() const;
917
56689b27 918 //! Return resolution for rendering text.
919 unsigned int Resolution() const { return myResolution; }
920
921 //! Resolution scale factor (rendered resolution to standard resolution).
922 //! This scaling factor for parameters like text size to be properly displayed on device (screen / printer).
923 Standard_ShortReal ResolutionRatio() const { return myResolutionRatio; }
924
925 //! Rendering scale factor (rendering viewport height to real window buffer height).
926 Standard_ShortReal RenderScale() const { return myRenderScale; }
927
928 //! Return TRUE if rendering scale factor is not 1.
929 Standard_Boolean HasRenderScale() const { return Abs (myRenderScale - 1.0f) > 0.0001f; }
930
931 //! Rendering scale factor (inverted value).
932 Standard_ShortReal RenderScaleInv() const { return myRenderScaleInv; }
933
2a332745 934 //! Return scale factor for line width.
935 Standard_ShortReal LineWidthScale() const { return myLineWidthScale; }
936
56689b27 937 //! Set resolution ratio.
938 //! Note that this method rounds @theRatio to nearest integer.
939 void SetResolution (unsigned int theResolution,
940 Standard_ShortReal theRatio,
941 Standard_ShortReal theScale)
942 {
943 myResolution = (unsigned int )(theScale * theResolution + 0.5f);
944 myRenderScale = theScale;
945 myRenderScaleInv = 1.0f / theScale;
946 SetResolutionRatio (theRatio * theScale);
947 }
948
75c262a9 949 //! Set resolution ratio.
950 //! Note that this method rounds @theRatio to nearest integer.
951 void SetResolutionRatio (const Standard_ShortReal theRatio)
952 {
56689b27 953 myResolutionRatio = theRatio;
954 myLineWidthScale = Max (1.0f, std::floor (theRatio + 0.5f));
75c262a9 955 }
956
2a332745 957 //! Return line feater width in pixels.
958 Standard_ShortReal LineFeather() const { return myLineFeather; }
959
960 //! Set line feater width.
961 void SetLineFeather(Standard_ShortReal theValue) { myLineFeather = theValue; }
962
c39bb31b 963 //! Return Graphics Driver's vendor.
964 const TCollection_AsciiString& Vendor() const { return myVendor; }
965
bc73b006 966 //! Dumps the content of me into the stream
967 Standard_EXPORT void DumpJson (Standard_OStream& theOStream, Standard_Integer theDepth = -1) const;
968
969 //! Dumps the content of openGL state into the stream
970 Standard_EXPORT static void DumpJsonOpenGlState (Standard_OStream& theOStream, Standard_Integer theDepth = -1);
971
5f8b738e 972private:
973
974 //! Wrapper to system function to retrieve GL function pointer by name.
975 Standard_EXPORT void* findProc (const char* theFuncName);
976
ee51a9fe 977 //! Print error if not all functions have been exported by context for reported version.
978 //! Note that this will never happen when using GLX, since returned functions can not be validated.
979 //! @param theGlVerMajor the OpenGL major version with missing functions
980 //! @param theGlVerMinor the OpenGL minor version with missing functions
0ae9ac21 981 //! @param theLastFailedProc function name which cannot be found
982 Standard_EXPORT void checkWrongVersion (Standard_Integer theGlVerMajor, Standard_Integer theGlVerMinor,
983 const char* theLastFailedProc);
ee51a9fe 984
5f8b738e 985 //! Private initialization function that should be called only once.
4e1523ef 986 Standard_EXPORT void init (const Standard_Boolean theIsCoreProfile);
5f8b738e 987
01ca42b2 988public: //! @name core profiles
989
990 OpenGl_GlCore11* core11; //!< OpenGL 1.1 core functionality
991 OpenGl_GlCore11Fwd* core11fwd; //!< OpenGL 1.1 without deprecated entry points
992 OpenGl_GlCore15* core15; //!< OpenGL 1.5 core functionality
993 OpenGl_GlCore15Fwd* core15fwd; //!< OpenGL 1.5 without deprecated entry points
994 OpenGl_GlCore20* core20; //!< OpenGL 2.0 core functionality (includes 1.5)
995 OpenGl_GlCore20Fwd* core20fwd; //!< OpenGL 2.0 without deprecated entry points
996 OpenGl_GlCore32* core32; //!< OpenGL 3.2 core profile
997 OpenGl_GlCore32Back* core32back; //!< OpenGL 3.2 backward compatibility profile
25ef750e 998 OpenGl_GlCore33* core33; //!< OpenGL 3.3 core profile
999 OpenGl_GlCore33Back* core33back; //!< OpenGL 3.3 backward compatibility profile
01ca42b2 1000 OpenGl_GlCore41* core41; //!< OpenGL 4.1 core profile
1001 OpenGl_GlCore41Back* core41back; //!< OpenGL 4.1 backward compatibility profile
1002 OpenGl_GlCore42* core42; //!< OpenGL 4.2 core profile
1003 OpenGl_GlCore42Back* core42back; //!< OpenGL 4.2 backward compatibility profile
1004 OpenGl_GlCore43* core43; //!< OpenGL 4.3 core profile
1005 OpenGl_GlCore43Back* core43back; //!< OpenGL 4.3 backward compatibility profile
1006 OpenGl_GlCore44* core44; //!< OpenGL 4.4 core profile
1007 OpenGl_GlCore44Back* core44back; //!< OpenGL 4.4 backward compatibility profile
9491df8c 1008 OpenGl_GlCore45* core45; //!< OpenGL 4.5 core profile
1009 OpenGl_GlCore45Back* core45back; //!< OpenGL 4.5 backward compatibility profile
5f8b738e 1010
58655684 1011 Handle(OpenGl_Caps) caps; //!< context options
1012
01ca42b2 1013public: //! @name extensions
5f8b738e 1014
a1073ae2 1015 Standard_Boolean hasHighp; //!< highp in GLSL ES fragment shader is supported
1016 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)
1017 Standard_Boolean hasTexRGBA8; //!< always available on desktop; on OpenGL ES - since 3.0 or as extension GL_OES_rgb8_rgba8
67312b79 1018 Standard_Boolean hasTexFloatLinear; //!< texture-filterable state for 32-bit floating texture formats (always on desktop, GL_OES_texture_float_linear within OpenGL ES)
ba00aab7 1019 Standard_Boolean hasTexSRGB; //!< sRGB texture formats (desktop OpenGL 2.0, OpenGL ES 3.0 or GL_EXT_texture_sRGB)
1020 Standard_Boolean hasFboSRGB; //!< sRGB FBO render targets (desktop OpenGL 2.1, OpenGL ES 3.0)
1021 Standard_Boolean hasSRGBControl; //!< sRGB write control (any desktop OpenGL, OpenGL ES + GL_EXT_sRGB_write_control extension)
c39bb31b 1022 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)
59515ca6 1023 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
a1073ae2 1024 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)
1025 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)
1026 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)
1027 OpenGl_FeatureFlag hasSampleVariables; //!< Complex flag indicating support of MSAA variables in GLSL shader (desktop OpenGL 4.0, GL_ARB_sample_shading)
2a332745 1028 OpenGl_FeatureFlag hasGeometryStage; //!< Complex flag indicating support of Geometry shader (desktop OpenGL 3.2, OpenGL ES 3.2, GL_EXT_geometry_shader)
a1073ae2 1029 Standard_Boolean arbDrawBuffers; //!< GL_ARB_draw_buffers
1030 Standard_Boolean arbNPTW; //!< GL_ARB_texture_non_power_of_two
1031 Standard_Boolean arbTexRG; //!< GL_ARB_texture_rg
67312b79 1032 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
cc8cbabe 1033 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 1034 OpenGl_ArbTexBindless* arbTexBindless; //!< GL_ARB_bindless_texture
1035 OpenGl_ArbTBO* arbTBO; //!< GL_ARB_texture_buffer_object
1036 Standard_Boolean arbTboRGB32; //!< GL_ARB_texture_buffer_object_rgb32 (3-component TBO), in core since 4.0
1037 OpenGl_ArbIns* arbIns; //!< GL_ARB_draw_instanced
1038 OpenGl_ArbDbg* arbDbg; //!< GL_ARB_debug_output
1039 OpenGl_ArbFBO* arbFBO; //!< GL_ARB_framebuffer_object
1040 OpenGl_ArbFBOBlit* arbFBOBlit; //!< glBlitFramebuffer function, moved out from OpenGl_ArbFBO structure for compatibility with OpenGL ES 2.0
1041 Standard_Boolean arbSampleShading; //!< GL_ARB_sample_shading
1042 Standard_Boolean extFragDepth; //!< GL_EXT_frag_depth on OpenGL ES 2.0 (gl_FragDepthEXT built-in variable, before OpenGL ES 3.0)
1043 Standard_Boolean extDrawBuffers; //!< GL_EXT_draw_buffers
1044 OpenGl_ExtGS* extGS; //!< GL_EXT_geometry_shader4
1045 Standard_Boolean extBgra; //!< GL_EXT_bgra or GL_EXT_texture_format_BGRA8888 on OpenGL ES
1046 Standard_Boolean extAnis; //!< GL_EXT_texture_filter_anisotropic
1047 Standard_Boolean extPDS; //!< GL_EXT_packed_depth_stencil
1048 Standard_Boolean atiMem; //!< GL_ATI_meminfo
1049 Standard_Boolean nvxMem; //!< GL_NVX_gpu_memory_info
1050 Standard_Boolean oesSampleVariables; //!< GL_OES_sample_variables
8c3237d4 1051 Standard_Boolean oesStdDerivatives; //!< GL_OES_standard_derivatives
5f8b738e 1052
8613985b 1053public: //! @name public properties tracking current state
1054
1055 OpenGl_MatrixState<Standard_ShortReal> ModelWorldState; //!< state of orientation matrix
1056 OpenGl_MatrixState<Standard_ShortReal> WorldViewState; //!< state of orientation matrix
1057 OpenGl_MatrixState<Standard_ShortReal> ProjectionState; //!< state of projection matrix
1058
5e27df78 1059private: // system-dependent fields
2166f0fa 1060
da8bb41d 1061#if defined(HAVE_EGL)
1062 Aspect_Drawable myWindow; //!< EGL surface : EGLSurface
1063 Aspect_Display myDisplay; //!< EGL connection to the Display : EGLDisplay
1064 Aspect_RenderingContext myGContext; //!< EGL rendering context : EGLContext
1065#elif defined(_WIN32)
2bd4c032 1066 Aspect_Handle myWindow; //!< window handle (owner of GL context) : HWND
1067 Aspect_Handle myWindowDC; //!< Device Descriptor handle : HDC
1068 Aspect_RenderingContext myGContext; //!< Rendering Context handle : HGLRC
4fe56619 1069#elif defined(__APPLE__) && !defined(MACOSX_USE_GLX)
a2e4f780 1070 #if defined(TARGET_OS_IPHONE) && TARGET_OS_IPHONE
1071 EAGLContext* myGContext; //!< Rendering Context handle
1072 #else
1073 NSOpenGLContext* myGContext; //!< Rendering Context handle
1074 #endif
2bd4c032 1075#else
1076 Aspect_Drawable myWindow; //!< window handle (owner of GL context) : GLXDrawable
1077 Aspect_Display myDisplay; //!< connection to the X-server : Display*
1078 Aspect_RenderingContext myGContext; //!< X-GLX rendering context : GLXContext
1079#endif
1080
5e27df78 1081private: // context info
1082
c04c30b3 1083 typedef NCollection_Shared< NCollection_DataMap<TCollection_AsciiString, Standard_Integer> > OpenGl_DelayReleaseMap;
c04c30b3 1084 typedef NCollection_Shared< NCollection_List<Handle(OpenGl_Resource)> > OpenGl_ResourcesStack;
5e27df78 1085
a174a3c5 1086 Handle(OpenGl_ResourcesMap) mySharedResources; //!< shared resources with unique identification key
1087 Handle(OpenGl_DelayReleaseMap) myDelayed; //!< shared resources for delayed release
3125ebb6 1088 Handle(OpenGl_ResourcesStack) myUnusedResources; //!< stack of resources for delayed clean up
5e27df78 1089
30f0ad28 1090 OpenGl_Clipping myClippingState; //!< state of clip planes
4269bd1b 1091
7d9e854b 1092 void* myGlLibHandle; //!< optional handle to GL library
01ca42b2 1093 NCollection_Handle<OpenGl_GlFunctions>
7d9e854b 1094 myFuncs; //!< mega structure for all GL functions
1095 Standard_Integer myAnisoMax; //!< maximum level of anisotropy texture filter
1096 Standard_Integer myTexClamp; //!< either GL_CLAMP_TO_EDGE (1.2+) or GL_CLAMP (1.1)
1097 Standard_Integer myMaxTexDim; //!< value for GL_MAX_TEXTURE_SIZE
cc8cbabe 1098 Standard_Integer myMaxTexCombined; //!< value for GL_MAX_COMBINED_TEXTURE_IMAGE_UNITS
5c225e8e 1099 Standard_Integer myMaxTexUnitsFFP; //!< value for GL_MAX_TEXTURE_UNITS (fixed-function pipeline only)
6997ff1c 1100 Standard_Integer myMaxDumpSizeX; //!< maximum FBO width for image dump
1101 Standard_Integer myMaxDumpSizeY; //!< maximum FBO height for image dump
7d9e854b 1102 Standard_Integer myMaxClipPlanes; //!< value for GL_MAX_CLIP_PLANES
3c4b62a4 1103 Standard_Integer myMaxMsaaSamples; //!< value for GL_MAX_SAMPLES
a1073ae2 1104 Standard_Integer myMaxDrawBuffers; //!< value for GL_MAX_DRAW_BUFFERS
1105 Standard_Integer myMaxColorAttachments; //!< value for GL_MAX_COLOR_ATTACHMENTS
7d9e854b 1106 Standard_Integer myGlVerMajor; //!< cached GL version major number
1107 Standard_Integer myGlVerMinor; //!< cached GL version minor number
1108 Standard_Boolean myIsInitialized; //!< flag indicates initialization state
1109 Standard_Boolean myIsStereoBuffers; //!< context supports stereo buffering
1110 Standard_Boolean myIsGlNormalizeEnabled; //!< GL_NORMALIZE flag
1111 //!< Used to tell OpenGl that normals should be normalized
72f6dc61 1112 Graphic3d_TextureUnit mySpriteTexUnit; //!< sampler2D occSamplerPointSprite, texture unit for point sprite texture
2166f0fa 1113
e084dbbc 1114 Standard_Boolean myHasRayTracing; //! indicates whether ray tracing mode is supported
1115 Standard_Boolean myHasRayTracingTextures; //! indicates whether textures in ray tracing mode are supported
1116 Standard_Boolean myHasRayTracingAdaptiveSampling; //! indicates whether adaptive screen sampling in ray tracing mode is supported
1117 Standard_Boolean myHasRayTracingAdaptiveSamplingAtomic; //! indicates whether atomic adaptive screen sampling in ray tracing mode is supported
3a9b5dc8 1118
67312b79 1119 Standard_Boolean myHasPBR; //!< indicates whether PBR shading model is supported
72f6dc61 1120 Graphic3d_TextureUnit myPBREnvLUTTexUnit; //!< sampler2D occEnvLUT, texture unit where environment lookup table is expected to be binded (0 if PBR is not supported)
1121 Graphic3d_TextureUnit myPBRDiffIBLMapSHTexUnit; //!< sampler2D occDiffIBLMapSHCoeffs, texture unit where diffuse (irradiance) IBL map's spherical harmonics coefficients is expected to be binded
67312b79 1122 //! (0 if PBR is not supported)
72f6dc61 1123 Graphic3d_TextureUnit myPBRSpecIBLMapTexUnit; //!< samplerCube occSpecIBLMap, texture unit where specular IBL map is expected to be binded (0 if PBR is not supported)
67312b79 1124
30f0ad28 1125 Handle(OpenGl_ShaderManager) myShaderManager; //! support object for managing shader programs
1126
7d3e64ef 1127private: //! @name fields tracking current state
1128
15669413 1129 Handle(OpenGl_FrameStats) myFrameStats; //!< structure accumulating frame statistics
6d0e6be5 1130 Handle(OpenGl_ShaderProgram) myActiveProgram; //!< currently active GLSL program
cc8cbabe 1131 Handle(OpenGl_TextureSet) myActiveTextures; //!< currently bound textures
1132 //!< currently active sampler objects
72f6dc61 1133 Standard_Integer myActiveMockTextures; //!< currently active mock sampler objects
6d0e6be5 1134 Handle(OpenGl_FrameBuffer) myDefaultFbo; //!< default Frame Buffer Object
1135 Handle(OpenGl_LineAttributes) myHatchStyles; //!< resource holding predefined hatch styles patterns
72f6dc61 1136 Handle(OpenGl_Texture) myTextureRgbaBlack;//!< mock black texture returning (0, 0, 0, 0)
1137 Handle(OpenGl_Texture) myTextureRgbaWhite;//!< mock white texture returning (1, 1, 1, 1)
3bffef55 1138 Standard_Integer myViewport[4]; //!< current viewport
56689b27 1139 Standard_Integer myViewportVirt[4]; //!< virtual viewport
6d0e6be5 1140 Standard_Integer myPointSpriteOrig; //!< GL_POINT_SPRITE_COORD_ORIGIN state (GL_UPPER_LEFT by default)
1141 Standard_Integer myRenderMode; //!< value for active rendering mode
1142 Standard_Integer myPolygonMode; //!< currently used polygon rasterization mode (glPolygonMode)
8d1a539c 1143 Graphic3d_PolygonOffset myPolygonOffset; //!< currently applied polygon offset
6d0e6be5 1144 bool myToCullBackFaces; //!< back face culling mode enabled state (glIsEnabled (GL_CULL_FACE))
1145 Standard_Integer myReadBuffer; //!< current read buffer
c3487460 1146 NCollection_Array1<Standard_Integer>
1147 myDrawBuffers; //!< current draw buffers
6d0e6be5 1148 unsigned int myDefaultVao; //!< default Vertex Array Object
f88457e6 1149 Standard_Boolean myColorMask; //!< flag indicating writing into color buffer is enabled or disabled (glColorMask)
2a332745 1150 Standard_Boolean myAllowAlphaToCov; //!< flag allowing GL_SAMPLE_ALPHA_TO_COVERAGE usage
c40eb6b9 1151 Standard_Boolean myAlphaToCoverage; //!< flag indicating GL_SAMPLE_ALPHA_TO_COVERAGE state
6d0e6be5 1152 Standard_Boolean myIsGlDebugCtx; //!< debug context initialization state
ba00aab7 1153 Standard_Boolean myIsSRgbWindow; //!< indicates that window buffer is sRGB-ready
1154 Standard_Boolean myIsSRgbActive; //!< flag indicating GL_FRAMEBUFFER_SRGB state
6d0e6be5 1155 TCollection_AsciiString myVendor; //!< Graphics Driver's vendor
1156 TColStd_PackedMapOfInteger myFilters[6]; //!< messages suppressing filter (for sources from GL_DEBUG_SOURCE_API_ARB to GL_DEBUG_SOURCE_OTHER_ARB)
56689b27 1157 unsigned int myResolution; //!< Pixels density (PPI), defines scaling factor for parameters like text size
6d0e6be5 1158 Standard_ShortReal myResolutionRatio; //!< scaling factor for parameters like text size
56689b27 1159 //! to be properly displayed on device (screen / printer)
1160 Standard_ShortReal myLineWidthScale; //!< scaling factor for line width
2a332745 1161 Standard_ShortReal myLineFeather; //!< line feater width in pixels
56689b27 1162 Standard_ShortReal myRenderScale; //!< scaling factor for rendering resolution
1163 Standard_ShortReal myRenderScaleInv; //!< scaling factor for rendering resolution (inverted value)
8613985b 1164 OpenGl_Material myMatFront; //!< current front material state (cached to reduce GL context updates)
1165 OpenGl_Material myMatBack; //!< current back material state
c827ea3a 1166
5e27df78 1167private:
1168
1169 //! Copying allowed only within Handles
1170 OpenGl_Context (const OpenGl_Context& );
1171 OpenGl_Context& operator= (const OpenGl_Context& );
1172
2166f0fa
SK
1173};
1174
1175#endif // _OpenGl_Context_H__