Configuration for FXAA implementations. More...

#include <vtkFXAAOptions.h>

Inheritance diagram for vtkFXAAOptions:

Collaboration diagram for vtkFXAAOptions:

Public Types
enum	DebugOption { FXAA_NO_DEBUG = 0 , FXAA_DEBUG_SUBPIXEL_ALIASING , FXAA_DEBUG_EDGE_DIRECTION , FXAA_DEBUG_EDGE_NUM_STEPS , FXAA_DEBUG_EDGE_DISTANCE , FXAA_DEBUG_EDGE_SAMPLE_OFFSET , FXAA_DEBUG_ONLY_SUBPIX_AA , FXAA_DEBUG_ONLY_EDGE_AA }
	Debugging options that affect the output color buffer. More...

typedef vtkObject	Superclass

Public Member Functions
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.

vtkFXAAOptions *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.


virtual void	SetRelativeContrastThreshold (float)
	Threshold for applying FXAA to a pixel, relative to the maximum luminosity of its 4 immediate neighbors.

virtual float	GetRelativeContrastThreshold ()
	Threshold for applying FXAA to a pixel, relative to the maximum luminosity of its 4 immediate neighbors.


virtual void	SetHardContrastThreshold (float)
	Similar to RelativeContrastThreshold, but not scaled by the maximum luminosity.

virtual float	GetHardContrastThreshold ()
	Similar to RelativeContrastThreshold, but not scaled by the maximum luminosity.


virtual void	SetSubpixelBlendLimit (float)
	Subpixel aliasing is corrected by applying a lowpass filter to the current pixel.

virtual float	GetSubpixelBlendLimit ()
	Subpixel aliasing is corrected by applying a lowpass filter to the current pixel.


virtual void	SetSubpixelContrastThreshold (float)
	Minimum amount of subpixel aliasing required for subpixel antialiasing to be applied.

virtual float	GetSubpixelContrastThreshold ()
	Minimum amount of subpixel aliasing required for subpixel antialiasing to be applied.


virtual void	SetUseHighQualityEndpoints (bool)
	Use an improved edge endpoint detection algorithm.

virtual bool	GetUseHighQualityEndpoints ()
	Use an improved edge endpoint detection algorithm.

virtual void	UseHighQualityEndpointsOn ()
	Use an improved edge endpoint detection algorithm.

virtual void	UseHighQualityEndpointsOff ()
	Use an improved edge endpoint detection algorithm.


virtual void	SetEndpointSearchIterations (int)
	Set the number of iterations for the endpoint search algorithm.

virtual int	GetEndpointSearchIterations ()
	Set the number of iterations for the endpoint search algorithm.


virtual void	SetDebugOptionValue (DebugOption)
	Debugging options that affect the output color buffer.

virtual DebugOption	GetDebugOptionValue ()
	Debugging options that affect the output color buffer.

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()
	Turn debugging output on.

virtual void	DebugOff ()
	Turn debugging output off.

bool	GetDebug ()
	Get the value of the debug flag.

void	SetDebug (bool debugFlag)
	Set the value of the debug flag.

virtual void	Modified ()
	Update the modification time for this object.

virtual vtkMTimeType	GetMTime ()
	Return this object's modified time.

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

vtkTypeBool	HasObserver (unsigned long event)

vtkTypeBool	HasObserver (const char *event)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkTypeBool	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Allow user to set the AbortFlagOn() with the return value of the callback method.

int	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.

int	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not.

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.

virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class.

virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).

virtual void	Delete ()
	Delete a VTK object.

virtual void	FastDelete ()
	Delete a reference to this object.

void	InitializeObjectBase ()

void	Print (ostream &os)
	Print an object to an ostream.

virtual void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object).

virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object).

int	GetReferenceCount ()
	Return the current reference count of this object.

void	SetReferenceCount (int)
	Sets the reference count.

bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space.

virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

Static Public Member Functions
static vtkFXAAOptions *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkFXAAOptions *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

static void	BreakOnError ()
	This method is called when vtkErrorMacro executes.

static void	SetGlobalWarningDisplay (int val)
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static int	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
	Return 1 if this class type is the same type of (or a subclass of) the named class.

static vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.

static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkFXAAOptions ()

	~vtkFXAAOptions () override

Protected Member Functions inherited from vtkObject
	vtkObject ()

	~vtkObject () override

void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=nullptr)
	These methods allow a command to exclusively grab all events.

void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events.

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	RegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
float	RelativeContrastThreshold

float	HardContrastThreshold

float	SubpixelBlendLimit

float	SubpixelContrastThreshold

int	EndpointSearchIterations

bool	UseHighQualityEndpoints

DebugOption	DebugOptionValue

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Additional Inherited Members
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

Detailed Description

Configuration for FXAA implementations.

This class encapsulates the settings for vtkOpenGLFXAAFilter.

Definition at line 30 of file vtkFXAAOptions.h.

Member Typedef Documentation

◆ Superclass

typedef vtkObject vtkFXAAOptions::Superclass

Definition at line 50 of file vtkFXAAOptions.h.

Member Enumeration Documentation

◆ DebugOption

enum vtkFXAAOptions::DebugOption

Debugging options that affect the output color buffer.

See vtkFXAAFilterFS.glsl for details.

Enumerator
FXAA_NO_DEBUG
FXAA_DEBUG_SUBPIXEL_ALIASING
FXAA_DEBUG_EDGE_DIRECTION
FXAA_DEBUG_EDGE_NUM_STEPS
FXAA_DEBUG_EDGE_DISTANCE
FXAA_DEBUG_EDGE_SAMPLE_OFFSET
FXAA_DEBUG_ONLY_SUBPIX_AA
FXAA_DEBUG_ONLY_EDGE_AA

Definition at line 37 of file vtkFXAAOptions.h.

Constructor & Destructor Documentation

◆ vtkFXAAOptions()

vtkFXAAOptions::vtkFXAAOptions ( )

protected

◆ ~vtkFXAAOptions()

vtkFXAAOptions::~vtkFXAAOptions ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkFXAAOptions * vtkFXAAOptions::New ( )

static

◆ IsTypeOf()

static vtkTypeBool vtkFXAAOptions::IsTypeOf ( const char * type )

static

◆ IsA()

virtual vtkTypeBool vtkFXAAOptions::IsA ( const char * name )

virtual

Return 1 if this class is the same type of (or a subclass of) the named class.

Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkObjectBase.

◆ SafeDownCast()

static vtkFXAAOptions * vtkFXAAOptions::SafeDownCast ( vtkObjectBase * o )

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkFXAAOptions::NewInstanceInternal ( ) const

protectedvirtual

◆ NewInstance()

vtkFXAAOptions * vtkFXAAOptions::NewInstance ( ) const

◆ PrintSelf()

void vtkFXAAOptions::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)

overridevirtual

Methods invoked by print to print information about the object including superclasses.

Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkObject.

◆ SetRelativeContrastThreshold()

virtual void vtkFXAAOptions::SetRelativeContrastThreshold ( float )

virtual

Threshold for applying FXAA to a pixel, relative to the maximum luminosity of its 4 immediate neighbors.

The luminosity of the current pixel and it's NSWE neighbors is computed. The maximum luminosity and luminosity range (contrast) of all 5 pixels is found. If the contrast is less than RelativeContrastThreshold * maxLum, the pixel is not considered aliased and will not be affected by FXAA.

Suggested settings:

1/3: Too little
1/4: Low quality
1/8: High quality (default)
1/16: Overkill

◆ GetRelativeContrastThreshold()

virtual float vtkFXAAOptions::GetRelativeContrastThreshold ( )

virtual

Threshold for applying FXAA to a pixel, relative to the maximum luminosity of its 4 immediate neighbors.

The luminosity of the current pixel and it's NSWE neighbors is computed. The maximum luminosity and luminosity range (contrast) of all 5 pixels is found. If the contrast is less than RelativeContrastThreshold * maxLum, the pixel is not considered aliased and will not be affected by FXAA.

Suggested settings:

1/3: Too little
1/4: Low quality
1/8: High quality (default)
1/16: Overkill

◆ SetHardContrastThreshold()

virtual void vtkFXAAOptions::SetHardContrastThreshold ( float )

virtual

Similar to RelativeContrastThreshold, but not scaled by the maximum luminosity.

If the contrast of the current pixel and it's 4 immediate NSWE neighbors is less than HardContrastThreshold, the pixel is not considered aliased and will not be affected by FXAA.

Suggested settings:

1/32: Visible limit
1/16: High quality (default)
1/12: Upper limit (start of visible unfiltered edges)

◆ GetHardContrastThreshold()

virtual float vtkFXAAOptions::GetHardContrastThreshold ( )

virtual

Similar to RelativeContrastThreshold, but not scaled by the maximum luminosity.

If the contrast of the current pixel and it's 4 immediate NSWE neighbors is less than HardContrastThreshold, the pixel is not considered aliased and will not be affected by FXAA.

Suggested settings:

1/32: Visible limit
1/16: High quality (default)
1/12: Upper limit (start of visible unfiltered edges)

◆ SetSubpixelBlendLimit()

virtual void vtkFXAAOptions::SetSubpixelBlendLimit ( float )

virtual

Subpixel aliasing is corrected by applying a lowpass filter to the current pixel.

This is implemented by blending an average of the 3x3 neighborhood around the pixel into the final result. The amount of blending is determined by comparing the detected amount of subpixel aliasing to the total contrasting of the CNSWE pixels:

SubpixelBlending = abs(lumC - lumAveNSWE) / (lumMaxCNSWE - lumMinCNSWE)

This parameter sets an upper limit to the amount of subpixel blending to prevent the image from simply getting blurred.

Suggested settings:

1/2: Low amount of blending.
3/4: Medium amount of blending (default)
7/8: High amount of blending.
1: Maximum amount of blending.

◆ GetSubpixelBlendLimit()

virtual float vtkFXAAOptions::GetSubpixelBlendLimit ( )

virtual

Subpixel aliasing is corrected by applying a lowpass filter to the current pixel.

This is implemented by blending an average of the 3x3 neighborhood around the pixel into the final result. The amount of blending is determined by comparing the detected amount of subpixel aliasing to the total contrasting of the CNSWE pixels:

SubpixelBlending = abs(lumC - lumAveNSWE) / (lumMaxCNSWE - lumMinCNSWE)

This parameter sets an upper limit to the amount of subpixel blending to prevent the image from simply getting blurred.

Suggested settings:

1/2: Low amount of blending.
3/4: Medium amount of blending (default)
7/8: High amount of blending.
1: Maximum amount of blending.

◆ SetSubpixelContrastThreshold()

virtual void vtkFXAAOptions::SetSubpixelContrastThreshold ( float )

virtual

Minimum amount of subpixel aliasing required for subpixel antialiasing to be applied.

Subpixel aliasing is corrected by applying a lowpass filter to the current pixel. This is implemented by blending an average of the 3x3 neighborhood around the pixel into the final result. The amount of blending is determined by comparing the detected amount of subpixel aliasing to the total contrasting of the CNSWE pixels:

SubpixelBlending = abs(lumC - lumAveNSWE) / (lumMaxCNSWE - lumMinCNSWE)

If SubpixelBlending is less than this threshold, no lowpass blending will occur.

Suggested settings:

1/2: Low subpixel aliasing removal
1/3: Medium subpixel aliasing removal
1/4: Default subpixel aliasing removal
1/8: High subpixel aliasing removal
0: Complete subpixel aliasing removal

◆ GetSubpixelContrastThreshold()

virtual float vtkFXAAOptions::GetSubpixelContrastThreshold ( )

virtual

Minimum amount of subpixel aliasing required for subpixel antialiasing to be applied.

Subpixel aliasing is corrected by applying a lowpass filter to the current pixel. This is implemented by blending an average of the 3x3 neighborhood around the pixel into the final result. The amount of blending is determined by comparing the detected amount of subpixel aliasing to the total contrasting of the CNSWE pixels:

SubpixelBlending = abs(lumC - lumAveNSWE) / (lumMaxCNSWE - lumMinCNSWE)

If SubpixelBlending is less than this threshold, no lowpass blending will occur.

Suggested settings:

1/2: Low subpixel aliasing removal
1/3: Medium subpixel aliasing removal
1/4: Default subpixel aliasing removal
1/8: High subpixel aliasing removal
0: Complete subpixel aliasing removal

◆ SetUseHighQualityEndpoints()

virtual void vtkFXAAOptions::SetUseHighQualityEndpoints ( bool )

virtual

Use an improved edge endpoint detection algorithm.

If true, a modified edge endpoint detection algorithm is used that requires more texture lookups, but will properly detect aliased single-pixel lines.

If false, the edge endpoint algorithm proposed by NVIDIA will by used. This algorithm is faster (fewer lookups), but will fail to detect endpoints of single pixel edge steps.

Default setting is true.

◆ GetUseHighQualityEndpoints()

virtual bool vtkFXAAOptions::GetUseHighQualityEndpoints ( )

virtual

Use an improved edge endpoint detection algorithm.

If true, a modified edge endpoint detection algorithm is used that requires more texture lookups, but will properly detect aliased single-pixel lines.

If false, the edge endpoint algorithm proposed by NVIDIA will by used. This algorithm is faster (fewer lookups), but will fail to detect endpoints of single pixel edge steps.

Default setting is true.

◆ UseHighQualityEndpointsOn()

virtual void vtkFXAAOptions::UseHighQualityEndpointsOn ( )

virtual

Use an improved edge endpoint detection algorithm.

If true, a modified edge endpoint detection algorithm is used that requires more texture lookups, but will properly detect aliased single-pixel lines.

If false, the edge endpoint algorithm proposed by NVIDIA will by used. This algorithm is faster (fewer lookups), but will fail to detect endpoints of single pixel edge steps.

Default setting is true.

◆ UseHighQualityEndpointsOff()

virtual void vtkFXAAOptions::UseHighQualityEndpointsOff ( )

virtual

Use an improved edge endpoint detection algorithm.

If true, a modified edge endpoint detection algorithm is used that requires more texture lookups, but will properly detect aliased single-pixel lines.

If false, the edge endpoint algorithm proposed by NVIDIA will by used. This algorithm is faster (fewer lookups), but will fail to detect endpoints of single pixel edge steps.

Default setting is true.

◆ SetEndpointSearchIterations()

virtual void vtkFXAAOptions::SetEndpointSearchIterations ( int )

virtual

Set the number of iterations for the endpoint search algorithm.

Increasing this value will increase runtime, but also properly detect longer edges. The current implementation steps one pixel in both the positive and negative directions per iteration. The default value is 12, which will resolve endpoints of edges < 25 pixels long (2 * 12 + 1).

◆ GetEndpointSearchIterations()

virtual int vtkFXAAOptions::GetEndpointSearchIterations ( )

virtual

Set the number of iterations for the endpoint search algorithm.

Increasing this value will increase runtime, but also properly detect longer edges. The current implementation steps one pixel in both the positive and negative directions per iteration. The default value is 12, which will resolve endpoints of edges < 25 pixels long (2 * 12 + 1).

◆ SetDebugOptionValue()

virtual void vtkFXAAOptions::SetDebugOptionValue ( DebugOption )

virtual

Debugging options that affect the output color buffer.

See vtkFXAAFilterFS.glsl for details. Only one may be active at a time.

◆ GetDebugOptionValue()

virtual DebugOption vtkFXAAOptions::GetDebugOptionValue ( )

virtual

Debugging options that affect the output color buffer.

See vtkFXAAFilterFS.glsl for details. Only one may be active at a time.

Member Data Documentation

◆ RelativeContrastThreshold

float vtkFXAAOptions::RelativeContrastThreshold

protected

Definition at line 184 of file vtkFXAAOptions.h.

◆ HardContrastThreshold

float vtkFXAAOptions::HardContrastThreshold

protected

Definition at line 185 of file vtkFXAAOptions.h.

◆ SubpixelBlendLimit

float vtkFXAAOptions::SubpixelBlendLimit

protected

Definition at line 186 of file vtkFXAAOptions.h.

◆ SubpixelContrastThreshold

float vtkFXAAOptions::SubpixelContrastThreshold

protected

Definition at line 187 of file vtkFXAAOptions.h.

◆ EndpointSearchIterations

int vtkFXAAOptions::EndpointSearchIterations

protected

Definition at line 188 of file vtkFXAAOptions.h.

◆ UseHighQualityEndpoints

bool vtkFXAAOptions::UseHighQualityEndpoints

protected

Definition at line 189 of file vtkFXAAOptions.h.

◆ DebugOptionValue

DebugOption vtkFXAAOptions::DebugOptionValue

protected

Definition at line 190 of file vtkFXAAOptions.h.

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

Rendering/Core/vtkFXAAOptions.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Member Enumeration Documentation

◆ DebugOption

Constructor & Destructor Documentation

◆ vtkFXAAOptions()

◆ ~vtkFXAAOptions()

Member Function Documentation

◆ New()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ SetRelativeContrastThreshold()

◆ GetRelativeContrastThreshold()

◆ SetHardContrastThreshold()

◆ GetHardContrastThreshold()

◆ SetSubpixelBlendLimit()

◆ GetSubpixelBlendLimit()

◆ SetSubpixelContrastThreshold()

◆ GetSubpixelContrastThreshold()

◆ SetUseHighQualityEndpoints()

◆ GetUseHighQualityEndpoints()

◆ UseHighQualityEndpointsOn()

◆ UseHighQualityEndpointsOff()

◆ SetEndpointSearchIterations()

◆ GetEndpointSearchIterations()

◆ SetDebugOptionValue()

◆ GetDebugOptionValue()

Member Data Documentation

◆ RelativeContrastThreshold

◆ HardContrastThreshold

◆ SubpixelBlendLimit

◆ SubpixelContrastThreshold

◆ EndpointSearchIterations

◆ UseHighQualityEndpoints

◆ DebugOptionValue