VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkOpenGLFXAAFilter Class Reference

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

#include <vtkOpenGLFXAAFilter.h>

Inheritance diagram for vtkOpenGLFXAAFilter:
[legend]
Collaboration diagram for vtkOpenGLFXAAFilter:
[legend]

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. More...
 
vtkOpenGLFXAAFilterNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 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 ()
 Parameter for tuning the FXAA implementation. More...
 
virtual void SetHardContrastThreshold (float)
 Parameter for tuning the FXAA implementation. More...
 
virtual float GetHardContrastThreshold ()
 Parameter for tuning the FXAA implementation. More...
 
virtual void SetSubpixelBlendLimit (float)
 Parameter for tuning the FXAA implementation. More...
 
virtual float GetSubpixelBlendLimit ()
 Parameter for tuning the FXAA implementation. More...
 
virtual void SetSubpixelContrastThreshold (float)
 Parameter for tuning the FXAA implementation. More...
 
virtual float GetSubpixelContrastThreshold ()
 Parameter for tuning the FXAA implementation. More...
 
virtual void SetUseHighQualityEndpoints (bool val)
 Parameter for tuning the FXAA implementation. More...
 
virtual bool GetUseHighQualityEndpoints ()
 Parameter for tuning the FXAA implementation. More...
 
virtual void UseHighQualityEndpointsOn ()
 Parameter for tuning the FXAA implementation. More...
 
virtual void UseHighQualityEndpointsOff ()
 Parameter for tuning the FXAA implementation. More...
 
virtual void SetEndpointSearchIterations (int)
 Parameter for tuning the FXAA implementation. More...
 
virtual int GetEndpointSearchIterations ()
 Parameter for tuning the FXAA implementation. More...
 
virtual void SetDebugOptionValue (vtkFXAAOptions::DebugOption opt)
 Parameter for tuning the FXAA implementation. More...
 
virtual vtkFXAAOptions::DebugOption GetDebugOptionValue ()
 Parameter for tuning the FXAA implementation. More...
 
- 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...
 
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. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
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)
 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, 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)
 This method invokes an event and return whether the event was aborted or not. More...
 
- 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 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...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 

Static Public Member Functions

static vtkOpenGLFXAAFilterNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkOpenGLFXAAFilterSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 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 ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static int GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
- 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 vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () 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. More...
 
void InternalReleaseFocus ()
 These methods allow a command to exclusively grab all events. More...
 
- 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]
 
vtkOpenGLRenderTimerPreparationTimer
 
vtkOpenGLRenderTimerFXAATimer
 
float RelativeContrastThreshold
 
float HardContrastThreshold
 
float SubpixelBlendLimit
 
float SubpixelContrastThreshold
 
int EndpointSearchIterations
 
bool UseHighQualityEndpoints
 
vtkFXAAOptions::DebugOption DebugOptionValue
 
bool NeedToRebuildShader
 
vtkOpenGLRendererRenderer
 
vtkTextureObjectInput
 
vtkOpenGLQuadHelperQHelper
 
- 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 56 of file vtkOpenGLFXAAFilter.h.

Member Typedef Documentation

Definition at line 60 of file vtkOpenGLFXAAFilter.h.

Constructor & Destructor Documentation

vtkOpenGLFXAAFilter::vtkOpenGLFXAAFilter ( )
protected
vtkOpenGLFXAAFilter::~vtkOpenGLFXAAFilter ( )
overrideprotected

Member Function Documentation

static vtkOpenGLFXAAFilter* vtkOpenGLFXAAFilter::New ( )
static
static vtkTypeBool vtkOpenGLFXAAFilter::IsTypeOf ( const char *  type)
static
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.

static vtkOpenGLFXAAFilter* vtkOpenGLFXAAFilter::SafeDownCast ( vtkObjectBase o)
static
virtual vtkObjectBase* vtkOpenGLFXAAFilter::NewInstanceInternal ( ) const
protectedvirtual
vtkOpenGLFXAAFilter* vtkOpenGLFXAAFilter::NewInstance ( ) const
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.

void vtkOpenGLFXAAFilter::Execute ( vtkOpenGLRenderer ren)

Perform FXAA on the current render buffer in ren.

void vtkOpenGLFXAAFilter::ReleaseGraphicsResources ( )

Release all OpenGL state.

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.

virtual void vtkOpenGLFXAAFilter::SetRelativeContrastThreshold ( float  )
virtual

Parameter for tuning the FXAA implementation.

See vtkFXAAOptions for details and suggested values.

virtual float vtkOpenGLFXAAFilter::GetRelativeContrastThreshold ( )
virtual

Parameter for tuning the FXAA implementation.

See vtkFXAAOptions for details and suggested values.

virtual void vtkOpenGLFXAAFilter::SetHardContrastThreshold ( float  )
virtual

Parameter for tuning the FXAA implementation.

See vtkFXAAOptions for details and suggested values.

virtual float vtkOpenGLFXAAFilter::GetHardContrastThreshold ( )
virtual

Parameter for tuning the FXAA implementation.

See vtkFXAAOptions for details and suggested values.

virtual void vtkOpenGLFXAAFilter::SetSubpixelBlendLimit ( float  )
virtual

Parameter for tuning the FXAA implementation.

See vtkFXAAOptions for details and suggested values.

virtual float vtkOpenGLFXAAFilter::GetSubpixelBlendLimit ( )
virtual

Parameter for tuning the FXAA implementation.

See vtkFXAAOptions for details and suggested values.

virtual void vtkOpenGLFXAAFilter::SetSubpixelContrastThreshold ( float  )
virtual

Parameter for tuning the FXAA implementation.

See vtkFXAAOptions for details and suggested values.

virtual float vtkOpenGLFXAAFilter::GetSubpixelContrastThreshold ( )
virtual

Parameter for tuning the FXAA implementation.

See vtkFXAAOptions for details and suggested values.

virtual void vtkOpenGLFXAAFilter::SetUseHighQualityEndpoints ( bool  val)
virtual

Parameter for tuning the FXAA implementation.

See vtkFXAAOptions for details and suggested values.

virtual bool vtkOpenGLFXAAFilter::GetUseHighQualityEndpoints ( )
virtual

Parameter for tuning the FXAA implementation.

See vtkFXAAOptions for details and suggested values.

virtual void vtkOpenGLFXAAFilter::UseHighQualityEndpointsOn ( )
virtual

Parameter for tuning the FXAA implementation.

See vtkFXAAOptions for details and suggested values.

virtual void vtkOpenGLFXAAFilter::UseHighQualityEndpointsOff ( )
virtual

Parameter for tuning the FXAA implementation.

See vtkFXAAOptions for details and suggested values.

virtual void vtkOpenGLFXAAFilter::SetEndpointSearchIterations ( int  )
virtual

Parameter for tuning the FXAA implementation.

See vtkFXAAOptions for details and suggested values.

virtual int vtkOpenGLFXAAFilter::GetEndpointSearchIterations ( )
virtual

Parameter for tuning the FXAA implementation.

See vtkFXAAOptions for details and suggested values.

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

Parameter for tuning the FXAA implementation.

See vtkFXAAOptions for details and suggested values.

virtual vtkFXAAOptions::DebugOption vtkOpenGLFXAAFilter::GetDebugOptionValue ( )
virtual

Parameter for tuning the FXAA implementation.

See vtkFXAAOptions for details and suggested values.

void vtkOpenGLFXAAFilter::Prepare ( )
protected
void vtkOpenGLFXAAFilter::FreeGLObjects ( )
protected
void vtkOpenGLFXAAFilter::CreateGLObjects ( )
protected
void vtkOpenGLFXAAFilter::LoadInput ( )
protected
void vtkOpenGLFXAAFilter::ApplyFilter ( )
protected
void vtkOpenGLFXAAFilter::SubstituteFragmentShader ( std::string &  fragShader)
protected
void vtkOpenGLFXAAFilter::Finalize ( )
protected
void vtkOpenGLFXAAFilter::StartTimeQuery ( vtkOpenGLRenderTimer timer)
protected
void vtkOpenGLFXAAFilter::EndTimeQuery ( vtkOpenGLRenderTimer timer)
protected
void vtkOpenGLFXAAFilter::PrintBenchmark ( )
protected

Member Data Documentation

bool vtkOpenGLFXAAFilter::BlendState
protected

Definition at line 119 of file vtkOpenGLFXAAFilter.h.

bool vtkOpenGLFXAAFilter::DepthTestState
protected

Definition at line 120 of file vtkOpenGLFXAAFilter.h.

int vtkOpenGLFXAAFilter::Viewport[4]
protected

Definition at line 122 of file vtkOpenGLFXAAFilter.h.

vtkOpenGLRenderTimer* vtkOpenGLFXAAFilter::PreparationTimer
protected

Definition at line 125 of file vtkOpenGLFXAAFilter.h.

vtkOpenGLRenderTimer* vtkOpenGLFXAAFilter::FXAATimer
protected

Definition at line 126 of file vtkOpenGLFXAAFilter.h.

float vtkOpenGLFXAAFilter::RelativeContrastThreshold
protected

Definition at line 129 of file vtkOpenGLFXAAFilter.h.

float vtkOpenGLFXAAFilter::HardContrastThreshold
protected

Definition at line 130 of file vtkOpenGLFXAAFilter.h.

float vtkOpenGLFXAAFilter::SubpixelBlendLimit
protected

Definition at line 131 of file vtkOpenGLFXAAFilter.h.

float vtkOpenGLFXAAFilter::SubpixelContrastThreshold
protected

Definition at line 132 of file vtkOpenGLFXAAFilter.h.

int vtkOpenGLFXAAFilter::EndpointSearchIterations
protected

Definition at line 133 of file vtkOpenGLFXAAFilter.h.

bool vtkOpenGLFXAAFilter::UseHighQualityEndpoints
protected

Definition at line 135 of file vtkOpenGLFXAAFilter.h.

vtkFXAAOptions::DebugOption vtkOpenGLFXAAFilter::DebugOptionValue
protected

Definition at line 136 of file vtkOpenGLFXAAFilter.h.

bool vtkOpenGLFXAAFilter::NeedToRebuildShader
protected

Definition at line 139 of file vtkOpenGLFXAAFilter.h.

vtkOpenGLRenderer* vtkOpenGLFXAAFilter::Renderer
protected

Definition at line 141 of file vtkOpenGLFXAAFilter.h.

vtkTextureObject* vtkOpenGLFXAAFilter::Input
protected

Definition at line 142 of file vtkOpenGLFXAAFilter.h.

vtkOpenGLQuadHelper* vtkOpenGLFXAAFilter::QHelper
protected

Definition at line 144 of file vtkOpenGLFXAAFilter.h.


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