5a8d6f0270e76d4c612ef9ad9476a9666d3486a8
[occt.git] / src / OpenGl / OpenGl_View.hxx
1 // Created on: 2011-09-20
2 // Created by: Sergey ZERCHANINOV
3 // Copyright (c) 2011-2014 OPEN CASCADE SAS
4 //
5 // This file is part of Open CASCADE Technology software library.
6 //
7 // This library is free software; you can redistribute it and/or modify it under
8 // the terms of the GNU Lesser General Public License version 2.1 as published
9 // by the Free Software Foundation, with special exception defined in the file
10 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
11 // distribution for complete text of the license and disclaimer of any warranty.
12 //
13 // Alternatively, this file may be used under the terms of Open CASCADE
14 // commercial license or contractual agreement.
15
16 #ifndef _OpenGl_View_Header
17 #define _OpenGl_View_Header
18
19 #include <Standard_Transient.hxx>
20 #include <Standard_Type.hxx>
21
22 #include <TColStd_Array2OfReal.hxx>
23 #include <NCollection_List.hxx>
24 #include <math_BullardGenerator.hxx>
25
26 #include <Quantity_NameOfColor.hxx>
27 #include <Aspect_FillMethod.hxx>
28 #include <Aspect_GradientFillMethod.hxx>
29
30 #include <Graphic3d_CView.hxx>
31 #include <Graphic3d_CullingTool.hxx>
32 #include <Graphic3d_GraduatedTrihedron.hxx>
33 #include <Graphic3d_SequenceOfHClipPlane.hxx>
34 #include <Graphic3d_ToneMappingMethod.hxx>
35 #include <Graphic3d_TypeOfShadingModel.hxx>
36 #include <Graphic3d_WorldViewProjState.hxx>
37 #include <Graphic3d_ZLayerSettings.hxx>
38
39 #include <OpenGl_Aspects.hxx>
40 #include <OpenGl_BackgroundArray.hxx>
41 #include <OpenGl_Context.hxx>
42 #include <OpenGl_FrameBuffer.hxx>
43 #include <OpenGl_FrameStatsPrs.hxx>
44 #include <OpenGl_GraduatedTrihedron.hxx>
45 #include <OpenGl_LayerList.hxx>
46 #include <OpenGl_LineAttributes.hxx>
47 #include <OpenGl_SceneGeometry.hxx>
48 #include <OpenGl_Structure.hxx>
49 #include <OpenGl_Window.hxx>
50 #include <OpenGl_Workspace.hxx>
51 #include <OpenGl_TileSampler.hxx>
52
53 #include <map>
54 #include <set>
55
56 struct OpenGl_Matrix;
57
58 class Graphic3d_StructureManager;
59 class OpenGl_DepthPeeling;
60 class OpenGl_GraphicDriver;
61 class OpenGl_PBREnvironment;
62 class OpenGl_StateCounter;
63 class OpenGl_ShadowMap;
64 class OpenGl_ShadowMapArray;
65 class OpenGl_TriangleSet;
66 class OpenGl_Workspace;
67 class OpenGl_View;
68
69 DEFINE_STANDARD_HANDLE(OpenGl_View,Graphic3d_CView)
70
71 //! Implementation of OpenGl view.
72 class OpenGl_View : public Graphic3d_CView
73 {
74
75 public:
76
77   //! Constructor.
78   Standard_EXPORT OpenGl_View (const Handle(Graphic3d_StructureManager)& theMgr,
79                                const Handle(OpenGl_GraphicDriver)& theDriver,
80                                const Handle(OpenGl_Caps)& theCaps,
81                                OpenGl_StateCounter* theCounter);
82
83   //! Default destructor.
84   Standard_EXPORT virtual ~OpenGl_View();
85
86   //! Release OpenGL resources.
87   Standard_EXPORT void ReleaseGlResources (const Handle(OpenGl_Context)& theCtx);
88
89   //! Deletes and erases the view.
90   Standard_EXPORT virtual void Remove() Standard_OVERRIDE;
91
92   //! @param theDrawToFrontBuffer Advanced option to modify rendering mode:
93   //! 1. TRUE.  Drawing immediate mode structures directly to the front buffer over the scene image.
94   //! Fast, so preferred for interactive work (used by default).
95   //! However these extra drawings will be missed in image dump since it is performed from back buffer.
96   //! Notice that since no pre-buffering used the V-Sync will be ignored and rendering could be seen
97   //! in run-time (in case of slow hardware) and/or tearing may appear.
98   //! So this is strongly recommended to draw only simple (fast) structures.
99   //! 2. FALSE. Drawing immediate mode structures to the back buffer.
100   //! The complete scene is redrawn first, so this mode is slower if scene contains complex data and/or V-Sync
101   //! is turned on. But it works in any case and is especially useful for view dump because the dump image is read
102   //! from the back buffer.
103   //! @return previous mode.
104   Standard_EXPORT Standard_Boolean SetImmediateModeDrawToFront (const Standard_Boolean theDrawToFrontBuffer) Standard_OVERRIDE;
105
106   //! Creates and maps rendering window to the view.
107   //! @param theWindow [in] the window.
108   //! @param theContext [in] the rendering context. If NULL the context will be created internally.
109   Standard_EXPORT virtual void SetWindow (const Handle(Aspect_Window)&  theWindow,
110                                           const Aspect_RenderingContext theContext) Standard_OVERRIDE;
111
112   //! Returns window associated with the view.
113   virtual Handle(Aspect_Window) Window() const Standard_OVERRIDE
114   { return myWindow->PlatformWindow(); }
115
116   //! Returns True if the window associated to the view is defined.
117   virtual Standard_Boolean IsDefined() const Standard_OVERRIDE
118   { return !myWindow.IsNull(); }
119
120   //! Handle changing size of the rendering window.
121   Standard_EXPORT virtual void Resized() Standard_OVERRIDE;
122
123   //! Redraw content of the view.
124   Standard_EXPORT virtual void Redraw() Standard_OVERRIDE;
125
126   //! Redraw immediate content of the view.
127   Standard_EXPORT virtual void RedrawImmediate() Standard_OVERRIDE;
128
129   //! Marks BVH tree for given priority list as dirty and marks primitive set for rebuild.
130   Standard_EXPORT virtual void Invalidate() Standard_OVERRIDE;
131
132   //! Return true if view content cache has been invalidated.
133   virtual Standard_Boolean IsInvalidated() Standard_OVERRIDE { return !myBackBufferRestored; }
134
135   //! Dump active rendering buffer into specified memory buffer.
136   //! In Ray-Tracing allow to get a raw HDR buffer using Graphic3d_BT_RGB_RayTraceHdrLeft buffer type,
137   //! only Left view will be dumped ignoring stereoscopic parameter.
138   Standard_EXPORT virtual Standard_Boolean BufferDump (Image_PixMap& theImage,
139                                                        const Graphic3d_BufferType& theBufferType) Standard_OVERRIDE;
140
141   //! Marks BVH tree and the set of BVH primitives of correspondent priority list with id theLayerId as outdated.
142   Standard_EXPORT virtual void InvalidateBVHData (const Graphic3d_ZLayerId theLayerId) Standard_OVERRIDE;
143
144   //! Add a layer to the view.
145   //! @param theNewLayerId [in] id of new layer, should be > 0 (negative values are reserved for default layers).
146   //! @param theSettings   [in] new layer settings
147   //! @param theLayerAfter [in] id of layer to append new layer before
148   Standard_EXPORT virtual void InsertLayerBefore (const Graphic3d_ZLayerId theLayerId,
149                                                   const Graphic3d_ZLayerSettings& theSettings,
150                                                   const Graphic3d_ZLayerId theLayerAfter) Standard_OVERRIDE;
151
152   //! Add a layer to the view.
153   //! @param theNewLayerId  [in] id of new layer, should be > 0 (negative values are reserved for default layers).
154   //! @param theSettings    [in] new layer settings
155   //! @param theLayerBefore [in] id of layer to append new layer after
156   Standard_EXPORT virtual void InsertLayerAfter (const Graphic3d_ZLayerId theNewLayerId,
157                                                  const Graphic3d_ZLayerSettings& theSettings,
158                                                  const Graphic3d_ZLayerId theLayerBefore) Standard_OVERRIDE;
159
160   //! Remove a z layer with the given ID.
161   Standard_EXPORT virtual void RemoveZLayer (const Graphic3d_ZLayerId theLayerId) Standard_OVERRIDE;
162
163   //! Sets the settings for a single Z layer of specified view.
164   Standard_EXPORT virtual void SetZLayerSettings (const Graphic3d_ZLayerId theLayerId,
165                                                   const Graphic3d_ZLayerSettings& theSettings) Standard_OVERRIDE;
166
167   //! Returns the maximum Z layer ID.
168   //! First layer ID is Graphic3d_ZLayerId_Default, last ID is ZLayerMax().
169   Standard_EXPORT virtual Standard_Integer ZLayerMax() const Standard_OVERRIDE;
170
171   //! Returns the list of layers.
172   Standard_EXPORT virtual const NCollection_List<Handle(Graphic3d_Layer)>& Layers() const Standard_OVERRIDE;
173
174   //! Returns layer with given ID or NULL if undefined.
175   Standard_EXPORT virtual Handle(Graphic3d_Layer) Layer (const Graphic3d_ZLayerId theLayerId) const Standard_OVERRIDE;
176
177   //! Returns the bounding box of all structures displayed in the view.
178   //! If theToIncludeAuxiliary is TRUE, then the boundary box also includes minimum and maximum limits
179   //! of graphical elements forming parts of infinite and other auxiliary structures.
180   //! @param theToIncludeAuxiliary consider also auxiliary presentations (with infinite flag or with trihedron transformation persistence)
181   //! @return computed bounding box
182   Standard_EXPORT virtual Bnd_Box MinMaxValues (const Standard_Boolean theToIncludeAuxiliary) const Standard_OVERRIDE;
183
184   //! Returns pointer to an assigned framebuffer object.
185   Standard_EXPORT virtual Handle(Standard_Transient) FBO() const Standard_OVERRIDE;
186
187   //! Sets framebuffer object for offscreen rendering.
188   Standard_EXPORT virtual void SetFBO (const Handle(Standard_Transient)& theFbo) Standard_OVERRIDE;
189
190   //! Generate offscreen FBO in the graphic library.
191   //! If not supported on hardware returns NULL.
192   Standard_EXPORT virtual Handle(Standard_Transient) FBOCreate (const Standard_Integer theWidth,
193                                                                 const Standard_Integer theHeight) Standard_OVERRIDE;
194
195   //! Remove offscreen FBO from the graphic library
196   Standard_EXPORT virtual void FBORelease (Handle(Standard_Transient)& theFbo) Standard_OVERRIDE;
197
198   //! Read offscreen FBO configuration.
199   Standard_EXPORT virtual void FBOGetDimensions (const Handle(Standard_Transient)& theFbo,
200                                                  Standard_Integer& theWidth,
201                                                  Standard_Integer& theHeight,
202                                                  Standard_Integer& theWidthMax,
203                                                  Standard_Integer& theHeightMax) Standard_OVERRIDE;
204
205   //! Change offscreen FBO viewport.
206   Standard_EXPORT virtual void FBOChangeViewport (const Handle(Standard_Transient)& theFbo,
207                                                   const Standard_Integer theWidth,
208                                                   const Standard_Integer theHeight) Standard_OVERRIDE;
209
210   //! Returns additional buffers for depth peeling OIT.
211   const Handle(OpenGl_DepthPeeling)& DepthPeelingFbos() const { return myDepthPeelingFbos; }
212
213 public:
214
215   //! Returns gradient background fill colors.
216   Standard_EXPORT virtual Aspect_GradientBackground GradientBackground() const Standard_OVERRIDE;
217
218   //! Sets gradient background fill colors.
219   Standard_EXPORT virtual void SetGradientBackground (const Aspect_GradientBackground& theBackground) Standard_OVERRIDE;
220
221   //! Returns background image texture map.
222   virtual Handle(Graphic3d_TextureMap) BackgroundImage() Standard_OVERRIDE { return myBackgroundImage; }
223
224   //! Sets image texture or environment cubemap as backround.
225   //! @param theTextureMap [in] source to set a background;
226   //!                           should be either Graphic3d_Texture2D or Graphic3d_CubeMap
227   //! @param theToUpdatePBREnv [in] defines whether IBL maps will be generated or not
228   //!                               (see GeneratePBREnvironment())
229   Standard_EXPORT virtual void SetBackgroundImage (const Handle(Graphic3d_TextureMap)& theTextureMap,
230                                                    Standard_Boolean theToUpdatePBREnv = Standard_True) Standard_OVERRIDE;
231
232   //! Returns background image fill style.
233   Standard_EXPORT virtual Aspect_FillMethod BackgroundImageStyle() const Standard_OVERRIDE;
234
235   //! Sets background image fill style.
236   Standard_EXPORT virtual void SetBackgroundImageStyle (const Aspect_FillMethod theFillStyle) Standard_OVERRIDE;
237
238   //! Returns cubemap being set last time on background.
239   Standard_EXPORT Handle(Graphic3d_CubeMap) BackgroundCubeMap() const Standard_OVERRIDE;
240
241   //! Generates PBR specular probe and irradiance map
242   //! in order to provide environment indirect illumination in PBR shading model (Image Based Lighting).
243   //! The source of environment data is background cubemap.
244   //! If PBR is unavailable it does nothing.
245   //! If PBR is available but there is no cubemap being set to background it clears all IBL maps (see 'ClearPBREnvironment').
246   virtual void GeneratePBREnvironment() Standard_OVERRIDE { myPBREnvRequest = OpenGl_PBREnvRequest_BAKE; }
247
248   //! Fills PBR specular probe and irradiance map with white color.
249   //! So that environment indirect illumination will be constant
250   //! and will be fully controlled by ambient light sources.
251   //! If PBR is unavailable it does nothing.
252   virtual void ClearPBREnvironment() Standard_OVERRIDE { myPBREnvRequest = OpenGl_PBREnvRequest_CLEAR; }
253
254   //! Returns number of mipmap levels used in specular IBL map.
255   //! 0 if PBR environment is not created.
256   Standard_EXPORT unsigned int SpecIBLMapLevels() const;
257
258   //! Returns environment texture set for the view.
259   virtual Handle(Graphic3d_TextureEnv) TextureEnv() const Standard_OVERRIDE { return myTextureEnvData; }
260
261   //! Sets environment texture for the view.
262   Standard_EXPORT virtual void SetTextureEnv (const Handle(Graphic3d_TextureEnv)& theTextureEnv) Standard_OVERRIDE;
263
264   //! Returns local camera origin currently set for rendering, might be modified during rendering.
265   const gp_XYZ& LocalOrigin() const { return myLocalOrigin; }
266
267   //! Setup local camera origin currently set for rendering.
268   Standard_EXPORT void SetLocalOrigin (const gp_XYZ& theOrigin);
269
270   //! Returns list of lights of the view.
271   virtual const Handle(Graphic3d_LightSet)& Lights() const Standard_OVERRIDE { return myLights; }
272
273   //! Sets list of lights for the view.
274   virtual void SetLights (const Handle(Graphic3d_LightSet)& theLights) Standard_OVERRIDE
275   {
276     myLights = theLights;
277     myCurrLightSourceState = myStateCounter->Increment();
278   }
279
280   //! Returns list of clip planes set for the view.
281   virtual const Handle(Graphic3d_SequenceOfHClipPlane)& ClipPlanes() const Standard_OVERRIDE { return myClipPlanes; }
282
283   //! Sets list of clip planes for the view.
284   virtual void SetClipPlanes (const Handle(Graphic3d_SequenceOfHClipPlane)& thePlanes) Standard_OVERRIDE { myClipPlanes = thePlanes; }
285
286   //! Fill in the dictionary with diagnostic info.
287   //! Should be called within rendering thread.
288   //!
289   //! This API should be used only for user output or for creating automated reports.
290   //! The format of returned information (e.g. key-value layout)
291   //! is NOT part of this API and can be changed at any time.
292   //! Thus application should not parse returned information to weed out specific parameters.
293   Standard_EXPORT virtual void DiagnosticInformation (TColStd_IndexedDataMapOfStringString& theDict,
294                                                       Graphic3d_DiagnosticInfo theFlags) const Standard_OVERRIDE;
295
296   //! Returns string with statistic performance info.
297   Standard_EXPORT virtual TCollection_AsciiString StatisticInformation() const Standard_OVERRIDE;
298
299   //! Fills in the dictionary with statistic performance info.
300   Standard_EXPORT virtual void StatisticInformation (TColStd_IndexedDataMapOfStringString& theDict) const Standard_OVERRIDE;
301
302 public:
303
304   //! Returns background color.
305   const Quantity_ColorRGBA& BackgroundColor() const { return myBgColor; }
306
307   //! Change graduated trihedron.
308   OpenGl_GraduatedTrihedron& ChangeGraduatedTrihedron() { return myGraduatedTrihedron; }
309
310   void SetTextureEnv (const Handle(OpenGl_Context)&       theCtx,
311                       const Handle(Graphic3d_TextureEnv)& theTexture);
312
313   void SetBackgroundTextureStyle (const Aspect_FillMethod FillStyle);
314
315   void SetBackgroundGradient (const Quantity_Color& AColor1, const Quantity_Color& AColor2, const Aspect_GradientFillMethod AType);
316
317   void SetBackgroundGradientType (const Aspect_GradientFillMethod AType);
318
319   //! Returns list of OpenGL Z-layers.
320   const OpenGl_LayerList& LayerList() const { return myZLayers; }
321
322   //! Returns OpenGL window implementation.
323   const Handle(OpenGl_Window)& GlWindow() const { return myWindow; }
324
325   //! Returns OpenGL environment map.
326   const Handle(OpenGl_TextureSet)& GlTextureEnv() const { return myTextureEnv; }
327
328   //! Returns selector for BVH tree, providing a possibility to store information
329   //! about current view volume and to detect which objects are overlapping it.
330   const Graphic3d_CullingTool& BVHTreeSelector() const { return myBVHSelector; }
331
332   //! Returns true if there are immediate structures to display
333   bool HasImmediateStructures() const
334   {
335     return myZLayers.NbImmediateStructures() != 0;
336   }
337
338 public: //! @name obsolete Graduated Trihedron functionality
339
340   //! Displays Graduated Trihedron.
341   Standard_EXPORT virtual void GraduatedTrihedronDisplay (const Graphic3d_GraduatedTrihedron& theTrihedronData) Standard_OVERRIDE;
342
343   //! Erases Graduated Trihedron.
344   Standard_EXPORT virtual void GraduatedTrihedronErase() Standard_OVERRIDE;
345
346   //! Sets minimum and maximum points of scene bounding box for Graduated Trihedron stored in graphic view object.
347   //! @param theMin [in] the minimum point of scene.
348   //! @param theMax [in] the maximum point of scene.
349   Standard_EXPORT virtual void GraduatedTrihedronMinMaxValues (const Graphic3d_Vec3 theMin, const Graphic3d_Vec3 theMax) Standard_OVERRIDE;
350
351 protected: //! @name Internal methods for managing GL resources
352
353   //! Initializes OpenGl resource for environment texture.
354   void initTextureEnv (const Handle(OpenGl_Context)& theContext);
355
356 protected: //! @name low-level redrawing sub-routines
357
358   //! Prepare frame buffers for rendering.
359   Standard_EXPORT virtual bool prepareFrameBuffers (Graphic3d_Camera::Projection& theProj);
360
361   //! Redraws view for the given monographic camera projection, or left/right eye.
362   Standard_EXPORT virtual void redraw (const Graphic3d_Camera::Projection theProjection,
363                                        OpenGl_FrameBuffer*                theReadDrawFbo,
364                                        OpenGl_FrameBuffer*                theOitAccumFbo);
365
366   //! Redraws view for the given monographic camera projection, or left/right eye.
367   //!
368   //! Method will blit snapshot containing main scene (myMainSceneFbos or BackBuffer)
369   //! into presentation buffer (myMainSceneFbos -> offscreen FBO or
370   //! myMainSceneFbos -> BackBuffer or BackBuffer -> FrontBuffer),
371   //! and redraw immediate structures on top.
372   //!
373   //! When scene caching is disabled (myTransientDrawToFront, no double buffer in window, etc.),
374   //! the first step (blitting) will be skipped.
375   //!
376   //! @return false if immediate structures has been rendered directly into FrontBuffer
377   //! and Buffer Swap should not be called.
378   Standard_EXPORT virtual bool redrawImmediate (const Graphic3d_Camera::Projection theProjection,
379                                                 OpenGl_FrameBuffer* theReadFbo,
380                                                 OpenGl_FrameBuffer* theDrawFbo,
381                                                 OpenGl_FrameBuffer* theOitAccumFbo,
382                                                 const Standard_Boolean theIsPartialUpdate = Standard_False);
383
384   //! Blit image from/to specified buffers.
385   Standard_EXPORT bool blitBuffers (OpenGl_FrameBuffer*    theReadFbo,
386                                     OpenGl_FrameBuffer*    theDrawFbo,
387                                     const Standard_Boolean theToFlip = Standard_False);
388
389   //! Setup default FBO.
390   Standard_EXPORT void bindDefaultFbo (OpenGl_FrameBuffer* theCustomFbo = NULL);
391
392 protected: //! @name Rendering of GL graphics (with prepared drawing buffer).
393
394   //! Renders the graphical contents of the view into the preprepared shadowmap framebuffer.
395   //! @param theShadowMap [in] the framebuffer for rendering shadowmap.
396   Standard_EXPORT virtual void renderShadowMap (const Handle(OpenGl_ShadowMap)& theShadowMap);
397
398   //! Renders the graphical contents of the view into the preprepared window or framebuffer.
399   //! @param theProjection [in] the projection that should be used for rendering.
400   //! @param theReadDrawFbo [in] the framebuffer for rendering graphics.
401   //! @param theOitAccumFbo [in] the framebuffer for accumulating color and coverage for OIT process.
402   //! @param theToDrawImmediate [in] the flag indicates whether the rendering performs in immediate mode.
403   Standard_EXPORT virtual void render (Graphic3d_Camera::Projection theProjection,
404                                        OpenGl_FrameBuffer*          theReadDrawFbo,
405                                        OpenGl_FrameBuffer*          theOitAccumFbo,
406                                        const Standard_Boolean       theToDrawImmediate);
407
408   //! Renders the graphical scene.
409   //! @param theProjection [in] the projection that is used for rendering.
410   //! @param theReadDrawFbo [in] the framebuffer for rendering graphics.
411   //! @param theOitAccumFbo [in] the framebuffer for accumulating color and coverage for OIT process.
412   //! @param theToDrawImmediate [in] the flag indicates whether the rendering performs in immediate mode.
413   Standard_EXPORT virtual void renderScene (Graphic3d_Camera::Projection theProjection,
414                                             OpenGl_FrameBuffer*    theReadDrawFbo,
415                                             OpenGl_FrameBuffer*    theOitAccumFbo,
416                                             const Standard_Boolean theToDrawImmediate);
417
418   //! Draw background (gradient / image)
419   Standard_EXPORT virtual void drawBackground (const Handle(OpenGl_Workspace)& theWorkspace,
420                                                Graphic3d_Camera::Projection theProjection);
421
422   //! Render set of structures presented in the view.
423   //! @param theProjection [in] the projection that is used for rendering.
424   //! @param theReadDrawFbo [in] the framebuffer for rendering graphics.
425   //! @param theOitAccumFbo [in] the framebuffer for accumulating color and coverage for OIT process.
426   //! @param theToDrawImmediate [in] the flag indicates whether the rendering performs in immediate mode.
427   Standard_EXPORT virtual void renderStructs (Graphic3d_Camera::Projection theProjection,
428                                               OpenGl_FrameBuffer*    theReadDrawFbo,
429                                               OpenGl_FrameBuffer*    theOitAccumFbo,
430                                               const Standard_Boolean theToDrawImmediate);
431
432   //! Renders trihedron.
433   void renderTrihedron (const Handle(OpenGl_Workspace) &theWorkspace);
434
435   //! Renders frame statistics.
436   void renderFrameStats();
437
438 private:
439
440   //! Adds the structure to display lists of the view.
441   Standard_EXPORT virtual void displayStructure (const Handle(Graphic3d_CStructure)& theStructure,
442                                                  const Standard_Integer thePriority) Standard_OVERRIDE;
443
444   //! Erases the structure from display lists of the view.
445   Standard_EXPORT virtual void eraseStructure (const Handle(Graphic3d_CStructure)& theStructure) Standard_OVERRIDE;
446
447   //! Change Z layer of a structure already presented in view.
448   Standard_EXPORT virtual void changeZLayer (const Handle(Graphic3d_CStructure)& theCStructure,
449                                              const Graphic3d_ZLayerId theNewLayerId) Standard_OVERRIDE;
450
451   //! Changes the priority of a structure within its Z layer in the specified view.
452   Standard_EXPORT virtual void changePriority (const Handle(Graphic3d_CStructure)& theCStructure,
453                                                const Standard_Integer theNewPriority) Standard_OVERRIDE;
454
455 private:
456
457   //! Release sRGB resources (frame-buffers, textures, etc.).
458   void releaseSrgbResources (const Handle(OpenGl_Context)& theCtx);
459
460   //! Copy content of Back buffer to the Front buffer.
461   bool copyBackToFront();
462
463   //! Initialize blit quad.
464   OpenGl_VertexBuffer* initBlitQuad (const Standard_Boolean theToFlip);
465
466   //! Blend together views pair into stereo image.
467   void drawStereoPair (OpenGl_FrameBuffer* theDrawFbo);
468
469   //! Check and update OIT compatibility with current OpenGL context's state.
470   bool checkOitCompatibility (const Handle(OpenGl_Context)& theGlContext,
471                               const Standard_Boolean theMSAA);
472
473   //! Chooses compatible internal color format for OIT frame buffer.
474   bool chooseOitColorConfiguration (const Handle(OpenGl_Context)& theGlContext,
475                                     const Standard_Integer theConfigIndex,
476                                     OpenGl_ColorFormats& theFormats);
477
478 protected:
479
480   OpenGl_GraphicDriver*    myDriver;
481   Handle(OpenGl_Window)    myWindow;
482   Handle(OpenGl_Workspace) myWorkspace;
483   Handle(OpenGl_Caps)      myCaps;
484   Standard_Boolean         myWasRedrawnGL;
485
486   Handle(Graphic3d_SequenceOfHClipPlane) myClipPlanes;
487   gp_XYZ                          myLocalOrigin;
488   Handle(OpenGl_FrameBuffer)      myFBO;
489   Standard_Boolean                myToShowGradTrihedron;
490   Handle(Graphic3d_TextureMap)    myBackgroundImage;
491   Handle(Graphic3d_TextureEnv)    myTextureEnvData;
492   Graphic3d_GraduatedTrihedron    myGTrihedronData;
493
494   Handle(Graphic3d_LightSet)      myNoShadingLight;
495   Handle(Graphic3d_LightSet)      myLights;
496   OpenGl_LayerList                myZLayers; //!< main list of displayed structure, sorted by layers
497
498   Graphic3d_WorldViewProjState    myWorldViewProjState; //!< camera modification state
499   OpenGl_StateCounter*            myStateCounter;
500   Standard_Size                   myCurrLightSourceState;
501   Standard_Size                   myLightsRevision;
502
503   typedef std::pair<Standard_Size, Standard_Size> StateInfo;
504
505   StateInfo myLastOrientationState;
506   StateInfo myLastViewMappingState;
507   StateInfo myLastLightSourceState;
508
509   //! Is needed for selection of overlapping objects and storage of the current view volume
510   Graphic3d_CullingTool myBVHSelector;
511
512   OpenGl_GraduatedTrihedron myGraduatedTrihedron;
513   OpenGl_FrameStatsPrs      myFrameStatsPrs;
514
515   Handle(OpenGl_TextureSet) myTextureEnv;
516
517   //! Framebuffers for OpenGL output.
518   Handle(OpenGl_FrameBuffer) myOpenGlFBO;
519   Handle(OpenGl_FrameBuffer) myOpenGlFBO2;
520
521 protected: //! @name Rendering properties
522
523   //! Two framebuffers (left and right views) store cached main presentation
524   //! of the view (without presentation of immediate layers).
525   Standard_Integer           mySRgbState;             //!< track sRGB state
526   GLint                      myFboColorFormat;        //!< sized format for color attachments
527   GLint                      myFboDepthFormat;        //!< sized format for depth-stencil attachments
528   OpenGl_ColorFormats        myFboOitColorConfig;     //!< selected color format configuration for OIT color attachments
529   Handle(OpenGl_FrameBuffer) myMainSceneFbos[2];
530   Handle(OpenGl_FrameBuffer) myMainSceneFbosOit[2];      //!< Additional buffers for transparent draw of main layer.
531   Handle(OpenGl_FrameBuffer) myImmediateSceneFbos[2];    //!< Additional buffers for immediate layer in stereo mode.
532   Handle(OpenGl_FrameBuffer) myImmediateSceneFbosOit[2]; //!< Additional buffers for transparency draw of immediate layer.
533   Handle(OpenGl_FrameBuffer) myXrSceneFbo;               //!< additional FBO (without MSAA) for submitting to XR
534   Handle(OpenGl_DepthPeeling)   myDepthPeelingFbos;   //!< additional buffers for depth peeling
535   Handle(OpenGl_ShadowMapArray) myShadowMaps;         //!< additional FBOs for shadow map rendering
536   OpenGl_VertexBuffer        myFullScreenQuad;        //!< Vertices for full-screen quad rendering.
537   OpenGl_VertexBuffer        myFullScreenQuadFlip;
538   Standard_Boolean           myToFlipOutput;          //!< Flag to draw result image upside-down
539   unsigned int               myFrameCounter;          //!< redraw counter, for debugging
540   Standard_Boolean           myHasFboBlit;            //!< disable FBOs on failure
541   Standard_Boolean           myToDisableOIT;          //!< disable OIT on failure
542   Standard_Boolean           myToDisableOITMSAA;      //!< disable OIT with MSAA on failure
543   Standard_Boolean           myToDisableMSAA;         //!< disable MSAA after failure
544   Standard_Boolean           myTransientDrawToFront; //!< optimization flag for immediate mode (to render directly to the front buffer)
545   Standard_Boolean           myBackBufferRestored;
546   Standard_Boolean           myIsImmediateDrawn;     //!< flag indicates that immediate mode buffer contains some data
547
548 protected: //! @name Background parameters
549
550   OpenGl_Aspects*            myTextureParams;                     //!< Stores texture and its parameters for textured background
551   OpenGl_Aspects*            myCubeMapParams;                     //!< Stores cubemap and its parameters for cubemap background
552   Handle(Graphic3d_CubeMap)  myBackgroundCubeMap;                 //!< Cubemap has been set as background
553   Graphic3d_TypeOfBackground myBackgroundType;                    //!< Current type of background
554   OpenGl_BackgroundArray*    myBackgrounds[Graphic3d_TypeOfBackground_NB]; //!< Array of primitive arrays of different background types
555
556 protected: //! @name methods related to PBR
557
558   //! Checks whether PBR is available.
559   Standard_EXPORT Standard_Boolean checkPBRAvailability() const;
560
561   //! Generates IBL maps used in PBR pipeline.
562   //! If background cubemap is not set clears all IBL maps.
563   Standard_EXPORT void bakePBREnvironment (const Handle(OpenGl_Context)& theCtx);
564
565   //! Fills all IBL maps with white color.
566   //! So that environment lighting is considered to be constant and is completely controls by ambient light sources.
567   Standard_EXPORT void clearPBREnvironment (const Handle(OpenGl_Context)& theCtx);
568
569   //! Process requests to generate or to clear PBR environment.
570   Standard_EXPORT void processPBREnvRequest (const Handle(OpenGl_Context)& theCtx);
571
572 protected: //! @name fields and types related to PBR
573
574   //! State of PBR environment.
575   enum PBREnvironmentState
576   {
577     OpenGl_PBREnvState_NONEXISTENT,
578     OpenGl_PBREnvState_UNAVAILABLE, // indicates failed try to create PBR environment
579     OpenGl_PBREnvState_CREATED
580   };
581
582   //! Type of action which can be done with PBR environment.
583   enum PBREnvironmentRequest
584   {
585     OpenGl_PBREnvRequest_NONE,
586     OpenGl_PBREnvRequest_BAKE,
587     OpenGl_PBREnvRequest_CLEAR
588   };
589
590   Handle(OpenGl_PBREnvironment) myPBREnvironment; //!< manager of IBL maps used in PBR pipeline
591   PBREnvironmentState           myPBREnvState;    //!< state of PBR environment
592   PBREnvironmentRequest         myPBREnvRequest;  //!< type of action is requested to be done with PBR environment
593
594 protected: //! @name data types related to ray-tracing
595
596   //! Result of OpenGL shaders initialization.
597   enum RaytraceInitStatus
598   {
599     OpenGl_RT_NONE,
600     OpenGl_RT_INIT,
601     OpenGl_RT_FAIL
602   };
603
604   //! Describes update mode (state).
605   enum RaytraceUpdateMode
606   {
607     OpenGl_GUM_CHECK,   //!< check geometry state
608     OpenGl_GUM_PREPARE, //!< collect unchanged objects
609     OpenGl_GUM_REBUILD  //!< rebuild changed and new objects
610   };
611
612   //! Defines frequently used shader variables.
613   enum ShaderVariableIndex
614   {
615     OpenGl_RT_aPosition,
616
617     // camera position
618     OpenGl_RT_uOriginLT,
619     OpenGl_RT_uOriginLB,
620     OpenGl_RT_uOriginRT,
621     OpenGl_RT_uOriginRB,
622     OpenGl_RT_uDirectLT,
623     OpenGl_RT_uDirectLB,
624     OpenGl_RT_uDirectRT,
625     OpenGl_RT_uDirectRB,
626     OpenGl_RT_uViewPrMat,
627     OpenGl_RT_uUnviewMat,
628
629     // 3D scene params
630     OpenGl_RT_uSceneRad,
631     OpenGl_RT_uSceneEps,
632     OpenGl_RT_uLightAmbnt,
633     OpenGl_RT_uLightCount,
634
635     // background params
636     OpenGl_RT_uBackColorTop,
637     OpenGl_RT_uBackColorBot,
638
639     // ray-tracing params
640     OpenGl_RT_uShadowsEnabled,
641     OpenGl_RT_uReflectEnabled,
642     OpenGl_RT_uEnvMapEnabled,
643     OpenGl_RT_uEnvMapForBack,
644     OpenGl_RT_uTexSamplersArray,
645     OpenGl_RT_uBlockedRngEnabled,
646
647     // size of render window
648     OpenGl_RT_uWinSizeX,
649     OpenGl_RT_uWinSizeY,
650
651     // sampled frame params
652     OpenGl_RT_uAccumSamples,
653     OpenGl_RT_uFrameRndSeed,
654
655     // adaptive FSAA params
656     OpenGl_RT_uFsaaOffset,
657     OpenGl_RT_uSamples,
658
659     // images used by ISS mode
660     OpenGl_RT_uRenderImage,
661     OpenGl_RT_uTilesImage,
662     OpenGl_RT_uOffsetImage,
663     OpenGl_RT_uTileSize,
664     OpenGl_RT_uVarianceScaleFactor,
665
666     // maximum radiance value
667     OpenGl_RT_uMaxRadiance,
668
669     OpenGl_RT_NbVariables // special field
670   };
671
672   //! Defines OpenGL image samplers.
673   enum ShaderImageNames
674   {
675     OpenGl_RT_OutputImage = 0,
676     OpenGl_RT_VisualErrorImage = 1,
677     OpenGl_RT_TileOffsetsImage = 2,
678     OpenGl_RT_TileSamplesImage = 3
679   };
680
681   //! Tool class for management of shader sources.
682   class ShaderSource
683   {
684   public:
685
686     //! Default shader prefix - empty string.
687     static const TCollection_AsciiString EMPTY_PREFIX;
688
689     //! Creates new uninitialized shader source.
690     ShaderSource()
691     {
692       //
693     }
694
695   public:
696
697     //! Returns error description in case of load fail.
698     const TCollection_AsciiString& ErrorDescription() const
699     {
700       return myError;
701     }
702
703     //! Returns prefix to insert before the source.
704     const TCollection_AsciiString& Prefix() const
705     {
706       return myPrefix;
707     }
708
709     //! Sets prefix to insert before the source.
710     void SetPrefix (const TCollection_AsciiString& thePrefix)
711     {
712       myPrefix = thePrefix;
713     }
714
715     //! Returns shader source combined with prefix.
716     TCollection_AsciiString Source (const Handle(OpenGl_Context)& theCtx,
717                                     const GLenum theType) const;
718
719     //! Loads shader source from specified files.
720     Standard_Boolean LoadFromFiles (const TCollection_AsciiString* theFileNames, const TCollection_AsciiString& thePrefix = EMPTY_PREFIX);
721
722     //! Loads shader source from specified strings.
723     Standard_Boolean LoadFromStrings (const TCollection_AsciiString* theStrings, const TCollection_AsciiString& thePrefix = EMPTY_PREFIX);
724
725   private:
726
727     TCollection_AsciiString mySource; //!< Source string of the shader object
728     TCollection_AsciiString myPrefix; //!< Prefix to insert before the source
729     TCollection_AsciiString myError;  //!< error state
730
731   };
732
733   //! Default ray-tracing depth.
734   static const Standard_Integer THE_DEFAULT_NB_BOUNCES = 3;
735
736   //! Default size of traversal stack.
737   static const Standard_Integer THE_DEFAULT_STACK_SIZE = 10;
738
739   //! Compile-time ray-tracing parameters.
740   struct RaytracingParams
741   {
742     //! Actual size of traversal stack in shader program.
743     Standard_Integer StackSize;
744
745     //! Actual ray-tracing depth (number of ray bounces).
746     Standard_Integer NbBounces;
747
748     //! Define depth computation
749     Standard_Boolean IsZeroToOneDepth;
750
751     //! Enables/disables light propagation through transparent media.
752     Standard_Boolean TransparentShadows;
753
754     //! Enables/disables global illumination (GI) effects.
755     Standard_Boolean GlobalIllumination;
756
757     //! Enables/disables the use of OpenGL bindless textures.
758     Standard_Boolean UseBindlessTextures;
759
760     //! Enables/disables two-sided BSDF models instead of one-sided.
761     Standard_Boolean TwoSidedBsdfModels;
762
763     //! Enables/disables adaptive screen sampling for path tracing.
764     Standard_Boolean AdaptiveScreenSampling;
765
766     //! Enables/disables 1-pass atomic mode for AdaptiveScreenSampling.
767     Standard_Boolean AdaptiveScreenSamplingAtomic;
768
769     //! Enables/disables environment map for background.
770     Standard_Boolean UseEnvMapForBackground;
771
772     //! Enables/disables normal map ignoring during path tracing.
773     Standard_Boolean ToIgnoreNormalMap;
774
775     //! Maximum radiance value used for clamping radiance estimation.
776     Standard_ShortReal RadianceClampingValue;
777     
778     //! Enables/disables depth-of-field effect (path tracing, perspective camera).
779     Standard_Boolean DepthOfField;
780
781     //! Enables/disables cubemap backgraund.
782     Standard_Boolean CubemapForBack;
783
784     //! Tone mapping method for path tracing.
785     Graphic3d_ToneMappingMethod ToneMappingMethod;
786
787     //! Creates default compile-time ray-tracing parameters.
788     RaytracingParams()
789     : StackSize              (THE_DEFAULT_STACK_SIZE),
790       NbBounces              (THE_DEFAULT_NB_BOUNCES),
791       IsZeroToOneDepth       (Standard_False),
792       TransparentShadows     (Standard_False),
793       GlobalIllumination     (Standard_False),
794       UseBindlessTextures    (Standard_False),
795       TwoSidedBsdfModels     (Standard_False),
796       AdaptiveScreenSampling (Standard_False),
797       AdaptiveScreenSamplingAtomic (Standard_False),
798       UseEnvMapForBackground (Standard_False),
799       ToIgnoreNormalMap      (Standard_False),
800       RadianceClampingValue  (30.0),
801       DepthOfField           (Standard_False),
802       CubemapForBack         (Standard_False),
803       ToneMappingMethod      (Graphic3d_ToneMappingMethod_Disabled) { }
804   };
805
806   //! Describes state of OpenGL structure.
807   struct StructState
808   {
809     Standard_Size StructureState;
810     Standard_Size InstancedState;
811
812     //! Creates new structure state.
813     StructState (const Standard_Size theStructureState = 0,
814                  const Standard_Size theInstancedState = 0)
815     : StructureState (theStructureState),
816       InstancedState (theInstancedState)
817     {
818       //
819     }
820
821     //! Creates new structure state.
822     StructState (const OpenGl_Structure* theStructure)
823     {
824       StructureState = theStructure->ModificationState();
825
826       InstancedState = theStructure->InstancedStructure() != NULL ?
827         theStructure->InstancedStructure()->ModificationState() : 0;
828     }
829   };
830
831 protected: //! @name methods related to ray-tracing
832
833   //! Updates 3D scene geometry for ray-tracing.
834   Standard_Boolean updateRaytraceGeometry (const RaytraceUpdateMode      theMode,
835                                            const Standard_Integer        theViewId,
836                                            const Handle(OpenGl_Context)& theGlContext);
837
838   //! Updates 3D scene light sources for ray-tracing.
839   Standard_Boolean updateRaytraceLightSources (const OpenGl_Mat4& theInvModelView, const Handle(OpenGl_Context)& theGlContext);
840
841   //! Checks to see if the OpenGL structure is modified.
842   Standard_Boolean toUpdateStructure (const OpenGl_Structure* theStructure);
843
844   //! Adds OpenGL structure to ray-traced scene geometry.
845   Standard_Boolean addRaytraceStructure (const OpenGl_Structure*       theStructure,
846                                          const Handle(OpenGl_Context)& theGlContext);
847
848   //! Adds OpenGL groups to ray-traced scene geometry.
849   Standard_Boolean addRaytraceGroups (const OpenGl_Structure*        theStructure,
850                                       const OpenGl_RaytraceMaterial& theStructMat,
851                                       const Handle(TopLoc_Datum3D)&  theTrsf,
852                                       const Handle(OpenGl_Context)&  theGlContext);
853
854   //! Creates ray-tracing material properties.
855   OpenGl_RaytraceMaterial convertMaterial (const OpenGl_Aspects* theAspect,
856                                            const Handle(OpenGl_Context)& theGlContext);
857
858   //! Adds OpenGL primitive array to ray-traced scene geometry.
859   Handle(OpenGl_TriangleSet) addRaytracePrimitiveArray (const OpenGl_PrimitiveArray* theArray,
860                                                         const Standard_Integer       theMatID,
861                                                         const OpenGl_Mat4*           theTrans);
862
863   //! Adds vertex indices from OpenGL primitive array to ray-traced scene geometry.
864   Standard_Boolean addRaytraceVertexIndices (OpenGl_TriangleSet&                  theSet,
865                                              const Standard_Integer               theMatID,
866                                              const Standard_Integer               theCount,
867                                              const Standard_Integer               theOffset,
868                                              const OpenGl_PrimitiveArray&         theArray);
869
870   //! Adds OpenGL triangle array to ray-traced scene geometry.
871   Standard_Boolean addRaytraceTriangleArray (OpenGl_TriangleSet&                  theSet,
872                                              const Standard_Integer               theMatID,
873                                              const Standard_Integer               theCount,
874                                              const Standard_Integer               theOffset,
875                                              const Handle(Graphic3d_IndexBuffer)& theIndices);
876
877   //! Adds OpenGL triangle fan array to ray-traced scene geometry.
878   Standard_Boolean addRaytraceTriangleFanArray (OpenGl_TriangleSet&                  theSet,
879                                                 const Standard_Integer               theMatID,
880                                                 const Standard_Integer               theCount,
881                                                 const Standard_Integer               theOffset,
882                                                 const Handle(Graphic3d_IndexBuffer)& theIndices);
883
884   //! Adds OpenGL triangle strip array to ray-traced scene geometry.
885   Standard_Boolean addRaytraceTriangleStripArray (OpenGl_TriangleSet&                  theSet,
886                                                   const Standard_Integer               theMatID,
887                                                   const Standard_Integer               theCount,
888                                                   const Standard_Integer               theOffset,
889                                                   const Handle(Graphic3d_IndexBuffer)& theIndices);
890
891   //! Adds OpenGL quadrangle array to ray-traced scene geometry.
892   Standard_Boolean addRaytraceQuadrangleArray (OpenGl_TriangleSet&                  theSet,
893                                                const Standard_Integer               theMatID,
894                                                const Standard_Integer               theCount,
895                                                const Standard_Integer               theOffset,
896                                                const Handle(Graphic3d_IndexBuffer)& theIndices);
897
898   //! Adds OpenGL quadrangle strip array to ray-traced scene geometry.
899   Standard_Boolean addRaytraceQuadrangleStripArray (OpenGl_TriangleSet&                  theSet,
900                                                     const Standard_Integer               theMatID,
901                                                     const Standard_Integer               theCount,
902                                                     const Standard_Integer               theOffset,
903                                                     const Handle(Graphic3d_IndexBuffer)& theIndices);
904
905   //! Adds OpenGL polygon array to ray-traced scene geometry.
906   Standard_Boolean addRaytracePolygonArray (OpenGl_TriangleSet&                  theSet,
907                                             const Standard_Integer               theMatID,
908                                             const Standard_Integer               theCount,
909                                             const Standard_Integer               theOffset,
910                                             const Handle(Graphic3d_IndexBuffer)& theIndices);
911
912   //! Uploads ray-trace data to the GPU.
913   Standard_Boolean uploadRaytraceData (const Handle(OpenGl_Context)& theGlContext);
914
915   //! Generates shader prefix based on current ray-tracing options.
916   TCollection_AsciiString generateShaderPrefix (const Handle(OpenGl_Context)& theGlContext) const;
917
918   //! Performs safe exit when shaders initialization fails.
919   Standard_Boolean safeFailBack (const TCollection_ExtendedString& theMessage,
920                                  const Handle(OpenGl_Context)&     theGlContext);
921
922   //! Loads and compiles shader object from specified source.
923   Handle(OpenGl_ShaderObject) initShader (const GLenum                  theType,
924                                           const ShaderSource&           theSource,
925                                           const Handle(OpenGl_Context)& theGlContext);
926
927   //! Creates shader program from the given vertex and fragment shaders.
928   Handle(OpenGl_ShaderProgram) initProgram (const Handle(OpenGl_Context)&      theGlContext,
929                                             const Handle(OpenGl_ShaderObject)& theVertShader,
930                                             const Handle(OpenGl_ShaderObject)& theFragShader,
931                                             const TCollection_AsciiString& theName);
932
933   //! Initializes OpenGL/GLSL shader programs.
934   Standard_Boolean initRaytraceResources (const Standard_Integer theSizeX,
935                                           const Standard_Integer theSizeY,
936                                           const Handle(OpenGl_Context)& theGlContext);
937
938   //! Releases OpenGL/GLSL shader programs.
939   void releaseRaytraceResources (const Handle(OpenGl_Context)& theGlContext,
940                                  const Standard_Boolean        theToRebuild = Standard_False);
941
942   //! Updates auxiliary OpenGL frame buffers.
943   Standard_Boolean updateRaytraceBuffers (const Standard_Integer        theSizeX,
944                                           const Standard_Integer        theSizeY,
945                                           const Handle(OpenGl_Context)& theGlContext);
946
947   //! Generates viewing rays for corners of screen quad.
948   //! (ray tracing; path tracing for orthographic camera)
949   void updateCamera (const OpenGl_Mat4& theOrientation,
950                      const OpenGl_Mat4& theViewMapping,
951                      OpenGl_Vec3*       theOrigins,
952                      OpenGl_Vec3*       theDirects,
953                      OpenGl_Mat4&       theView,
954                      OpenGl_Mat4&       theUnView);
955
956   //! Generate viewing rays (path tracing, perspective camera).
957   void updatePerspCameraPT(const OpenGl_Mat4&           theOrientation,
958                            const OpenGl_Mat4&           theViewMapping,
959                            Graphic3d_Camera::Projection theProjection,
960                            OpenGl_Mat4&                 theViewPr,
961                            OpenGl_Mat4&                 theUnview,
962                            const int                    theWinSizeX,
963                            const int                    theWinSizeY);
964
965   //! Binds ray-trace textures to corresponding texture units.
966   void bindRaytraceTextures (const Handle(OpenGl_Context)& theGlContext,
967                              int theStereoView);
968
969   //! Unbinds ray-trace textures from corresponding texture unit.
970   void unbindRaytraceTextures (const Handle(OpenGl_Context)& theGlContext);
971
972   //! Sets uniform state for the given ray-tracing shader program.
973   Standard_Boolean setUniformState (const Standard_Integer        theProgramId,
974                                     const Standard_Integer        theSizeX,
975                                     const Standard_Integer        theSizeY,
976                                     Graphic3d_Camera::Projection  theProjection,
977                                     const Handle(OpenGl_Context)& theGlContext);
978
979   //! Runs ray-tracing shader programs.
980   Standard_Boolean runRaytraceShaders (const Standard_Integer        theSizeX,
981                                        const Standard_Integer        theSizeY,
982                                        Graphic3d_Camera::Projection  theProjection,
983                                        OpenGl_FrameBuffer*           theReadDrawFbo,
984                                        const Handle(OpenGl_Context)& theGlContext);
985
986   //! Runs classical (Whitted-style) ray-tracing kernel.
987   Standard_Boolean runRaytrace (const Standard_Integer        theSizeX,
988                                 const Standard_Integer        theSizeY,
989                                 Graphic3d_Camera::Projection  theProjection,
990                                 OpenGl_FrameBuffer*           theReadDrawFbo,
991                                 const Handle(OpenGl_Context)& theGlContext);
992
993   //! Runs path tracing (global illumination) kernel.
994   Standard_Boolean runPathtrace (const Standard_Integer        theSizeX,
995                                  const Standard_Integer        theSizeY,
996                                  Graphic3d_Camera::Projection  theProjection,
997                                  const Handle(OpenGl_Context)& theGlContext);
998
999   //! Runs path tracing (global illumination) kernel.
1000   Standard_Boolean runPathtraceOut (Graphic3d_Camera::Projection  theProjection,
1001                                     OpenGl_FrameBuffer*           theReadDrawFbo,
1002                                     const Handle(OpenGl_Context)& theGlContext);
1003
1004   //! Redraws the window using OpenGL/GLSL ray-tracing or path tracing.
1005   Standard_Boolean raytrace (const Standard_Integer        theSizeX,
1006                              const Standard_Integer        theSizeY,
1007                              Graphic3d_Camera::Projection  theProjection,
1008                              OpenGl_FrameBuffer*           theReadDrawFbo,
1009                              const Handle(OpenGl_Context)& theGlContext);
1010
1011 protected: //! @name fields related to ray-tracing
1012
1013   //! Result of RT/PT shaders initialization.
1014   RaytraceInitStatus myRaytraceInitStatus;
1015
1016   //! Is ray-tracing geometry data valid?
1017   Standard_Boolean myIsRaytraceDataValid;
1018
1019   //! True if warning about missing extension GL_ARB_bindless_texture has been displayed.
1020   Standard_Boolean myIsRaytraceWarnTextures;
1021
1022   //! 3D scene geometry data for ray-tracing.
1023   OpenGl_RaytraceGeometry myRaytraceGeometry;
1024
1025   //! Builder for triangle set.
1026   opencascade::handle<BVH_Builder<Standard_ShortReal, 3> > myRaytraceBVHBuilder;
1027
1028   //! Compile-time ray-tracing parameters.
1029   RaytracingParams myRaytraceParameters;
1030
1031   //! Radius of bounding sphere of the scene.
1032   Standard_ShortReal myRaytraceSceneRadius;
1033   //! Scene epsilon to prevent self-intersections.
1034   Standard_ShortReal myRaytraceSceneEpsilon;
1035
1036   //! OpenGL/GLSL source of ray-tracing fragment shader.
1037   ShaderSource myRaytraceShaderSource;
1038   //! OpenGL/GLSL source of adaptive-AA fragment shader.
1039   ShaderSource myPostFSAAShaderSource;
1040   //! OpenGL/GLSL source of RT/PT display fragment shader.
1041   ShaderSource myOutImageShaderSource;
1042
1043   //! OpenGL/GLSL ray-tracing fragment shader.
1044   Handle(OpenGl_ShaderObject) myRaytraceShader;
1045   //! OpenGL/GLSL adaptive-AA fragment shader.
1046   Handle(OpenGl_ShaderObject) myPostFSAAShader;
1047   //! OpenGL/GLSL ray-tracing display fragment shader.
1048   Handle(OpenGl_ShaderObject) myOutImageShader;
1049
1050   //! OpenGL/GLSL ray-tracing shader program.
1051   Handle(OpenGl_ShaderProgram) myRaytraceProgram;
1052   //! OpenGL/GLSL adaptive-AA shader program.
1053   Handle(OpenGl_ShaderProgram) myPostFSAAProgram;
1054   //! OpenGL/GLSL program for displaying texture.
1055   Handle(OpenGl_ShaderProgram) myOutImageProgram;
1056
1057   //! Texture buffer of data records of bottom-level BVH nodes.
1058   Handle(OpenGl_TextureBufferArb) mySceneNodeInfoTexture;
1059   //! Texture buffer of minimum points of bottom-level BVH nodes.
1060   Handle(OpenGl_TextureBufferArb) mySceneMinPointTexture;
1061   //! Texture buffer of maximum points of bottom-level BVH nodes.
1062   Handle(OpenGl_TextureBufferArb) mySceneMaxPointTexture;
1063   //! Texture buffer of transformations of high-level BVH nodes.
1064   Handle(OpenGl_TextureBufferArb) mySceneTransformTexture;
1065
1066   //! Texture buffer of vertex coords.
1067   Handle(OpenGl_TextureBufferArb) myGeometryVertexTexture;
1068   //! Texture buffer of vertex normals.
1069   Handle(OpenGl_TextureBufferArb) myGeometryNormalTexture;
1070   //! Texture buffer of vertex UV coords.
1071   Handle(OpenGl_TextureBufferArb) myGeometryTexCrdTexture;
1072   //! Texture buffer of triangle indices.
1073   Handle(OpenGl_TextureBufferArb) myGeometryTriangTexture;
1074
1075   //! Texture buffer of material properties.
1076   Handle(OpenGl_TextureBufferArb) myRaytraceMaterialTexture;
1077   //! Texture buffer of light source properties.
1078   Handle(OpenGl_TextureBufferArb) myRaytraceLightSrcTexture;
1079
1080   //! 1st framebuffer (FBO) to perform adaptive FSAA.
1081   //! Used in compatibility mode (no adaptive sampling).
1082   Handle(OpenGl_FrameBuffer) myRaytraceFBO1[2];
1083   //! 2nd framebuffer (FBO) to perform adaptive FSAA.
1084   //! Used in compatibility mode (no adaptive sampling).
1085   Handle(OpenGl_FrameBuffer) myRaytraceFBO2[2];
1086
1087   //! Output textures (2 textures are used in stereo mode).
1088   //! Used if adaptive screen sampling is activated.
1089   Handle(OpenGl_Texture) myRaytraceOutputTexture[2];
1090
1091   //! Texture containing per-tile visual error estimation (2 textures are used in stereo mode).
1092   //! Used if adaptive screen sampling is activated.
1093   Handle(OpenGl_Texture) myRaytraceVisualErrorTexture[2];
1094   //! Texture containing offsets of sampled screen tiles (2 textures are used in stereo mode).
1095   //! Used if adaptive screen sampling is activated.
1096   Handle(OpenGl_Texture) myRaytraceTileOffsetsTexture[2];
1097   //! Texture containing amount of extra per-tile samples (2 textures are used in stereo mode).
1098   //! Used if adaptive screen sampling is activated.
1099   Handle(OpenGl_Texture) myRaytraceTileSamplesTexture[2];
1100
1101   //! Vertex buffer (VBO) for drawing dummy quad.
1102   OpenGl_VertexBuffer myRaytraceScreenQuad;
1103
1104   //! Cached locations of frequently used uniform variables.
1105   Standard_Integer myUniformLocations[2][OpenGl_RT_NbVariables];
1106
1107   //! State of OpenGL structures reflected to ray-tracing.
1108   std::map<const OpenGl_Structure*, StructState> myStructureStates;
1109
1110   //! PrimitiveArray to TriangleSet map for scene partial update.
1111   std::map<Standard_Size, OpenGl_TriangleSet*> myArrayToTrianglesMap;
1112
1113   //! Set of IDs of non-raytracable elements (to detect updates).
1114   std::set<Standard_Integer> myNonRaytraceStructureIDs;
1115
1116   //! Marks if environment map should be updated.
1117   Standard_Boolean myToUpdateEnvironmentMap;
1118
1119   //! State of OpenGL layer list.
1120   Standard_Size myRaytraceLayerListState;
1121
1122   //! Number of accumulated frames (for progressive rendering).
1123   Standard_Integer myAccumFrames;
1124
1125   //! Stored ray origins used for detection of camera movements.
1126   OpenGl_Vec3 myPreviousOrigins[3];
1127
1128   //! Bullard RNG to produce random sequence.
1129   math_BullardGenerator myRNG;
1130
1131   //! Tool object for sampling screen tiles in PT mode.
1132   OpenGl_TileSampler myTileSampler;
1133
1134   //! Camera position used for projective mode
1135   OpenGl_Vec3 myEyeOrig;
1136
1137   //! Camera view direction used for projective mode
1138   OpenGl_Vec3 myEyeView;
1139
1140   //! Camera's screen vertical direction used for projective mode
1141   OpenGl_Vec3 myEyeVert;
1142
1143   //! Camera's screen horizontal direction used for projective mode
1144   OpenGl_Vec3 myEyeSide;
1145
1146   //! Camera's screen size used for projective mode
1147   OpenGl_Vec2 myEyeSize;
1148
1149   //! Aperture radius of camera on previous frame used for depth-of-field (path tracing)
1150   float myPrevCameraApertureRadius;
1151
1152   //! Focal distance of camera on previous frame used for depth-of-field (path tracing)
1153   float myPrevCameraFocalPlaneDist;
1154
1155 public:
1156
1157   DEFINE_STANDARD_ALLOC
1158   DEFINE_STANDARD_RTTIEXT(OpenGl_View,Graphic3d_CView) // Type definition
1159
1160   friend class OpenGl_GraphicDriver;
1161   friend class OpenGl_Workspace;
1162   friend class OpenGl_LayerList;
1163   friend class OpenGl_FrameStats;
1164 };
1165
1166 #endif // _OpenGl_View_Header