vtkGaussianBlurPass Class Reference

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

#include <vtkGaussianBlurPass.h>

Inheritance diagram for vtkGaussianBlurPass:

Collaboration diagram for vtkGaussianBlurPass:

Public Types
typedef vtkImageProcessingPass	Superclass
Public Types inherited from vtkImageProcessingPass
typedef vtkOpenGLRenderPass	Superclass
Public Types inherited from vtkOpenGLRenderPass
typedef vtkRenderPass	Superclass
Public Types inherited from vtkRenderPass
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.
vtkGaussianBlurPass *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
void	Render (const vtkRenderState *s) override
	Perform rendering according to a render state s.
void	ReleaseGraphicsResources (vtkWindow *w) override
	Release graphics resources and ask components to release their own resources.
Public Member Functions inherited from vtkImageProcessingPass
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.
vtkImageProcessingPass *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
void	ReleaseGraphicsResources (vtkWindow *w) override
	Release graphics resources and ask components to release their own resources.
virtual vtkRenderPass *	GetDelegatePass ()
	Delegate for rendering the image to be processed.
virtual void	SetDelegatePass (vtkRenderPass *delegatePass)
	Delegate for rendering the image to be processed.
Public Member Functions inherited from vtkOpenGLRenderPass
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.
vtkOpenGLRenderPass *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
virtual bool	SetShaderParameters (vtkShaderProgram *program, vtkAbstractMapper *mapper, vtkProp *prop, vtkOpenGLVertexArrayObject *VAO=nullptr)
	Update the uniforms of the shader program.
virtual vtkMTimeType	GetShaderStageMTime ()
	For multi-stage render passes that need to change shader code during a single pass, use this method to notify a mapper that the shader needs to be rebuilt (rather than reuse the last cached shader.
virtual void	SetActiveDrawBuffers (unsigned int)
	Number of active draw buffers.
virtual unsigned int	GetActiveDrawBuffers ()
virtual bool	PreReplaceShaderValues (std::string &vertexShader, std::string &geometryShader, std::string &fragmentShader, vtkAbstractMapper *mapper, vtkProp *prop)
	Use vtkShaderProgram::Substitute to replace.
virtual bool	PostReplaceShaderValues (std::string &vertexShader, std::string &geometryShader, std::string &fragmentShader, vtkAbstractMapper *mapper, vtkProp *prop)
	Use vtkShaderProgram::Substitute to replace.
Public Member Functions inherited from vtkRenderPass
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.
vtkRenderPass *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
virtual void	Render (const vtkRenderState *s)=0
	Perform rendering according to a render state s.
virtual void	ReleaseGraphicsResources (vtkWindow *w)
	Release graphics resources and ask components to release their own resources.
virtual int	GetNumberOfRenderedProps ()
	Number of props rendered at the last Render call.
Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)
virtual void	DebugOn ()
	Turn debugging output on.
virtual void	DebugOff ()
	Turn debugging output off.
bool	GetDebug ()
	Get the value of the debug flag.
void	SetDebug (bool debugFlag)
	Set the value of the debug flag.
virtual void	Modified ()
	Update the modification time for this object.
virtual vtkMTimeType	GetMTime ()
	Return this object's modified time.
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
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)
vtkTypeBool	InvokeEvent (unsigned long event)
vtkTypeBool	InvokeEvent (const char *event)
std::string	GetObjectDescription () const override
	The object description printed in messages and PrintSelf output.
unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
unsigned long	AddObserver (const char *event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObservers (const char *event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool	HasObserver (const char *event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
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.
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.
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.
vtkTypeBool	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
vtkTypeBool	InvokeEvent (const char *event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
virtual void	SetObjectName (const std::string &objectName)
	Set/get the name of this object for reporting purposes.
virtual std::string	GetObjectName () const
	Set/get the name of this object for reporting purposes.
Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.
virtual std::string	GetObjectDescription () const
	The object description printed in messages and PrintSelf output.
virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class.
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).
virtual void	Delete ()
	Delete a VTK object.
virtual void	FastDelete ()
	Delete a reference to this object.
void	InitializeObjectBase ()
void	Print (ostream &os)
	Print an object to an ostream.
void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object).
virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object).
int	GetReferenceCount ()
	Return the current reference count of this object.
void	SetReferenceCount (int)
	Sets the reference count.
bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space.
virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.
virtual bool	UsesGarbageCollector () const
	Indicate whether the class uses vtkGarbageCollector or not.

Static Public Member Functions
static vtkGaussianBlurPass *	New ()
static vtkTypeBool	IsTypeOf (const char *type)
static vtkGaussianBlurPass *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkImageProcessingPass
static vtkTypeBool	IsTypeOf (const char *type)
static vtkImageProcessingPass *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkOpenGLRenderPass
static vtkTypeBool	IsTypeOf (const char *type)
static vtkOpenGLRenderPass *	SafeDownCast (vtkObjectBase *o)
static vtkInformationObjectBaseVectorKey *	RenderPasses ()
	Key containing information about the current pass.
Static Public Member Functions inherited from vtkRenderPass
static vtkTypeBool	IsTypeOf (const char *type)
static vtkRenderPass *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
static void	BreakOnError ()
	This method is called when vtkErrorMacro executes.
static void	SetGlobalWarningDisplay (vtkTypeBool val)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static vtkTypeBool	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
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.
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).
static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.
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.

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkGaussianBlurPass ()
	Default constructor.
	~vtkGaussianBlurPass () override
	Destructor.
Protected Member Functions inherited from vtkImageProcessingPass
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkImageProcessingPass ()
	Default constructor.
	~vtkImageProcessingPass () override
	Destructor.
void	RenderDelegate (const vtkRenderState *s, int width, int height, int newWidth, int newHeight, vtkOpenGLFramebufferObject *fbo, vtkTextureObject *target)
	Render delegate with a image of different dimensions than the original one.
Protected Member Functions inherited from vtkOpenGLRenderPass
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkOpenGLRenderPass ()
	~vtkOpenGLRenderPass () override
void	PreRender (const vtkRenderState *s)
	Call before rendering to update the actors' information keys.
virtual void	PreRenderProp (vtkProp *prop)
	Called in PreRender to give a chance to subclasses to set additonal information keys.
void	PostRender (const vtkRenderState *s)
	Call after rendering to clean up the actors' information keys.
virtual void	PostRenderProp (vtkProp *prop)
	Called in PreRender to give a chance to subclasses to clean up information keys.
Protected Member Functions inherited from vtkRenderPass
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkRenderPass ()
	Default constructor.
	~vtkRenderPass () override
	Destructor.
void	UpdateCamera (vtkRenderer *renderer)
	Call UpdateCamera() on Renderer.
void	ClearLights (vtkRenderer *renderer)
	Call ClearLights() on Renderer.
void	UpdateLightGeometry (vtkRenderer *renderer)
	Call UpdateLightGeometry() on Renderer.
void	UpdateLights (vtkRenderer *renderer)
	Call UpdateLights() on Renderer.
void	UpdateGeometry (vtkRenderer *renderer, vtkFrameBufferObjectBase *fbo=nullptr)
	Call UpdateGeometry() on Renderer.
void	SetLastRenderingUsedDepthPeeling (vtkRenderer *renderer, bool value)
	Modify protected member LastRenderingUsedDepthPeeling on Renderer.
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.
void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events.
Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()
virtual	~vtkObjectBase ()
virtual void	RegisterInternal (vtkObjectBase *, vtkTypeBool check)
virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)
virtual void	ReportReferences (vtkGarbageCollector *)
virtual void	ObjectFinalize ()
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)

Protected Attributes
vtkOpenGLFramebufferObject *	FrameBufferObject
	Graphics resources.
vtkTextureObject *	Pass1
vtkTextureObject *	Pass2
vtkOpenGLHelper *	BlurProgram
Protected Attributes inherited from vtkImageProcessingPass
vtkRenderPass *	DelegatePass
Protected Attributes inherited from vtkOpenGLRenderPass
unsigned int	ActiveDrawBuffers = 0
Protected Attributes inherited from vtkRenderPass
int	NumberOfRenderedProps
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
std::string	ObjectName
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

Implement a post-processing Gaussian blur render pass.

Blur the image rendered 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 farthest 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 54 of file vtkGaussianBlurPass.h.

Member Typedef Documentation

Superclass

typedef vtkImageProcessingPass vtkGaussianBlurPass::Superclass

Definition at line 58 of file vtkGaussianBlurPass.h.

Constructor & Destructor Documentation

vtkGaussianBlurPass()

vtkGaussianBlurPass::vtkGaussianBlurPass ( )

protected

Default constructor.

DelegatePass is set to NULL.

~vtkGaussianBlurPass()

vtkGaussianBlurPass::~vtkGaussianBlurPass ( )

overrideprotected

Destructor.

Member Function Documentation

New()

static vtkGaussianBlurPass * vtkGaussianBlurPass::New ( )

static

IsTypeOf()

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

static

IsA()

virtual vtkTypeBool 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.

SafeDownCast()

static vtkGaussianBlurPass * vtkGaussianBlurPass::SafeDownCast ( vtkObjectBase *  o )

static

NewInstanceInternal()

virtual vtkObjectBase * vtkGaussianBlurPass::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkImageProcessingPass.

NewInstance()

vtkGaussianBlurPass * vtkGaussianBlurPass::NewInstance

(

)

const

PrintSelf()

void vtkGaussianBlurPass::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 vtkObjectBase.

Render()

void vtkGaussianBlurPass::Render ( const vtkRenderState *  s )

overridevirtual

Perform rendering according to a render state s.

Precondition

s_exists: s!=0

Implements vtkRenderPass.

ReleaseGraphicsResources()

void vtkGaussianBlurPass::ReleaseGraphicsResources ( vtkWindow *  w )

overridevirtual

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

Precondition

w_exists: w!=0

Reimplemented from vtkRenderPass.

Member Data Documentation

FrameBufferObject

vtkOpenGLFramebufferObject* vtkGaussianBlurPass::FrameBufferObject

protected

Graphics resources.

Definition at line 88 of file vtkGaussianBlurPass.h.

Pass1

vtkTextureObject* vtkGaussianBlurPass::Pass1

protected

Definition at line 89 of file vtkGaussianBlurPass.h.

Pass2

vtkTextureObject* vtkGaussianBlurPass::Pass2

protected

Definition at line 90 of file vtkGaussianBlurPass.h.

BlurProgram

vtkOpenGLHelper* vtkGaussianBlurPass::BlurProgram

protected

Definition at line 93 of file vtkGaussianBlurPass.h.

---

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

• Rendering/OpenGL2/vtkGaussianBlurPass.h