vtkWebGPURenderWindow.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 vtkWebGPURenderWindow_h
#define vtkWebGPURenderWindow_h
 
#include "vtkRenderWindow.h"
 
#include "vtkRenderingWebGPUModule.h" // for export macro
#include "vtkTypeUInt8Array.h"        // for ivar
#include "vtk_wgpu.h"                 // for webgpu
 
VTK_ABI_NAMESPACE_BEGIN
 
class VTKRENDERINGWEBGPU_EXPORT vtkWebGPURenderWindow : public vtkRenderWindow
{
public:
  vtkTypeMacro(vtkWebGPURenderWindow, vtkRenderWindow);
  void PrintSelf(ostream& os, vtkIndent indent) override;
 
  // for high power preference, we shall request discrete GPU instead of integrated GPU or the CPU.
  void SetPowerPreference(bool high = true)
  {
    this->PowerPreference =
      high ? wgpu::PowerPreference::HighPerformance : wgpu::PowerPreference::LowPower;
    this->Modified();
  }
 
  virtual bool Initialize() = 0;
 
  virtual void CreateAWindow() = 0;
 
  virtual void DestroyWindow() = 0;
 
  void Start() override;
 
  void End() override;
 
  void Render() override;
 
  void StereoMidpoint() override;
  void Frame() override;
 
  const char* GetRenderingBackend() override;
 
  void ReadPixels();
 
 
  unsigned char* GetPixelData(int x, int y, int x2, int y2, int front, int right) override;
  int GetPixelData(
    int x, int y, int x2, int y2, int front, vtkUnsignedCharArray* data, int right) override;
  int SetPixelData(
    int x, int y, int x2, int y2, unsigned char* data, int front, int right) override;
  int SetPixelData(
    int x, int y, int x2, int y2, vtkUnsignedCharArray* data, int front, int right) override;
 
 
  float* GetRGBAPixelData(int x, int y, int x2, int y2, int front, int right = 0) override;
  int GetRGBAPixelData(
    int x, int y, int x2, int y2, int front, vtkFloatArray* data, int right = 0) override;
  int SetRGBAPixelData(
    int x, int y, int x2, int y2, float* data, int front, int blend = 0, int right = 0) override;
  int SetRGBAPixelData(int x, int y, int x2, int y2, vtkFloatArray* data, int front, int blend = 0,
    int right = 0) override;
  void ReleaseRGBAPixelData(float* data) override;
  unsigned char* GetRGBACharPixelData(
    int x, int y, int x2, int y2, int front, int right = 0) override;
  int GetRGBACharPixelData(
    int x, int y, int x2, int y2, int front, vtkUnsignedCharArray* data, int right = 0) override;
  int SetRGBACharPixelData(int x, int y, int x2, int y2, unsigned char* data, int front,
    int blend = 0, int right = 0) override;
  int SetRGBACharPixelData(int x, int y, int x2, int y2, vtkUnsignedCharArray* data, int front,
    int blend = 0, int right = 0) override;
 
 
  float* GetZbufferData(int x1, int y1, int x2, int y2) override;
  int GetZbufferData(int x1, int y1, int x2, int y2, float* z) override;
  int GetZbufferData(int x1, int y1, int x2, int y2, vtkFloatArray* buffer) override;
  int SetZbufferData(int x1, int y1, int x2, int y2, float* buffer) override;
  int SetZbufferData(int x1, int y1, int x2, int y2, vtkFloatArray* buffer) override;
 
  int GetColorBufferSizes(int* rgba) override;
  void WaitForCompletion() override;
 
  int SupportsOpenGL() override;
 
  const char* ReportCapabilities() override;
 
  bool InitializeFromCurrentContext() override;
 
  void ReleaseGraphicsResources(vtkWindow*) override;
 
  inline wgpu::RenderPassEncoder NewRenderPass(wgpu::RenderPassDescriptor& descriptor)
  {
    return this->CommandEncoder.BeginRenderPass(&descriptor);
  }
 
  inline wgpu::RenderBundleEncoder NewRenderBundleEncoder(
    wgpu::RenderBundleEncoderDescriptor& descriptor)
  {
    return this->Device.CreateRenderBundleEncoder(&descriptor);
  }
 
  inline wgpu::CommandEncoder GetCommandEncoder() { return this->CommandEncoder; }
  inline wgpu::TextureView GetOffscreenColorAttachmentView() { return this->ColorAttachment.View; }
  inline wgpu::TextureView GetDepthStencilView() { return this->DepthStencil.View; }
  inline wgpu::TextureFormat GetDepthStencilFormat() { return this->DepthStencil.Format; }
  inline bool HasStencil() { return this->DepthStencil.HasStencil; }
  inline wgpu::Device GetDevice() { return this->Device; }
 
  wgpu::TextureFormat GetPreferredSwapChainTextureFormat();
 
protected:
  vtkWebGPURenderWindow();
  ~vtkWebGPURenderWindow() override;
 
  bool WGPUInit();
  void WGPUFinalize();
 
  void CreateSwapChain();
  void DestroySwapChain();
 
  void CreateOffscreenColorAttachments();
  void DestroyOffscreenColorAttachments();
 
  void CreateDepthStencilTexture();
  void DestroyDepthStencilTexture();
 
  void CreateFSQGraphicsPipeline();
  void DestroyFSQGraphicsPipeline();
 
  void RenderOffscreenTexture();
 
  void FlushCommandBuffers(vtkTypeUInt32 count, wgpu::CommandBuffer* buffers);
 
  bool WGPUInitialized = false;
  wgpu::PowerPreference PowerPreference = wgpu::PowerPreference::HighPerformance;
  wgpu::Adapter Adapter;
  wgpu::Device Device;
  wgpu::Surface Surface;
  wgpu::CommandEncoder CommandEncoder;
 
  struct vtkWGPUSwapChain
  {
    wgpu::SwapChain Instance;
    wgpu::TextureView Framebuffer;
    wgpu::TextureFormat TexFormat;
    wgpu::PresentMode PresentMode;
    int Width = 0;
    int Height = 0;
  };
  vtkWGPUSwapChain SwapChain;
 
  struct vtkWGPUDeptStencil
  {
    wgpu::Texture Texture;
    wgpu::TextureView View;
    wgpu::TextureFormat Format;
    bool HasStencil;
  };
  vtkWGPUDeptStencil DepthStencil;
 
  struct vtkWGPUColorAttachment
  {
    wgpu::Texture Texture;
    wgpu::TextureView View;
    wgpu::TextureFormat Format;
    wgpu::Buffer OffscreenBuffer;
  };
  vtkWGPUColorAttachment ColorAttachment;
 
  struct vtkWGPUUserStagingPixelData
  {
    wgpu::Origin3D Origin;
    wgpu::Extent3D Extent;
    wgpu::TextureDataLayout Layout;
    wgpu::Buffer Buffer; // for SetPixelData
  };
  vtkWGPUUserStagingPixelData StagingPixelData;
 
  struct vtkWGPUFullScreenQuad
  {
    wgpu::RenderPipeline Pipeline;
    wgpu::BindGroup BindGroup;
  };
  vtkWGPUFullScreenQuad FSQ;
 
  struct MappingContext
  {
    vtkSmartPointer<vtkTypeUInt8Array> dst;
    wgpu::Buffer src;
    unsigned long size;
  } BufferMapReadContext;
 
  vtkNew<vtkTypeUInt8Array> CachedPixelBytes;
 
private:
  vtkWebGPURenderWindow(const vtkWebGPURenderWindow&) = delete;
  void operator=(const vtkWebGPURenderWindow&) = delete;
};
 
VTK_ABI_NAMESPACE_END
#endif