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
 
typedef vtkObject Superclass
 
- Public Types inherited from vtkObject
typedef vtkObjectBase Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkGaussianBlurPassNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
void ReleaseGraphicsResources (vtkWindow *w)
 
virtual int IsA (const char *type)
 
vtkGaussianBlurPassNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
void ReleaseGraphicsResources (vtkWindow *w)
 
virtual void Render (const vtkRenderState *s)
 
virtual void Render (const vtkRenderState *s)
 
- Public Member Functions inherited from vtkImageProcessingPass
vtkImageProcessingPassNewInstance () const
 
vtkImageProcessingPassNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
void ReleaseGraphicsResources (vtkWindow *w)
 
virtual vtkRenderPassGetDelegatePass ()
 
virtual void SetDelegatePass (vtkRenderPass *delegatePass)
 
virtual vtkRenderPassGetDelegatePass ()
 
virtual void SetDelegatePass (vtkRenderPass *delegatePass)
 
- Public Member Functions inherited from vtkRenderPass
vtkRenderPassNewInstance () const
 
vtkRenderPassNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual int GetNumberOfRenderedProps ()
 
virtual int GetNumberOfRenderedProps ()
 
- Public Member Functions inherited from vtkObject
vtkObjectNewInstance () const
 
virtual void DebugOn ()
 
virtual void DebugOff ()
 
bool GetDebug ()
 
void SetDebug (bool debugFlag)
 
virtual void Modified ()
 
virtual unsigned long GetMTime ()
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 
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 *)
 
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)
 
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)
 
int InvokeEvent (unsigned long event, void *callData)
 
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
 
virtual void Delete ()
 
virtual void FastDelete ()
 
void Print (ostream &os)
 
virtual void Register (vtkObjectBase *o)
 
virtual void UnRegister (vtkObjectBase *o)
 
void SetReferenceCount (int)
 
void PrintRevisions (ostream &)
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 

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 int IsTypeOf (const char *type)
 
static vtkRenderPassSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkObject
static int IsTypeOf (const char *type)
 
static vtkObjectSafeDownCast (vtkObjectBase *o)
 
static vtkObjectNew ()
 
static void BreakOnError ()
 
static void SetGlobalWarningDisplay (int val)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static int IsTypeOf (const char *name)
 
static vtkObjectBaseNew ()
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkGaussianBlurPass ()
 
virtual ~vtkGaussianBlurPass ()
 
virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkGaussianBlurPass ()
 
virtual ~vtkGaussianBlurPass ()
 
- Protected Member Functions inherited from vtkImageProcessingPass
 vtkImageProcessingPass ()
 
virtual ~vtkImageProcessingPass ()
 
 vtkImageProcessingPass ()
 
virtual ~vtkImageProcessingPass ()
 
void RenderDelegate (const vtkRenderState *s, int width, int height, int newWidth, int newHeight, vtkFrameBufferObject *fbo, vtkTextureObject *target)
 
void RenderDelegate (const vtkRenderState *s, int width, int height, int newWidth, int newHeight, vtkFrameBufferObject *fbo, vtkTextureObject *target)
 
- Protected Member Functions inherited from vtkRenderPass
 vtkRenderPass ()
 
virtual ~vtkRenderPass ()
 
void UpdateCamera (vtkRenderer *renderer)
 
void ClearLights (vtkRenderer *renderer)
 
void UpdateLightGeometry (vtkRenderer *renderer)
 
void UpdateLights (vtkRenderer *renderer)
 
void UpdateGeometry (vtkRenderer *renderer)
 
 vtkRenderPass ()
 
virtual ~vtkRenderPass ()
 
void UpdateCamera (vtkRenderer *renderer)
 
void ClearLights (vtkRenderer *renderer)
 
void UpdateLightGeometry (vtkRenderer *renderer)
 
void UpdateLights (vtkRenderer *renderer)
 
void UpdateGeometry (vtkRenderer *renderer)
 
void SetLastRenderingUsedDepthPeeling (vtkRenderer *renderer, bool value)
 
void SetLastRenderingUsedDepthPeeling (vtkRenderer *renderer, bool value)
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
virtual ~vtkObject ()
 
virtual void RegisterInternal (vtkObjectBase *, int check)
 
virtual void UnRegisterInternal (vtkObjectBase *, int check)
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
 
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 Supported
 
bool SupportProbed
 
vtkOpenGLHelperBlurProgram
 
vtkFrameBufferObjectFrameBufferObject
 
vtkTextureObjectPass1
 
vtkTextureObjectPass2
 
vtkShaderProgram2BlurProgram
 
- 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 61 of file vtkGaussianBlurPass.h.

Member Typedef Documentation

Definition at line 65 of file vtkGaussianBlurPass.h.

Definition at line 67 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 vtkObject.

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 89 of file vtkGaussianBlurPass.h.

vtkTextureObject * vtkGaussianBlurPass::Pass1
protected

Graphics resources.

Definition at line 90 of file vtkGaussianBlurPass.h.

vtkTextureObject * vtkGaussianBlurPass::Pass2
protected

Graphics resources.

Definition at line 91 of file vtkGaussianBlurPass.h.

vtkShaderProgram2* vtkGaussianBlurPass::BlurProgram
protected

Graphics resources.

Definition at line 92 of file vtkGaussianBlurPass.h.

bool vtkGaussianBlurPass::Supported
protected

Definition at line 95 of file vtkGaussianBlurPass.h.

bool vtkGaussianBlurPass::SupportProbed
protected

Definition at line 96 of file vtkGaussianBlurPass.h.

vtkOpenGLHelper* vtkGaussianBlurPass::BlurProgram
protected

Definition at line 97 of file vtkGaussianBlurPass.h.


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