Open Inventor Release 2024.1.2
 
Loading...
Searching...
No Matches
SoFullSceneAntialiasingParameters Class Reference

VSG extension Antialiasing parameters class for the FSAA algorithm. More...

#include <Inventor/antialiasing/SoFullSceneAntialiasingParameters.h>

+ Inheritance diagram for SoFullSceneAntialiasingParameters:

Public Member Functions

 SoFullSceneAntialiasingParameters (const int numSamples, const bool useHQ, const int filterMask=SoFullSceneAntialiasing::ALL)
 Constructor that takes the different parameters that can be configured.
 
virtual ~SoFullSceneAntialiasingParameters ()
 
bool useHighQualityFilter () const
 Returns true if the high quality filter is requested.
 
int getNumSamples () const
 Returns the requested number of samples.
 
int getFilterMask () const
 Returns the requested combination of the different values of SoFullSceneAntialiasing::Filter.
 
virtual SoAntialiasingParameterscopy () const
 Copy to a new instance.
 
- Public Member Functions inherited from SoAntialiasingParameters
virtual ~SoAntialiasingParameters ()
 Default destructor.
 

Detailed Description

VSG extension Antialiasing parameters class for the FSAA algorithm.

This class provides the different parameters that can be set to configure the FSAA antialiasing algorithm. These objects are used with the setAntialiasing() method in SoSceneManager and some viewer classes (e.g. SoWinGLWidget).

Limitations

The high quality filter is available only on NVidia platforms and only if the extension GL_NV_multisample_filter_hint is available.

SEE ALSO

SoAccumulationAntialiasingParameters, SoFXAAParameters, SoFullSceneAntialiasing

Definition at line 50 of file SoFullSceneAntialiasingParameters.h.

Constructor & Destructor Documentation

◆ SoFullSceneAntialiasingParameters()

SoFullSceneAntialiasingParameters::SoFullSceneAntialiasingParameters ( const int  numSamples,
const bool  useHQ,
const int  filterMask = SoFullSceneAntialiasing::ALL 
)

Constructor that takes the different parameters that can be configured.

Parameters
numSamplesThe number of samples we want to enable in the window's pixel format.
useHQIndicates if the high quality filter provided by NVidia should be enabled.
filterMaskIs a combination of SoFullSceneAntialiasing::Filter enum values to define the primitives affected by the FSAA.

◆ ~SoFullSceneAntialiasingParameters()

virtual SoFullSceneAntialiasingParameters::~SoFullSceneAntialiasingParameters ( )
virtual

Member Function Documentation

◆ copy()

virtual SoAntialiasingParameters * SoFullSceneAntialiasingParameters::copy ( ) const
inlinevirtual

Copy to a new instance.

Implements SoAntialiasingParameters.

Definition at line 87 of file SoFullSceneAntialiasingParameters.h.

◆ getFilterMask()

int SoFullSceneAntialiasingParameters::getFilterMask ( ) const

Returns the requested combination of the different values of SoFullSceneAntialiasing::Filter.

◆ getNumSamples()

int SoFullSceneAntialiasingParameters::getNumSamples ( ) const

Returns the requested number of samples.

The window's pixel format will have up to this number of samples. If the graphic device doesn't support this number of samples a lower number will be used.

◆ useHighQualityFilter()

bool SoFullSceneAntialiasingParameters::useHighQualityFilter ( ) const

Returns true if the high quality filter is requested.


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