vtkWebGPUPointCloudMapperInternals.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 vtkWebGPUPointCloudMapperInternals_h
#define vtkWebGPUPointCloudMapperInternals_h

#include "vtkObject.h"
#include "vtkRenderingWebGPUModule.h"
#include "vtkSmartPointer.h"
#include "vtkWebGPUComputePointCloudMapper.h"
#include "vtk_wgpu.h"

class vtkPolyData;
class vtkRenderer;
class vtkWebGPUComputeBuffer;
class vtkWebGPUComputePass;
class vtkWebGPUComputePipeline;
class vtkWebGPUComputePointCloudMapper;
class vtkWebGPURenderWindow;

VTK_ABI_NAMESPACE_BEGIN

class VTKRENDERINGWEBGPU_NO_EXPORT vtkWebGPUPointCloudMapperInternals : public vtkObject
{
public:
  static vtkWebGPUPointCloudMapperInternals* New();
  vtkTypeMacro(vtkWebGPUPointCloudMapperInternals, vtkObject);

  void PrintSelf(ostream& os, vtkIndent indent) override;

  void SetMapper(vtkWebGPUComputePointCloudMapper* mapper);

  struct CopyDepthBufferRenderPipeline
  {
    wgpu::BindGroup BindGroup = nullptr;
    wgpu::RenderPipeline Pipeline = nullptr;
    wgpu::Buffer FramebufferWidthUniformBuffer = nullptr;
  };

protected:
  vtkWebGPUPointCloudMapperInternals();
  ~vtkWebGPUPointCloudMapperInternals() override;

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

  friend class vtkWebGPUComputePointCloudMapper;

  vtkWebGPURenderWindow* GetRendererRenderWindow(vtkRenderer* renderer);

  void Initialize(vtkRenderer* renderer);

  void UpdateRenderWindowDepthBuffer(vtkRenderer* renderer);

  void CreateCopyDepthBufferRenderPipeline(vtkWebGPURenderWindow* wgpuRenderWindow);

  void CopyDepthBufferToRenderWindow(vtkWebGPURenderWindow* wgpuRenderWindow);

  void Update(vtkRenderer* renderer);

  void UseRenderWindowDevice(vtkRenderer* renderer);

  void ResizeToRenderWindow(vtkRenderer* renderer);

  void InitializeDepthCopyPass(vtkRenderer* renderer);

  void InitializePointRenderPass(vtkRenderer* renderer);

  void UploadPointsToGPU();

  void UploadColorsToGPU();

  void UploadCameraVPMatrix(vtkRenderer* renderer);

  // Whether or not the compute pipeline has been initialized
  bool Initialized = false;

  // Compute pipeline for the point cloud rendering
  vtkSmartPointer<vtkWebGPUComputePipeline> ComputePipeline;

  // Compute pass that copies the depth buffer of the render window into the custom depth
  // buffer for rendering the points
  vtkSmartPointer<vtkWebGPUComputePass> CopyDepthPass;
  // Compute pass that renders the points to the framebuffer of the render window of the
  // WebGPURenderer
  vtkSmartPointer<vtkWebGPUComputePass> RenderPointsPass;

  // Custom depth buffer for the render of the points
  vtkSmartPointer<vtkWebGPUComputeBuffer> PointDepthBuffer;
  // Index of the buffer that contains the point data in the render point pass
  int PointBufferIndex = -1;
  // Index of the buffer that holds the colors of the points in float format in the point render
  // pass
  int PointColorBufferIndex = -1;

  // Custom depth buffer that contains the depth of the points after they've been rendered
  int PointDepthBufferIndex = -1;
  // Index of the view-projection matrix buffer in the render point pass
  int CameraVPBufferIndex = -1;
  // Index of the framebuffer in the render point pass
  int FrameBufferRenderTextureIndex = -1;

  // The renderer culling pass always calls GetBounds() on the mappers. We use this opportunity to
  // cache the polyData input so that we can reuse it later without having to call on the expensive
  // GetInput() function
  vtkPolyData* CachedInput = nullptr;
  // MTime of the last points we uploaded to the GPU
  vtkMTimeType LastPointsMTime = 0;
  // MTime of the last point data (for point colors) we uploaded to the GPU
  vtkMTimeType LastPointDataMTime = 0;

  // Contains the wgpu objects for refereing to the render pipeline that copies the point depth
  // buffer to the depth buffer of the render window
  CopyDepthBufferRenderPipeline CopyDepthBufferPipeline;

  // vtkWebGPUComputePointCloudMapper whose internals this instance is
  vtkWebGPUComputePointCloudMapper* ParentMapper = nullptr;
};
VTK_ABI_NAMESPACE_END

#endif
// VTK-HeaderTest-Exclude: vtkWebGPUBindGroupInternals.h