0030483: Visualization, Path Tracing - make Tile Size configurable
[occt.git] / src / Graphic3d / Graphic3d_RenderingParams.hxx
CommitLineData
bc8c79bb 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
15669413 19#include <Graphic3d_AspectText3d.hxx>
20#include <Graphic3d_TransformPers.hxx>
a1073ae2 21#include <Graphic3d_RenderTransparentMethod.hxx>
bc8c79bb 22#include <Graphic3d_RenderingMode.hxx>
f978241f 23#include <Graphic3d_StereoMode.hxx>
eb85ed36 24#include <Graphic3d_ToneMappingMethod.hxx>
f978241f 25#include <Graphic3d_Vec4.hxx>
bc8c79bb 26
27//! Helper class to store rendering parameters.
28class Graphic3d_RenderingParams
29{
30public:
4b1c8733 31 //! Default pixels density.
32 static const unsigned int THE_DEFAULT_RESOLUTION = 72u;
bc8c79bb 33
34 //! Default ray-tracing depth.
35 static const Standard_Integer THE_DEFAULT_DEPTH = 3;
36
f978241f 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
15669413 48 //! Statistics display flags.
5e30547b 49 //! If not specified otherwise, the counter value is computed for a single rendered frame.
15669413 50 enum PerfCounters
51 {
52 PerfCounters_NONE = 0x000, //!< no stats
5e30547b 53 PerfCounters_FrameRate = 0x001, //!< Frame Rate, frames per second (number of frames within elapsed time)
54 PerfCounters_CPU = 0x002, //!< CPU utilization as frames per second (number of frames within CPU utilization time (rendering thread))
15669413 55 PerfCounters_Layers = 0x004, //!< count layers (groups of structures)
56 PerfCounters_Structures = 0x008, //!< count low-level Structures (normal unhighlighted Presentable Object is usually represented by 1 Structure)
57 //
58 PerfCounters_Groups = 0x010, //!< count primitive Groups (1 Structure holds 1 or more primitive Group)
59 PerfCounters_GroupArrays = 0x020, //!< count Arrays within Primitive Groups (optimal primitive Group holds 1 Array)
60 //
61 PerfCounters_Triangles = 0x040, //!< count Triangles
62 PerfCounters_Points = 0x080, //!< count Points
63 //
64 PerfCounters_EstimMem = 0x100, //!< estimated GPU memory usage
5e30547b 65 //
66 PerfCounters_FrameTime = 0x200, //!< frame CPU utilization time (rendering thread); @sa Graphic3d_FrameStatsTimer
67 PerfCounters_FrameTimeMax= 0x400, //!< maximum frame times
68 //
69 PerfCounters_SkipImmediate = 0x800, //!< do not include immediate viewer updates (e.g. lazy updates without redrawing entire view content)
15669413 70 //! show basic statistics
71 PerfCounters_Basic = PerfCounters_FrameRate | PerfCounters_CPU | PerfCounters_Layers | PerfCounters_Structures,
72 //! extended (verbose) statistics
73 PerfCounters_Extended = PerfCounters_Basic
74 | PerfCounters_Groups | PerfCounters_GroupArrays
75 | PerfCounters_Triangles | PerfCounters_Points
76 | PerfCounters_EstimMem,
5e30547b 77 //! all counters
78 PerfCounters_All = PerfCounters_Extended
79 | PerfCounters_FrameTime
80 | PerfCounters_FrameTimeMax,
15669413 81 };
82
0e3025bc 83 //! State of frustum culling optimization.
84 enum FrustumCulling
85 {
86 FrustumCulling_Off, //!< culling is disabled
87 FrustumCulling_On, //!< culling is active, and the list of culled entities is automatically updated before redraw
88 FrustumCulling_NoUpdate //!< culling is active, but the list of culled entities is not updated
89 };
90
bc8c79bb 91public:
92
93 //! Creates default rendering parameters.
94 Graphic3d_RenderingParams()
189f85a3 95 : Method (Graphic3d_RM_RASTERIZATION),
a1073ae2 96 TransparencyMethod (Graphic3d_RTM_BLEND_UNORDERED),
97 OitDepthFactor (0.0f),
3c4b62a4 98 NbMsaaSamples (0),
56689b27 99 RenderResolutionScale (1.0f),
f88457e6 100 ToEnableDepthPrepass (Standard_False),
c40eb6b9 101 ToEnableAlphaToCoverage (Standard_False),
3c4b62a4 102 // ray tracing parameters
f978241f 103 IsGlobalIlluminationEnabled (Standard_False),
f978241f 104 RaytracingDepth (THE_DEFAULT_DEPTH),
189f85a3 105 IsShadowEnabled (Standard_True),
106 IsReflectionEnabled (Standard_False),
107 IsAntialiasingEnabled (Standard_False),
108 IsTransparentShadowEnabled (Standard_False),
f978241f 109 UseEnvironmentMapBackground (Standard_False),
8c820969 110 CoherentPathTracingMode (Standard_False),
3a9b5dc8 111 AdaptiveScreenSampling (Standard_False),
112 ShowSamplingTiles (Standard_False),
b4327ba8 113 TwoSidedBsdfModels (Standard_False),
b09447ed 114 RadianceClampingValue (30.0),
d877e610 115 RebuildRayTracingShaders (Standard_False),
66d1cdc6 116 RayTracingTileSize (32),
4eaaf9d8 117 NbRayTracingTiles (16 * 16),
b27ab03d 118 CameraApertureRadius (0.0f),
119 CameraFocalPlaneDist (1.0f),
0e3025bc 120 FrustumCullingState (FrustumCulling_On),
eb85ed36 121 ToneMappingMethod (Graphic3d_ToneMappingMethod_Disabled),
122 Exposure (0.f),
123 WhitePoint (1.f),
3c4b62a4 124 // stereoscopic parameters
f978241f 125 StereoMode (Graphic3d_StereoMode_QuadBuffer),
126 AnaglyphFilter (Anaglyph_RedCyan_Optimized),
4b1c8733 127 ToReverseStereo (Standard_False),
15669413 128 //
5e30547b 129 StatsPosition (new Graphic3d_TransformPers (Graphic3d_TMF_2d, Aspect_TOTP_LEFT_UPPER, Graphic3d_Vec2i (20, 20))),
130 ChartPosition (new Graphic3d_TransformPers (Graphic3d_TMF_2d, Aspect_TOTP_RIGHT_UPPER, Graphic3d_Vec2i (20, 20))),
131 ChartSize (-1, -1),
15669413 132 StatsTextAspect (new Graphic3d_AspectText3d()),
133 StatsUpdateInterval (1.0),
134 StatsTextHeight (16),
5e30547b 135 StatsNbFrames (1),
136 StatsMaxChartTime (0.1f),
15669413 137 CollectedStats (PerfCounters_Basic),
138 ToShowStats (Standard_False),
139 //
4b1c8733 140 Resolution (THE_DEFAULT_RESOLUTION)
bc8c79bb 141 {
f978241f 142 const Graphic3d_Vec4 aZero (0.0f, 0.0f, 0.0f, 0.0f);
143 AnaglyphLeft .SetRow (0, Graphic3d_Vec4 (1.0f, 0.0f, 0.0f, 0.0f));
144 AnaglyphLeft .SetRow (1, aZero);
145 AnaglyphLeft .SetRow (2, aZero);
146 AnaglyphLeft .SetRow (3, aZero);
147 AnaglyphRight.SetRow (0, aZero);
148 AnaglyphRight.SetRow (1, Graphic3d_Vec4 (0.0f, 1.0f, 0.0f, 0.0f));
149 AnaglyphRight.SetRow (2, Graphic3d_Vec4 (0.0f, 0.0f, 1.0f, 0.0f));
150 AnaglyphRight.SetRow (3, aZero);
15669413 151
152 StatsTextAspect->SetColor (Quantity_NOC_WHITE);
153 StatsTextAspect->SetColorSubTitle (Quantity_NOC_BLACK);
154 StatsTextAspect->SetFont (Font_NOF_ASCII_MONO);
155 StatsTextAspect->SetDisplayType (Aspect_TODT_SHADOW);
156 StatsTextAspect->SetTextZoomable (Standard_False);
157 StatsTextAspect->SetTextFontAspect (Font_FA_Regular);
bc8c79bb 158 }
159
75c262a9 160 //! Returns resolution ratio.
161 Standard_ShortReal ResolutionRatio() const
162 {
163 return Resolution / static_cast<Standard_ShortReal> (THE_DEFAULT_RESOLUTION);
164 }
165
bc8c79bb 166public:
167
a1073ae2 168 Graphic3d_RenderingMode Method; //!< specifies rendering mode, Graphic3d_RM_RASTERIZATION by default
169 Graphic3d_RenderTransparentMethod TransparencyMethod; //!< specifies rendering method for transparent graphics
170 Standard_ShortReal OitDepthFactor; //!< scalar factor [0-1] controlling influence of depth of a fragment to its final coverage
171 Standard_Integer NbMsaaSamples; //!< number of MSAA samples (should be within 0..GL_MAX_SAMPLES, power-of-two number), 0 by default
172 Standard_ShortReal RenderResolutionScale; //!< rendering resolution scale factor, 1 by default;
173 //! incompatible with MSAA (e.g. NbMsaaSamples should be set to 0)
f88457e6 174 Standard_Boolean ToEnableDepthPrepass; //!< enables/disables depth pre-pass, False by default
c40eb6b9 175 Standard_Boolean ToEnableAlphaToCoverage; //!< enables/disables alpha to coverage, False by default
a1073ae2 176
177 Standard_Boolean IsGlobalIlluminationEnabled; //!< enables/disables global illumination effects (path tracing)
178 Standard_Integer SamplesPerPixel; //!< number of samples per pixel (SPP)
179 Standard_Integer RaytracingDepth; //!< maximum ray-tracing depth, 3 by default
180 Standard_Boolean IsShadowEnabled; //!< enables/disables shadows rendering, True by default
181 Standard_Boolean IsReflectionEnabled; //!< enables/disables specular reflections, False by default
182 Standard_Boolean IsAntialiasingEnabled; //!< enables/disables adaptive anti-aliasing, False by default
183 Standard_Boolean IsTransparentShadowEnabled; //!< enables/disables light propagation through transparent media, False by default
184 Standard_Boolean UseEnvironmentMapBackground; //!< enables/disables environment map background
185 Standard_Boolean CoherentPathTracingMode; //!< enables/disables 'coherent' tracing mode (single RNG seed within 16x16 image blocks)
186 Standard_Boolean AdaptiveScreenSampling; //!< enables/disables adaptive screen sampling mode for path tracing, FALSE by default
187 Standard_Boolean ShowSamplingTiles; //!< enables/disables debug mode for adaptive screen sampling, FALSE by default
188 Standard_Boolean TwoSidedBsdfModels; //!< forces path tracing to use two-sided versions of original one-sided scattering models
189 Standard_ShortReal RadianceClampingValue; //!< maximum radiance value used for clamping radiance estimation.
190 Standard_Boolean RebuildRayTracingShaders; //!< forces rebuilding ray tracing shaders at the next frame
66d1cdc6 191 Standard_Integer RayTracingTileSize; //!< screen tile size, 32 by default (adaptive sampling mode of path tracing);
192 Standard_Integer NbRayTracingTiles; //!< maximum number of screen tiles per frame, 256 by default (adaptive sampling mode of path tracing);
193 //! this parameter limits the number of tiles to be rendered per redraw, increasing Viewer interactivity,
194 //! but also increasing the time for achieving a good quality; -1 means no limit
b27ab03d 195 Standard_ShortReal CameraApertureRadius; //!< aperture radius of perspective camera used for depth-of-field, 0.0 by default (no DOF) (path tracing only)
196 Standard_ShortReal CameraFocalPlaneDist; //!< focal distance of perspective camera used for depth-of field, 1.0 by default (path tracing only)
0e3025bc 197 FrustumCulling FrustumCullingState; //!< state of frustum culling optimization; FrustumCulling_On by default
a1073ae2 198
eb85ed36 199 Graphic3d_ToneMappingMethod ToneMappingMethod; //!< specifies tone mapping method for path tracing, Graphic3d_ToneMappingMethod_Disabled by default
200 Standard_ShortReal Exposure; //!< exposure value used for tone mapping (path tracing), 0.0 by default
201 Standard_ShortReal WhitePoint; //!< white point value used in filmic tone mapping (path tracing), 1.0 by default
202
a1073ae2 203 Graphic3d_StereoMode StereoMode; //!< stereoscopic output mode, Graphic3d_StereoMode_QuadBuffer by default
204 Anaglyph AnaglyphFilter; //!< filter for anaglyph output, Anaglyph_RedCyan_Optimized by default
205 Graphic3d_Mat4 AnaglyphLeft; //!< left anaglyph filter (in normalized colorspace), Color = AnaglyphRight * theColorRight + AnaglyphLeft * theColorLeft;
206 Graphic3d_Mat4 AnaglyphRight; //!< right anaglyph filter (in normalized colorspace), Color = AnaglyphRight * theColorRight + AnaglyphLeft * theColorLeft;
207 Standard_Boolean ToReverseStereo; //!< flag to reverse stereo pair, FALSE by default
208
15669413 209 Handle(Graphic3d_TransformPers) StatsPosition; //!< location of stats, upper-left position by default
5e30547b 210 Handle(Graphic3d_TransformPers) ChartPosition; //!< location of stats chart, upper-right position by default
211 Graphic3d_Vec2i ChartSize; //!< chart size in pixels, (-1, -1) by default which means that chart will occupy a portion of viewport
15669413 212 Handle(Graphic3d_AspectText3d) StatsTextAspect; //!< stats text aspect
213 Standard_ShortReal StatsUpdateInterval; //!< time interval between stats updates in seconds, 1.0 second by default;
214 //! too often updates might impact performance and will smear text within widgets
215 //! (especially framerate, which is better averaging);
216 //! 0.0 interval will force updating on each frame
217 Standard_Integer StatsTextHeight; //!< stats text size; 16 by default
5e30547b 218 Standard_Integer StatsNbFrames; //!< number of data frames to collect history; 1 by default
219 Standard_ShortReal StatsMaxChartTime; //!< upper time limit within frame chart in seconds; 0.1 seconds by default (100 ms or 10 FPS)
15669413 220 PerfCounters CollectedStats; //!< performance counters to collect, PerfCounters_Basic by default;
221 //! too verbose options might impact rendering performance,
222 //! because some counters might lack caching optimization (and will require expensive iteration through all data structures)
223 Standard_Boolean ToShowStats; //!< display performance statistics, FALSE by default;
224 //! note that counters specified within CollectedStats will be updated nevertheless
225 //! of visibility of widget managed by ToShowStats flag (e.g. stats can be retrieved by application for displaying using other methods)
226
a1073ae2 227 unsigned int Resolution; //!< Pixels density (PPI), defines scaling factor for parameters like text size
228 //! (when defined in screen-space units rather than in 3D) to be properly displayed
229 //! on device (screen / printer). 72 is default value.
230 //! Note that using difference resolution in different Views in same Viewer
231 //! will lead to performance regression (for example, text will be recreated every time).
bc8c79bb 232};
233
234#endif // _Graphic3d_RenderingParams_HeaderFile