Implement Depth Peeling for use within a framebuffer pass. More...

#include <vtkDepthPeelingPass.h>

Inheritance diagram for vtkDepthPeelingPass:

Collaboration diagram for vtkDepthPeelingPass:

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

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

bool	PostReplaceShaderValues (std::string &vertexShader, std::string &geometryShader, std::string &fragmentShader, vtkAbstractMapper mapper, vtkProp prop) override
	Use vtkShaderProgram::Substitute to replace //VTK::XXX:YYY declarations in the shader sources. More...

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

void	SetOpaqueZTexture (vtkTextureObject *)

void	SetOpaqueRGBATexture (vtkTextureObject *)

virtual void	SetDepthFormat (int)
	Set the format to use for the depth texture e.g. More...


virtual vtkRenderPass *	GetTranslucentPass ()
	Delegate for rendering the translucent polygonal geometry. More...

virtual void	SetTranslucentPass (vtkRenderPass *translucentPass)
	Delegate for rendering the translucent polygonal geometry. More...


virtual void	SetOcclusionRatio (double)
	In case of use of depth peeling technique for rendering translucent material, define the threshold under which the algorithm stops to iterate over peel layers. More...

virtual double	GetOcclusionRatio ()
	In case of use of depth peeling technique for rendering translucent material, define the threshold under which the algorithm stops to iterate over peel layers. More...


virtual void	SetMaximumNumberOfPeels (int)
	In case of depth peeling, define the maximum number of peeling layers. More...

virtual int	GetMaximumNumberOfPeels ()
	In case of depth peeling, define the maximum number of peeling layers. More...

Public Member Functions inherited from vtkOpenGLRenderPass
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	PreReplaceShaderValues (std::string &vertexShader, std::string &geometryShader, std::string &fragmentShader, vtkAbstractMapper mapper, vtkProp prop)
	Use vtkShaderProgram::Substitute to replace //VTK::XXX:YYY declarations in the shader sources. 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 ()

Public Member Functions inherited from vtkRenderPass
vtkRenderPass *	NewInstance () 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 ()

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

static vtkTypeBool	IsTypeOf (const char *type)

static vtkDepthPeelingPass *	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 vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkDepthPeelingPass ()
	Default constructor. More...

	~vtkDepthPeelingPass () override
	Destructor. More...

void	BlendIntermediatePeels (vtkOpenGLRenderWindow *renWin, bool)

void	BlendFinalPeel (vtkOpenGLRenderWindow *renWin)

Protected Member Functions inherited from vtkOpenGLRenderPass
	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
	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)
	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	CollectRevisions (ostream &)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
vtkRenderPass *	TranslucentPass

vtkTimeStamp	CheckTime

double	OcclusionRatio
	In case of use of depth peeling technique for rendering translucent material, define the threshold under which the algorithm stops to iterate over peel layers. More...

int	MaximumNumberOfPeels
	In case of depth peeling, define the maximum number of peeling layers. More...

vtkOpenGLFramebufferObject *	Framebuffer

vtkOpenGLQuadHelper *	FinalBlend

vtkOpenGLQuadHelper *	IntermediateBlend

vtkTextureObject *	OpaqueZTexture

vtkTextureObject *	OpaqueRGBATexture

bool	OwnOpaqueZTexture

bool	OwnOpaqueRGBATexture

vtkTextureObject *	TranslucentRGBATexture [3]

int	ColorDrawCount

int	PeelCount

vtkTextureObject *	TranslucentZTexture [2]

int	DepthFormat

vtkOpenGLState *	State


int	ViewportX
	Cache viewport values for depth peeling. More...

int	ViewportY
	Cache viewport values for depth peeling. More...

int	ViewportWidth
	Cache viewport values for depth peeling. More...

int	ViewportHeight
	Cache viewport values for depth peeling. More...

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
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Detailed Description

Implement Depth Peeling for use within a framebuffer pass.

Note that this implementation is used as a fallback for drivers that don't support floating point textures. Most renderings will use the subclass vtkDualDepthPeelingPass instead.

Render the translucent polygonal geometry of a scene without sorting polygons in the view direction.

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 depth peeling algorithm works by rendering the translucent polygonal geometry multiple times (once for each peel). The actually rendering of the translucent polygonal geometry is performed by its delegate TranslucentPass. This delegate is therefore used multiple times.

Its delegate is usually set to a vtkTranslucentPass.

This implementation makes use of textures and is suitable for ES3 For ES3 it must be embedded within a pass that makes use of framebuffers so that the required OpaqueZTexture and OpaqueRGBATexture can be passed from the outer framebuffer pass. For OpenGL ES3 be aware the occlusion ratio test is not supported. The maximum number of peels is used instead so set it to a reasonable value. For many scenes a value of 4 or 5 will work well.

See also: vtkRenderPass, vtkTranslucentPass, vtkFramebufferPass

Tests:: vtkDepthPeelingPass (Tests)

Definition at line 66 of file vtkDepthPeelingPass.h.

Member Typedef Documentation

typedef vtkOpenGLRenderPass vtkDepthPeelingPass::Superclass

Definition at line 71 of file vtkDepthPeelingPass.h.

Constructor & Destructor Documentation

vtkDepthPeelingPass::vtkDepthPeelingPass ( )

protected

Default constructor.

TranslucentPass is set to NULL.

vtkDepthPeelingPass::~vtkDepthPeelingPass ( )

overrideprotected

Destructor.

Member Function Documentation

static vtkDepthPeelingPass* vtkDepthPeelingPass::New ( )

static

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

static

virtual vtkTypeBool vtkDepthPeelingPass::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 vtkOpenGLRenderPass.

Reimplemented in vtkDualDepthPeelingPass.

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

static

virtual vtkObjectBase* vtkDepthPeelingPass::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkOpenGLRenderPass.

Reimplemented in vtkDualDepthPeelingPass.

vtkDepthPeelingPass* vtkDepthPeelingPass::NewInstance ( ) const

void vtkDepthPeelingPass::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 vtkRenderPass.

Reimplemented in vtkDualDepthPeelingPass.

void vtkDepthPeelingPass::Render ( const vtkRenderState * s )

overridevirtual

Perform rendering according to a render state s.

Precondition: s_exists: s!=0

Implements vtkRenderPass.

Reimplemented in vtkDualDepthPeelingPass.

void vtkDepthPeelingPass::ReleaseGraphicsResources ( vtkWindow * w )

overridevirtual

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

Precondition: w_exists: w!=0

Reimplemented from vtkRenderPass.

Reimplemented in vtkDualDepthPeelingPass.

virtual vtkRenderPass* vtkDepthPeelingPass::GetTranslucentPass ( )

virtual

Delegate for rendering the translucent polygonal geometry.

If it is NULL, nothing will be rendered and a warning will be emitted. It is usually set to a vtkTranslucentPass. Initial value is a NULL pointer.

virtual void vtkDepthPeelingPass::SetTranslucentPass ( vtkRenderPass * translucentPass )

virtual

Delegate for rendering the translucent polygonal geometry.

If it is NULL, nothing will be rendered and a warning will be emitted. It is usually set to a vtkTranslucentPass. Initial value is a NULL pointer.

virtual void vtkDepthPeelingPass::SetOcclusionRatio ( double )

virtual

In case of use of depth peeling technique for rendering translucent material, define the threshold under which the algorithm stops to iterate over peel layers.

This is the ratio of the number of pixels that have been touched by the last layer over the total number of pixels of the viewport area. Initial value is 0.0, meaning rendering have to be exact. Greater values may speed-up the rendering with small impact on the quality.

virtual double vtkDepthPeelingPass::GetOcclusionRatio ( )

virtual

In case of use of depth peeling technique for rendering translucent material, define the threshold under which the algorithm stops to iterate over peel layers.

This is the ratio of the number of pixels that have been touched by the last layer over the total number of pixels of the viewport area. Initial value is 0.0, meaning rendering have to be exact. Greater values may speed-up the rendering with small impact on the quality.

virtual void vtkDepthPeelingPass::SetMaximumNumberOfPeels ( int )

virtual

In case of depth peeling, define the maximum number of peeling layers.

Initial value is 4. A special value of 0 means no maximum limit. It has to be a positive value.

virtual int vtkDepthPeelingPass::GetMaximumNumberOfPeels ( )

virtual

In case of depth peeling, define the maximum number of peeling layers.

Initial value is 4. A special value of 0 means no maximum limit. It has to be a positive value.

bool vtkDepthPeelingPass::PostReplaceShaderValues	(	std::string &	vertexShader,
		std::string &	geometryShader,
		std::string &	fragmentShader,
		vtkAbstractMapper *	mapper,
		vtkProp *	prop
	)

overridevirtual

Use vtkShaderProgram::Substitute to replace //VTK::XXX:YYY declarations in the shader sources.

Gets called after other mapper shader replacements. Return false on error.

Reimplemented from vtkOpenGLRenderPass.

Reimplemented in vtkDualDepthPeelingPass.

bool vtkDepthPeelingPass::SetShaderParameters	(	vtkShaderProgram *	program,
		vtkAbstractMapper *	mapper,
		vtkProp *	prop,
		vtkOpenGLVertexArrayObject *	VAO = `nullptr`
	)

overridevirtual

Update the uniforms of the shader program.

Return false on error.

Reimplemented from vtkOpenGLRenderPass.

Reimplemented in vtkDualDepthPeelingPass.

void vtkDepthPeelingPass::SetOpaqueZTexture ( vtkTextureObject * )

void vtkDepthPeelingPass::SetOpaqueRGBATexture ( vtkTextureObject * )

virtual void vtkDepthPeelingPass::SetDepthFormat ( int )

virtual

Set the format to use for the depth texture e.g.

vtkTextureObject::Float32

void vtkDepthPeelingPass::BlendIntermediatePeels	(	vtkOpenGLRenderWindow *	renWin,
		bool
	)

protected

void vtkDepthPeelingPass::BlendFinalPeel ( vtkOpenGLRenderWindow * renWin )

protected

Member Data Documentation

vtkRenderPass* vtkDepthPeelingPass::TranslucentPass

protected

Definition at line 155 of file vtkDepthPeelingPass.h.

vtkTimeStamp vtkDepthPeelingPass::CheckTime

protected

Definition at line 156 of file vtkDepthPeelingPass.h.

int vtkDepthPeelingPass::ViewportX

protected

Cache viewport values for depth peeling.

Definition at line 162 of file vtkDepthPeelingPass.h.

int vtkDepthPeelingPass::ViewportY

protected

Cache viewport values for depth peeling.

Definition at line 163 of file vtkDepthPeelingPass.h.

int vtkDepthPeelingPass::ViewportWidth

protected

Cache viewport values for depth peeling.

Definition at line 164 of file vtkDepthPeelingPass.h.

int vtkDepthPeelingPass::ViewportHeight

protected

Cache viewport values for depth peeling.

Definition at line 165 of file vtkDepthPeelingPass.h.

double vtkDepthPeelingPass::OcclusionRatio

protected

In case of use of depth peeling technique for rendering translucent material, define the threshold under which the algorithm stops to iterate over peel layers.

This is the ratio of the number of pixels that have been touched by the last layer over the total number of pixels of the viewport area. Initial value is 0.0, meaning rendering have to be exact. Greater values may speed-up the rendering with small impact on the quality.

Definition at line 177 of file vtkDepthPeelingPass.h.

int vtkDepthPeelingPass::MaximumNumberOfPeels

protected

In case of depth peeling, define the maximum number of peeling layers.

Initial value is 4. A special value of 0 means no maximum limit. It has to be a positive value.

Definition at line 184 of file vtkDepthPeelingPass.h.

vtkOpenGLFramebufferObject* vtkDepthPeelingPass::Framebuffer

protected

Definition at line 186 of file vtkDepthPeelingPass.h.

vtkOpenGLQuadHelper* vtkDepthPeelingPass::FinalBlend

protected

Definition at line 188 of file vtkDepthPeelingPass.h.

vtkOpenGLQuadHelper* vtkDepthPeelingPass::IntermediateBlend

protected

Definition at line 189 of file vtkDepthPeelingPass.h.

vtkTextureObject* vtkDepthPeelingPass::OpaqueZTexture

protected

Definition at line 192 of file vtkDepthPeelingPass.h.

vtkTextureObject* vtkDepthPeelingPass::OpaqueRGBATexture

protected

Definition at line 193 of file vtkDepthPeelingPass.h.

bool vtkDepthPeelingPass::OwnOpaqueZTexture

protected

Definition at line 194 of file vtkDepthPeelingPass.h.

bool vtkDepthPeelingPass::OwnOpaqueRGBATexture

protected

Definition at line 195 of file vtkDepthPeelingPass.h.

vtkTextureObject* vtkDepthPeelingPass::TranslucentRGBATexture[3]

protected

Definition at line 198 of file vtkDepthPeelingPass.h.

int vtkDepthPeelingPass::ColorDrawCount

protected

Definition at line 199 of file vtkDepthPeelingPass.h.

int vtkDepthPeelingPass::PeelCount

protected

Definition at line 200 of file vtkDepthPeelingPass.h.

vtkTextureObject* vtkDepthPeelingPass::TranslucentZTexture[2]

protected

Definition at line 203 of file vtkDepthPeelingPass.h.

int vtkDepthPeelingPass::DepthFormat

protected

Definition at line 204 of file vtkDepthPeelingPass.h.

vtkOpenGLState* vtkDepthPeelingPass::State

protected

Definition at line 210 of file vtkDepthPeelingPass.h.

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

/home/demarle/Source/VTK/release/8.2/build/Utilities/Doxygen/dox/Rendering/OpenGL2/vtkDepthPeelingPass.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation