VTK  9.1.0
vtkOpenGLRenderer.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkOpenGLRenderer.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 =========================================================================*/
23 #ifndef vtkOpenGLRenderer_h
24 #define vtkOpenGLRenderer_h
25 
26 #include "vtkDeprecation.h" // for VTK_DEPRECATED_IN_9_0_0
27 #include "vtkRenderer.h"
28 #include "vtkRenderingOpenGL2Module.h" // For export macro
29 #include "vtkSmartPointer.h" // For vtkSmartPointer
30 #include <string> // Ivars
31 #include <vector> // STL Header
32 
33 class vtkFloatArray;
35 class vtkRenderPass;
36 class vtkOpenGLState;
37 class vtkOpenGLTexture;
39 class vtkTextureObject;
42 class vtkPBRLUTTexture;
44 class vtkShaderProgram;
45 class vtkShadowMapPass;
46 class vtkSSAOPass;
47 
48 class VTKRENDERINGOPENGL2_EXPORT vtkOpenGLRenderer : public vtkRenderer
49 {
50 public:
53  void PrintSelf(ostream& os, vtkIndent indent) override;
54 
58  void DeviceRender(void) override;
59 
64 
72 
73  void Clear(void) override;
74 
78  int UpdateLights(void) override;
79 
87 
95  "Removed in 9.1.0 as this bug does not affect any macOS release that VTK supports")
96  bool HaveApplePrimitiveIdBug();
97 
102  static bool HaveAppleQueryAllocationBug();
103 
109  bool IsDualDepthPeelingSupported();
110 
111  // Get the state object used to keep track of
112  // OpenGL state
113  vtkOpenGLState* GetState();
114 
115  // get the standard lighting uniform declarations
116  // for the current set of lights
117  const char* GetLightingUniforms();
118 
119  // update the lighting uniforms for this shader if they
120  // are out of date
121  void UpdateLightingUniforms(vtkShaderProgram* prog);
122 
123  // get the complexity of the current lights as a int
124  // 0 = no lighting
125  // 1 = headlight
126  // 2 = directional lights
127  // 3 = positional lights
129  {
130  NoLighting = 0,
131  Headlight = 1,
132  Directional = 2,
133  Positional = 3
134  };
135  vtkGetMacro(LightingComplexity, int);
136 
137  // get the number of lights turned on
138  vtkGetMacro(LightingCount, int);
139 
141 
148 
150 
157 
162 
164 
167  vtkSetMacro(UseSphericalHarmonics, bool);
168  vtkGetMacro(UseSphericalHarmonics, bool);
169  vtkBooleanMacro(UseSphericalHarmonics, bool);
171 
175  void SetEnvironmentTexture(vtkTexture* texture, bool isSRGB = false) override;
176 
177  // Method to release graphics resources
179 
180 protected:
182  ~vtkOpenGLRenderer() override;
183 
187  void CheckCompilation(unsigned int fragmentShader);
188 
194  int UpdateGeometry(vtkFrameBufferObjectBase* fbo = nullptr) override;
195 
202 
203  friend class vtkOpenGLProperty;
204  friend class vtkOpenGLTexture;
206  friend class vtkOpenGLImageResliceMapper;
207 
212 
217 
222 
227 
232 
233  // Is rendering at translucent geometry stage using depth peeling and
234  // rendering a layer other than the first one? (Boolean value)
235  // If so, the uniform variables UseTexture and Texture can be set.
236  // (Used by vtkOpenGLProperty or vtkOpenGLTexture)
238 
239  friend class vtkRenderPass;
240 
245 
250 
256 
257 private:
258  vtkOpenGLRenderer(const vtkOpenGLRenderer&) = delete;
259  void operator=(const vtkOpenGLRenderer&) = delete;
260 };
261 
262 #endif
Implement Depth Peeling for use within a framebuffer pass.
dynamic, self-adjusting array of float
Definition: vtkFloatArray.h:36
abstract interface to OpenGL FBOs
a simple class to control print indentation
Definition: vtkIndent.h:34
Perform FXAA antialiasing on the current framebuffer.
OpenGL mapper for image slice display.
OpenGL property.
OpenGL renderer.
vtkPBRLUTTexture * GetEnvMapLookupTable()
Get environment textures used for image based lighting.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkPBRPrefilterTexture * EnvMapPrefiltered
void SetEnvironmentTexture(vtkTexture *texture, bool isSRGB=false) override
Overriden in order to connect the texture to the environment map textures.
vtkPBRIrradianceTexture * GetEnvMapIrradiance()
Get environment textures used for image based lighting.
vtkSmartPointer< vtkFloatArray > SphericalHarmonics
vtkShadowMapPass * ShadowMapPass
Shadows are delegated to an instance of vtkShadowMapPass.
vtkPBRIrradianceTexture * EnvMapIrradiance
std::string LightingDeclaration
vtkDepthPeelingPass * DepthPeelingPass
Depth peeling is delegated to an instance of vtkDepthPeelingPass.
vtkPBRLUTTexture * EnvMapLookupTable
vtkSSAOPass * SSAOPass
SSAO is delegated to an instance of vtkSSAOPass.
vtkTransform * GetUserLightTransform()
Set the user light transform applied after the camera transform.
void Clear(void) override
Clear the image to the background color.
vtkTexture * GetCurrentTexturedBackground()
Check and return the textured background for the current state If monocular or stereo left eye,...
vtkSmartPointer< vtkTransform > UserLightTransform
Optional user transform for lights.
void DeviceRenderTranslucentPolygonalGeometry(vtkFrameBufferObjectBase *fbo=nullptr) override
Render translucent polygonal geometry.
vtkOrderIndependentTranslucentPass * TranslucentPass
Fallback for transparency.
vtkMTimeType LightingUpdateTime
int UpdateLights(void) override
Ask lights to load themselves into graphics pipeline.
static vtkOpenGLRenderer * New()
void DeviceRenderOpaqueGeometry(vtkFrameBufferObjectBase *fbo=nullptr) override
Overridden to support hidden line removal.
vtkOpenGLFXAAFilter * FXAAFilter
FXAA is delegated to an instance of vtkOpenGLFXAAFilter.
void ReleaseGraphicsResources(vtkWindow *w) override
int UpdateGeometry(vtkFrameBufferObjectBase *fbo=nullptr) override
Ask all props to update and draw any opaque and translucent geometry.
vtkFloatArray * GetSphericalHarmonics()
Get spherical harmonics coefficients used for irradiance.
void SetUserLightTransform(vtkTransform *transform)
Set the user light transform applied after the camera transform.
vtkPBRPrefilterTexture * GetEnvMapPrefiltered()
Get environment textures used for image based lighting.
void DeviceRender(void) override
Concrete open gl render method.
~vtkOpenGLRenderer() override
void CheckCompilation(unsigned int fragmentShader)
Check the compilation status of some fragment shader source.
int GetDepthPeelingHigherLayer()
Is rendering at translucent geometry stage using depth peeling and rendering a layer other than the f...
OpenGL state storage.
OpenGL texture map.
Implement OIT rendering using average color.
precompute irradiance texture used in physically based rendering
precompute BRDF look-up table texture used in physically based rendering
precompute prefilter texture used in physically based rendering
Perform part of the rendering of a vtkRenderer.
Definition: vtkRenderPass.h:57
abstract specification for renderers
Definition: vtkRenderer.h:73
Implement a screen-space ambient occlusion pass.
Definition: vtkSSAOPass.h:43
The ShaderProgram uses one or more Shader objects.
Implement a shadow mapping render pass.
abstracts an OpenGL texture object.
handles properties associated with a texture map
Definition: vtkTexture.h:66
describes linear transformations via a 4x4 matrix
Definition: vtkTransform.h:55
window superclass for vtkRenderWindow
Definition: vtkWindow.h:39
@ string
Definition: vtkX3D.h:496
#define VTK_DEPRECATED_IN_9_1_0(reason)
vtkTypeUInt32 vtkMTimeType
Definition: vtkType.h:287