vtkOpenGLFXAAFilter.h

Go to the documentation of this file.

/*=========================================================================
 
  Program:   Visualization Toolkit
  Module:    vtkOpenGLFXAAFilter.h
 
  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
  All rights reserved.
  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
 
     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notice for more information.
 
=========================================================================*/
 
#ifndef vtkOpenGLFXAAFilter_h
#define vtkOpenGLFXAAFilter_h
 
#include "vtkFXAAOptions.h" // For DebugOptions enum
#include "vtkObject.h"
#include "vtkRenderingOpenGL2Module.h" // For export macro
 
#include <string> // For std::string
 
class vtkFXAAOptions;
class vtkOpenGLRenderer;
class vtkOpenGLRenderTimer;
class vtkShaderProgram;
class vtkTextureObject;
class vtkOpenGLQuadHelper;
 
class VTKRENDERINGOPENGL2_EXPORT vtkOpenGLFXAAFilter : public vtkObject
{
public:
  static vtkOpenGLFXAAFilter* New();
  vtkTypeMacro(vtkOpenGLFXAAFilter, vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;
 
  void Execute(vtkOpenGLRenderer* ren);
 
  void ReleaseGraphicsResources();
 
  void UpdateConfiguration(vtkFXAAOptions* opts);
 
 
  vtkSetClampMacro(RelativeContrastThreshold, float, 0.f, 1.f);
  vtkGetMacro(RelativeContrastThreshold, float);
  vtkSetClampMacro(HardContrastThreshold, float, 0.f, 1.f);
  vtkGetMacro(HardContrastThreshold, float);
  vtkSetClampMacro(SubpixelBlendLimit, float, 0.f, 1.f);
  vtkGetMacro(SubpixelBlendLimit, float);
  vtkSetClampMacro(SubpixelContrastThreshold, float, 0.f, 1.f);
  vtkGetMacro(SubpixelContrastThreshold, float);
  virtual void SetUseHighQualityEndpoints(bool val);
  vtkGetMacro(UseHighQualityEndpoints, bool);
  vtkBooleanMacro(UseHighQualityEndpoints, bool);
  vtkSetClampMacro(EndpointSearchIterations, int, 0, VTK_INT_MAX);
  vtkGetMacro(EndpointSearchIterations, int);
  virtual void SetDebugOptionValue(vtkFXAAOptions::DebugOption opt);
  vtkGetMacro(DebugOptionValue, vtkFXAAOptions::DebugOption);
 
protected:
  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();
 
  // Cache GL state that we modify
  bool BlendState;
  bool DepthTestState;
 
  int Viewport[4]; // x, y, width, height
 
  // Used to measure execution time:
  vtkOpenGLRenderTimer* PreparationTimer;
  vtkOpenGLRenderTimer* FXAATimer;
 
  // Parameters:
  float RelativeContrastThreshold;
  float HardContrastThreshold;
  float SubpixelBlendLimit;
  float SubpixelContrastThreshold;
  int EndpointSearchIterations;
 
  bool UseHighQualityEndpoints;
  vtkFXAAOptions::DebugOption DebugOptionValue;
 
  // Set to true when the shader definitions change so we know when to rebuild.
  bool NeedToRebuildShader;
 
  vtkOpenGLRenderer* Renderer;
  vtkTextureObject* Input;
 
  vtkOpenGLQuadHelper* QHelper;
 
private:
  vtkOpenGLFXAAFilter(const vtkOpenGLFXAAFilter&) = delete;
  void operator=(const vtkOpenGLFXAAFilter&) = delete;
};
 
#endif // vtkOpenGLFXAAFilter_h