VTK  9.2.6
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 =========================================================================*/
53 #ifndef vtkDepthPeelingPass_h
54 #define vtkDepthPeelingPass_h
55 
56 #include "vtkOpenGLRenderPass.h"
57 #include "vtkRenderingOpenGL2Module.h" // For export macro
58 #include <vector> // STL Header
59 
61 class vtkTextureObject;
63 class vtkOpenGLState;
65 
66 class VTKRENDERINGOPENGL2_EXPORT vtkDepthPeelingPass : public vtkOpenGLRenderPass
67 {
68 public:
69  static vtkDepthPeelingPass* New();
71  void PrintSelf(ostream& os, vtkIndent indent) override;
72 
77  void Render(const vtkRenderState* s) override;
78 
84  void ReleaseGraphicsResources(vtkWindow* w) override;
85 
87 
93  vtkGetObjectMacro(TranslucentPass, vtkRenderPass);
94  virtual void SetTranslucentPass(vtkRenderPass* translucentPass);
96 
98 
107  vtkSetClampMacro(OcclusionRatio, double, 0.0, 0.5);
108  vtkGetMacro(OcclusionRatio, double);
110 
112 
117  vtkSetMacro(MaximumNumberOfPeels, int);
118  vtkGetMacro(MaximumNumberOfPeels, int);
120 
121  // vtkOpenGLRenderPass virtuals:
122  bool PostReplaceShaderValues(std::string& vertexShader, std::string& geometryShader,
123  std::string& fragmentShader, vtkAbstractMapper* mapper, vtkProp* prop) override;
124  bool SetShaderParameters(vtkShaderProgram* program, vtkAbstractMapper* mapper, vtkProp* prop,
125  vtkOpenGLVertexArrayObject* VAO = nullptr) override;
126 
127  // Set Opaque Z texture, this must be set from the outer FO
128  void SetOpaqueZTexture(vtkTextureObject*);
129 
130  // Set Opaque RGBA texture, this must be set from the outer FO
131  void SetOpaqueRGBATexture(vtkTextureObject*);
132 
137  vtkSetMacro(DepthFormat, int);
138 
139 protected:
144 
148  ~vtkDepthPeelingPass() override;
149 
152 
154 
162 
173 
180 
182 
185 
186  // obtained from the outer FO, we read from them
191 
192  // each peel merges two color buffers into one result
193  vtkTextureObject* TranslucentRGBATexture[3];
196 
197  // each peel compares a prior Z and writes to next
198  vtkTextureObject* TranslucentZTexture[2];
200 
201  void BlendIntermediatePeels(vtkOpenGLRenderWindow* renWin, bool);
202  void BlendFinalPeel(vtkOpenGLRenderWindow* renWin);
203 
204  // useful to store
206 
207 private:
208  vtkDepthPeelingPass(const vtkDepthPeelingPass&) = delete;
209  void operator=(const vtkDepthPeelingPass&) = delete;
210 };
211 
212 #endif
OpenGL rendering window.
abstract superclass for all actors, volumes and annotations
Definition: vtkProp.h:56
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:35
int ViewportX
Cache viewport values for depth peeling.
window superclass for vtkRenderWindow
Definition: vtkWindow.h:38
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:39
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:59
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.
The ShaderProgram uses one or more Shader objects.