vtkWebGPUDeepFramebuffer.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 vtkWebGPUDeepFramebuffer_h
#define vtkWebGPUDeepFramebuffer_h
 
#include "vtkObject.h"
 
#include "vtkRenderingWebGPUModule.h" // for export macro
#include "vtkSmartPointer.h"          // for ivar
#include "vtk_wgpu.h"                 // for the WebGPU C API
 
#include <cstdint> // for fixed width types
 
VTK_ABI_NAMESPACE_BEGIN
class vtkWebGPUConfiguration;
 
class VTKRENDERINGWEBGPU_EXPORT vtkWebGPUDeepFramebuffer : public vtkObject
{
public:
  static vtkWebGPUDeepFramebuffer* New();
  vtkTypeMacro(vtkWebGPUDeepFramebuffer, vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  vtkGetMacro(AverageLayersPerPixel, std::uint32_t);
  vtkSetClampMacro(AverageLayersPerPixel, std::uint32_t, 1, 64);

  void SetWGPUConfiguration(vtkWebGPUConfiguration* config);

  bool Resize(int width, int height);

  void Clear();

  WGPUBuffer GetHeadPointersBuffer() { return this->HeadPointersBuffer; }
  WGPUBuffer GetFragmentNodesBuffer() { return this->FragmentNodesBuffer; }
  WGPUBuffer GetFragmentCounterBuffer() { return this->FragmentCounterBuffer; }

  vtkGetMacro(Width, int);
  vtkGetMacro(Height, int);
  vtkGetMacro(FragmentNodeCapacity, std::uint32_t);

  void ReleaseGraphicsResources();
 
protected:
  vtkWebGPUDeepFramebuffer();
  ~vtkWebGPUDeepFramebuffer() override;
 
private:
  static constexpr std::uint32_t FragmentNodeSize = 28;

  static constexpr std::uint32_t InvalidIndex = 0xFFFFFFFFu;
 
  vtkWebGPUDeepFramebuffer(const vtkWebGPUDeepFramebuffer&) = delete;
  void operator=(const vtkWebGPUDeepFramebuffer&) = delete;
 
  vtkSmartPointer<vtkWebGPUConfiguration> WGPUConfiguration;
 
  WGPUBuffer HeadPointersBuffer = nullptr;
  WGPUBuffer FragmentNodesBuffer = nullptr;
  WGPUBuffer FragmentCounterBuffer = nullptr;
 
  int Width = 0;
  int Height = 0;
  std::uint32_t AverageLayersPerPixel = 8;
  std::uint32_t FragmentNodeCapacity = 0;
};
VTK_ABI_NAMESPACE_END
 
#endif