vtkOpenGLRenderer.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause
#ifndef vtkOpenGLRenderer_h
#define vtkOpenGLRenderer_h

#include "vtkRenderer.h"

#include "vtkOpenGLQuadHelper.h"       // for ivar
#include "vtkPBRIrradianceTexture.h"   // for ivar
#include "vtkPBRLUTTexture.h"          // for ivar
#include "vtkPBRPrefilterTexture.h"    // for ivar
#include "vtkRenderingOpenGL2Module.h" // For export macro
#include "vtkSmartPointer.h"           // For vtkSmartPointer
#include "vtkWrappingHints.h"          // For VTK_MARSHALAUTO
#include <string>                      // Ivars

VTK_ABI_NAMESPACE_BEGIN
class vtkFloatArray;
class vtkOpenGLFXAAFilter;
class vtkRenderPass;
class vtkOpenGLState;
class vtkOpenGLTexture;
class vtkOrderIndependentTranslucentPass;
class vtkTextureObject;
class vtkDepthPeelingPass;
class vtkShaderProgram;
class vtkShadowMapPass;
class vtkSSAOPass;
class vtkPolyData;
class vtkTexturedActor2D;
class vtkPolyDataMapper2D;
class vtkOverrideAttribute;
class vtkCameraPass;
class vtkHexagonalBokehBlurPass;

class VTKRENDERINGOPENGL2_EXPORT VTK_MARSHALAUTO vtkOpenGLRenderer : public vtkRenderer
{
public:
  static vtkOpenGLRenderer* New();
  VTK_NEWINSTANCE
  static vtkOverrideAttribute* CreateOverrideAttributes();
  vtkTypeMacro(vtkOpenGLRenderer, vtkRenderer);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  void DeviceRender() override;

  void DeviceRenderOpaqueGeometry(vtkFrameBufferObjectBase* fbo = nullptr) override;

  void DeviceRenderTranslucentPolygonalGeometry(vtkFrameBufferObjectBase* fbo = nullptr) override;

  void Clear() override;

  int UpdateLights() override;

  int GetDepthPeelingHigherLayer();

  static bool HaveAppleQueryAllocationBug();

  bool IsDualDepthPeelingSupported();

  // Get the state object used to keep track of
  // OpenGL state
  vtkOpenGLState* GetState();

  // get the standard lighting uniform declarations
  // for the current set of lights
  const char* GetLightingUniforms();

  // update the lighting uniforms for this shader if they
  // are out of date
  void UpdateLightingUniforms(vtkShaderProgram* prog);

  // get the complexity of the current lights as a int
  // 0 = no lighting
  // 1 = headlight
  // 2 = directional lights
  // 3 = positional lights
  enum LightingComplexityEnum
  {
    NoLighting = 0,
    Headlight = 1,
    Directional = 2,
    Positional = 3
  };
  vtkGetMacro(LightingComplexity, int);

  // get the number of lights turned on
  vtkGetMacro(LightingCount, int);


  void SetUserLightTransform(vtkTransform* transform);
  vtkTransform* GetUserLightTransform();


  vtkSetSmartPointerMacro(EnvMapLookupTable, vtkPBRLUTTexture);
  vtkPBRLUTTexture* GetEnvMapLookupTable();
  vtkSetSmartPointerMacro(EnvMapIrradiance, vtkPBRIrradianceTexture);
  vtkPBRIrradianceTexture* GetEnvMapIrradiance();
  vtkSetSmartPointerMacro(EnvMapPrefiltered, vtkPBRPrefilterTexture);
  vtkPBRPrefilterTexture* GetEnvMapPrefiltered();

  vtkFloatArray* GetSphericalHarmonics();


  vtkSetMacro(UseSphericalHarmonics, bool);
  vtkGetMacro(UseSphericalHarmonics, bool);
  vtkBooleanMacro(UseSphericalHarmonics, bool);

  void SetEnvironmentTexture(vtkTexture* texture, bool isSRGB = false) override;

  // Method to release graphics resources
  void ReleaseGraphicsResources(vtkWindow* w) override;

protected:
  vtkOpenGLRenderer();
  ~vtkOpenGLRenderer() override;

  void CheckCompilation(unsigned int fragmentShader);

  int UpdateGeometry(vtkFrameBufferObjectBase* fbo = nullptr) override;

  vtkTexture* GetCurrentTexturedBackground();

  friend class vtkOpenGLProperty;
  friend class vtkOpenGLTexture;
  friend class vtkOpenGLImageSliceMapper;
  friend class vtkOpenGLImageResliceMapper;

  vtkOpenGLFXAAFilter* FXAAFilter;

  vtkDepthPeelingPass* DepthPeelingPass;

  vtkOrderIndependentTranslucentPass* TranslucentPass;

  vtkShadowMapPass* ShadowMapPass;

  vtkSSAOPass* SSAOPass;

  // Is rendering at translucent geometry stage using depth peeling and
  // rendering a layer other than the first one? (Boolean value)
  // If so, the uniform variables UseTexture and Texture can be set.
  // (Used by vtkOpenGLProperty or vtkOpenGLTexture)
  int DepthPeelingHigherLayer;

  friend class vtkRenderPass;

  std::string LightingDeclaration;
  int LightingComplexity;
  int LightingCount;
  vtkMTimeType LightingUpdateTime;

  vtkSmartPointer<vtkTransform> UserLightTransform;

  vtkSmartPointer<vtkPBRLUTTexture> EnvMapLookupTable;
  vtkSmartPointer<vtkPBRIrradianceTexture> EnvMapIrradiance;
  vtkSmartPointer<vtkPBRPrefilterTexture> EnvMapPrefiltered;
  vtkSmartPointer<vtkFloatArray> SphericalHarmonics;
  bool UseSphericalHarmonics;

  vtkSmartPointer<vtkTexturedActor2D> BackgroundTextureActor;
  vtkSmartPointer<vtkTexturedActor2D> BackgroundGradientActor;
  vtkSmartPointer<vtkPolyDataMapper2D> BackgroundMapper;
  vtkSmartPointer<vtkPolyData> BackgroundQuad;

private:
  vtkOpenGLRenderer(const vtkOpenGLRenderer&) = delete;
  void operator=(const vtkOpenGLRenderer&) = delete;

  vtkSmartPointer<vtkHexagonalBokehBlurPass> BackgroundPass;
};

#define vtkOpenGLRenderer_OVERRIDE_ATTRIBUTES vtkOpenGLRenderer::CreateOverrideAttributes()
VTK_ABI_NAMESPACE_END
#endif