VTK  9.3.0
vtkOpenGLGPUVolumeRayCastMapper.h
Go to the documentation of this file.
1 // SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
2 // SPDX-License-Identifier: BSD-3-Clause
61 #ifndef vtkOpenGLGPUVolumeRayCastMapper_h
62 #define vtkOpenGLGPUVolumeRayCastMapper_h
63 #include <map> // For methods
64 
66 #include "vtkNew.h" // For vtkNew
67 #include "vtkRenderingVolumeOpenGL2Module.h" // For export macro
68 #include "vtkShader.h" // For methods
69 #include "vtkSmartPointer.h" // For smartptr
70 
71 VTK_ABI_NAMESPACE_BEGIN
74 class vtkOpenGLCamera;
75 class vtkOpenGLTransferFunctions2D;
76 class vtkOpenGLVolumeGradientOpacityTables;
77 class vtkOpenGLVolumeOpacityTables;
78 class vtkOpenGLVolumeRGBTables;
79 class vtkShaderProgram;
80 class vtkTextureObject;
81 class vtkVolume;
83 class vtkVolumeTexture;
85 
86 class VTKRENDERINGVOLUMEOPENGL2_EXPORT vtkOpenGLGPUVolumeRayCastMapper
88 {
89 public:
91 
92  enum Passes
93  {
95  DepthPass = 1
96  };
97 
99  void PrintSelf(ostream& os, vtkIndent indent) override;
100 
101  // Description:
102  // Low level API to enable access to depth texture in
103  // RenderToTexture mode. It will return either nullptr if
104  // RenderToImage was never turned on or texture captured
105  // the last time RenderToImage was on.
107 
108  // Description:
109  // Low level API to enable access to color texture in
110  // RenderToTexture mode. It will return either nullptr if
111  // RenderToImage was never turned on or texture captured
112  // the last time RenderToImage was on.
114 
115  // Description:
116  // Low level API to export the depth texture as vtkImageData in
117  // RenderToImage mode.
118  void GetDepthImage(vtkImageData* im) override;
119 
120  // Description:
121  // Low level API to export the color texture as vtkImageData in
122  // RenderToImage mode.
123  void GetColorImage(vtkImageData* im) override;
124 
125  // Description:
126  // Mapper can have multiple passes and internally it will set
127  // the state. The state can not be set externally explicitly
128  // but can be set indirectly depending on the options set by
129  // the user.
130  vtkGetMacro(CurrentPass, int);
131 
132  // Sets a depth texture for this mapper to use
133  // This allows many mappers to use the same
134  // texture reducing GPU usage. If this is set
135  // the standard depth texture code is skipped
136  // The depth texture should be activated
137  // and deactivated outside of this class
139 
145  void SetPartitions(unsigned short x, unsigned short y, unsigned short z);
146 
156 
157  // Description:
158  // Delete OpenGL objects.
159  // \post done: this->OpenGLObjectsCreated==0
160  void ReleaseGraphicsResources(vtkWindow* window) override;
161 
162 protected:
165 
167 
168  // Description:
169  // Build vertex and fragment shader for the volume rendering
171  vtkRenderer* ren, vtkVolume* vol, int noOfComponents, int independentComponents);
172 
173  // Description:
174  // Build vertex and fragment shader for the volume rendering
176 
177  // TODO Take these out as these are no longer needed
178  // Methods called by the AMR Volume Mapper.
179  void PreRender(vtkRenderer* vtkNotUsed(ren), vtkVolume* vtkNotUsed(vol),
180  double vtkNotUsed(datasetBounds)[6], double vtkNotUsed(scalarRange)[2],
181  int vtkNotUsed(noOfComponents), unsigned int vtkNotUsed(numberOfLevels)) override
182  {
183  }
184 
185  // \pre input is up-to-date
186  void RenderBlock(vtkRenderer* vtkNotUsed(ren), vtkVolume* vtkNotUsed(vol),
187  unsigned int vtkNotUsed(level)) override
188  {
189  }
190 
191  void PostRender(vtkRenderer* vtkNotUsed(ren), int vtkNotUsed(noOfComponents)) override {}
192 
193  // Description:
194  // Rendering volume on GPU
195  void GPURender(vtkRenderer* ren, vtkVolume* vol) override;
196 
197  // Description:
198  // Method that performs the actual rendering given a volume and a shader
199  void DoGPURender(vtkRenderer* ren, vtkOpenGLCamera* cam, vtkShaderProgram* shaderProgram,
200  vtkOpenGLShaderProperty* shaderProperty);
201 
202  // Description:
203  // Update the reduction factor of the render viewport (this->ReductionFactor)
204  // according to the time spent in seconds to render the previous frame
205  // (this->TimeToDraw) and a time in seconds allocated to render the next
206  // frame (allocatedTime).
207  // \pre valid_current_reduction_range: this->ReductionFactor>0.0 && this->ReductionFactor<=1.0
208  // \pre positive_TimeToDraw: this->TimeToDraw>=0.0
209  // \pre positive_time: allocatedTime>0
210  // \post valid_new_reduction_range: this->ReductionFactor>0.0 && this->ReductionFactor<=1.0
211  void ComputeReductionFactor(double allocatedTime);
212 
213  // Description:
214  // Returns a reduction ratio for each dimension
215  // This ratio is computed from MaxMemoryInBytes and MaxMemoryFraction so that the total
216  // memory usage of the resampled image, by the returned ratio, does not exceed
217  // `MaxMemoryInBytes * MaxMemoryFraction`
218  // \pre input is up-to-date
219  // \post Aspect ratio of image is always kept
220  // - for a 1D image `ratio[1] == ratio[2] == 1`
221  // - for a 2D image `ratio[0] == ratio[1]` and `ratio[2] == 1`
222  // - for a 3D image `ratio[0] == ratio[1] == ratio[2]`
223  void GetReductionRatio(double* ratio) override;
224 
225  // Description:
226  // Empty implementation.
228  vtkRenderWindow* vtkNotUsed(window), vtkVolumeProperty* vtkNotUsed(property)) override
229  {
230  return 1;
231  }
232 
234 
238 
243  std::map<vtkShader::Type, vtkShader*>& shaders, vtkOpenGLShaderProperty* p);
244 
249  std::map<vtkShader::Type, vtkShader*>& shaders, vtkRenderer* ren, vtkVolume* vol, int numComps);
250 
256  std::map<vtkShader::Type, vtkShader*>& shaders, vtkOpenGLShaderProperty* p);
258  std::map<vtkShader::Type, vtkShader*>& shaders, vtkRenderer* ren, vtkVolume* vol, int numComps);
260  std::map<vtkShader::Type, vtkShader*>& shaders, vtkRenderer* ren, vtkVolume* vol, int numComps);
262  std::map<vtkShader::Type, vtkShader*>& shaders, vtkRenderer* ren, vtkVolume* vol, int numComps);
264  std::map<vtkShader::Type, vtkShader*>& shaders, vtkRenderer* ren, vtkVolume* vol, int numComps);
266  std::map<vtkShader::Type, vtkShader*>& shaders, vtkRenderer* ren, vtkVolume* vol, int numComps);
268  std::map<vtkShader::Type, vtkShader*>& shaders, vtkRenderer* ren, vtkVolume* vol, int numComps);
270  std::map<vtkShader::Type, vtkShader*>& shaders, vtkRenderer* ren, vtkVolume* vol, int numComps);
272  std::map<vtkShader::Type, vtkShader*>& shaders, vtkRenderer* ren, vtkVolume* vol, int numComps);
274  std::map<vtkShader::Type, vtkShader*>& shaders, vtkRenderer* ren, vtkVolume* vol, int numComps);
276  std::map<vtkShader::Type, vtkShader*>& shaders, vtkVolume* vol, bool prePass);
277 
282 
290 
293 
294 public:
296  using VolumeInputMap = std::map<int, vtkVolumeInputHelper>;
298 
299 private:
300  class vtkInternal;
301  vtkInternal* Impl;
302 
303  friend class vtkVolumeTexture;
304 
306  void operator=(const vtkOpenGLGPUVolumeRayCastMapper&) = delete;
307 };
308 
309 VTK_ABI_NAMESPACE_END
310 #endif // vtkOpenGLGPUVolumeRayCastMapper_h
Ray casting performed on the GPU.
topologically and geometrically regular array of data
Definition: vtkImageData.h:43
abstract interface for implicit functions
a simple class to control print indentation
Definition: vtkIndent.h:29
OpenGL camera.
OpenGL implementation of volume rendering through ray-casting.
void GetColorImage(vtkImageData *im) override
Low level API to export the color texture as vtkImageData in RenderToImage mode.
vtkTextureObject * GetDepthTexture()
void ReplaceShaderRTT(std::map< vtkShader::Type, vtkShader * > &shaders, vtkRenderer *ren, vtkVolume *vol, int numComps)
Caches the vtkOpenGLRenderPass::RenderPasses() information.
void SetShaderParametersRenderPass()
Update parameters from RenderPass.
void PreRender(vtkRenderer *vtkNotUsed(ren), vtkVolume *vtkNotUsed(vol), double vtkNotUsed(datasetBounds)[6], double vtkNotUsed(scalarRange)[2], int vtkNotUsed(noOfComponents), unsigned int vtkNotUsed(numberOfLevels)) override
void ReplaceShaderCustomUniforms(std::map< vtkShader::Type, vtkShader * > &shaders, vtkOpenGLShaderProperty *p)
RenderPass string replacements on shader templates called from ReplaceShaderValues.
void GetShaderTemplate(std::map< vtkShader::Type, vtkShader * > &shaders, vtkOpenGLShaderProperty *p)
Create the basic shader template strings before substitutions.
void GetDepthImage(vtkImageData *im) override
Low level API to export the depth texture as vtkImageData in RenderToImage mode.
static vtkOpenGLGPUVolumeRayCastMapper * New()
void BuildShader(vtkRenderer *ren)
void ReplaceShaderCropping(std::map< vtkShader::Type, vtkShader * > &shaders, vtkRenderer *ren, vtkVolume *vol, int numComps)
Caches the vtkOpenGLRenderPass::RenderPasses() information.
void ReplaceShaderRenderPass(std::map< vtkShader::Type, vtkShader * > &shaders, vtkVolume *vol, bool prePass)
Caches the vtkOpenGLRenderPass::RenderPasses() information.
vtkTextureObject * GetColorTexture()
void DoGPURender(vtkRenderer *ren, vtkOpenGLCamera *cam, vtkShaderProgram *shaderProgram, vtkOpenGLShaderProperty *shaderProperty)
std::map< int, vtkVolumeInputHelper > VolumeInputMap
bool PreLoadData(vtkRenderer *ren, vtkVolume *vol)
Load the volume texture into GPU memory.
void ReplaceShaderTermination(std::map< vtkShader::Type, vtkShader * > &shaders, vtkRenderer *ren, vtkVolume *vol, int numComps)
Caches the vtkOpenGLRenderPass::RenderPasses() information.
void RenderBlock(vtkRenderer *vtkNotUsed(ren), vtkVolume *vtkNotUsed(vol), unsigned int vtkNotUsed(level)) override
void PostRender(vtkRenderer *vtkNotUsed(ren), int vtkNotUsed(noOfComponents)) override
void SetSharedDepthTexture(vtkTextureObject *nt)
void ComputeReductionFactor(double allocatedTime)
void ReplaceShaderPicking(std::map< vtkShader::Type, vtkShader * > &shaders, vtkRenderer *ren, vtkVolume *vol, int numComps)
Caches the vtkOpenGLRenderPass::RenderPasses() information.
void ReplaceShaderBase(std::map< vtkShader::Type, vtkShader * > &shaders, vtkRenderer *ren, vtkVolume *vol, int numComps)
Caches the vtkOpenGLRenderPass::RenderPasses() information.
void GetReductionRatio(double *ratio) override
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
void ReplaceShaderClipping(std::map< vtkShader::Type, vtkShader * > &shaders, vtkRenderer *ren, vtkVolume *vol, int numComps)
Caches the vtkOpenGLRenderPass::RenderPasses() information.
vtkMTimeType GetRenderPassStageMTime(vtkVolume *vol)
vtkOpenGLRenderPass API
void ReplaceShaderCompute(std::map< vtkShader::Type, vtkShader * > &shaders, vtkRenderer *ren, vtkVolume *vol, int numComps)
Caches the vtkOpenGLRenderPass::RenderPasses() information.
void ReplaceShaderMasking(std::map< vtkShader::Type, vtkShader * > &shaders, vtkRenderer *ren, vtkVolume *vol, int numComps)
Caches the vtkOpenGLRenderPass::RenderPasses() information.
void BuildDepthPassShader(vtkRenderer *ren, vtkVolume *vol, int noOfComponents, int independentComponents)
vtkGenericOpenGLResourceFreeCallback * ResourceCallback
void SetPartitions(unsigned short x, unsigned short y, unsigned short z)
Set a fixed number of partitions in which to split the volume during rendering.
vtkNew< vtkInformation > LastRenderPassInfo
Caches the vtkOpenGLRenderPass::RenderPasses() information.
void GPURender(vtkRenderer *ren, vtkVolume *vol) override
Handled in the subclass - the actual render method.
void ReplaceShaderValues(std::map< vtkShader::Type, vtkShader * > &shaders, vtkRenderer *ren, vtkVolume *vol, int numComps)
Perform string replacements on the shader templates.
void ReleaseGraphicsResources(vtkWindow *window) override
Release any graphics resources that are being consumed by this mapper.
void ReplaceShaderShading(std::map< vtkShader::Type, vtkShader * > &shaders, vtkRenderer *ren, vtkVolume *vol, int numComps)
Caches the vtkOpenGLRenderPass::RenderPasses() information.
int IsRenderSupported(vtkRenderWindow *vtkNotUsed(window), vtkVolumeProperty *vtkNotUsed(property)) override
Based on hardware and properties, we may or may not be able to render using 3D texture mapping.
represent GPU shader properties
create a window for renderers to draw into
abstract specification for renderers
Definition: vtkRenderer.h:62
The ShaderProgram uses one or more Shader objects.
abstracts an OpenGL texture object.
Convenience container for internal structures specific to a volume input.
represents the common properties for rendering a volume.
Creates and manages the volume texture rendered by vtkOpenGLGPUVolumeRayCastMapper.
represents a volume (data & properties) in a rendered scene
Definition: vtkVolume.h:40
window superclass for vtkRenderWindow
Definition: vtkWindow.h:28
@ level
Definition: vtkX3D.h:395
vtkTypeUInt32 vtkMTimeType
Definition: vtkType.h:270