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=========================================================================*/
132#ifndef vtkOpenGLRenderer_h
133#define vtkOpenGLRenderer_h
134
135#include "vtkDeprecation.h" // for VTK_DEPRECATED_IN_9_0_0
136#include "vtkRenderer.h"
137#include "vtkRenderingOpenGL2Module.h" // For export macro
138#include "vtkSmartPointer.h" // For vtkSmartPointer
139#include <string> // Ivars
140#include <vector> // STL Header
141
142class vtkFloatArray;
144class vtkRenderPass;
145class vtkOpenGLState;
146class vtkOpenGLTexture;
148class vtkTextureObject;
151class vtkPBRLUTTexture;
153class vtkShaderProgram;
154class vtkShadowMapPass;
155class vtkSSAOPass;
156
157class VTKRENDERINGOPENGL2_EXPORT vtkOpenGLRenderer : public vtkRenderer
158{
159public:
162 void PrintSelf(ostream& os, vtkIndent indent) override;
163
167 void DeviceRender(void) override;
168
173
181
182 void Clear(void) override;
183
187 int UpdateLights(void) override;
188
196
204 "Removed in 9.1.0 as this bug does not affect any macOS release that VTK supports")
205 bool HaveApplePrimitiveIdBug();
206
211 static bool HaveAppleQueryAllocationBug();
212
218 bool IsDualDepthPeelingSupported();
219
220 // Get the state object used to keep track of
221 // OpenGL state
222 vtkOpenGLState* GetState();
223
224 // get the standard lighting uniform declarations
225 // for the current set of lights
226 const char* GetLightingUniforms();
227
228 // update the lighting uniforms for this shader if they
229 // are out of date
230 void UpdateLightingUniforms(vtkShaderProgram* prog);
231
232 // get the complexity of the current lights as a int
233 // 0 = no lighting
234 // 1 = headlight
235 // 2 = directional lights
236 // 3 = positional lights
238 {
239 NoLighting = 0,
240 Headlight = 1,
241 Directional = 2,
242 Positional = 3
243 };
244 vtkGetMacro(LightingComplexity, int);
245
246 // get the number of lights turned on
247 vtkGetMacro(LightingCount, int);
248
250
257
259
266
271
273
276 vtkSetMacro(UseSphericalHarmonics, bool);
277 vtkGetMacro(UseSphericalHarmonics, bool);
278 vtkBooleanMacro(UseSphericalHarmonics, bool);
280
284 void SetEnvironmentTexture(vtkTexture* texture, bool isSRGB = false) override;
285
286 // Method to release graphics resources
288
289protected:
292
296 void CheckCompilation(unsigned int fragmentShader);
297
303 int UpdateGeometry(vtkFrameBufferObjectBase* fbo = nullptr) override;
304
311
312 friend class vtkOpenGLProperty;
313 friend class vtkOpenGLTexture;
315 friend class vtkOpenGLImageResliceMapper;
316
321
326
331
336
341
342 // Is rendering at translucent geometry stage using depth peeling and
343 // rendering a layer other than the first one? (Boolean value)
344 // If so, the uniform variables UseTexture and Texture can be set.
345 // (Used by vtkOpenGLProperty or vtkOpenGLTexture)
347
348 friend class vtkRenderPass;
349
354
359
365
366private:
367 vtkOpenGLRenderer(const vtkOpenGLRenderer&) = delete;
368 void operator=(const vtkOpenGLRenderer&) = delete;
369};
370
371#endif
Implement Depth Peeling for use within a framebuffer pass.
dynamic, self-adjusting array of float
abstract interface to OpenGL FBOs
a simple class to control print indentation
Definition: vtkIndent.h:113
Perform FXAA antialiasing on the current framebuffer.
OpenGL mapper for image slice display.
OpenGL property.
OpenGL renderer.
vtkPBRPrefilterTexture * GetEnvMapPrefiltered()
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.
vtkSmartPointer< vtkFloatArray > SphericalHarmonics
vtkPBRLUTTexture * GetEnvMapLookupTable()
Get environment textures used for image based lighting.
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.
void Clear(void) override
Clear the image to the background color.
vtkSmartPointer< vtkTransform > UserLightTransform
Optional user transform for lights.
vtkTransform * GetUserLightTransform()
Set the user light transform applied after the camera transform.
void DeviceRenderTranslucentPolygonalGeometry(vtkFrameBufferObjectBase *fbo=nullptr) override
Render translucent polygonal geometry.
vtkTexture * GetCurrentTexturedBackground()
Check and return the textured background for the current state If monocular or stereo left eye,...
vtkOrderIndependentTranslucentPass * TranslucentPass
Fallback for transparency.
vtkMTimeType LightingUpdateTime
int UpdateLights(void) override
Ask lights to load themselves into graphics pipeline.
void DeviceRenderOpaqueGeometry(vtkFrameBufferObjectBase *fbo=nullptr) override
Overridden to support hidden line removal.
static vtkOpenGLRenderer * New()
vtkOpenGLFXAAFilter * FXAAFilter
FXAA is delegated to an instance of vtkOpenGLFXAAFilter.
void ReleaseGraphicsResources(vtkWindow *w) override
vtkPBRIrradianceTexture * GetEnvMapIrradiance()
Get environment textures used for image based lighting.
int UpdateGeometry(vtkFrameBufferObjectBase *fbo=nullptr) override
Ask all props to update and draw any opaque and translucent geometry.
void SetUserLightTransform(vtkTransform *transform)
Set the user light transform applied after the camera transform.
void DeviceRender(void) override
Concrete open gl render method.
vtkFloatArray * GetSphericalHarmonics()
Get spherical harmonics coefficients used for irradiance.
~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:182
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.
Hold a reference to a vtkObjectBase instance.
abstracts an OpenGL texture object.
handles properties associated with a texture map
Definition: vtkTexture.h:175
describes linear transformations via a 4x4 matrix
Definition: vtkTransform.h:164
window superclass for vtkRenderWindow
Definition: vtkWindow.h:39
#define VTK_DEPRECATED_IN_9_1_0(reason)
vtkTypeUInt32 vtkMTimeType
Definition: vtkType.h:287