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

Implement a post-processing Gaussian blur render pass. More...

#include <vtkGaussianBlurPass.h>

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

Public Types

typedef vtkImageProcessingPass Superclass
 
typedef vtkImageProcessingPass Superclass
 
- Public Types inherited from vtkImageProcessingPass
typedef vtkRenderPass Superclass
 
typedef vtkRenderPass Superclass
 
- Public Types inherited from vtkRenderPass
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...
 
vtkGaussianBlurPassNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void Render (const vtkRenderState *s)
 Perform rendering according to a render state s. More...
 
void ReleaseGraphicsResources (vtkWindow *w)
 Release graphics resources and ask components to release their own resources. More...
 
virtual int IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkGaussianBlurPassNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void Render (const vtkRenderState *s)
 Perform rendering according to a render state s. More...
 
void ReleaseGraphicsResources (vtkWindow *w)
 Release graphics resources and ask components to release their own resources. More...
 
- Public Member Functions inherited from vtkImageProcessingPass
vtkImageProcessingPassNewInstance () const
 
vtkImageProcessingPassNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
void ReleaseGraphicsResources (vtkWindow *w)
 Release graphics resources and ask components to release their own resources. More...
 
virtual vtkRenderPassGetDelegatePass ()
 Delegate for rendering the image to be processed. More...
 
virtual void SetDelegatePass (vtkRenderPass *delegatePass)
 Delegate for rendering the image to be processed. More...
 
virtual vtkRenderPassGetDelegatePass ()
 Delegate for rendering the image to be processed. More...
 
virtual void SetDelegatePass (vtkRenderPass *delegatePass)
 Delegate for rendering the image to be processed. More...
 
- Public Member Functions inherited from vtkRenderPass
vtkRenderPassNewInstance () const
 
virtual int GetNumberOfRenderedProps ()
 Number of props rendered at the last Render call. 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 ()
 
int HasObserver (unsigned long event)
 
int 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...
 
int HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
int 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 vtkGaussianBlurPassNew ()
 
static int IsTypeOf (const char *type)
 
static vtkGaussianBlurPassSafeDownCast (vtkObjectBase *o)
 
static vtkGaussianBlurPassNew ()
 
static int IsTypeOf (const char *type)
 
static vtkGaussianBlurPassSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkImageProcessingPass
static int IsTypeOf (const char *type)
 
static vtkImageProcessingPassSafeDownCast (vtkObjectBase *o)
 
static int IsTypeOf (const char *type)
 
static vtkImageProcessingPassSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkRenderPass
static int IsTypeOf (const char *type)
 
static vtkRenderPassSafeDownCast (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
 
 vtkGaussianBlurPass ()
 Default constructor. More...
 
virtual ~vtkGaussianBlurPass ()
 Destructor. More...
 
virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkGaussianBlurPass ()
 Default constructor. More...
 
virtual ~vtkGaussianBlurPass ()
 Destructor. More...
 
- Protected Member Functions inherited from vtkImageProcessingPass
 vtkImageProcessingPass ()
 Default constructor. More...
 
virtual ~vtkImageProcessingPass ()
 Destructor. More...
 
void RenderDelegate (const vtkRenderState *s, int width, int height, int newWidth, int newHeight, vtkFrameBufferObject *fbo, vtkTextureObject *target)
 Render delegate with a image of different dimensions than the original one. More...
 
 vtkImageProcessingPass ()
 Default constructor. More...
 
virtual ~vtkImageProcessingPass ()
 Destructor. More...
 
void RenderDelegate (const vtkRenderState *s, int width, int height, int newWidth, int newHeight, vtkFrameBufferObject *fbo, vtkTextureObject *target)
 Render delegate with a image of different dimensions than the original one. More...
 
- Protected Member Functions inherited from vtkRenderPass
 vtkRenderPass ()
 Default constructor. More...
 
virtual ~vtkRenderPass ()
 Destructor. More...
 
void UpdateCamera (vtkRenderer *renderer)
 Call UpdateCamera() on Renderer. More...
 
void ClearLights (vtkRenderer *renderer)
 Call ClearLights() on Renderer. More...
 
void UpdateLightGeometry (vtkRenderer *renderer)
 Call UpdateLightGeometry() on Renderer. More...
 
void UpdateLights (vtkRenderer *renderer)
 Call UpdateLights() on Renderer. More...
 
void UpdateGeometry (vtkRenderer *renderer)
 Call UpdateGeometry() on Renderer. More...
 
void SetLastRenderingUsedDepthPeeling (vtkRenderer *renderer, bool value)
 Modify protected member LastRenderingUsedDepthPeeling on Renderer. More...
 
- 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 ()
 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

vtkFrameBufferObjectFrameBufferObject
 Graphics resources. More...
 
vtkTextureObjectPass1
 
vtkTextureObjectPass2
 
vtkShaderProgram2BlurProgram
 
bool Supported
 
bool SupportProbed
 
vtkOpenGLHelperBlurProgram
 
- Protected Attributes inherited from vtkImageProcessingPass
vtkRenderPassDelegatePass
 
- Protected Attributes inherited from vtkRenderPass
int NumberOfRenderedProps
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

Implement a post-processing Gaussian blur render pass.

Blur the image renderered by its delegate. Blurring uses a Gaussian low-pass filter with a 5x5 kernel.

This pass expects an initialized depth buffer and color buffer. Initialized buffers means they have been cleared with farest z-value and background color/gradient/transparent color. An opaque pass may have been performed right after the initialization.

The delegate is used once.

Its delegate is usually set to a vtkCameraPass or to a post-processing pass.

This pass requires a OpenGL context that supports texture objects (TO), framebuffer objects (FBO) and GLSL. If not, it will emit an error message and will render its delegate and return.

Implementation:
As the filter is separable, it first blurs the image horizontally and then vertically. This reduces the number of texture sampling to 5 per pass. In addition, as texture sampling can already blend texel values in linear mode, by adjusting the texture coordinate accordingly, only 3 texture sampling are actually necessary. Reference: OpenGL Bloom Toturial by Philip Rideout, section Exploit Hardware Filtering http://prideout.net/bloom/index.php#Sneaky
See also
vtkRenderPass

Blur the image renderered by its delegate. Blurring uses a Gaussian low-pass filter with a 5x5 kernel.

This pass expects an initialized depth buffer and color buffer. Initialized buffers means they have been cleared with farest z-value and background color/gradient/transparent color. An opaque pass may have been performed right after the initialization.

The delegate is used once.

Its delegate is usually set to a vtkCameraPass or to a post-processing pass.

This pass requires a OpenGL context that supports texture objects (TO), framebuffer objects (FBO) and GLSL. If not, it will emit an error message and will render its delegate and return.

Implementation:
As the filter is separable, it first blurs the image horizontally and then vertically. This reduces the number of texture sampling to 5 per pass. In addition, as texture sampling can already blend texel values in linear mode, by adjusting the texture coordinate accordingly, only 3 texture sampling are actually necessary. Reference: OpenGL Bloom Toturial by Philip Rideout, section Exploit Hardware Filtering http://prideout.net/bloom/index.php#Sneaky
See also
vtkRenderPass
Tests:
vtkGaussianBlurPass (Tests)

Definition at line 62 of file vtkGaussianBlurPass.h.

Member Typedef Documentation

Definition at line 66 of file vtkGaussianBlurPass.h.

Definition at line 68 of file vtkGaussianBlurPass.h.

Constructor & Destructor Documentation

vtkGaussianBlurPass::vtkGaussianBlurPass ( )
protected

Default constructor.

DelegatePass is set to NULL.

virtual vtkGaussianBlurPass::~vtkGaussianBlurPass ( )
protectedvirtual

Destructor.

vtkGaussianBlurPass::vtkGaussianBlurPass ( )
protected

Default constructor.

DelegatePass is set to NULL.

virtual vtkGaussianBlurPass::~vtkGaussianBlurPass ( )
protectedvirtual

Destructor.

Member Function Documentation

static vtkGaussianBlurPass* vtkGaussianBlurPass::New ( )
static
static int vtkGaussianBlurPass::IsTypeOf ( const char *  type)
static
virtual int vtkGaussianBlurPass::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 vtkImageProcessingPass.

static vtkGaussianBlurPass* vtkGaussianBlurPass::SafeDownCast ( vtkObjectBase o)
static
virtual vtkObjectBase* vtkGaussianBlurPass::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkImageProcessingPass.

vtkGaussianBlurPass* vtkGaussianBlurPass::NewInstance ( ) const
void vtkGaussianBlurPass::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 vtkRenderPass.

virtual void vtkGaussianBlurPass::Render ( const vtkRenderState s)
virtual

Perform rendering according to a render state s.

Precondition
s_exists: s!=0

Implements vtkRenderPass.

void vtkGaussianBlurPass::ReleaseGraphicsResources ( vtkWindow w)
virtual

Release graphics resources and ask components to release their own resources.

Precondition
w_exists: w!=0

Reimplemented from vtkRenderPass.

static vtkGaussianBlurPass* vtkGaussianBlurPass::New ( )
static
static int vtkGaussianBlurPass::IsTypeOf ( const char *  type)
static
virtual int vtkGaussianBlurPass::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 vtkImageProcessingPass.

static vtkGaussianBlurPass* vtkGaussianBlurPass::SafeDownCast ( vtkObjectBase o)
static
virtual vtkObjectBase* vtkGaussianBlurPass::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkImageProcessingPass.

vtkGaussianBlurPass* vtkGaussianBlurPass::NewInstance ( ) const
void vtkGaussianBlurPass::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 vtkImageProcessingPass.

virtual void vtkGaussianBlurPass::Render ( const vtkRenderState s)
virtual

Perform rendering according to a render state s.

Precondition
s_exists: s!=0

Implements vtkRenderPass.

void vtkGaussianBlurPass::ReleaseGraphicsResources ( vtkWindow w)
virtual

Release graphics resources and ask components to release their own resources.

Precondition
w_exists: w!=0

Reimplemented from vtkImageProcessingPass.

Member Data Documentation

vtkFrameBufferObject * vtkGaussianBlurPass::FrameBufferObject
protected

Graphics resources.

Definition at line 96 of file vtkGaussianBlurPass.h.

vtkTextureObject * vtkGaussianBlurPass::Pass1
protected

Definition at line 97 of file vtkGaussianBlurPass.h.

vtkTextureObject * vtkGaussianBlurPass::Pass2
protected

Definition at line 98 of file vtkGaussianBlurPass.h.

vtkShaderProgram2* vtkGaussianBlurPass::BlurProgram
protected

Definition at line 99 of file vtkGaussianBlurPass.h.

bool vtkGaussianBlurPass::Supported
protected

Definition at line 101 of file vtkGaussianBlurPass.h.

bool vtkGaussianBlurPass::SupportProbed
protected

Definition at line 102 of file vtkGaussianBlurPass.h.

vtkOpenGLHelper* vtkGaussianBlurPass::BlurProgram
protected

Definition at line 103 of file vtkGaussianBlurPass.h.


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