VTK  9.0.1
vtkDepthPeelingPass.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkDepthPeelingPass.h
5 
6  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7  All rights reserved.
8  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
9 
10  This software is distributed WITHOUT ANY WARRANTY; without even
11  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12  PURPOSE. See the above copyright notice for more information.
13 
14 =========================================================================*/
50 #ifndef vtkDepthPeelingPass_h
51 #define vtkDepthPeelingPass_h
52 
53 #include "vtkOpenGLRenderPass.h"
54 #include "vtkRenderingOpenGL2Module.h" // For export macro
55 #include <vector> // STL Header
56 
58 class vtkTextureObject;
60 class vtkOpenGLState;
62 
63 class VTKRENDERINGOPENGL2_EXPORT vtkDepthPeelingPass : public vtkOpenGLRenderPass
64 {
65 public:
66  static vtkDepthPeelingPass* New();
68  void PrintSelf(ostream& os, vtkIndent indent) override;
69 
74  void Render(const vtkRenderState* s) override;
75 
81  void ReleaseGraphicsResources(vtkWindow* w) override;
82 
84 
90  vtkGetObjectMacro(TranslucentPass, vtkRenderPass);
91  virtual void SetTranslucentPass(vtkRenderPass* translucentPass);
93 
95 
104  vtkSetClampMacro(OcclusionRatio, double, 0.0, 0.5);
105  vtkGetMacro(OcclusionRatio, double);
107 
109 
114  vtkSetMacro(MaximumNumberOfPeels, int);
115  vtkGetMacro(MaximumNumberOfPeels, int);
117 
118  // vtkOpenGLRenderPass virtuals:
119  bool PostReplaceShaderValues(std::string& vertexShader, std::string& geometryShader,
120  std::string& fragmentShader, vtkAbstractMapper* mapper, vtkProp* prop) override;
121  bool SetShaderParameters(vtkShaderProgram* program, vtkAbstractMapper* mapper, vtkProp* prop,
122  vtkOpenGLVertexArrayObject* VAO = nullptr) override;
123 
124  // Set Opaque Z texture, this must be set from the outer FO
125  void SetOpaqueZTexture(vtkTextureObject*);
126 
127  // Set Opaque RGBA texture, this must be set from the outer FO
128  void SetOpaqueRGBATexture(vtkTextureObject*);
129 
134  vtkSetMacro(DepthFormat, int);
135 
136 protected:
141 
145  ~vtkDepthPeelingPass() override;
146 
149 
151 
159 
170 
177 
179 
182 
183  // obtained from the outer FO, we read from them
188 
189  // each peel merges two color buffers into one result
190  vtkTextureObject* TranslucentRGBATexture[3];
193 
194  // each peel compares a prior Z and writes to next
195  vtkTextureObject* TranslucentZTexture[2];
197 
198  void BlendIntermediatePeels(vtkOpenGLRenderWindow* renWin, bool);
199  void BlendFinalPeel(vtkOpenGLRenderWindow* renWin);
200 
201  // useful to store
203 
204 private:
205  vtkDepthPeelingPass(const vtkDepthPeelingPass&) = delete;
206  void operator=(const vtkDepthPeelingPass&) = delete;
207 };
208 
209 #endif
OpenGL rendering window.
abstract superclass for all actors, volumes and annotations
Definition: vtkProp.h:53
Implement Depth Peeling for use within a framebuffer pass.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
int ViewportHeight
Cache viewport values for depth peeling.
vtkOpenGLQuadHelper * FinalBlend
record modification and/or execution time
Definition: vtkTimeStamp.h:32
int ViewportX
Cache viewport values for depth peeling.
window superclass for vtkRenderWindow
Definition: vtkWindow.h:37
double OcclusionRatio
In case of use of depth peeling technique for rendering translucent material, define the threshold un...
Context in which a vtkRenderPass will render.
vtkTextureObject * OpaqueZTexture
OpenGL state storage.
vtkOpenGLFramebufferObject * Framebuffer
vtkOpenGLQuadHelper * IntermediateBlend
a simple class to control print indentation
Definition: vtkIndent.h:33
The VertexArrayObject class uses, or emulates, vertex array objects.
int ViewportWidth
Cache viewport values for depth peeling.
Internal class which encapsulates OpenGL FramebufferObject.
abstract class specifies interface to map data
abstracts an OpenGL texture object.
int MaximumNumberOfPeels
In case of depth peeling, define the maximum number of peeling layers.
virtual void Render(const vtkRenderState *s)=0
Perform rendering according to a render state s.
vtkTextureObject * OpaqueRGBATexture
Class to make rendering a full screen quad easier.
virtual void ReleaseGraphicsResources(vtkWindow *w)
Release graphics resources and ask components to release their own resources.
int ViewportY
Cache viewport values for depth peeling.
vtkRenderPass * TranslucentPass
static vtkObject * New()
Create an object with Debug turned off, modified time initialized to zero, and reference counting on...
Perform part of the rendering of a vtkRenderer.
Definition: vtkRenderPass.h:56
virtual bool SetShaderParameters(vtkShaderProgram *program, vtkAbstractMapper *mapper, vtkProp *prop, vtkOpenGLVertexArrayObject *VAO=nullptr)
Update the uniforms of the shader program.
vtkOpenGLState * State
Abstract render pass with shader modifications.
virtual bool PostReplaceShaderValues(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...
The ShaderProgram uses one or more Shader objects.