Perform FXAA antialiasing on the current framebuffer. More...

#include <vtkOpenGLFXAAFilter.h>

Inheritance diagram for vtkOpenGLFXAAFilter:

Collaboration diagram for vtkOpenGLFXAAFilter:

Public Types
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.

vtkOpenGLFXAAFilter *	NewInstance () const

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

void	Execute (vtkOpenGLRenderer *ren)
	Perform FXAA on the current render buffer in ren.

void	ReleaseGraphicsResources ()
	Release all OpenGL state.

void	UpdateConfiguration (vtkFXAAOptions *opts)
	Copy the configuration values from opts into this filter.


virtual void	SetRelativeContrastThreshold (float)
	Parameter for tuning the FXAA implementation.

virtual float	GetRelativeContrastThreshold ()
	Parameter for tuning the FXAA implementation.

virtual void	SetHardContrastThreshold (float)
	Parameter for tuning the FXAA implementation.

virtual float	GetHardContrastThreshold ()
	Parameter for tuning the FXAA implementation.

virtual void	SetSubpixelBlendLimit (float)
	Parameter for tuning the FXAA implementation.

virtual float	GetSubpixelBlendLimit ()
	Parameter for tuning the FXAA implementation.

virtual void	SetSubpixelContrastThreshold (float)
	Parameter for tuning the FXAA implementation.

virtual float	GetSubpixelContrastThreshold ()
	Parameter for tuning the FXAA implementation.

virtual void	SetUseHighQualityEndpoints (bool val)
	Parameter for tuning the FXAA implementation.

virtual bool	GetUseHighQualityEndpoints ()
	Parameter for tuning the FXAA implementation.

virtual void	UseHighQualityEndpointsOn ()
	Parameter for tuning the FXAA implementation.

virtual void	UseHighQualityEndpointsOff ()
	Parameter for tuning the FXAA implementation.

virtual void	SetEndpointSearchIterations (int)
	Parameter for tuning the FXAA implementation.

virtual int	GetEndpointSearchIterations ()
	Parameter for tuning the FXAA implementation.

virtual void	SetDebugOptionValue (vtkFXAAOptions::DebugOption opt)
	Parameter for tuning the FXAA implementation.

virtual vtkFXAAOptions::DebugOption	GetDebugOptionValue ()
	Parameter for tuning the FXAA implementation.

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 vtkOpenGLFXAAFilter *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkOpenGLFXAAFilter *	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

	vtkOpenGLFXAAFilter ()

	~vtkOpenGLFXAAFilter () override

void	Prepare ()

void	FreeGLObjects ()

void	CreateGLObjects ()

void	LoadInput ()

void	ApplyFilter ()

void	SubstituteFragmentShader (std::string &fragShader)

void	Finalize ()

void	StartTimeQuery (vtkOpenGLRenderTimer *timer)

void	EndTimeQuery (vtkOpenGLRenderTimer *timer)

void	PrintBenchmark ()

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
bool	BlendState

bool	DepthTestState

int	Viewport [4]

vtkOpenGLRenderTimer *	PreparationTimer

vtkOpenGLRenderTimer *	FXAATimer

float	RelativeContrastThreshold

float	HardContrastThreshold

float	SubpixelBlendLimit

float	SubpixelContrastThreshold

int	EndpointSearchIterations

bool	UseHighQualityEndpoints

vtkFXAAOptions::DebugOption	DebugOptionValue

bool	NeedToRebuildShader

vtkOpenGLRenderer *	Renderer

vtkTextureObject *	Input

vtkOpenGLQuadHelper *	QHelper

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

Perform FXAA antialiasing on the current framebuffer.

Call Execute() to run a FXAA antialiasing pass on the current OpenGL framebuffer. See method documentation for tunable parameters.

Based on the following implementation and description:

Whitepaper: http://developer.download.nvidia.com/assets/gamedev/files/sdk/11/FXAA_WhitePaper.pdf

Sample implementation: https://github.com/NVIDIAGameWorks/GraphicsSamples/blob/master/samples/es3-kepler/FXAA/FXAA3_11.h

TODO there are currently some "banding" artifacts on some edges, particularly single pixel lines. These seem to be caused by using a linear RGB input, rather than a gamma-correct sRGB input. Future work should combine this pass with a gamma correction pass to correct this. Bonus points for precomputing luminosity into the sRGB's alpha channel to save cycles in the FXAA shader!

Definition at line 56 of file vtkOpenGLFXAAFilter.h.

Member Typedef Documentation

◆ Superclass

typedef vtkObject vtkOpenGLFXAAFilter::Superclass

Definition at line 60 of file vtkOpenGLFXAAFilter.h.

Constructor & Destructor Documentation

◆ vtkOpenGLFXAAFilter()

vtkOpenGLFXAAFilter::vtkOpenGLFXAAFilter ( )

protected

◆ ~vtkOpenGLFXAAFilter()

vtkOpenGLFXAAFilter::~vtkOpenGLFXAAFilter ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkOpenGLFXAAFilter * vtkOpenGLFXAAFilter::New ( )

static

◆ IsTypeOf()

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

static

◆ IsA()

virtual vtkTypeBool vtkOpenGLFXAAFilter::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 vtkOpenGLFXAAFilter * vtkOpenGLFXAAFilter::SafeDownCast ( vtkObjectBase * o )

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkOpenGLFXAAFilter::NewInstanceInternal ( ) const

protectedvirtual

◆ NewInstance()

vtkOpenGLFXAAFilter * vtkOpenGLFXAAFilter::NewInstance ( ) const

◆ PrintSelf()

void vtkOpenGLFXAAFilter::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.

◆ Execute()

void vtkOpenGLFXAAFilter::Execute ( vtkOpenGLRenderer * ren )

Perform FXAA on the current render buffer in ren.

◆ ReleaseGraphicsResources()

void vtkOpenGLFXAAFilter::ReleaseGraphicsResources ( )

Release all OpenGL state.

◆ UpdateConfiguration()

void vtkOpenGLFXAAFilter::UpdateConfiguration ( vtkFXAAOptions * opts )

Copy the configuration values from opts into this filter.

Note that this copies the configuration values from opts – it does not save the opts pointer.