[occt.git] / src / Graphic3d / Graphic3d_RenderingParams.hxx

// Created on: 2014-05-14
// Created by: Denis BOGOLEPOV
// Copyright (c) 2014 OPEN CASCADE SAS
//
// This file is part of Open CASCADE Technology software library.
//
// This library is free software; you can redistribute it and/or modify it under
// the terms of the GNU Lesser General Public License version 2.1 as published
// by the Free Software Foundation, with special exception defined in the file
// OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
// distribution for complete text of the license and disclaimer of any warranty.
//
// Alternatively, this file may be used under the terms of Open CASCADE
// commercial license or contractual agreement.

#ifndef _Graphic3d_RenderingParams_HeaderFile
#define _Graphic3d_RenderingParams_HeaderFile

#include <Font_Hinting.hxx>
#include <Graphic3d_AspectText3d.hxx>
#include <Graphic3d_TransformPers.hxx>
#include <Graphic3d_RenderTransparentMethod.hxx>
#include <Graphic3d_RenderingMode.hxx>
#include <Graphic3d_StereoMode.hxx>
#include <Graphic3d_ToneMappingMethod.hxx>
#include <Graphic3d_TypeOfShadingModel.hxx>
#include <Graphic3d_Vec4.hxx>

//! Helper class to store rendering parameters.
class Graphic3d_RenderingParams
{
public:
  //! Default pixels density.
  static const unsigned int THE_DEFAULT_RESOLUTION = 72u;

  //! Default ray-tracing depth.
  static const Standard_Integer THE_DEFAULT_DEPTH = 3;

  //! Anaglyph filter presets.
  enum Anaglyph
  {
    Anaglyph_RedCyan_Simple,       //!< simple    filter for Red-Cyan      glasses (R+GB)
    Anaglyph_RedCyan_Optimized,    //!< optimized filter for Red-Cyan      glasses (R+GB)
    Anaglyph_YellowBlue_Simple,    //!< simple    filter for Yellow-Blue   glasses (RG+B)
    Anaglyph_YellowBlue_Optimized, //!< optimized filter for Yellow-Blue   glasses (RG+B)
    Anaglyph_GreenMagenta_Simple,  //!< simple    filter for Green-Magenta glasses (G+RB)
    Anaglyph_UserDefined           //!< use externally specified matrices
  };

  //! Statistics display flags.
  //! If not specified otherwise, the counter value is computed for a single rendered frame.
  enum PerfCounters
  {
    PerfCounters_NONE        = 0x000, //!< no stats
    PerfCounters_FrameRate   = 0x001, //!< Frame Rate,        frames per second (number of frames within elapsed time)
    PerfCounters_CPU         = 0x002, //!< CPU utilization as frames per second (number of frames within CPU utilization time (rendering thread))
    PerfCounters_Layers      = 0x004, //!< count layers (groups of structures)
    PerfCounters_Structures  = 0x008, //!< count low-level Structures (normal unhighlighted Presentable Object is usually represented by 1 Structure)
    //
    PerfCounters_Groups      = 0x010, //!< count primitive Groups (1 Structure holds 1 or more primitive Group)
    PerfCounters_GroupArrays = 0x020, //!< count Arrays within Primitive Groups (optimal primitive Group holds 1 Array)
    //
    PerfCounters_Triangles   = 0x040, //!< count Triangles
    PerfCounters_Points      = 0x080, //!< count Points
    PerfCounters_Lines       = 0x100, //!< count Line segments
    //
    PerfCounters_EstimMem    = 0x200, //!< estimated GPU memory usage
    //
    PerfCounters_FrameTime   = 0x400, //!< frame CPU utilization time (rendering thread); @sa Graphic3d_FrameStatsTimer
    PerfCounters_FrameTimeMax= 0x800, //!< maximum frame times
    //
    PerfCounters_SkipImmediate = 0x1000, //!< do not include immediate viewer updates (e.g. lazy updates without redrawing entire view content)
    //! show basic statistics
    PerfCounters_Basic = PerfCounters_FrameRate | PerfCounters_CPU | PerfCounters_Layers | PerfCounters_Structures,
    //! extended (verbose) statistics
    PerfCounters_Extended = PerfCounters_Basic
                          | PerfCounters_Groups | PerfCounters_GroupArrays
                          | PerfCounters_Triangles | PerfCounters_Points | PerfCounters_Lines
                          | PerfCounters_EstimMem,
    //! all counters
    PerfCounters_All = PerfCounters_Extended
                     | PerfCounters_FrameTime
                     | PerfCounters_FrameTimeMax,
  };

  //! State of frustum culling optimization.
  enum FrustumCulling
  {
    FrustumCulling_Off,     //!< culling is disabled
    FrustumCulling_On,      //!< culling is active, and the list of culled entities is automatically updated before redraw
    FrustumCulling_NoUpdate //!< culling is active, but the list of culled entities is not updated
  };

public:

  //! Creates default rendering parameters.
  Graphic3d_RenderingParams()
  : Method                      (Graphic3d_RM_RASTERIZATION),
    ShadingModel                (Graphic3d_TOSM_FRAGMENT),
    TransparencyMethod          (Graphic3d_RTM_BLEND_UNORDERED),
    Resolution                  (THE_DEFAULT_RESOLUTION),
    FontHinting                 (Font_Hinting_Off),
    LineFeather                 (1.0f),
    // PBR parameters
    PbrEnvPow2Size              (9),
    PbrEnvSpecMapNbLevels       (6),
    PbrEnvBakingDiffNbSamples   (1024),
    PbrEnvBakingSpecNbSamples   (256),
    PbrEnvBakingProbability     (0.99f),
    //
    OitDepthFactor              (0.0f),
    NbOitDepthPeelingLayers     (4),
    NbMsaaSamples               (0),
    RenderResolutionScale       (1.0f),
    ShadowMapResolution         (1024),
    ShadowMapBias               (0.005f),
    ToEnableDepthPrepass        (Standard_False),
    ToEnableAlphaToCoverage     (Standard_True),
    // ray tracing parameters
    IsGlobalIlluminationEnabled (Standard_False),
    SamplesPerPixel(0),
    RaytracingDepth             (THE_DEFAULT_DEPTH),
    IsShadowEnabled             (Standard_True),
    IsReflectionEnabled         (Standard_False),
    IsAntialiasingEnabled       (Standard_False),
    IsTransparentShadowEnabled  (Standard_False),
    UseEnvironmentMapBackground (Standard_False),
    ToIgnoreNormalMapInRayTracing (Standard_False),
    CoherentPathTracingMode     (Standard_False),
    AdaptiveScreenSampling      (Standard_False),
    AdaptiveScreenSamplingAtomic(Standard_False),
    ShowSamplingTiles           (Standard_False),
    TwoSidedBsdfModels          (Standard_False),
    RadianceClampingValue       (30.0),
    RebuildRayTracingShaders    (Standard_False),
    RayTracingTileSize          (32),
    NbRayTracingTiles           (16 * 16),
    CameraApertureRadius        (0.0f),
    CameraFocalPlaneDist        (1.0f),
    FrustumCullingState         (FrustumCulling_On),
    ToneMappingMethod           (Graphic3d_ToneMappingMethod_Disabled),
    Exposure                    (0.f),
    WhitePoint                  (1.f),
    // stereoscopic parameters
    StereoMode (Graphic3d_StereoMode_QuadBuffer),
    HmdFov2d (30.0f),
    AnaglyphFilter (Anaglyph_RedCyan_Optimized),
    ToReverseStereo (Standard_False),
    ToMirrorComposer (Standard_True),
    //
    StatsPosition (new Graphic3d_TransformPers (Graphic3d_TMF_2d, Aspect_TOTP_LEFT_UPPER,  Graphic3d_Vec2i (20, 20))),
    ChartPosition (new Graphic3d_TransformPers (Graphic3d_TMF_2d, Aspect_TOTP_RIGHT_UPPER, Graphic3d_Vec2i (20, 20))),
    ChartSize (-1, -1),
    StatsTextAspect (new Graphic3d_AspectText3d()),
    StatsUpdateInterval (1.0),
    StatsTextHeight (16),
    StatsNbFrames (1),
    StatsMaxChartTime (0.1f),
    CollectedStats (PerfCounters_Basic),
    ToShowStats (Standard_False)
  {
    const Graphic3d_Vec4 aZero (0.0f, 0.0f, 0.0f, 0.0f);
    AnaglyphLeft .SetRow (0, Graphic3d_Vec4 (1.0f,  0.0f,  0.0f, 0.0f));
    AnaglyphLeft .SetRow (1, aZero);
    AnaglyphLeft .SetRow (2, aZero);
    AnaglyphLeft .SetRow (3, aZero);
    AnaglyphRight.SetRow (0, aZero);
    AnaglyphRight.SetRow (1, Graphic3d_Vec4 (0.0f,  1.0f,  0.0f, 0.0f));
    AnaglyphRight.SetRow (2, Graphic3d_Vec4 (0.0f,  0.0f,  1.0f, 0.0f));
    AnaglyphRight.SetRow (3, aZero);

    StatsTextAspect->SetColor (Quantity_NOC_WHITE);
    StatsTextAspect->SetColorSubTitle (Quantity_NOC_BLACK);
    StatsTextAspect->SetFont (Font_NOF_ASCII_MONO);
    StatsTextAspect->SetDisplayType (Aspect_TODT_SHADOW);
    StatsTextAspect->SetTextZoomable (Standard_False);
    StatsTextAspect->SetTextFontAspect (Font_FA_Regular);
  }

  //! Returns resolution ratio.
  Standard_ShortReal ResolutionRatio() const
  {
    return Resolution / static_cast<Standard_ShortReal> (THE_DEFAULT_RESOLUTION);
  }

  //! Dumps the content of me into the stream
  Standard_EXPORT void DumpJson (Standard_OStream& theOStream, Standard_Integer theDepth = -1) const;

public: //! @name general parameters

  Graphic3d_RenderingMode           Method;                      //!< specifies rendering mode, Graphic3d_RM_RASTERIZATION by default
  Graphic3d_TypeOfShadingModel      ShadingModel;                //!< specified default shading model, Graphic3d_TOSM_FRAGMENT by default
  Graphic3d_RenderTransparentMethod TransparencyMethod;          //!< specifies rendering method for transparent graphics
  unsigned int                      Resolution;                  //!< Pixels density (PPI), defines scaling factor for parameters like text size
                                                                 //!  (when defined in screen-space units rather than in 3D) to be properly displayed
                                                                 //!  on device (screen / printer). 72 is default value.
                                                                 //!  Note that using difference resolution in different Views in same Viewer
                                                                 //!  will lead to performance regression (for example, text will be recreated every time).
  Font_Hinting                      FontHinting;                 //!< enables/disables text hinting within textured fonts, Font_Hinting_Off by default;
                                                                 //!  hinting improves readability of thin text on low-resolution screen,
                                                                 //!  but adds distortions to original font depending on font family and font library version
  Standard_ShortReal                LineFeather;                 //!< line feather width in pixels (> 0.0), 1.0 by default;
                                                                 //!  high values produce blurred results, small values produce sharp (aliased) edges

public: //! @name rendering resolution parameters

  Standard_Integer                  PbrEnvPow2Size;              //!< size of IBL maps side can be calculated as 2^PbrEnvPow2Size (> 0), 9 by default
  Standard_Integer                  PbrEnvSpecMapNbLevels;       //!< number of levels used in specular IBL map (> 1), 6 by default
  Standard_Integer                  PbrEnvBakingDiffNbSamples;   //!< number of samples used in Monte-Carlo integration during diffuse IBL map's
                                                                 //!  spherical harmonics coefficients generation (> 0), 1024 by default
  Standard_Integer                  PbrEnvBakingSpecNbSamples;   //!< number of samples used in Monte-Carlo integration during specular IBL map's generation (> 0), 256 by default
  Standard_ShortReal                PbrEnvBakingProbability;     //!< controls strength of samples reducing strategy during specular IBL map's generation
                                                                 //!  (see 'SpecIBLMapSamplesFactor' function for detail explanation) [0.0, 1.0], 0.99 by default

  Standard_ShortReal                OitDepthFactor;              //!< scalar factor [0-1] controlling influence of depth of a fragment to its final coverage (Graphic3d_RTM_BLEND_OIT), 0.0 by default
  Standard_Integer                  NbOitDepthPeelingLayers;     //!< number of depth peeling (Graphic3d_RTM_DEPTH_PEELING_OIT) layers, 4 by default
  Standard_Integer                  NbMsaaSamples;               //!< number of MSAA samples (should be within 0..GL_MAX_SAMPLES, power-of-two number), 0 by default
  Standard_ShortReal                RenderResolutionScale;       //!< rendering resolution scale factor, 1 by default;
                                                                 //!  incompatible with MSAA (e.g. NbMsaaSamples should be set to 0)
  Standard_Integer                  ShadowMapResolution;         //!< shadow texture map resolution, 1024 by default
  Standard_ShortReal                ShadowMapBias;               //!< shadowmap bias, 0.005 by default;
  Standard_Boolean                  ToEnableDepthPrepass;        //!< enables/disables depth pre-pass, False by default
  Standard_Boolean                  ToEnableAlphaToCoverage;     //!< enables/disables alpha to coverage, True by default

public: //! @name Ray-Tracing/Path-Tracing parameters

  Standard_Boolean                  IsGlobalIlluminationEnabled; //!< enables/disables global illumination effects (path tracing)
  Standard_Integer                  SamplesPerPixel;             //!< number of samples per pixel (SPP)
  Standard_Integer                  RaytracingDepth;             //!< maximum ray-tracing depth, 3 by default
  Standard_Boolean                  IsShadowEnabled;             //!< enables/disables shadows rendering, True by default
  Standard_Boolean                  IsReflectionEnabled;         //!< enables/disables specular reflections, False by default
  Standard_Boolean                  IsAntialiasingEnabled;       //!< enables/disables adaptive anti-aliasing, False by default
  Standard_Boolean                  IsTransparentShadowEnabled;  //!< enables/disables light propagation through transparent media, False by default
  Standard_Boolean                  UseEnvironmentMapBackground; //!< enables/disables environment map background
  Standard_Boolean                  ToIgnoreNormalMapInRayTracing; //!< enables/disables normal map ignoring during path tracing; FALSE by default
  Standard_Boolean                  CoherentPathTracingMode;     //!< enables/disables 'coherent' tracing mode (single RNG seed within 16x16 image blocks)
  Standard_Boolean                  AdaptiveScreenSampling;      //!< enables/disables adaptive screen sampling mode for path tracing, FALSE by default
  Standard_Boolean                  AdaptiveScreenSamplingAtomic;//!< enables/disables usage of atomic float operations within adaptive screen sampling, FALSE by default
  Standard_Boolean                  ShowSamplingTiles;           //!< enables/disables debug mode for adaptive screen sampling, FALSE by default
  Standard_Boolean                  TwoSidedBsdfModels;          //!< forces path tracing to use two-sided versions of original one-sided scattering models
  Standard_ShortReal                RadianceClampingValue;       //!< maximum radiance value used for clamping radiance estimation.
  Standard_Boolean                  RebuildRayTracingShaders;    //!< forces rebuilding ray tracing shaders at the next frame
  Standard_Integer                  RayTracingTileSize;          //!< screen tile size, 32 by default (adaptive sampling mode of path tracing);
  Standard_Integer                  NbRayTracingTiles;           //!< maximum number of screen tiles per frame, 256 by default (adaptive sampling mode of path tracing);
                                                                 //!  this parameter limits the number of tiles to be rendered per redraw, increasing Viewer interactivity,
                                                                 //!  but also increasing the time for achieving a good quality; -1 means no limit
  Standard_ShortReal                CameraApertureRadius;        //!< aperture radius of perspective camera used for depth-of-field, 0.0 by default (no DOF) (path tracing only)
  Standard_ShortReal                CameraFocalPlaneDist;        //!< focal  distance of perspective camera used for depth-of field, 1.0 by default (path tracing only)
  FrustumCulling                    FrustumCullingState;         //!< state of frustum culling optimization; FrustumCulling_On by default

  Graphic3d_ToneMappingMethod       ToneMappingMethod;           //!< specifies tone mapping method for path tracing, Graphic3d_ToneMappingMethod_Disabled by default
  Standard_ShortReal                Exposure;                    //!< exposure value used for tone mapping (path tracing), 0.0 by default
  Standard_ShortReal                WhitePoint;                  //!< white point value used in filmic tone mapping (path tracing), 1.0 by default

public: //! @name VR / stereoscopic parameters

  Graphic3d_StereoMode              StereoMode;                  //!< stereoscopic output mode, Graphic3d_StereoMode_QuadBuffer by default
  Standard_ShortReal                HmdFov2d;                    //!< sharp field of view range in degrees for displaying on-screen 2D elements, 30.0 by default;
  Anaglyph                          AnaglyphFilter;              //!< filter for anaglyph output, Anaglyph_RedCyan_Optimized by default
  Graphic3d_Mat4                    AnaglyphLeft;                //!< left  anaglyph filter (in normalized colorspace), Color = AnaglyphRight * theColorRight + AnaglyphLeft * theColorLeft;
  Graphic3d_Mat4                    AnaglyphRight;               //!< right anaglyph filter (in normalized colorspace), Color = AnaglyphRight * theColorRight + AnaglyphLeft * theColorLeft;
  Standard_Boolean                  ToReverseStereo;             //!< flag to reverse stereo pair, FALSE by default
  Standard_Boolean                  ToMirrorComposer;            //!< if output device is an external composer - mirror rendering results in window in addition to sending frame to composer, TRUE by default

public: //! @name on-screen display parameters

  Handle(Graphic3d_TransformPers)   StatsPosition;               //!< location of stats, upper-left position by default
  Handle(Graphic3d_TransformPers)   ChartPosition;               //!< location of stats chart, upper-right position by default
  Graphic3d_Vec2i                   ChartSize;                   //!< chart size in pixels, (-1, -1) by default which means that chart will occupy a portion of viewport
  Handle(Graphic3d_AspectText3d)    StatsTextAspect;             //!< stats text aspect
  Standard_ShortReal                StatsUpdateInterval;         //!< time interval between stats updates in seconds, 1.0 second by default;
                                                                 //!  too often updates might impact performance and will smear text within widgets
                                                                 //!  (especially framerate, which is better averaging);
                                                                 //!  0.0 interval will force updating on each frame
  Standard_Integer                  StatsTextHeight;             //!< stats text size; 16 by default
  Standard_Integer                  StatsNbFrames;               //!< number of data frames to collect history; 1 by default
  Standard_ShortReal                StatsMaxChartTime;           //!< upper time limit within frame chart in seconds; 0.1 seconds by default (100 ms or 10 FPS)
  PerfCounters                      CollectedStats;              //!< performance counters to collect, PerfCounters_Basic by default;
                                                                 //!  too verbose options might impact rendering performance,
                                                                 //!  because some counters might lack caching optimization (and will require expensive iteration through all data structures)
  Standard_Boolean                  ToShowStats;                 //!< display performance statistics, FALSE by default;
                                                                 //!  note that counters specified within CollectedStats will be updated nevertheless
                                                                 //!  of visibility of widget managed by ToShowStats flag (e.g. stats can be retrieved by application for displaying using other methods)

};

#endif // _Graphic3d_RenderingParams_HeaderFile
Commit	Line	Data
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
d37aef5c	19	#include <Font_Hinting.hxx>
15669413	20	#include <Graphic3d_AspectText3d.hxx>
15669413	21	#include <Graphic3d_TransformPers.hxx>
a1073ae2	22	#include <Graphic3d_RenderTransparentMethod.hxx>
bc8c79bb	23	#include <Graphic3d_RenderingMode.hxx>
f978241f	24	#include <Graphic3d_StereoMode.hxx>
eb85ed36	25	#include <Graphic3d_ToneMappingMethod.hxx>
114db5a5	26	#include <Graphic3d_TypeOfShadingModel.hxx>
f978241f	27	#include <Graphic3d_Vec4.hxx>
bc8c79bb	28
	29	//! Helper class to store rendering parameters.
	30	class Graphic3d_RenderingParams
	31	{
	32	public:
4b1c8733	33	//! Default pixels density.
4b1c8733	34	static const unsigned int THE_DEFAULT_RESOLUTION = 72u;
bc8c79bb	35
	36	//! Default ray-tracing depth.
	37	static const Standard_Integer THE_DEFAULT_DEPTH = 3;
	38
f978241f	39	//! Anaglyph filter presets.
	40	enum Anaglyph
	41	{
	42	Anaglyph_RedCyan_Simple, //!< simple filter for Red-Cyan glasses (R+GB)
	43	Anaglyph_RedCyan_Optimized, //!< optimized filter for Red-Cyan glasses (R+GB)
	44	Anaglyph_YellowBlue_Simple, //!< simple filter for Yellow-Blue glasses (RG+B)
	45	Anaglyph_YellowBlue_Optimized, //!< optimized filter for Yellow-Blue glasses (RG+B)
	46	Anaglyph_GreenMagenta_Simple, //!< simple filter for Green-Magenta glasses (G+RB)
	47	Anaglyph_UserDefined //!< use externally specified matrices
	48	};
	49
15669413	50	//! Statistics display flags.
5e30547b	51	//! If not specified otherwise, the counter value is computed for a single rendered frame.
15669413	52	enum PerfCounters
	53	{
	54	PerfCounters_NONE = 0x000, //!< no stats
5e30547b	55	PerfCounters_FrameRate = 0x001, //!< Frame Rate, frames per second (number of frames within elapsed time)
5e30547b	56	PerfCounters_CPU = 0x002, //!< CPU utilization as frames per second (number of frames within CPU utilization time (rendering thread))
15669413	57	PerfCounters_Layers = 0x004, //!< count layers (groups of structures)
	58	PerfCounters_Structures = 0x008, //!< count low-level Structures (normal unhighlighted Presentable Object is usually represented by 1 Structure)
	59	//
	60	PerfCounters_Groups = 0x010, //!< count primitive Groups (1 Structure holds 1 or more primitive Group)
	61	PerfCounters_GroupArrays = 0x020, //!< count Arrays within Primitive Groups (optimal primitive Group holds 1 Array)
	62	//
	63	PerfCounters_Triangles = 0x040, //!< count Triangles
	64	PerfCounters_Points = 0x080, //!< count Points
b9f43ad1	65	PerfCounters_Lines = 0x100, //!< count Line segments
15669413	66	//
b9f43ad1	67	PerfCounters_EstimMem = 0x200, //!< estimated GPU memory usage
5e30547b	68	//
b9f43ad1	69	PerfCounters_FrameTime = 0x400, //!< frame CPU utilization time (rendering thread); @sa Graphic3d_FrameStatsTimer
b9f43ad1	70	PerfCounters_FrameTimeMax= 0x800, //!< maximum frame times
5e30547b	71	//
b9f43ad1	72	PerfCounters_SkipImmediate = 0x1000, //!< do not include immediate viewer updates (e.g. lazy updates without redrawing entire view content)
15669413	73	//! show basic statistics
	74	PerfCounters_Basic = PerfCounters_FrameRate \| PerfCounters_CPU \| PerfCounters_Layers \| PerfCounters_Structures,
	75	//! extended (verbose) statistics
	76	PerfCounters_Extended = PerfCounters_Basic
	77	\| PerfCounters_Groups \| PerfCounters_GroupArrays
b9f43ad1	78	\| PerfCounters_Triangles \| PerfCounters_Points \| PerfCounters_Lines
15669413	79	\| PerfCounters_EstimMem,
5e30547b	80	//! all counters
	81	PerfCounters_All = PerfCounters_Extended
	82	\| PerfCounters_FrameTime
	83	\| PerfCounters_FrameTimeMax,
15669413	84	};
15669413	85
0e3025bc	86	//! State of frustum culling optimization.
	87	enum FrustumCulling
	88	{
	89	FrustumCulling_Off, //!< culling is disabled
	90	FrustumCulling_On, //!< culling is active, and the list of culled entities is automatically updated before redraw
	91	FrustumCulling_NoUpdate //!< culling is active, but the list of culled entities is not updated
	92	};
	93
bc8c79bb	94	public:
	95
	96	//! Creates default rendering parameters.
	97	Graphic3d_RenderingParams()
189f85a3	98	: Method (Graphic3d_RM_RASTERIZATION),
114db5a5	99	ShadingModel (Graphic3d_TOSM_FRAGMENT),
a1073ae2	100	TransparencyMethod (Graphic3d_RTM_BLEND_UNORDERED),
d37aef5c	101	Resolution (THE_DEFAULT_RESOLUTION),
d37aef5c	102	FontHinting (Font_Hinting_Off),
2a332745	103	LineFeather (1.0f),
67312b79	104	// PBR parameters
	105	PbrEnvPow2Size (9),
	106	PbrEnvSpecMapNbLevels (6),
	107	PbrEnvBakingDiffNbSamples (1024),
	108	PbrEnvBakingSpecNbSamples (256),
	109	PbrEnvBakingProbability (0.99f),
	110	//
a1073ae2	111	OitDepthFactor (0.0f),
78c4e836	112	NbOitDepthPeelingLayers (4),
3c4b62a4	113	NbMsaaSamples (0),
56689b27	114	RenderResolutionScale (1.0f),
d84e8669	115	ShadowMapResolution (1024),
d84e8669	116	ShadowMapBias (0.005f),
f88457e6	117	ToEnableDepthPrepass (Standard_False),
2a332745	118	ToEnableAlphaToCoverage (Standard_True),
3c4b62a4	119	// ray tracing parameters
f978241f	120	IsGlobalIlluminationEnabled (Standard_False),
d533dafb	121	SamplesPerPixel(0),
f978241f	122	RaytracingDepth (THE_DEFAULT_DEPTH),
189f85a3	123	IsShadowEnabled (Standard_True),
	124	IsReflectionEnabled (Standard_False),
	125	IsAntialiasingEnabled (Standard_False),
	126	IsTransparentShadowEnabled (Standard_False),
f978241f	127	UseEnvironmentMapBackground (Standard_False),
78607702	128	ToIgnoreNormalMapInRayTracing (Standard_False),
8c820969	129	CoherentPathTracingMode (Standard_False),
3a9b5dc8	130	AdaptiveScreenSampling (Standard_False),
e084dbbc	131	AdaptiveScreenSamplingAtomic(Standard_False),
3a9b5dc8	132	ShowSamplingTiles (Standard_False),
b4327ba8	133	TwoSidedBsdfModels (Standard_False),
b09447ed	134	RadianceClampingValue (30.0),
d877e610	135	RebuildRayTracingShaders (Standard_False),
66d1cdc6	136	RayTracingTileSize (32),
4eaaf9d8	137	NbRayTracingTiles (16 * 16),
b27ab03d	138	CameraApertureRadius (0.0f),
b27ab03d	139	CameraFocalPlaneDist (1.0f),
0e3025bc	140	FrustumCullingState (FrustumCulling_On),
eb85ed36	141	ToneMappingMethod (Graphic3d_ToneMappingMethod_Disabled),
	142	Exposure (0.f),
	143	WhitePoint (1.f),
3c4b62a4	144	// stereoscopic parameters
f978241f	145	StereoMode (Graphic3d_StereoMode_QuadBuffer),
b40cdc2b	146	HmdFov2d (30.0f),
f978241f	147	AnaglyphFilter (Anaglyph_RedCyan_Optimized),
4b1c8733	148	ToReverseStereo (Standard_False),
b40cdc2b	149	ToMirrorComposer (Standard_True),
15669413	150	//
5e30547b	151	StatsPosition (new Graphic3d_TransformPers (Graphic3d_TMF_2d, Aspect_TOTP_LEFT_UPPER, Graphic3d_Vec2i (20, 20))),
	152	ChartPosition (new Graphic3d_TransformPers (Graphic3d_TMF_2d, Aspect_TOTP_RIGHT_UPPER, Graphic3d_Vec2i (20, 20))),
	153	ChartSize (-1, -1),
15669413	154	StatsTextAspect (new Graphic3d_AspectText3d()),
	155	StatsUpdateInterval (1.0),
	156	StatsTextHeight (16),
5e30547b	157	StatsNbFrames (1),
5e30547b	158	StatsMaxChartTime (0.1f),
15669413	159	CollectedStats (PerfCounters_Basic),
d37aef5c	160	ToShowStats (Standard_False)
bc8c79bb	161	{
f978241f	162	const Graphic3d_Vec4 aZero (0.0f, 0.0f, 0.0f, 0.0f);
	163	AnaglyphLeft .SetRow (0, Graphic3d_Vec4 (1.0f, 0.0f, 0.0f, 0.0f));
	164	AnaglyphLeft .SetRow (1, aZero);
	165	AnaglyphLeft .SetRow (2, aZero);
	166	AnaglyphLeft .SetRow (3, aZero);
	167	AnaglyphRight.SetRow (0, aZero);
	168	AnaglyphRight.SetRow (1, Graphic3d_Vec4 (0.0f, 1.0f, 0.0f, 0.0f));
	169	AnaglyphRight.SetRow (2, Graphic3d_Vec4 (0.0f, 0.0f, 1.0f, 0.0f));
	170	AnaglyphRight.SetRow (3, aZero);
15669413	171
	172	StatsTextAspect->SetColor (Quantity_NOC_WHITE);
	173	StatsTextAspect->SetColorSubTitle (Quantity_NOC_BLACK);
	174	StatsTextAspect->SetFont (Font_NOF_ASCII_MONO);
	175	StatsTextAspect->SetDisplayType (Aspect_TODT_SHADOW);
	176	StatsTextAspect->SetTextZoomable (Standard_False);
	177	StatsTextAspect->SetTextFontAspect (Font_FA_Regular);
bc8c79bb	178	}
bc8c79bb	179
75c262a9	180	//! Returns resolution ratio.
	181	Standard_ShortReal ResolutionRatio() const
	182	{
	183	return Resolution / static_cast<Standard_ShortReal> (THE_DEFAULT_RESOLUTION);
	184	}
d37aef5c	185
a5162275	186	//! Dumps the content of me into the stream
a5162275	187	Standard_EXPORT void DumpJson (Standard_OStream& theOStream, Standard_Integer theDepth = -1) const;
75c262a9	188
d37aef5c	189	public: //! @name general parameters
bc8c79bb	190
a1073ae2	191	Graphic3d_RenderingMode Method; //!< specifies rendering mode, Graphic3d_RM_RASTERIZATION by default
114db5a5	192	Graphic3d_TypeOfShadingModel ShadingModel; //!< specified default shading model, Graphic3d_TOSM_FRAGMENT by default
a1073ae2	193	Graphic3d_RenderTransparentMethod TransparencyMethod; //!< specifies rendering method for transparent graphics
d37aef5c	194	unsigned int Resolution; //!< Pixels density (PPI), defines scaling factor for parameters like text size
	195	//! (when defined in screen-space units rather than in 3D) to be properly displayed
	196	//! on device (screen / printer). 72 is default value.
	197	//! Note that using difference resolution in different Views in same Viewer
	198	//! will lead to performance regression (for example, text will be recreated every time).
	199	Font_Hinting FontHinting; //!< enables/disables text hinting within textured fonts, Font_Hinting_Off by default;
	200	//! hinting improves readability of thin text on low-resolution screen,
	201	//! but adds distortions to original font depending on font family and font library version
	202	Standard_ShortReal LineFeather; //!< line feather width in pixels (> 0.0), 1.0 by default;
2a332745	203	//! high values produce blurred results, small values produce sharp (aliased) edges
67312b79	204
d37aef5c	205	public: //! @name rendering resolution parameters
d37aef5c	206
67312b79	207	Standard_Integer PbrEnvPow2Size; //!< size of IBL maps side can be calculated as 2^PbrEnvPow2Size (> 0), 9 by default
	208	Standard_Integer PbrEnvSpecMapNbLevels; //!< number of levels used in specular IBL map (> 1), 6 by default
	209	Standard_Integer PbrEnvBakingDiffNbSamples; //!< number of samples used in Monte-Carlo integration during diffuse IBL map's
	210	//! spherical harmonics coefficients generation (> 0), 1024 by default
	211	Standard_Integer PbrEnvBakingSpecNbSamples; //!< number of samples used in Monte-Carlo integration during specular IBL map's generation (> 0), 256 by default
	212	Standard_ShortReal PbrEnvBakingProbability; //!< controls strength of samples reducing strategy during specular IBL map's generation
	213	//! (see 'SpecIBLMapSamplesFactor' function for detail explanation) [0.0, 1.0], 0.99 by default
	214
78c4e836	215	Standard_ShortReal OitDepthFactor; //!< scalar factor [0-1] controlling influence of depth of a fragment to its final coverage (Graphic3d_RTM_BLEND_OIT), 0.0 by default
78c4e836	216	Standard_Integer NbOitDepthPeelingLayers; //!< number of depth peeling (Graphic3d_RTM_DEPTH_PEELING_OIT) layers, 4 by default
a1073ae2	217	Standard_Integer NbMsaaSamples; //!< number of MSAA samples (should be within 0..GL_MAX_SAMPLES, power-of-two number), 0 by default
	218	Standard_ShortReal RenderResolutionScale; //!< rendering resolution scale factor, 1 by default;
	219	//! incompatible with MSAA (e.g. NbMsaaSamples should be set to 0)
d84e8669	220	Standard_Integer ShadowMapResolution; //!< shadow texture map resolution, 1024 by default
d84e8669	221	Standard_ShortReal ShadowMapBias; //!< shadowmap bias, 0.005 by default;
f88457e6	222	Standard_Boolean ToEnableDepthPrepass; //!< enables/disables depth pre-pass, False by default
2a332745	223	Standard_Boolean ToEnableAlphaToCoverage; //!< enables/disables alpha to coverage, True by default
a1073ae2	224
d37aef5c	225	public: //! @name Ray-Tracing/Path-Tracing parameters
d37aef5c	226
a1073ae2	227	Standard_Boolean IsGlobalIlluminationEnabled; //!< enables/disables global illumination effects (path tracing)
	228	Standard_Integer SamplesPerPixel; //!< number of samples per pixel (SPP)
	229	Standard_Integer RaytracingDepth; //!< maximum ray-tracing depth, 3 by default
	230	Standard_Boolean IsShadowEnabled; //!< enables/disables shadows rendering, True by default
	231	Standard_Boolean IsReflectionEnabled; //!< enables/disables specular reflections, False by default
	232	Standard_Boolean IsAntialiasingEnabled; //!< enables/disables adaptive anti-aliasing, False by default
	233	Standard_Boolean IsTransparentShadowEnabled; //!< enables/disables light propagation through transparent media, False by default
	234	Standard_Boolean UseEnvironmentMapBackground; //!< enables/disables environment map background
78607702	235	Standard_Boolean ToIgnoreNormalMapInRayTracing; //!< enables/disables normal map ignoring during path tracing; FALSE by default
a1073ae2	236	Standard_Boolean CoherentPathTracingMode; //!< enables/disables 'coherent' tracing mode (single RNG seed within 16x16 image blocks)
a1073ae2	237	Standard_Boolean AdaptiveScreenSampling; //!< enables/disables adaptive screen sampling mode for path tracing, FALSE by default
e084dbbc	238	Standard_Boolean AdaptiveScreenSamplingAtomic;//!< enables/disables usage of atomic float operations within adaptive screen sampling, FALSE by default
a1073ae2	239	Standard_Boolean ShowSamplingTiles; //!< enables/disables debug mode for adaptive screen sampling, FALSE by default
	240	Standard_Boolean TwoSidedBsdfModels; //!< forces path tracing to use two-sided versions of original one-sided scattering models
	241	Standard_ShortReal RadianceClampingValue; //!< maximum radiance value used for clamping radiance estimation.
	242	Standard_Boolean RebuildRayTracingShaders; //!< forces rebuilding ray tracing shaders at the next frame
66d1cdc6	243	Standard_Integer RayTracingTileSize; //!< screen tile size, 32 by default (adaptive sampling mode of path tracing);
	244	Standard_Integer NbRayTracingTiles; //!< maximum number of screen tiles per frame, 256 by default (adaptive sampling mode of path tracing);
	245	//! this parameter limits the number of tiles to be rendered per redraw, increasing Viewer interactivity,
	246	//! but also increasing the time for achieving a good quality; -1 means no limit
b27ab03d	247	Standard_ShortReal CameraApertureRadius; //!< aperture radius of perspective camera used for depth-of-field, 0.0 by default (no DOF) (path tracing only)
b27ab03d	248	Standard_ShortReal CameraFocalPlaneDist; //!< focal distance of perspective camera used for depth-of field, 1.0 by default (path tracing only)
0e3025bc	249	FrustumCulling FrustumCullingState; //!< state of frustum culling optimization; FrustumCulling_On by default
a1073ae2	250
eb85ed36	251	Graphic3d_ToneMappingMethod ToneMappingMethod; //!< specifies tone mapping method for path tracing, Graphic3d_ToneMappingMethod_Disabled by default
	252	Standard_ShortReal Exposure; //!< exposure value used for tone mapping (path tracing), 0.0 by default
	253	Standard_ShortReal WhitePoint; //!< white point value used in filmic tone mapping (path tracing), 1.0 by default
	254
d37aef5c	255	public: //! @name VR / stereoscopic parameters
d37aef5c	256
a1073ae2	257	Graphic3d_StereoMode StereoMode; //!< stereoscopic output mode, Graphic3d_StereoMode_QuadBuffer by default
b40cdc2b	258	Standard_ShortReal HmdFov2d; //!< sharp field of view range in degrees for displaying on-screen 2D elements, 30.0 by default;
a1073ae2	259	Anaglyph AnaglyphFilter; //!< filter for anaglyph output, Anaglyph_RedCyan_Optimized by default
	260	Graphic3d_Mat4 AnaglyphLeft; //!< left anaglyph filter (in normalized colorspace), Color = AnaglyphRight * theColorRight + AnaglyphLeft * theColorLeft;
	261	Graphic3d_Mat4 AnaglyphRight; //!< right anaglyph filter (in normalized colorspace), Color = AnaglyphRight * theColorRight + AnaglyphLeft * theColorLeft;
	262	Standard_Boolean ToReverseStereo; //!< flag to reverse stereo pair, FALSE by default
b40cdc2b	263	Standard_Boolean ToMirrorComposer; //!< if output device is an external composer - mirror rendering results in window in addition to sending frame to composer, TRUE by default
a1073ae2	264
d37aef5c	265	public: //! @name on-screen display parameters
d37aef5c	266
15669413	267	Handle(Graphic3d_TransformPers) StatsPosition; //!< location of stats, upper-left position by default
5e30547b	268	Handle(Graphic3d_TransformPers) ChartPosition; //!< location of stats chart, upper-right position by default
5e30547b	269	Graphic3d_Vec2i ChartSize; //!< chart size in pixels, (-1, -1) by default which means that chart will occupy a portion of viewport
15669413	270	Handle(Graphic3d_AspectText3d) StatsTextAspect; //!< stats text aspect
	271	Standard_ShortReal StatsUpdateInterval; //!< time interval between stats updates in seconds, 1.0 second by default;
	272	//! too often updates might impact performance and will smear text within widgets
	273	//! (especially framerate, which is better averaging);
	274	//! 0.0 interval will force updating on each frame
	275	Standard_Integer StatsTextHeight; //!< stats text size; 16 by default
5e30547b	276	Standard_Integer StatsNbFrames; //!< number of data frames to collect history; 1 by default
5e30547b	277	Standard_ShortReal StatsMaxChartTime; //!< upper time limit within frame chart in seconds; 0.1 seconds by default (100 ms or 10 FPS)
15669413	278	PerfCounters CollectedStats; //!< performance counters to collect, PerfCounters_Basic by default;
	279	//! too verbose options might impact rendering performance,
	280	//! because some counters might lack caching optimization (and will require expensive iteration through all data structures)
	281	Standard_Boolean ToShowStats; //!< display performance statistics, FALSE by default;
	282	//! note that counters specified within CollectedStats will be updated nevertheless
	283	//! of visibility of widget managed by ToShowStats flag (e.g. stats can be retrieved by application for displaying using other methods)
	284
bc8c79bb	285	};
	286
	287	#endif // _Graphic3d_RenderingParams_HeaderFile