0027899: Visualization, Ray Tracing - Provide ability to rebuild GLSL shaders on...
[occt.git] / src / Graphic3d / Graphic3d_RenderingParams.hxx
1 // Created on: 2014-05-14
2 // Created by: Denis BOGOLEPOV
3 // Copyright (c) 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 _Graphic3d_RenderingParams_HeaderFile
17 #define _Graphic3d_RenderingParams_HeaderFile
18
19 #include <Graphic3d_RenderingMode.hxx>
20 #include <Graphic3d_StereoMode.hxx>
21 #include <Graphic3d_Mat4.hxx>
22 #include <Graphic3d_Vec4.hxx>
23
24 //! Helper class to store rendering parameters.
25 class Graphic3d_RenderingParams
26 {
27 public:
28   //! Default pixels density.
29   static const unsigned int THE_DEFAULT_RESOLUTION = 72u;
30
31   //! Default number of samples per pixel.
32   static const Standard_Integer THE_DEFAULT_SPP = 1;
33
34   //! Default ray-tracing depth.
35   static const Standard_Integer THE_DEFAULT_DEPTH = 3;
36
37   //! Anaglyph filter presets.
38   enum Anaglyph
39   {
40     Anaglyph_RedCyan_Simple,       //!< simple    filter for Red-Cyan      glasses (R+GB)
41     Anaglyph_RedCyan_Optimized,    //!< optimized filter for Red-Cyan      glasses (R+GB)
42     Anaglyph_YellowBlue_Simple,    //!< simple    filter for Yellow-Blue   glasses (RG+B)
43     Anaglyph_YellowBlue_Optimized, //!< optimized filter for Yellow-Blue   glasses (RG+B)
44     Anaglyph_GreenMagenta_Simple,  //!< simple    filter for Green-Magenta glasses (G+RB)
45     Anaglyph_UserDefined           //!< use externally specified matrices
46   };
47
48 public:
49
50   //! Creates default rendering parameters.
51   Graphic3d_RenderingParams()
52   : Method                      (Graphic3d_RM_RASTERIZATION),
53     NbMsaaSamples               (0),
54     // ray tracing parameters
55     IsGlobalIlluminationEnabled (Standard_False),
56     SamplesPerPixel             (THE_DEFAULT_SPP),
57     RaytracingDepth             (THE_DEFAULT_DEPTH),
58     IsShadowEnabled             (Standard_True),
59     IsReflectionEnabled         (Standard_False),
60     IsAntialiasingEnabled       (Standard_False),
61     IsTransparentShadowEnabled  (Standard_False),
62     UseEnvironmentMapBackground (Standard_False),
63     CoherentPathTracingMode     (Standard_False),
64     AdaptiveScreenSampling      (Standard_False),
65     ShowSamplingTiles           (Standard_False),
66     RebuildRayTracingShaders    (Standard_False),
67     // stereoscopic parameters
68     StereoMode (Graphic3d_StereoMode_QuadBuffer),
69     AnaglyphFilter (Anaglyph_RedCyan_Optimized),
70     ToReverseStereo (Standard_False),
71
72     Resolution (THE_DEFAULT_RESOLUTION)
73   {
74     const Graphic3d_Vec4 aZero (0.0f, 0.0f, 0.0f, 0.0f);
75     AnaglyphLeft .SetRow (0, Graphic3d_Vec4 (1.0f,  0.0f,  0.0f, 0.0f));
76     AnaglyphLeft .SetRow (1, aZero);
77     AnaglyphLeft .SetRow (2, aZero);
78     AnaglyphLeft .SetRow (3, aZero);
79     AnaglyphRight.SetRow (0, aZero);
80     AnaglyphRight.SetRow (1, Graphic3d_Vec4 (0.0f,  1.0f,  0.0f, 0.0f));
81     AnaglyphRight.SetRow (2, Graphic3d_Vec4 (0.0f,  0.0f,  1.0f, 0.0f));
82     AnaglyphRight.SetRow (3, aZero);
83   }
84
85   //! Returns resolution ratio.
86   Standard_ShortReal ResolutionRatio() const
87   {
88     return Resolution / static_cast<Standard_ShortReal> (THE_DEFAULT_RESOLUTION);
89   }
90
91 public:
92
93   Graphic3d_RenderingMode Method;                      //!< specifies rendering mode, Graphic3d_RM_RASTERIZATION by default
94   Standard_Integer        NbMsaaSamples;               //!< number of MSAA samples (should be within 0..GL_MAX_SAMPLES, power-of-two number), 0 by default
95
96   Standard_Boolean        IsGlobalIlluminationEnabled; //!< enables/disables global illumination effects (path tracing)
97   Standard_Integer        SamplesPerPixel;             //!< number of samples per pixel (SPP)
98   Standard_Integer        RaytracingDepth;             //!< maximum ray-tracing depth, 3 by default
99   Standard_Boolean        IsShadowEnabled;             //!< enables/disables shadows rendering, True by default
100   Standard_Boolean        IsReflectionEnabled;         //!< enables/disables specular reflections, False by default
101   Standard_Boolean        IsAntialiasingEnabled;       //!< enables/disables adaptive anti-aliasing, False by default
102   Standard_Boolean        IsTransparentShadowEnabled;  //!< enables/disables light propagation through transparent media, False by default
103   Standard_Boolean        UseEnvironmentMapBackground; //!< enables/disables environment map background
104   Standard_Boolean        CoherentPathTracingMode;     //!< enables/disables 'coherent' tracing mode (single RNG seed within 16x16 image blocks)
105   Standard_Boolean        AdaptiveScreenSampling;      //!< enables/disables adaptive screen sampling mode for path tracing, FALSE by default
106   Standard_Boolean        ShowSamplingTiles;           //!< enables/disables debug mode for adaptive screen sampling, FALSE by default
107   Standard_Boolean        RebuildRayTracingShaders;    //!< forces rebuilding ray tracing shaders at the next frame
108
109   Graphic3d_StereoMode    StereoMode;                  //!< stereoscopic output mode, Graphic3d_StereoMode_QuadBuffer by default
110   Anaglyph                AnaglyphFilter;              //!< filter for anaglyph output, Anaglyph_RedCyan_Optimized by default
111   Graphic3d_Mat4          AnaglyphLeft;                //!< left  anaglyph filter (in normalized colorspace), Color = AnaglyphRight * theColorRight + AnaglyphLeft * theColorLeft;
112   Graphic3d_Mat4          AnaglyphRight;               //!< right anaglyph filter (in normalized colorspace), Color = AnaglyphRight * theColorRight + AnaglyphLeft * theColorLeft;
113   Standard_Boolean        ToReverseStereo;             //!< flag to reverse stereo pair, FALSE by default
114
115   unsigned int            Resolution;                  //!< Pixels density (PPI), defines scaling factor for parameters like text size
116                                                        //!< (when defined in screen-space units rather than in 3D) to be properly displayed
117                                                        //!< on device (screen / printer). 72 is default value.
118                                                        //!< Note that using difference resolution in different Views in same Viewer
119                                                        //!< will lead to performance regression (for example, text will be recreated every time).
120
121 };
122
123 #endif // _Graphic3d_RenderingParams_HeaderFile