vtkWebGPURenderPipelineCache.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 vtkWebGPURenderPipelineCache_h
#define vtkWebGPURenderPipelineCache_h
 
#include "vtkObject.h"
 
#include "vtkRenderingWebGPUModule.h" // for export macro
#include "vtkWrappingHints.h"         // For VTK_MARSHALAUTO
#include "vtk_wgpu.h"                 // for webgpu C API
 
VTK_ABI_NAMESPACE_BEGIN
 
class vtkWebGPUConfiguration;
class vtkWebGPURenderer;
class vtkWebGPURenderWindow;
class vtkWindow;
 
class VTKRENDERINGWEBGPU_EXPORT VTK_MARSHALAUTO vtkWebGPURenderPipelineCache : public vtkObject
{
public:
  static vtkWebGPURenderPipelineCache* New();
  vtkTypeMacro(vtkWebGPURenderPipelineCache, vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  void ReleaseGraphicsResources(vtkWindow* window);

  WGPURenderPipeline GetRenderPipeline(const std::string& key);

  std::string GetPipelineKey(WGPURenderPipelineDescriptor* descriptor, const char* shaderSource);

  std::string GetPipelineKey(WGPURenderPipelineDescriptor* descriptor,
    const char* vertexShaderSource, const char* fragmentShaderSource);

  void CreateRenderPipeline(WGPURenderPipelineDescriptor* descriptor,
    vtkWebGPURenderWindow* wgpuRenderWindow, const char* shaderSource);

  void CreateRenderPipeline(WGPURenderPipelineDescriptor* descriptor,
    vtkWebGPURenderWindow* wgpuRenderWindow, const char* vertexShaderSource,
    const char* fragmentShaderSource);

  void CreateRenderPipelineAsync(WGPURenderPipelineDescriptor* descriptor,
    vtkWebGPURenderWindow* wgpuRenderWindow, const char* vertexShaderSource,
    const char* fragmentShaderSource);

  void WaitForPendingRenderPipelines();

  static bool Substitute(
    std::string& source, const std::string& search, const std::string& replace, bool all);

  void DestroyRenderPipeline(const std::string& key);
 
protected:
  vtkWebGPURenderPipelineCache();
  ~vtkWebGPURenderPipelineCache() override;
 
private:
  vtkWebGPURenderPipelineCache(const vtkWebGPURenderPipelineCache&) = delete;
  void operator=(const vtkWebGPURenderPipelineCache&) = delete;

  bool PrepareShaderModules(WGPURenderPipelineDescriptor* descriptor,
    vtkWebGPURenderWindow* wgpuRenderWindow, const char* vertexShaderSource,
    const char* fragmentShaderSource);
 
  class vtkInternals;
  std::unique_ptr<vtkInternals> Internals;
  // Only needed to drive the event loop while pipelines are being compiled.
  vtkWebGPUConfiguration* Configuration = nullptr;
};
 
VTK_ABI_NAMESPACE_END
#endif