vtkWebGPUComputePassInternals.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 vtkWebGPUComputePassInternals_h
#define vtkWebGPUComputePassInternals_h

#include "Private/vtkWebGPUComputePassBufferStorageInternals.h"
#include "Private/vtkWebGPUComputePassTextureStorageInternals.h"
#include "vtkObject.h"
#include "vtkSmartPointer.h"
#include "vtkWebGPUConfiguration.h"
#include "vtk_wgpu.h" // for webgpu

#include <unordered_map>
#include <unordered_set>

class vtkWebGPUComputePipeline;

VTK_ABI_NAMESPACE_BEGIN

class VTKRENDERINGWEBGPU_EXPORT vtkWebGPUComputePassInternals : public vtkObject
{
public:
  static vtkWebGPUComputePassInternals* New();
  vtkTypeMacro(vtkWebGPUComputePassInternals, vtkObject);

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

  void SetParentPass(vtkWeakPointer<vtkWebGPUComputePass> parentPass);


  void SetWGPUConfiguration(vtkWebGPUConfiguration* config);
  vtkGetSmartPointerMacro(WGPUConfiguration, vtkWebGPUConfiguration);


  vtkWeakPointer<vtkWebGPUComputePipeline> GetAssociatedPipeline();
  void SetAssociatedPipeline(vtkWeakPointer<vtkWebGPUComputePipeline> associatedPipeline);

  wgpu::BindGroupLayoutEntry CreateBindGroupLayoutEntry(
    uint32_t binding, vtkWebGPUComputeBuffer::BufferMode mode);

  wgpu::BindGroupLayoutEntry CreateBindGroupLayoutEntry(uint32_t binding,
    vtkSmartPointer<vtkWebGPUComputeTexture> computeTexture,
    vtkSmartPointer<vtkWebGPUComputeTextureView> textureView);

  wgpu::BindGroupLayoutEntry CreateBindGroupLayoutEntry(uint32_t binding,
    vtkSmartPointer<vtkWebGPUComputeTexture> computeTexture,
    wgpu::TextureViewDimension textureViewDimension);

  wgpu::BindGroupEntry CreateBindGroupEntry(wgpu::Buffer buffer, uint32_t binding,
    vtkWebGPUComputeBuffer::BufferMode mode, uint32_t offset);

  wgpu::BindGroupEntry CreateBindGroupEntry(uint32_t binding, wgpu::TextureView textureView);

  void CreateShaderModule();

  void CreateBindGroupsAndLayouts();

  static wgpu::BindGroupLayout CreateBindGroupLayout(
    const wgpu::Device& device, const std::vector<wgpu::BindGroupLayoutEntry>& layoutEntries);

  std::vector<wgpu::BindGroupEntry> CreateBindGroupEntries(
    const std::vector<vtkWebGPUComputeBuffer*>& buffers);

  bool CheckBufferIndex(int bufferIndex, const std::string& callerFunctionName);

  bool CheckTextureIndex(int textureIndex, const std::string& callerFunctionName);

  bool CheckTextureViewIndex(int textureViewIndex, const std::string& callerFunctionName);

  bool CheckBufferCorrectness(vtkSmartPointer<vtkWebGPUComputeBuffer> buffer);

  void RecreateBufferBindGroup(int bufferIndex);

  void RegisterBufferToPipeline(
    vtkSmartPointer<vtkWebGPUComputeBuffer> buffer, wgpu::Buffer wgpuBuffer);


  bool GetRegisteredBufferFromPipeline(
    vtkSmartPointer<vtkWebGPUComputeBuffer> buffer, wgpu::Buffer& wgpuBuffer);

  bool GetRegisteredTextureFromPipeline(
    vtkSmartPointer<vtkWebGPUComputeTexture> texture, wgpu::Texture& wgpuTexture);

  wgpu::Buffer GetWGPUBuffer(std::size_t bufferIndex);

  void RegisterTextureToPipeline(
    vtkSmartPointer<vtkWebGPUComputeTexture> texture, wgpu::Texture wgpuTexture);

  void RecreateBuffer(int bufferIndex, vtkIdType newByteSize);

  void RecreateTexture(int textureIndex);

  void RecreateTextureViews(int textureIndex);

  wgpu::TextureView CreateWebGPUTextureView(
    vtkSmartPointer<vtkWebGPUComputeTextureView> textureView, wgpu::Texture wgpuTexture);

  void UpdateWebGPUBuffer(vtkSmartPointer<vtkWebGPUComputeBuffer> buffer, wgpu::Buffer wgpuBuffer);

  void UpdateComputeTextureAndViews(
    vtkSmartPointer<vtkWebGPUComputeTexture> texture, wgpu::Texture newWgpuTexture);

  void RecreateTextureBindGroup(int textureIndex);

  void SetupRenderBuffer(vtkSmartPointer<vtkWebGPUComputeRenderBuffer> renderBuffer);

  void RecreateRenderTexture(vtkSmartPointer<vtkWebGPUComputeRenderTexture> renderTexture);

  void CreateWebGPUComputePipeline();

  wgpu::PipelineLayout CreateWebGPUComputePipelineLayout();

  wgpu::CommandEncoder CreateCommandEncoder();

  wgpu::ComputePassEncoder CreateComputePassEncoder(const wgpu::CommandEncoder& commandEncoder);

  void WebGPUDispatch(unsigned int groupsX, unsigned int groupsY, unsigned int groupsZ);

  void SubmitCommandEncoderToQueue(const wgpu::CommandEncoder& commandEncoder);

  void ReleaseResources();

  // Compute pass whose internals this class represents
  vtkWeakPointer<vtkWebGPUComputePass> ParentPass;

protected:
  vtkWebGPUComputePassInternals() = default;
  ~vtkWebGPUComputePassInternals() override;

private:
  friend class vtkWebGPUComputePass;
  friend class vtkWebGPUComputePassBufferStorageInternals;
  friend class vtkWebGPUComputePassTextureStorageInternals;
  friend class vtkWebGPUComputePipeline;
  // For the mapper to be able to access the wgpu::Buffer objects for use in a render pipeline
  friend class vtkWebGPUPointCloudMapperInternals;

  vtkWebGPUComputePassInternals(const vtkWebGPUComputePassInternals&) = delete;
  void operator=(const vtkWebGPUComputePassInternals&) = delete;

  bool Initialized = false;
  // Whether or not the binds group / layouts have changed since they were last created and so they
  // need to be recreated. Defaults to true since the bind group / layouts are initially not created
  // so they are invalid.
  bool BindGroupOrLayoutsInvalidated = true;

  // Device of the compute pipeline this pass belongs to. Used to submit commands.
  vtkSmartPointer<vtkWebGPUConfiguration> WGPUConfiguration;

  // The compute pipeline this compute pass belongs to.
  vtkWeakPointer<vtkWebGPUComputePipeline> AssociatedPipeline;

  wgpu::ShaderModule ShaderModule;
  // List of the bind groups, used to set the bind groups of the compute pass at each dispatch
  std::vector<wgpu::BindGroup> BindGroups;
  // Maps a bind group index to to the list of bind group entries for this group. These
  // entries will be used at the creation of the bind groups
  std::unordered_map<int, std::vector<wgpu::BindGroupEntry>> BindGroupEntries;
  std::vector<wgpu::BindGroupLayout> BindGroupLayouts;
  // Maps a bind group index to to the list of bind group layout entries for this group.
  // These layout entries will be used at the creation of the bind group layouts
  std::unordered_map<int, std::vector<wgpu::BindGroupLayoutEntry>> BindGroupLayoutEntries;
  // WebGPU compute shader pipeline
  wgpu::ComputePipeline ComputePipeline;

  // Object responsible for the management (creation, re-creatioin, deletion, ...) of textures and
  // their texture views
  vtkSmartPointer<vtkWebGPUComputePassTextureStorageInternals> TextureStorage;

  // Object responsible for the management (creation, re-creatioin, deletion, ...) of buffers
  vtkSmartPointer<vtkWebGPUComputePassBufferStorageInternals> BufferStorage;
};

VTK_ABI_NAMESPACE_END

#endif