Implement a post-processing DOF blur pass. More...

#include <vtkDepthOfFieldPass.h>

Inheritance diagram for vtkDepthOfFieldPass:

Collaboration diagram for vtkDepthOfFieldPass:

Public Types
typedef vtkDepthImageProcessingPass	Superclass

Public Types inherited from vtkDepthImageProcessingPass
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. More...

vtkDepthOfFieldPass *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...

void	Render (const vtkRenderState *s) override
	Perform rendering according to a render state `s`. More...

void	ReleaseGraphicsResources (vtkWindow *w) override
	Release graphics resources and ask components to release their own resources. More...


virtual void	SetAutomaticFocalDistance (bool)
	Use automatic focal distance calculation, this is on by default When on the center of the viewport will always be in focus regardless of where the focal point is. More...

virtual bool	GetAutomaticFocalDistance ()
	Use automatic focal distance calculation, this is on by default When on the center of the viewport will always be in focus regardless of where the focal point is. More...

virtual void	AutomaticFocalDistanceOn ()
	Use automatic focal distance calculation, this is on by default When on the center of the viewport will always be in focus regardless of where the focal point is. More...

virtual void	AutomaticFocalDistanceOff ()
	Use automatic focal distance calculation, this is on by default When on the center of the viewport will always be in focus regardless of where the focal point is. More...

Public Member Functions inherited from vtkDepthImageProcessingPass
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...

vtkDepthImageProcessingPass *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...

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. More...

vtkImageProcessingPass *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...

void	ReleaseGraphicsResources (vtkWindow *w) override
	Release graphics resources and ask components to release their own resources. More...

virtual vtkRenderPass *	GetDelegatePass ()
	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 vtkOpenGLRenderPass
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...

vtkOpenGLRenderPass *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...

virtual bool	SetShaderParameters (vtkShaderProgram program, vtkAbstractMapper mapper, vtkProp prop, vtkOpenGLVertexArrayObject VAO=nullptr)
	Update the uniforms of the shader program. More...

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. More...

virtual void	SetActiveDrawBuffers (unsigned int)
	Number of active draw buffers. More...

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. More...

virtual bool	PostReplaceShaderValues (std::string &vertexShader, std::string &geometryShader, std::string &fragmentShader, vtkAbstractMapper mapper, vtkProp prop)
	Use vtkShaderProgram::Substitute to replace. More...

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. More...

vtkRenderPass *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...

virtual void	Render (const vtkRenderState *s)=0
	Perform rendering according to a render state `s`. More...

virtual void	ReleaseGraphicsResources (vtkWindow *w)
	Release graphics resources and ask components to release their own resources. More...

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	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...

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)

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

vtkCommand *	GetCommand (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...

vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkTypeBool	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 vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class. 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	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...

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 vtkDepthOfFieldPass *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkDepthOfFieldPass *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkDepthImageProcessingPass
static vtkTypeBool	IsTypeOf (const char *type)

static vtkDepthImageProcessingPass *	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. More...

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. 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 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 vtkObjectBase *	New ()
	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 vtkObjectBase *	NewInstanceInternal () const

	vtkDepthOfFieldPass ()
	Default constructor. More...

	~vtkDepthOfFieldPass () override
	Destructor. More...

Protected Member Functions inherited from vtkDepthImageProcessingPass
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkDepthImageProcessingPass ()
	Default constructor. More...

	~vtkDepthImageProcessingPass () override
	Destructor. More...

virtual void	RenderDelegate (const vtkRenderState s, int width, int height, int newWidth, int newHeight, vtkOpenGLFramebufferObject fbo, vtkTextureObject colortarget, vtkTextureObject depthtarget)
	Render delegate with a image of different dimensions than the original one. More...

void	ReadWindowSize (const vtkRenderState *s)
	Read parent size - for sake of code clarity This function is generic, can be useful in multiple image-based rendering classes. More...

Protected Member Functions inherited from vtkImageProcessingPass
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkImageProcessingPass ()
	Default constructor. More...

	~vtkImageProcessingPass () override
	Destructor. More...

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. More...

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. More...

void	PostRender (const vtkRenderState *s)
	Call after rendering to clean up the actors' information keys. More...

Protected Member Functions inherited from vtkRenderPass
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkRenderPass ()
	Default constructor. More...

	~vtkRenderPass () override
	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, vtkFrameBufferObjectBase fbo=nullptr)
	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=nullptr)
	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	RegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
vtkOpenGLFramebufferObject *	FrameBufferObject
	Graphics resources. More...

vtkTextureObject *	Pass1

vtkTextureObject *	Pass1Depth

vtkOpenGLHelper *	BlurProgram

bool	AutomaticFocalDistance

Protected Attributes inherited from vtkDepthImageProcessingPass
int	Origin [2]

int	Width

int	Height

int	W

int	H

int	ExtraPixels

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

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 DOF blur pass.

Currently only does behind the focal plane

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.

The delegate is used once.

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

Implementation:: As the filter is separable, it first blurs the image horizontally and then vertically. This reduces the number of texture samples

See also: vtkRenderPass

Definition at line 49 of file vtkDepthOfFieldPass.h.

Member Typedef Documentation

◆ Superclass

typedef vtkDepthImageProcessingPass vtkDepthOfFieldPass::Superclass

Definition at line 53 of file vtkDepthOfFieldPass.h.

Constructor & Destructor Documentation

◆ vtkDepthOfFieldPass()

vtkDepthOfFieldPass::vtkDepthOfFieldPass ( )

protected

Default constructor.

DelegatePass is set to NULL.

◆ ~vtkDepthOfFieldPass()

vtkDepthOfFieldPass::~vtkDepthOfFieldPass ( )

overrideprotected

Destructor.

Member Function Documentation

◆ New()

static vtkDepthOfFieldPass * vtkDepthOfFieldPass::New ( )

static

◆ IsTypeOf()

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

static

◆ IsA()

virtual vtkTypeBool vtkDepthOfFieldPass::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 vtkDepthImageProcessingPass.

◆ SafeDownCast()

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

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkDepthOfFieldPass::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkDepthImageProcessingPass.

◆ NewInstance()

vtkDepthOfFieldPass * vtkDepthOfFieldPass::NewInstance ( ) const

◆ PrintSelf()

void vtkDepthOfFieldPass::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 vtkDepthImageProcessingPass.

◆ SetAutomaticFocalDistance()

virtual void vtkDepthOfFieldPass::SetAutomaticFocalDistance ( bool )

virtual

Use automatic focal distance calculation, this is on by default When on the center of the viewport will always be in focus regardless of where the focal point is.

◆ GetAutomaticFocalDistance()

virtual bool vtkDepthOfFieldPass::GetAutomaticFocalDistance ( )

virtual

Use automatic focal distance calculation, this is on by default When on the center of the viewport will always be in focus regardless of where the focal point is.

◆ AutomaticFocalDistanceOn()

virtual void vtkDepthOfFieldPass::AutomaticFocalDistanceOn ( )

virtual

Use automatic focal distance calculation, this is on by default When on the center of the viewport will always be in focus regardless of where the focal point is.

◆ AutomaticFocalDistanceOff()

virtual void vtkDepthOfFieldPass::AutomaticFocalDistanceOff ( )

virtual

Use automatic focal distance calculation, this is on by default When on the center of the viewport will always be in focus regardless of where the focal point is.

◆ Render()

void vtkDepthOfFieldPass::Render ( const vtkRenderState * s )

overridevirtual

Perform rendering according to a render state s.

Precondition: s_exists: s!=0

Implements vtkRenderPass.

◆ ReleaseGraphicsResources()

void vtkDepthOfFieldPass::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* vtkDepthOfFieldPass::FrameBufferObject

protected

Graphics resources.

Definition at line 94 of file vtkDepthOfFieldPass.h.

◆ Pass1

vtkTextureObject* vtkDepthOfFieldPass::Pass1

protected

Definition at line 95 of file vtkDepthOfFieldPass.h.

◆ Pass1Depth

vtkTextureObject* vtkDepthOfFieldPass::Pass1Depth

protected

Definition at line 96 of file vtkDepthOfFieldPass.h.

◆ BlurProgram

vtkOpenGLHelper* vtkDepthOfFieldPass::BlurProgram

protected

Definition at line 99 of file vtkDepthOfFieldPass.h.

◆ AutomaticFocalDistance

bool vtkDepthOfFieldPass::AutomaticFocalDistance

protected

Definition at line 101 of file vtkDepthOfFieldPass.h.

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

Rendering/OpenGL2/vtkDepthOfFieldPass.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkDepthOfFieldPass()

◆ ~vtkDepthOfFieldPass()

Member Function Documentation

◆ New()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ SetAutomaticFocalDistance()

◆ GetAutomaticFocalDistance()

◆ AutomaticFocalDistanceOn()

◆ AutomaticFocalDistanceOff()

◆ Render()

◆ ReleaseGraphicsResources()

Member Data Documentation

◆ FrameBufferObject

◆ Pass1

◆ Pass1Depth

◆ BlurProgram

◆ AutomaticFocalDistance