vtkOpenGLFXAAFilter Class Reference

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 int	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...
vtkOpenGLFXAAFilter *	NewInstance () const
virtual void	PrintSelf (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...
void	Execute (vtkOpenGLRenderer *ren)
	Perform FXAA on the current render buffer in ren. More...
void	ReleaseGraphicsResources ()
	Release all OpenGL state. More...
void	UpdateConfiguration (vtkFXAAOptions *opts)
	Copy the configuration values from opts into this filter. More...
virtual void	SetRelativeContrastThreshold (float)
	Parameter for tuning the FXAA implementation. More...
virtual float	GetRelativeContrastThreshold ()
virtual void	SetHardContrastThreshold (float)
virtual float	GetHardContrastThreshold ()
virtual void	SetSubpixelBlendLimit (float)
virtual float	GetSubpixelBlendLimit ()
virtual void	SetSubpixelContrastThreshold (float)
virtual float	GetSubpixelContrastThreshold ()
virtual void	SetUseHighQualityEndpoints (bool val)
virtual bool	GetUseHighQualityEndpoints ()
virtual void	UseHighQualityEndpointsOn ()
virtual void	UseHighQualityEndpointsOff ()
virtual void	SetEndpointSearchIterations (int)
virtual int	GetEndpointSearchIterations ()
virtual void	SetDebugOptionValue (vtkFXAAOptions::DebugOption opt)
virtual vtkFXAAOptions::DebugOption	GetDebugOptionValue ()
Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)
virtual void	DebugOn ()
	Turn debugging output on. More...
virtual void	DebugOff ()
	Turn debugging output off. More...
bool	GetDebug ()
	Get the value of the debug flag. More...
void	SetDebug (bool debugFlag)
	Set the value of the debug flag. More...
virtual void	Modified ()
	Update the modification time for this object. More...
virtual vtkMTimeType	GetMTime ()
	Return this object's modified time. More...
unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
unsigned long	AddObserver (const char *event, vtkCommand *, float priority=0.0f)
vtkCommand *	GetCommand (unsigned long tag)
void	RemoveObserver (vtkCommand *)
void	RemoveObservers (unsigned long event, vtkCommand *)
void	RemoveObservers (const char *event, vtkCommand *)
int	HasObserver (unsigned long event, vtkCommand *)
int	HasObserver (const char *event, vtkCommand *)
void	RemoveObserver (unsigned long tag)
void	RemoveObservers (unsigned long event)
void	RemoveObservers (const char *event)
void	RemoveAllObservers ()
int	HasObserver (unsigned long event)
int	HasObserver (const char *event)
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. More...
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
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. More...
int	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not. More...
int	InvokeEvent (const char *event, void *callData)
int	InvokeEvent (unsigned long event)
int	InvokeEvent (const char *event)
Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string. More...
virtual void	Delete ()
	Delete a VTK object. More...
virtual void	FastDelete ()
	Delete a reference to this object. More...
void	InitializeObjectBase ()
void	Print (ostream &os)
	Print an object to an ostream. More...
virtual void	PrintHeader (ostream &os, vtkIndent indent)
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
virtual void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object). More...
virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object). More...
int	GetReferenceCount ()
	Return the current reference count of this object. More...
void	SetReferenceCount (int)
	Sets the reference count. More...
void	PrintRevisions (ostream &)
	Legacy. More...

Static Public Member Functions
static vtkOpenGLFXAAFilter *	New ()
static int	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. More...
static void	BreakOnError ()
	This method is called when vtkErrorMacro executes. More...
static void	SetGlobalWarningDisplay (int val)
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...
static void	GlobalWarningDisplayOn ()
static void	GlobalWarningDisplayOff ()
static int	GetGlobalWarningDisplay ()
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. More...
static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkOpenGLFXAAFilter ()
	~vtkOpenGLFXAAFilter ()
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=NULL)
	These methods allow a command to exclusively grab all events. More...
void	InternalReleaseFocus ()
Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()
virtual	~vtkObjectBase ()
virtual void	CollectRevisions (ostream &)
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
vtkShaderProgram *	Program
vtkOpenGLVertexArrayObject *	VAO
vtkOpenGLBufferObject *	VBO
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount
vtkWeakPointerBase **	WeakPointers

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 57 of file vtkOpenGLFXAAFilter.h.

Member Typedef Documentation

Superclass

typedef vtkObject vtkOpenGLFXAAFilter::Superclass

Definition at line 61 of file vtkOpenGLFXAAFilter.h.

Constructor & Destructor Documentation

vtkOpenGLFXAAFilter()

vtkOpenGLFXAAFilter::vtkOpenGLFXAAFilter ( )

protected

~vtkOpenGLFXAAFilter()

vtkOpenGLFXAAFilter::~vtkOpenGLFXAAFilter ( )

protected

Member Function Documentation

New()

static vtkOpenGLFXAAFilter* vtkOpenGLFXAAFilter::New ( )

static

IsTypeOf()

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

static

IsA()

virtual int 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()

virtual void vtkOpenGLFXAAFilter::PrintSelf ( ostream &  os, vtkIndent  indent  )

virtual

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.

SetRelativeContrastThreshold()

virtual void vtkOpenGLFXAAFilter::SetRelativeContrastThreshold ( float  )

virtual

Parameter for tuning the FXAA implementation.

See vtkFXAAOptions for details and suggested values.

GetRelativeContrastThreshold()

virtual float vtkOpenGLFXAAFilter::GetRelativeContrastThreshold ( )

virtual

SetHardContrastThreshold()

virtual void vtkOpenGLFXAAFilter::SetHardContrastThreshold ( float  )

virtual

GetHardContrastThreshold()

virtual float vtkOpenGLFXAAFilter::GetHardContrastThreshold ( )

virtual

SetSubpixelBlendLimit()

virtual void vtkOpenGLFXAAFilter::SetSubpixelBlendLimit ( float  )

virtual

GetSubpixelBlendLimit()

virtual float vtkOpenGLFXAAFilter::GetSubpixelBlendLimit ( )

virtual

SetSubpixelContrastThreshold()

virtual void vtkOpenGLFXAAFilter::SetSubpixelContrastThreshold ( float  )

virtual

GetSubpixelContrastThreshold()

virtual float vtkOpenGLFXAAFilter::GetSubpixelContrastThreshold ( )

virtual

SetUseHighQualityEndpoints()

virtual void vtkOpenGLFXAAFilter::SetUseHighQualityEndpoints ( bool  val )

virtual

GetUseHighQualityEndpoints()

virtual bool vtkOpenGLFXAAFilter::GetUseHighQualityEndpoints ( )

virtual

UseHighQualityEndpointsOn()

virtual void vtkOpenGLFXAAFilter::UseHighQualityEndpointsOn ( )

virtual

UseHighQualityEndpointsOff()

virtual void vtkOpenGLFXAAFilter::UseHighQualityEndpointsOff ( )

virtual

SetEndpointSearchIterations()

virtual void vtkOpenGLFXAAFilter::SetEndpointSearchIterations ( int  )

virtual

GetEndpointSearchIterations()

virtual int vtkOpenGLFXAAFilter::GetEndpointSearchIterations ( )

virtual

SetDebugOptionValue()

virtual void vtkOpenGLFXAAFilter::SetDebugOptionValue ( vtkFXAAOptions::DebugOption  opt )

virtual

GetDebugOptionValue()

virtual vtkFXAAOptions::DebugOption vtkOpenGLFXAAFilter::GetDebugOptionValue ( )

virtual

Prepare()

void vtkOpenGLFXAAFilter::Prepare ( )

protected

FreeGLObjects()

void vtkOpenGLFXAAFilter::FreeGLObjects ( )

protected

CreateGLObjects()

void vtkOpenGLFXAAFilter::CreateGLObjects ( )

protected

LoadInput()

void vtkOpenGLFXAAFilter::LoadInput ( )

protected

ApplyFilter()

void vtkOpenGLFXAAFilter::ApplyFilter ( )

protected

SubstituteFragmentShader()

void vtkOpenGLFXAAFilter::SubstituteFragmentShader ( std::string &  fragShader )

protected

Finalize()

void vtkOpenGLFXAAFilter::Finalize ( )

protected

StartTimeQuery()

void vtkOpenGLFXAAFilter::StartTimeQuery ( vtkOpenGLRenderTimer *  timer )

protected

EndTimeQuery()

void vtkOpenGLFXAAFilter::EndTimeQuery ( vtkOpenGLRenderTimer *  timer )

protected

PrintBenchmark()

void vtkOpenGLFXAAFilter::PrintBenchmark ( )

protected

Member Data Documentation

BlendState

bool vtkOpenGLFXAAFilter::BlendState

protected

Definition at line 120 of file vtkOpenGLFXAAFilter.h.

DepthTestState

bool vtkOpenGLFXAAFilter::DepthTestState

protected

Definition at line 121 of file vtkOpenGLFXAAFilter.h.

Viewport

int vtkOpenGLFXAAFilter::Viewport[4]

protected

Definition at line 123 of file vtkOpenGLFXAAFilter.h.

PreparationTimer

vtkOpenGLRenderTimer* vtkOpenGLFXAAFilter::PreparationTimer

protected

Definition at line 126 of file vtkOpenGLFXAAFilter.h.

FXAATimer

vtkOpenGLRenderTimer* vtkOpenGLFXAAFilter::FXAATimer

protected

Definition at line 127 of file vtkOpenGLFXAAFilter.h.

RelativeContrastThreshold

float vtkOpenGLFXAAFilter::RelativeContrastThreshold

protected

Definition at line 130 of file vtkOpenGLFXAAFilter.h.

HardContrastThreshold

float vtkOpenGLFXAAFilter::HardContrastThreshold

protected

Definition at line 131 of file vtkOpenGLFXAAFilter.h.

SubpixelBlendLimit

float vtkOpenGLFXAAFilter::SubpixelBlendLimit

protected

Definition at line 132 of file vtkOpenGLFXAAFilter.h.

SubpixelContrastThreshold

float vtkOpenGLFXAAFilter::SubpixelContrastThreshold

protected

Definition at line 133 of file vtkOpenGLFXAAFilter.h.

EndpointSearchIterations

int vtkOpenGLFXAAFilter::EndpointSearchIterations

protected

Definition at line 134 of file vtkOpenGLFXAAFilter.h.

UseHighQualityEndpoints

bool vtkOpenGLFXAAFilter::UseHighQualityEndpoints

protected

Definition at line 136 of file vtkOpenGLFXAAFilter.h.

DebugOptionValue

vtkFXAAOptions::DebugOption vtkOpenGLFXAAFilter::DebugOptionValue

protected

Definition at line 137 of file vtkOpenGLFXAAFilter.h.

NeedToRebuildShader

bool vtkOpenGLFXAAFilter::NeedToRebuildShader

protected

Definition at line 140 of file vtkOpenGLFXAAFilter.h.

Renderer

vtkOpenGLRenderer* vtkOpenGLFXAAFilter::Renderer

protected

Definition at line 142 of file vtkOpenGLFXAAFilter.h.

Input

vtkTextureObject* vtkOpenGLFXAAFilter::Input

protected

Definition at line 143 of file vtkOpenGLFXAAFilter.h.

Program

vtkShaderProgram* vtkOpenGLFXAAFilter::Program

protected

Definition at line 145 of file vtkOpenGLFXAAFilter.h.

VAO

vtkOpenGLVertexArrayObject* vtkOpenGLFXAAFilter::VAO

protected

Definition at line 146 of file vtkOpenGLFXAAFilter.h.

VBO

vtkOpenGLBufferObject* vtkOpenGLFXAAFilter::VBO

protected

Definition at line 147 of file vtkOpenGLFXAAFilter.h.

---

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

• dox/Rendering/OpenGL2/vtkOpenGLFXAAFilter.h