vtkWebGPUCellToPrimitiveConverter.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 vtkWebGPUCellToPrimitiveConverter_h
#define vtkWebGPUCellToPrimitiveConverter_h

#include "vtkObject.h"

#include "vtkDeprecation.h"           // for VTK_DEPRECATED_IN_9_7_0
#include "vtkProperty.h"              // for VTK_SURFACE
#include "vtkRenderingWebGPUModule.h" // for export macro
#include "vtkSmartPointer.h"          // for vtkSmartPointer
#include "vtkTimeStamp.h"             // for vtkTimeStamp

#include "vtk_wgpu.h" // for wgpu::Buffer

#include <array>   // for std::array
#include <utility> // for std::pair

VTK_ABI_NAMESPACE_BEGIN
class vtkWebGPUConfiguration;
class vtkPolyData;
class vtkCellArray;
class vtkDataArray;
class vtkWebGPUComputePass;
class vtkWebGPUComputePipeline;

class VTKRENDERINGWEBGPU_EXPORT vtkWebGPUCellToPrimitiveConverter : public vtkObject
{
public:
  static vtkWebGPUCellToPrimitiveConverter* New();
  vtkTypeMacro(vtkWebGPUCellToPrimitiveConverter, vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  void ReleaseGraphicsResources(vtkWindow*);

  enum TopologySourceType : int
  {
    // Used to draw VTK_VERTEX and VTK_POLY_VERTEX cell types
    TOPOLOGY_SOURCE_VERTS = 0,
    // Used to draw VTK_LINE and VTK_POLY_LINE cell types.
    TOPOLOGY_SOURCE_LINES,
    // Used to draw only the points of each line segment.
    // Activated when `vtkProperty::Representation` == `VTK_POINTS`
    TOPOLOGY_SOURCE_LINE_POINTS,
    // Used to draw VTK_QUAD, VTK_TRIANGLE and VTK_POLYGON cell types.
    TOPOLOGY_SOURCE_POLYGONS,
    // Used to draw only the corner points of each face.
    // Activated when `vtkProperty::Representation` == `VTK_POINTS`
    TOPOLOGY_SOURCE_POLYGON_POINTS,
    // Used to draw only the edges of each face.
    // Activated when `vtkProperty::Representation` == `VTK_WIREFRAME`
    TOPOLOGY_SOURCE_POLYGON_EDGES,
    NUM_TOPOLOGY_SOURCE_TYPES
  };


  VTK_DEPRECATED_IN_9_7_0("Use DispatchMeshToPrimitiveComputePipeline() that accepts const "
                          "std::array<T*, N> parameters instead.")
  bool DispatchMeshToPrimitiveComputePipeline(vtkWebGPUConfiguration* wgpuConfiguration,
    vtkPolyData* mesh, int representation, vtkTypeUInt32* vertexCounts[NUM_TOPOLOGY_SOURCE_TYPES],
    wgpu::Buffer* connectivityBuffers[NUM_TOPOLOGY_SOURCE_TYPES],
    wgpu::Buffer* cellIdBuffers[NUM_TOPOLOGY_SOURCE_TYPES],
    wgpu::Buffer* edgeArrayBuffers[NUM_TOPOLOGY_SOURCE_TYPES],
    wgpu::Buffer* cellIdOffsetUniformBuffers[NUM_TOPOLOGY_SOURCE_TYPES]);
  bool DispatchMeshToPrimitiveComputePipeline(vtkWebGPUConfiguration* wgpuConfiguration,
    vtkPolyData* mesh, int representation,
    const std::array<vtkTypeUInt32*, NUM_TOPOLOGY_SOURCE_TYPES>& vertexCounts,
    const std::array<wgpu::Buffer*, NUM_TOPOLOGY_SOURCE_TYPES>& connectivityBuffers,
    const std::array<wgpu::Buffer*, NUM_TOPOLOGY_SOURCE_TYPES>& cellIdBuffers,
    const std::array<wgpu::Buffer*, NUM_TOPOLOGY_SOURCE_TYPES>& edgeArrayBuffers,
    const std::array<wgpu::Buffer*, NUM_TOPOLOGY_SOURCE_TYPES>& cellIdOffsetUniformBuffers);

  bool DispatchMeshesToPrimitiveComputePipeline(vtkWebGPUConfiguration* wgpuConfiguration,
    std::vector<vtkPolyData*> meshes, int representation,
    std::vector<std::pair<vtkTypeUInt32, vtkTypeUInt32>>*
      vertexOffsetAndCounts[NUM_TOPOLOGY_SOURCE_TYPES],
    std::array<wgpu::Buffer*, NUM_TOPOLOGY_SOURCE_TYPES>& connectivityBuffers,
    std::array<wgpu::Buffer*, NUM_TOPOLOGY_SOURCE_TYPES>& cellIdBuffers,
    std::array<wgpu::Buffer*, NUM_TOPOLOGY_SOURCE_TYPES>& edgeArrayBuffers);

  VTK_DEPRECATED_IN_9_7_0("Use DispatchCellArrayToPrimitiveComputePipeline() instead.")
  bool DispatchCellToPrimitiveComputePipeline(vtkWebGPUConfiguration* wgpuConfiguration,
    vtkCellArray* cells, int representation, int cellType, vtkTypeUInt32 cellIdOffset,
    vtkTypeUInt32* vertexCount, wgpu::Buffer* connectivityBuffer, wgpu::Buffer* cellIdBuffer,
    wgpu::Buffer* edgeArrayBuffer, wgpu::Buffer* cellIdOffsetUniformBuffer);

  bool DispatchCellArrayToPrimitiveComputePipeline(vtkWebGPUConfiguration* wgpuConfiguration,
    vtkCellArray* cells, int representation, int cellType, vtkTypeUInt32 cellIdOffset,
    vtkTypeUInt32* vertexCount, wgpu::Buffer* connectivityBuffer, wgpu::Buffer* cellIdBuffer,
    wgpu::Buffer* edgeArrayBuffer, wgpu::Buffer* cellIdOffsetUniformBuffer,
    vtkDataArray* pointCoordinates = nullptr);

  bool DispatchCellArraysToPrimitiveComputePipeline(vtkWebGPUConfiguration* wgpuConfiguration,
    const std::vector<vtkCellArray*>& cellArrays, int representation, int cellType,
    const std::vector<vtkIdType>& numberOfPoints,
    std::vector<std::pair<vtkTypeUInt32, vtkTypeUInt32>>* vertexOffsetAndCounts,
    wgpu::Buffer* connectivityBuffer, wgpu::Buffer* cellIdBuffer, wgpu::Buffer* edgeArrayBuffer,
    const std::vector<vtkDataArray*>& pointCoordinates = {});

  bool GetNeedToRebuildCellToPrimitiveComputePipeline(
    vtkCellArray* cells, vtkWebGPUCellToPrimitiveConverter::TopologySourceType topologySourceType);

  void UpdateCellToPrimitiveComputePipelineTimestamp(
    vtkWebGPUCellToPrimitiveConverter::TopologySourceType topologySourceType);

  static vtkIdType GetTessellatedPrimitiveSizeOffsetForCellType(int cellType);

  static const char* GetTopologySourceTypeAsString(TopologySourceType topologySourceType);

  static const char* GetCellTypeAsString(int cellType);

  static const char* GetTessellatedPrimitiveTypeAsString(TopologySourceType topologySourceType);

  static std::size_t GetTessellatedPrimitiveSize(TopologySourceType topologySourceType);

  static TopologySourceType GetTopologySourceTypeForCellType(
    int cellType, int representation = VTK_SURFACE);

protected:
  vtkWebGPUCellToPrimitiveConverter();
  ~vtkWebGPUCellToPrimitiveConverter() override;

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

  std::pair<vtkSmartPointer<vtkWebGPUComputePass>, vtkSmartPointer<vtkWebGPUComputePipeline>>
  CreateCellToPrimitiveComputePassForCellType(
    vtkSmartPointer<vtkWebGPUConfiguration> wgpuConfiguration,
    TopologySourceType topologySourceType);

  // Timestamps help reuse previous resources as much as possible.
  vtkTimeStamp TopologyBuildTimestamp[vtkWebGPUCellToPrimitiveConverter::NUM_TOPOLOGY_SOURCE_TYPES];
  // compute pass speeds up cell to primitive conversions.
  vtkSmartPointer<vtkWebGPUComputePass>
    ComputePasses[vtkWebGPUCellToPrimitiveConverter::NUM_TOPOLOGY_SOURCE_TYPES];
  // compute pipeline to execute the compute pass.
  vtkSmartPointer<vtkWebGPUComputePipeline>
    ComputePipelines[vtkWebGPUCellToPrimitiveConverter::NUM_TOPOLOGY_SOURCE_TYPES];
};

VTK_ABI_NAMESPACE_END

#endif