Implement an Order Independent Transparency render pass. More...

#include <vtkDepthPeelingPass.h>

Inheritance diagram for vtkDepthPeelingPass:

Collaboration diagram for vtkDepthPeelingPass:

Public Types
typedef vtkRenderPass	Superclass

typedef vtkOpenGLRenderPass	Superclass

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

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

vtkDepthPeelingPass *	NewInstance () 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 bool	ReplaceShaderValues (std::string &vertexShader, std::string &geometryShader, std::string &fragmentShader, vtkAbstractMapper mapper, vtkProp prop)
	Is rendering at translucent geometry stage using depth peeling and rendering a layer other than the first one? (Boolean value) If so, the uniform variables UseTexture and Texture can be set. More...

virtual bool	SetShaderParameters (vtkShaderProgram program, vtkAbstractMapper mapper, vtkProp *prop)
	Update the uniforms of the shader program. 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...


virtual bool	GetLastRenderingUsedDepthPeeling ()
	Tells if the last time this pass was executed, the depth peeling algorithm was actually used. 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

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

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 ()

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

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

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

static int	IsTypeOf (const char *type)

static vtkDepthPeelingPass *	SafeDownCast (vtkObjectBase *o)

static vtkDepthPeelingPass *	New ()

static int	IsTypeOf (const char *type)

static vtkDepthPeelingPass *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkOpenGLRenderPass
static int	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 int	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 ()
	Is rendering at translucent geometry stage using depth peeling and rendering a layer other than the first one? (Boolean value) If so, the uniform variables UseTexture and Texture can be set. More...

virtual	~vtkDepthPeelingPass ()
	Destructor. More...

void	CheckSupport (vtkOpenGLRenderWindow *w)
	Check if depth peeling is supported by the current OpenGL context. More...

void	CheckCompilation (unsigned int fragmentShader)
	Check the compilation status of some fragment shader source. More...

int	RenderPeel (const vtkRenderState *s, int layer)
	Render a peel layer. More...

virtual vtkObjectBase *	NewInstanceInternal () const

	vtkDepthPeelingPass ()
	Default constructor. More...

virtual	~vtkDepthPeelingPass ()
	Destructor. More...

void	BlendIntermediatePeels (vtkOpenGLRenderWindow *renWin, bool)

void	BlendFinalPeel (vtkOpenGLRenderWindow *renWin)

Protected Member Functions inherited from vtkOpenGLRenderPass
	vtkOpenGLRenderPass ()

	~vtkOpenGLRenderPass ()

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

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
vtkRenderPass *	TranslucentPass

vtkTimeStamp	CheckTime

bool	IsChecked

bool	IsSupported

unsigned int	DepthFormat
	Actual depth format: vtkgl::DEPTH_COMPONENT16_ARB or vtkgl::DEPTH_COMPONENT24_ARB. More...

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

bool	LastRenderingUsedDepthPeeling

vtkDepthPeelingPassLayerList *	LayerList
	Used by the depth peeling technique to store the transparency layers. More...

unsigned int	OpaqueLayerZ

unsigned int	TransparentLayerZ

int	DepthPeelingHigherLayer

vtkShaderProgram2 *	Prog

vtkShader2 *	Shader

int	ShadowTexUnit

int	OpaqueShadowTexUnit

vtkOpenGLHelper *	FinalBlendProgram

vtkOpenGLHelper *	IntermediateBlendProgram

vtkTextureObject *	OpaqueZTexture

vtkTextureObject *	OpaqueRGBATexture

vtkTextureObject *	TranslucentRGBATexture

vtkTextureObject *	TranslucentZTexture

vtkTextureObject *	CurrentRGBATexture

std::vector< float > *	DepthZData


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 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 an Order Independent Transparency render pass.

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.

See also: vtkRenderPass, vtkTranslucentPass

Note that this implementation is only 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.

See also: vtkRenderPass, vtkTranslucentPass

Tests:: vtkDepthPeelingPass (Tests)

Definition at line 50 of file vtkDepthPeelingPass.h.

Member Typedef Documentation

typedef vtkRenderPass vtkDepthPeelingPass::Superclass

Definition at line 54 of file vtkDepthPeelingPass.h.

typedef vtkOpenGLRenderPass vtkDepthPeelingPass::Superclass

Definition at line 63 of file vtkDepthPeelingPass.h.

Constructor & Destructor Documentation

vtkDepthPeelingPass::vtkDepthPeelingPass ( )

protected

Is rendering at translucent geometry stage using depth peeling and rendering a layer other than the first one? (Boolean value) If so, the uniform variables UseTexture and Texture can be set.

(Used by vtkOpenGLProperty or vtkOpenGLTexture) int GetDepthPeelingHigherLayer(); Default constructor. TranslucentPass is set to NULL.

virtual vtkDepthPeelingPass::~vtkDepthPeelingPass ( )

protectedvirtual

Destructor.

vtkDepthPeelingPass::vtkDepthPeelingPass ( )

protected

Default constructor.

TranslucentPass is set to NULL.

virtual vtkDepthPeelingPass::~vtkDepthPeelingPass ( )

protectedvirtual

Destructor.

Member Function Documentation

static vtkDepthPeelingPass* vtkDepthPeelingPass::New ( )

static

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

static

virtual int 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 vtkRenderPass.

Reimplemented in vtkDualDepthPeelingPass.

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

static

virtual vtkObjectBase* vtkDepthPeelingPass::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkRenderPass.

Reimplemented in vtkDualDepthPeelingPass.

vtkDepthPeelingPass* vtkDepthPeelingPass::NewInstance ( ) const

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

Reimplemented in vtkDualDepthPeelingPass.

virtual void vtkDepthPeelingPass::Render ( const vtkRenderState * s )

virtual

Perform rendering according to a render state s.

Precondition: s_exists: s!=0

Implements vtkRenderPass.

Reimplemented in vtkDualDepthPeelingPass.

void vtkDepthPeelingPass::ReleaseGraphicsResources ( vtkWindow * w )

virtual

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.

virtual bool vtkDepthPeelingPass::GetLastRenderingUsedDepthPeeling ( )

virtual

Tells if the last time this pass was executed, the depth peeling algorithm was actually used.

Initial value is false.

void vtkDepthPeelingPass::CheckSupport ( vtkOpenGLRenderWindow * w )

protected

Check if depth peeling is supported by the current OpenGL context.

Precondition: w_exists: w!=0

void vtkDepthPeelingPass::CheckCompilation ( unsigned int fragmentShader )

protected

Check the compilation status of some fragment shader source.

int vtkDepthPeelingPass::RenderPeel	(	const vtkRenderState *	s,
		int	layer
	)

protected

Render a peel layer.

If there is no more GPU RAM to save the texture, return false otherwise returns true. Also if layer==0 and no prop have been rendered (there is no translucent geometry), it returns false.

Precondition: s_exists: s!=0; positive_layer: layer>=0

static vtkDepthPeelingPass* vtkDepthPeelingPass::New ( )

static

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

static

virtual int 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 vtkRenderPass.

Reimplemented in vtkDualDepthPeelingPass.

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

static

virtual vtkObjectBase* vtkDepthPeelingPass::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkRenderPass.

Reimplemented in vtkDualDepthPeelingPass.

vtkDepthPeelingPass* vtkDepthPeelingPass::NewInstance ( ) const

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

Reimplemented in vtkDualDepthPeelingPass.

virtual void vtkDepthPeelingPass::Render ( const vtkRenderState * s )

virtual

Perform rendering according to a render state s.

Precondition: s_exists: s!=0

Implements vtkRenderPass.

Reimplemented in vtkDualDepthPeelingPass.

void vtkDepthPeelingPass::ReleaseGraphicsResources ( vtkWindow * w )

virtual

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.

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

virtual

Is rendering at translucent geometry stage using depth peeling and rendering a layer other than the first one? (Boolean value) If so, the uniform variables UseTexture and Texture can be set.

(Used by vtkOpenGLProperty or vtkOpenGLTexture) int GetDepthPeelingHigherLayer();

Reimplemented from vtkOpenGLRenderPass.

Reimplemented in vtkDualDepthPeelingPass.

virtual bool vtkDepthPeelingPass::SetShaderParameters	(	vtkShaderProgram *	program,
		vtkAbstractMapper *	mapper,
		vtkProp *	prop
	)

virtual

Update the uniforms of the shader program.

Return false on error.

Reimplemented from vtkOpenGLRenderPass.

Reimplemented in vtkDualDepthPeelingPass.

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

protected

void vtkDepthPeelingPass::BlendFinalPeel ( vtkOpenGLRenderWindow * renWin )

protected

Member Data Documentation

vtkRenderPass * vtkDepthPeelingPass::TranslucentPass

protected

Definition at line 153 of file vtkDepthPeelingPass.h.

vtkTimeStamp vtkDepthPeelingPass::CheckTime

protected

Definition at line 154 of file vtkDepthPeelingPass.h.

bool vtkDepthPeelingPass::IsChecked

protected

Definition at line 155 of file vtkDepthPeelingPass.h.

bool vtkDepthPeelingPass::IsSupported

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.

unsigned int vtkDepthPeelingPass::DepthFormat

protected

Actual depth format: vtkgl::DEPTH_COMPONENT16_ARB or vtkgl::DEPTH_COMPONENT24_ARB.

Definition at line 172 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 183 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 190 of file vtkDepthPeelingPass.h.

bool vtkDepthPeelingPass::LastRenderingUsedDepthPeeling

protected

Definition at line 192 of file vtkDepthPeelingPass.h.

vtkDepthPeelingPassLayerList* vtkDepthPeelingPass::LayerList

protected

Used by the depth peeling technique to store the transparency layers.

Definition at line 197 of file vtkDepthPeelingPass.h.

unsigned int vtkDepthPeelingPass::OpaqueLayerZ

protected

Definition at line 199 of file vtkDepthPeelingPass.h.

unsigned int vtkDepthPeelingPass::TransparentLayerZ

protected

Definition at line 200 of file vtkDepthPeelingPass.h.

int vtkDepthPeelingPass::DepthPeelingHigherLayer

protected

Definition at line 207 of file vtkDepthPeelingPass.h.

vtkShaderProgram2* vtkDepthPeelingPass::Prog

protected

Definition at line 209 of file vtkDepthPeelingPass.h.

vtkShader2* vtkDepthPeelingPass::Shader

protected

Definition at line 210 of file vtkDepthPeelingPass.h.

int vtkDepthPeelingPass::ShadowTexUnit

protected

Definition at line 212 of file vtkDepthPeelingPass.h.

int vtkDepthPeelingPass::OpaqueShadowTexUnit

protected

Definition at line 213 of file vtkDepthPeelingPass.h.

vtkOpenGLHelper* vtkDepthPeelingPass::FinalBlendProgram

protected

Definition at line 180 of file vtkDepthPeelingPass.h.

vtkOpenGLHelper* vtkDepthPeelingPass::IntermediateBlendProgram

protected

Definition at line 181 of file vtkDepthPeelingPass.h.

vtkTextureObject* vtkDepthPeelingPass::OpaqueZTexture

protected

Definition at line 183 of file vtkDepthPeelingPass.h.

vtkTextureObject* vtkDepthPeelingPass::OpaqueRGBATexture

protected

Definition at line 184 of file vtkDepthPeelingPass.h.

vtkTextureObject* vtkDepthPeelingPass::TranslucentRGBATexture

protected

Definition at line 185 of file vtkDepthPeelingPass.h.

vtkTextureObject* vtkDepthPeelingPass::TranslucentZTexture

protected

Definition at line 186 of file vtkDepthPeelingPass.h.

vtkTextureObject* vtkDepthPeelingPass::CurrentRGBATexture

protected

Definition at line 187 of file vtkDepthPeelingPass.h.

std::vector<float>* vtkDepthPeelingPass::DepthZData

protected

Definition at line 188 of file vtkDepthPeelingPass.h.

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

/home/demarle/Builds/VTK/release/Utilities/Doxygen/dox/Rendering/OpenGL/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