Open Inventor Release 2024.1.1
 
Loading...
Searching...
No Matches
SoFXAAParameters Class Reference

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

#include <Inventor/antialiasing/SoFXAAParameters.h>

+ Inheritance diagram for SoFXAAParameters:

Public Member Functions

 SoFXAAParameters (int qualityPreset, float subPixQuality, float edgeThresholdQuality, float edgeThresholdMin)
 Constructor which takes a value for each possible parameter.
 
virtual ~SoFXAAParameters ()
 Default destructor.
 
int getQualityPreset () const
 Returns the quality preset.
 
float getSubPixQuality () const
 Returns the subPixQuality parameter.
 
float getEdgeThresholdQuality () const
 Returns the edgeThresholdQuality parameter.
 
float getEdgeThresholdMin () const
 Returns the edgeThresholdMinimum parameter.
 
bool operator== (const SoFXAAParameters &other) const
 
bool operator!= (const SoFXAAParameters &other) const
 
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 FXAA algorithm.

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

SEE ALSO

SoAccumulationAntialiasingParameters, SoFullSceneAntialiasingParameters

Definition at line 43 of file SoFXAAParameters.h.

Constructor & Destructor Documentation

◆ SoFXAAParameters()

SoFXAAParameters::SoFXAAParameters ( int  qualityPreset,
float  subPixQuality,
float  edgeThresholdQuality,
float  edgeThresholdMin 
)

Constructor which takes a value for each possible parameter.

Parameters
qualityPresetQuality value in the range [10;15] , [20;29] or equal to 39.
subPixQualityChooses the amount of sub-pixel aliasing removal (1.0 upper limit = softer, 0.0 = off).
edgeThresholdQualityThe minimum amount of local contrast required to apply algorithm (0.333 = too little but faster, 0.063 = overkill and slower).
edgeThresholdMinTrims the algorithm from processing darks (0.0833 = upper limit the start of visible unfiltered edges, 0.0625 = high quality and faster, 0.0312 = visible limit but slower).

◆ ~SoFXAAParameters()

virtual SoFXAAParameters::~SoFXAAParameters ( )
virtual

Default destructor.

Member Function Documentation

◆ copy()

virtual SoAntialiasingParameters * SoFXAAParameters::copy ( ) const
inlinevirtual

Copy to a new instance.

Implements SoAntialiasingParameters.

Definition at line 94 of file SoFXAAParameters.h.

◆ getEdgeThresholdMin()

float SoFXAAParameters::getEdgeThresholdMin ( ) const

Returns the edgeThresholdMinimum parameter.

◆ getEdgeThresholdQuality()

float SoFXAAParameters::getEdgeThresholdQuality ( ) const

Returns the edgeThresholdQuality parameter.

◆ getQualityPreset()

int SoFXAAParameters::getQualityPreset ( ) const

Returns the quality preset.

◆ getSubPixQuality()

float SoFXAAParameters::getSubPixQuality ( ) const

Returns the subPixQuality parameter.

◆ operator!=()

bool SoFXAAParameters::operator!= ( const SoFXAAParameters other) const
inline

Definition at line 88 of file SoFXAAParameters.h.

◆ operator==()

bool SoFXAAParameters::operator== ( const SoFXAAParameters other) const
inline

Definition at line 80 of file SoFXAAParameters.h.


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