vtkWebGPUPolyDataMapper.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 vtkWebGPUPolyDataMapper_h
#define vtkWebGPUPolyDataMapper_h
 
#include "vtkPolyDataMapper.h"
 
#include "vtkRenderingWebGPUModule.h" // for export macro
#include "vtkType.h"                  // for types
#include "vtk_wgpu.h"                 // for webgpu
 
#include <unordered_set> // for the not set compute render buffers
 
VTK_ABI_NAMESPACE_BEGIN
class vtkCellArray;
class vtkTypeFloat32Array;
class vtkWebGPURenderWindow;
class vtkWebGPURenderer;
class vtkWebGPUComputeRenderBuffer;
 
class VTKRENDERINGWEBGPU_EXPORT vtkWebGPUPolyDataMapper : public vtkPolyDataMapper
{
public:
  static vtkWebGPUPolyDataMapper* New();
  vtkTypeMacro(vtkWebGPUPolyDataMapper, vtkPolyDataMapper);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  enum PointDataAttributes : int
  {
    POINT_POSITIONS = 0,
    POINT_COLORS,
    POINT_NORMALS,
    POINT_TANGENTS,
    POINT_UVS,
    POINT_NB_ATTRIBUTES,
    POINT_UNDEFINED
  };

  enum CellDataAttributes : int
  {
    CELL_COLORS = 0,
    CELL_NORMALS,
    CELL_EDGES,
    CELL_NB_ATTRIBUTES,
    CELL_UNDEFINED
  };

  void RenderPiece(vtkRenderer* ren, vtkActor* act) override;
  void EncodeRenderCommands(
    vtkRenderer* renderer, vtkActor* act, const wgpu::RenderPassEncoder& passEncoder);
  void EncodeRenderCommands(
    vtkRenderer* renderer, vtkActor* act, const wgpu::RenderBundleEncoder& bundleEncoder);

  void ReleaseGraphicsResources(vtkWindow*) override;

  bool GetSupportsSelection() override { return false; }

  void ShallowCopy(vtkAbstractMapper* m) override;

  void MapDataArrayToVertexAttribute(const char* vertexAttributeName, const char* dataArrayName,
    int fieldAssociation, int componentno = -1) override;
 
  // This method will Map the specified data array for use as
  // a texture coordinate for texture tname. The actual
  // attribute will be named tname_coord so as to not
  // conflict with the texture sampler definition which will
  // be tname.
  void MapDataArrayToMultiTextureAttribute(const char* tname, const char* dataArrayName,
    int fieldAssociation, int componentno = -1) override;

  void RemoveVertexAttributeMapping(const char* vertexAttributeName) override;

  void RemoveAllVertexAttributeMappings() override;

  void ProcessSelectorPixelBuffers(
    vtkHardwareSelector* sel, std::vector<unsigned int>& pixeloffsets, vtkProp* prop) override;

  vtkSmartPointer<vtkWebGPUComputeRenderBuffer> AcquirePointAttributeComputeRenderBuffer(
    PointDataAttributes attribute, int bufferGroup, int bufferBinding, int uniformsGroup,
    int uniformsBinding);

  vtkSmartPointer<vtkWebGPUComputeRenderBuffer> AcquireCellAttributeComputeRenderBuffer(
    CellDataAttributes attribute, int bufferGroup, int bufferBinding, int uniformsGroup,
    int uniformsBinding);
 
protected:
  vtkWebGPUPolyDataMapper();
  ~vtkWebGPUPolyDataMapper() override;

  void ComputeBounds() override;

  void SetupPipelineLayout(const wgpu::Device& device, vtkRenderer* renderer, vtkActor* actor);

  void SetupBindGroups(const wgpu::Device& device, vtkRenderer* renderer);

  unsigned long GetPointAttributeByteSize(vtkWebGPUPolyDataMapper::PointDataAttributes attribute);

  unsigned long GetCellAttributeByteSize(vtkWebGPUPolyDataMapper::CellDataAttributes attribute);

  unsigned long GetPointAttributeElementSize(
    vtkWebGPUPolyDataMapper::PointDataAttributes attribute);

  unsigned long GetCellAttributeElementSize(vtkWebGPUPolyDataMapper::CellDataAttributes attribute);

  vtkIdType GetPointAttributeByteOffset(PointDataAttributes attribute);

  vtkIdType GetCellAttributeByteOffset(CellDataAttributes attribute);

  unsigned long GetExactPointBufferSize();
  unsigned long GetExactCellBufferSize();
  std::vector<unsigned long> GetExactConnecitivityBufferSizes();
  bool UpdateMeshGeometryBuffers(
    vtkWebGPURenderWindow* wgpuRenWin, const wgpu::Device& device, vtkActor* actor);
  bool UpdateMeshIndexBuffers(const wgpu::Device& device);
  vtkTypeFloat32Array* ComputeEdgeArray(vtkCellArray* polys);

  void SetupGraphicsPipeline(const wgpu::Device& device, vtkRenderer* renderer, vtkActor* actor);
 
  wgpu::PipelineLayout PipelineLayout;
  wgpu::ShaderModule Shader;
 
  struct MeshAttributeBuffers
  {
    struct
    {
      // point attributes.
      wgpu::Buffer Buffer;
    } Point;
 
    struct
    {
      // cell attributes.
      wgpu::Buffer Buffer;
    } Cell;
  };
  MeshAttributeBuffers MeshSSBO;
 
  struct AttributeDescriptor
  {
    vtkTypeUInt32 Start = 0;
    vtkTypeUInt32 NumTuples = 0;
    vtkTypeUInt32 NumComponents = 0;
    vtkTypeUInt32 Pad = 0; // for 16-byte alignment in MeshAttributeDescriptor
  };
  struct MeshAttributeDescriptor
  {
    AttributeDescriptor Positions;
    AttributeDescriptor Colors;
    AttributeDescriptor Normals;
    AttributeDescriptor Tangents;
    AttributeDescriptor UVs;
    AttributeDescriptor CellColors;
    AttributeDescriptor CellNormals;
    AttributeDescriptor CellEdgeArray;
  };
  wgpu::Buffer AttributeDescriptorBuffer;
 
  vtkTimeStamp PointCellAttributesBuildTimestamp;
  vtkTimeStamp Primitive2CellIDsBuildTimestamp;
 
  bool InitializedPipeline = false;
  bool UpdatedPrimitiveSizes = false;
  bool UpdatedGeometryBuffers = false;
  bool UpdatedPrimitiveBuffers = false;
  bool HasPointColors = false;
  bool HasPointNormals = false;
  bool HasPointTangents = false;
  bool HasPointUVs = false;
  bool HasCellColors = false;
  bool HasCellNormals = false;
  // used by RenderPiece and functions it calls to reduce
  // calls to get the input and allow for rendering of
  // other polydata (not the input)
  vtkPolyData* CurrentInput = nullptr;
  // vtkRenderer culls props to frustum. At that point, it requests
  // mappers for bounds of the geometry. We cache the vtkAlgorithm output
  // so that `UpdateMeshGeometryBuffers` can reuse it without climbing up
  // vtkAlgorithm pipeline.
  vtkPolyData* CachedInput = nullptr;
 
  // 1 bind group for this polydata mesh
  wgpu::BindGroup MeshAttributeBindGroup;
  // 1 bind group layout for the above bindgroup
  wgpu::BindGroupLayout MeshAttributeBindGroupLayout;
 
  struct PrimitiveBindGroupInfo
  {
    // 1 uniform buffer for the primitive size.
    wgpu::Buffer PrimitiveSizeBuffer;
    // 1 buffer for the primitive cell ids and point ids.
    wgpu::Buffer Buffer;
    // 1 bind group for the primitive size uniform.
    wgpu::BindGroup BindGroup;
    // each primitive-type gets a pipeline.
    wgpu::RenderPipeline Pipeline;
    // vertexCount for draw call.
    vtkTypeUInt32 VertexCount = 0;
  };
  // 1 bind group layout for the above bindgroups.
  wgpu::BindGroupLayout PrimitiveBindGroupLayout;
 
  PrimitiveBindGroupInfo PointPrimitiveBGInfo;
  PrimitiveBindGroupInfo LinePrimitiveBGInfo;
  PrimitiveBindGroupInfo TrianglePrimitiveBGInfo;
  unsigned long EdgeArrayCount = 0;
 
  // Cache these so that subsequent arrivals to UpdateMeshGeometry do not unnecessarily invoke
  // MapScalars().
  int LastScalarMode;
  bool LastScalarVisibility;
  vtkDataArray* LastColors = nullptr;
 
private:
  friend class vtkWebGPUComputeRenderBuffer;
  friend class vtkWebGPURenderer;

  wgpu::Buffer GetPointDataWGPUBuffer() { return this->MeshSSBO.Point.Buffer; }

  wgpu::Buffer GetCellDataWGPUBuffer() { return this->MeshSSBO.Cell.Buffer; }

  std::vector<vtkSmartPointer<vtkWebGPUComputeRenderBuffer>> SetupComputeRenderBuffers;

  std::unordered_set<vtkSmartPointer<vtkWebGPUComputeRenderBuffer>> NotSetupComputeRenderBuffers;

  const PointDataAttributes PointDataAttributesOrder[PointDataAttributes::POINT_NB_ATTRIBUTES] = {
    PointDataAttributes::POINT_POSITIONS, PointDataAttributes::POINT_COLORS,
    PointDataAttributes::POINT_NORMALS, PointDataAttributes::POINT_TANGENTS,
    PointDataAttributes::POINT_UVS
  };

  const CellDataAttributes CellDataAttributesOrder[CellDataAttributes::CELL_NB_ATTRIBUTES] = {
    CellDataAttributes::CELL_EDGES, CellDataAttributes::CELL_COLORS,
    CellDataAttributes::CELL_NORMALS
  };
 
  vtkWebGPUPolyDataMapper(const vtkWebGPUPolyDataMapper&) = delete;
  void operator=(const vtkWebGPUPolyDataMapper&) = delete;
};
VTK_ABI_NAMESPACE_END
#endif