SoFullSceneAntialiasingParameters Class Reference

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

#include <Inventor/antialiasing/SoFullSceneAntialiasingParameters.h>

Inheritance diagram for SoFullSceneAntialiasingParameters:

List of all members.

Public Member Functions

 SoFullSceneAntialiasingParameters (const int numSamples, const bool useHQ, const int filterMask=SoFullSceneAntialiasing::ALL)
virtual ~SoFullSceneAntialiasingParameters ()
bool useHighQualityFilter () const
int getNumSamples () const
int getFilterMask () const

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).


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


SoAccumulationAntialiasingParameters, SoFXAAParameters, SoFullSceneAntialiasing

Constructor & Destructor Documentation

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

Constructor that takes the different parameters that can be configured.

numSamples The number of samples we want to enable in the window's pixel format.
useHQ Indicates if the high quality filter provided by NVidia should be enabled.
filterMask Is a combination of SoFullSceneAntialiasing::Filter enum values to define the primitives affected by the FSAA.
virtual SoFullSceneAntialiasingParameters::~SoFullSceneAntialiasingParameters (  )  [virtual]

Member Function Documentation

int SoFullSceneAntialiasingParameters::getFilterMask (  )  const

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

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.

bool SoFullSceneAntialiasingParameters::useHighQualityFilter (  )  const

Returns true if the high quality filter is requested.

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

Open Inventor Toolkit reference manual, generated on 22 Sep 2021
Copyright © Thermo Fisher Scientific All rights reserved.