Open CASCADE Technology  7.1.0.beta
Public Types | Public Member Functions | Data Fields | Static Public Attributes

Graphic3d_RenderingParams Class Reference

Helper class to store rendering parameters. More...

#include <Graphic3d_RenderingParams.hxx>

Public Types

enum  Anaglyph {
  Anaglyph_RedCyan_Simple, Anaglyph_RedCyan_Optimized, Anaglyph_YellowBlue_Simple, Anaglyph_YellowBlue_Optimized,
  Anaglyph_GreenMagenta_Simple, Anaglyph_UserDefined
}
 Anaglyph filter presets. More...
 

Public Member Functions

 Graphic3d_RenderingParams ()
 Creates default rendering parameters. More...
 
Standard_ShortReal ResolutionRatio () const
 Returns resolution ratio. More...
 

Data Fields

Graphic3d_RenderingMode Method
 specifies rendering mode, Graphic3d_RM_RASTERIZATION by default More...
 
Standard_Integer NbMsaaSamples
 number of MSAA samples (should be within 0..GL_MAX_SAMPLES, power-of-two number), 0 by default More...
 
Standard_Boolean IsGlobalIlluminationEnabled
 enables/disables global illumination effects (path tracing) More...
 
Standard_Integer SamplesPerPixel
 number of samples per pixel (SPP) More...
 
Standard_Integer RaytracingDepth
 maximum ray-tracing depth, 3 by default More...
 
Standard_Boolean IsShadowEnabled
 enables/disables shadows rendering, True by default More...
 
Standard_Boolean IsReflectionEnabled
 enables/disables specular reflections, False by default More...
 
Standard_Boolean IsAntialiasingEnabled
 enables/disables adaptive anti-aliasing, False by default More...
 
Standard_Boolean IsTransparentShadowEnabled
 enables/disables light propagation through transparent media, False by default More...
 
Standard_Boolean UseEnvironmentMapBackground
 enables/disables environment map background More...
 
Standard_Boolean CoherentPathTracingMode
 enables/disables 'coherent' tracing mode (single RNG seed within 16x16 image blocks) More...
 
Standard_Boolean AdaptiveScreenSampling
 enables/disables adaptive screen sampling mode for path tracing, FALSE by default More...
 
Standard_Boolean ShowSamplingTiles
 enables/disables debug mode for adaptive screen sampling, FALSE by default More...
 
Standard_Boolean RebuildRayTracingShaders
 forces rebuilding ray tracing shaders at the next frame More...
 
Graphic3d_StereoMode StereoMode
 stereoscopic output mode, Graphic3d_StereoMode_QuadBuffer by default More...
 
Anaglyph AnaglyphFilter
 filter for anaglyph output, Anaglyph_RedCyan_Optimized by default More...
 
Graphic3d_Mat4 AnaglyphLeft
 left anaglyph filter (in normalized colorspace), Color = AnaglyphRight * theColorRight + AnaglyphLeft * theColorLeft; More...
 
Graphic3d_Mat4 AnaglyphRight
 right anaglyph filter (in normalized colorspace), Color = AnaglyphRight * theColorRight + AnaglyphLeft * theColorLeft; More...
 
Standard_Boolean ToReverseStereo
 flag to reverse stereo pair, FALSE by default More...
 
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). More...
 

Static Public Attributes

static const unsigned int THE_DEFAULT_RESOLUTION = 72u
 Default pixels density. More...
 
static const Standard_Integer THE_DEFAULT_SPP = 1
 Default number of samples per pixel. More...
 
static const Standard_Integer THE_DEFAULT_DEPTH = 3
 Default ray-tracing depth. More...
 

Detailed Description

Helper class to store rendering parameters.

Member Enumeration Documentation

Anaglyph filter presets.

Enumerator
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

Constructor & Destructor Documentation

Graphic3d_RenderingParams::Graphic3d_RenderingParams ( )
inline

Creates default rendering parameters.

Member Function Documentation

Standard_ShortReal Graphic3d_RenderingParams::ResolutionRatio ( ) const
inline

Returns resolution ratio.

Field Documentation

Standard_Boolean Graphic3d_RenderingParams::AdaptiveScreenSampling

enables/disables adaptive screen sampling mode for path tracing, FALSE by default

Anaglyph Graphic3d_RenderingParams::AnaglyphFilter

filter for anaglyph output, Anaglyph_RedCyan_Optimized by default

Graphic3d_Mat4 Graphic3d_RenderingParams::AnaglyphLeft

left anaglyph filter (in normalized colorspace), Color = AnaglyphRight * theColorRight + AnaglyphLeft * theColorLeft;

Graphic3d_Mat4 Graphic3d_RenderingParams::AnaglyphRight

right anaglyph filter (in normalized colorspace), Color = AnaglyphRight * theColorRight + AnaglyphLeft * theColorLeft;

Standard_Boolean Graphic3d_RenderingParams::CoherentPathTracingMode

enables/disables 'coherent' tracing mode (single RNG seed within 16x16 image blocks)

Standard_Boolean Graphic3d_RenderingParams::IsAntialiasingEnabled

enables/disables adaptive anti-aliasing, False by default

Standard_Boolean Graphic3d_RenderingParams::IsGlobalIlluminationEnabled

enables/disables global illumination effects (path tracing)

Standard_Boolean Graphic3d_RenderingParams::IsReflectionEnabled

enables/disables specular reflections, False by default

Standard_Boolean Graphic3d_RenderingParams::IsShadowEnabled

enables/disables shadows rendering, True by default

Standard_Boolean Graphic3d_RenderingParams::IsTransparentShadowEnabled

enables/disables light propagation through transparent media, False by default

Graphic3d_RenderingMode Graphic3d_RenderingParams::Method

specifies rendering mode, Graphic3d_RM_RASTERIZATION by default

Standard_Integer Graphic3d_RenderingParams::NbMsaaSamples

number of MSAA samples (should be within 0..GL_MAX_SAMPLES, power-of-two number), 0 by default

Standard_Integer Graphic3d_RenderingParams::RaytracingDepth

maximum ray-tracing depth, 3 by default

Standard_Boolean Graphic3d_RenderingParams::RebuildRayTracingShaders

forces rebuilding ray tracing shaders at the next frame

unsigned int Graphic3d_RenderingParams::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).

Standard_Integer Graphic3d_RenderingParams::SamplesPerPixel

number of samples per pixel (SPP)

Standard_Boolean Graphic3d_RenderingParams::ShowSamplingTiles

enables/disables debug mode for adaptive screen sampling, FALSE by default

Graphic3d_StereoMode Graphic3d_RenderingParams::StereoMode

stereoscopic output mode, Graphic3d_StereoMode_QuadBuffer by default

const Standard_Integer Graphic3d_RenderingParams::THE_DEFAULT_DEPTH = 3
static

Default ray-tracing depth.

const unsigned int Graphic3d_RenderingParams::THE_DEFAULT_RESOLUTION = 72u
static

Default pixels density.

const Standard_Integer Graphic3d_RenderingParams::THE_DEFAULT_SPP = 1
static

Default number of samples per pixel.

Standard_Boolean Graphic3d_RenderingParams::ToReverseStereo

flag to reverse stereo pair, FALSE by default

Standard_Boolean Graphic3d_RenderingParams::UseEnvironmentMapBackground

enables/disables environment map background


The documentation for this class was generated from the following file: