VTK  9.0.20200712
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:
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. 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 ()
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)
vtkCommandGetCommand (unsigned long tag)
void RemoveObserver (vtkCommand *)
void RemoveObservers (unsigned long event, vtkCommand *)
void RemoveObservers (const char *event, vtkCommand *)
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
vtkTypeBool HasObserver (const char *event, vtkCommand *)
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)
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 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). 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...
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space. 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 ()
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 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). More...
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
static void SetMemkindDirectory (const char *directoryname)
 The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...
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. 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 ()
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
virtual ~vtkObjectBase ()
virtual void ReportReferences (vtkGarbageCollector *)
 vtkObjectBase (const vtkObjectBase &)
void operator= (const vtkObjectBase &)

Protected Attributes

bool BlendState
bool DepthTestState
int Viewport [4]
float RelativeContrastThreshold
float HardContrastThreshold
float SubpixelBlendLimit
float SubpixelContrastThreshold
int EndpointSearchIterations
bool UseHighQualityEndpoints
vtkFXAAOptions::DebugOption DebugOptionValue
bool NeedToRebuildShader
- 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

Definition at line 60 of file vtkOpenGLFXAAFilter.h.

Constructor & Destructor Documentation

◆ vtkOpenGLFXAAFilter()

vtkOpenGLFXAAFilter::vtkOpenGLFXAAFilter ( )

◆ ~vtkOpenGLFXAAFilter()

vtkOpenGLFXAAFilter::~vtkOpenGLFXAAFilter ( )

Member Function Documentation

◆ New()

static vtkOpenGLFXAAFilter* vtkOpenGLFXAAFilter::New ( )

◆ IsTypeOf()

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

◆ IsA()

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

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)

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkOpenGLFXAAFilter::NewInstanceInternal ( ) const

◆ NewInstance()

vtkOpenGLFXAAFilter* vtkOpenGLFXAAFilter::NewInstance ( ) const

◆ PrintSelf()

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

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  )

Parameter for tuning the FXAA implementation.

See vtkFXAAOptions for details and suggested values.

◆ GetRelativeContrastThreshold()

virtual float vtkOpenGLFXAAFilter::GetRelativeContrastThreshold ( )

◆ SetHardContrastThreshold()

virtual void vtkOpenGLFXAAFilter::SetHardContrastThreshold ( float  )

◆ GetHardContrastThreshold()

virtual float vtkOpenGLFXAAFilter::GetHardContrastThreshold ( )

◆ SetSubpixelBlendLimit()

virtual void vtkOpenGLFXAAFilter::SetSubpixelBlendLimit ( float  )

◆ GetSubpixelBlendLimit()

virtual float vtkOpenGLFXAAFilter::GetSubpixelBlendLimit ( )

◆ SetSubpixelContrastThreshold()

virtual void vtkOpenGLFXAAFilter::SetSubpixelContrastThreshold ( float  )

◆ GetSubpixelContrastThreshold()

virtual float vtkOpenGLFXAAFilter::GetSubpixelContrastThreshold ( )

◆ SetUseHighQualityEndpoints()

virtual void vtkOpenGLFXAAFilter::SetUseHighQualityEndpoints ( bool  val)

◆ GetUseHighQualityEndpoints()

virtual bool vtkOpenGLFXAAFilter::GetUseHighQualityEndpoints ( )

◆ UseHighQualityEndpointsOn()

virtual void vtkOpenGLFXAAFilter::UseHighQualityEndpointsOn ( )

◆ UseHighQualityEndpointsOff()

virtual void vtkOpenGLFXAAFilter::UseHighQualityEndpointsOff ( )

◆ SetEndpointSearchIterations()

virtual void vtkOpenGLFXAAFilter::SetEndpointSearchIterations ( int  )

◆ GetEndpointSearchIterations()

virtual int vtkOpenGLFXAAFilter::GetEndpointSearchIterations ( )

◆ SetDebugOptionValue()

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

◆ GetDebugOptionValue()

virtual vtkFXAAOptions::DebugOption vtkOpenGLFXAAFilter::GetDebugOptionValue ( )

◆ Prepare()

void vtkOpenGLFXAAFilter::Prepare ( )

◆ FreeGLObjects()

void vtkOpenGLFXAAFilter::FreeGLObjects ( )

◆ CreateGLObjects()

void vtkOpenGLFXAAFilter::CreateGLObjects ( )

◆ LoadInput()

void vtkOpenGLFXAAFilter::LoadInput ( )

◆ ApplyFilter()

void vtkOpenGLFXAAFilter::ApplyFilter ( )

◆ SubstituteFragmentShader()

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

◆ Finalize()

void vtkOpenGLFXAAFilter::Finalize ( )

◆ StartTimeQuery()

void vtkOpenGLFXAAFilter::StartTimeQuery ( vtkOpenGLRenderTimer timer)

◆ EndTimeQuery()

void vtkOpenGLFXAAFilter::EndTimeQuery ( vtkOpenGLRenderTimer timer)

◆ PrintBenchmark()

void vtkOpenGLFXAAFilter::PrintBenchmark ( )

Member Data Documentation

◆ BlendState

bool vtkOpenGLFXAAFilter::BlendState

Definition at line 119 of file vtkOpenGLFXAAFilter.h.

◆ DepthTestState

bool vtkOpenGLFXAAFilter::DepthTestState

Definition at line 120 of file vtkOpenGLFXAAFilter.h.

◆ Viewport

int vtkOpenGLFXAAFilter::Viewport[4]

Definition at line 122 of file vtkOpenGLFXAAFilter.h.

◆ PreparationTimer

vtkOpenGLRenderTimer* vtkOpenGLFXAAFilter::PreparationTimer

Definition at line 125 of file vtkOpenGLFXAAFilter.h.

◆ FXAATimer

vtkOpenGLRenderTimer* vtkOpenGLFXAAFilter::FXAATimer

Definition at line 126 of file vtkOpenGLFXAAFilter.h.

◆ RelativeContrastThreshold

float vtkOpenGLFXAAFilter::RelativeContrastThreshold

Definition at line 129 of file vtkOpenGLFXAAFilter.h.

◆ HardContrastThreshold

float vtkOpenGLFXAAFilter::HardContrastThreshold

Definition at line 130 of file vtkOpenGLFXAAFilter.h.

◆ SubpixelBlendLimit

float vtkOpenGLFXAAFilter::SubpixelBlendLimit

Definition at line 131 of file vtkOpenGLFXAAFilter.h.

◆ SubpixelContrastThreshold

float vtkOpenGLFXAAFilter::SubpixelContrastThreshold

Definition at line 132 of file vtkOpenGLFXAAFilter.h.

◆ EndpointSearchIterations

int vtkOpenGLFXAAFilter::EndpointSearchIterations

Definition at line 133 of file vtkOpenGLFXAAFilter.h.

◆ UseHighQualityEndpoints

bool vtkOpenGLFXAAFilter::UseHighQualityEndpoints

Definition at line 135 of file vtkOpenGLFXAAFilter.h.

◆ DebugOptionValue

vtkFXAAOptions::DebugOption vtkOpenGLFXAAFilter::DebugOptionValue

Definition at line 136 of file vtkOpenGLFXAAFilter.h.

◆ NeedToRebuildShader

bool vtkOpenGLFXAAFilter::NeedToRebuildShader

Definition at line 139 of file vtkOpenGLFXAAFilter.h.

◆ Renderer

vtkOpenGLRenderer* vtkOpenGLFXAAFilter::Renderer

Definition at line 141 of file vtkOpenGLFXAAFilter.h.

◆ Input

vtkTextureObject* vtkOpenGLFXAAFilter::Input

Definition at line 142 of file vtkOpenGLFXAAFilter.h.

◆ QHelper

vtkOpenGLQuadHelper* vtkOpenGLFXAAFilter::QHelper

Definition at line 144 of file vtkOpenGLFXAAFilter.h.

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