vtkWebGPURenderTextureDeviceResource.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 vtkWebGPURenderTextureDeviceResource_h
#define vtkWebGPURenderTextureDeviceResource_h
#include "vtkDataArray.h"
#include "vtkRenderingWebGPUModule.h" // For export macro
#include "vtkWebGPUTextureDeviceResource.h"
#include "vtkWrappingHints.h" // For VTK_MARSHALAUTO
#include "vtk_wgpu.h"         // for webgpu

#include <cstdint>

VTK_ABI_NAMESPACE_BEGIN
class vtkWindow;
class vtkImageData;
class vtkWebGPUConfiguration;
class VTKRENDERINGWEBGPU_EXPORT VTK_MARSHALAUTO vtkWebGPURenderTextureDeviceResource
  : public vtkWebGPUTextureDeviceResource
{
public:
  vtkTypeMacro(vtkWebGPURenderTextureDeviceResource, vtkWebGPUTextureDeviceResource);
  static vtkWebGPURenderTextureDeviceResource* New();
  void PrintSelf(ostream& os, vtkIndent indent) override;

  void ReleaseGraphicsResources(vtkWindow* window);

  enum class AddressMode
  {
    UNDEFINED = 0,
    CLAMP_TO_EDGE,
    REPEAT,
    MIRROR_REPEAT
  };

  enum class FilterMode
  {
    UNDEFINED = 0,
    NEAREST,
    LINEAR
  };

  enum class SamplerMode
  {
    UNDEFINED = 0,
    FILTERING,
    NON_FILTERING,
    COMPARISON
  };

  enum class CompareFunction
  {
    UNDEFINED = 0,
    NEVER,
    LESS,
    LESS_EQUAL,
    GREATER,
    GREATER_EQUAL,
    EQUAL,
    NOT_EQUAL,
    ALWAYS
  };


  vtkGetEnumMacro(AddressModeU, AddressMode);
  vtkSetEnumMacro(AddressModeU, AddressMode);
  vtkGetEnumMacro(AddressModeV, AddressMode);
  vtkSetEnumMacro(AddressModeV, AddressMode);
  vtkGetEnumMacro(AddressModeW, AddressMode);
  vtkSetEnumMacro(AddressModeW, AddressMode);


  vtkGetEnumMacro(MagFilter, FilterMode);
  vtkSetEnumMacro(MagFilter, FilterMode);
  vtkGetEnumMacro(MinFilter, FilterMode);
  vtkSetEnumMacro(MinFilter, FilterMode);
  vtkGetEnumMacro(MipmapFilter, FilterMode);
  vtkSetEnumMacro(MipmapFilter, FilterMode);


  vtkGetEnumMacro(SamplerBindingType, SamplerMode);
  vtkSetEnumMacro(SamplerBindingType, SamplerMode);


  vtkGetEnumMacro(CompareFunc, CompareFunction);
  vtkSetEnumMacro(CompareFunc, CompareFunction);


  vtkGetMacro(LODMinClamp, float);
  vtkSetMacro(LODMinClamp, float);
  vtkGetMacro(LODMaxClamp, float);
  vtkSetMacro(LODMaxClamp, float);


  vtkGetMacro(MaxAnisotropy, vtkTypeUInt16);
  vtkSetMacro(MaxAnisotropy, vtkTypeUInt16);


  vtkGetMacro(SampleCount, vtkTypeUInt32);
  vtkSetMacro(SampleCount, vtkTypeUInt32);

  void SendToWebGPUDevice(
    std::vector<void*> dataPlanes, vtkWebGPUConfiguration* wgpuConfiguration, bool cubeMap = false);

  wgpu::BindGroupLayoutEntry MakeSamplerBindGroupLayoutEntry(
    std::uint32_t binding, wgpu::ShaderStage visibility);

  wgpu::BindGroupEntry MakeSamplerBindGroupEntry(std::uint32_t binding);

  wgpu::BindGroupLayoutEntry MakeTextureViewBindGroupLayoutEntry(
    std::uint32_t binding, wgpu::ShaderStage visibility);

  wgpu::BindGroupEntry MakeTextureViewBindGroupEntry(std::uint32_t binding);


  vtkSetStdStringFromCharMacro(Label);
  vtkSetMacro(Label, std::string);
  vtkGetCharFromStdStringMacro(Label);

  static const char* GetTextureSampleTypeString(TextureSampleType type);
  static wgpu::FilterMode GetWebGPUFilterMode(FilterMode mode);
  static wgpu::MipmapFilterMode GetWGPUMipMapFilterMode(FilterMode mode);
  static wgpu::AddressMode GetWebGPUAddressMode(AddressMode mode);
  static wgpu::SamplerBindingType GetWebGPUSamplerBindingType(SamplerMode mode);
  static wgpu::CompareFunction GetWebGPUCompareFunction(CompareFunction mode);

protected:
  vtkWebGPURenderTextureDeviceResource();
  ~vtkWebGPURenderTextureDeviceResource() override;

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

  AddressMode AddressModeU = AddressMode::UNDEFINED;
  AddressMode AddressModeV = AddressMode::UNDEFINED;
  AddressMode AddressModeW = AddressMode::UNDEFINED;

  FilterMode MagFilter = FilterMode::UNDEFINED;
  FilterMode MinFilter = FilterMode::UNDEFINED;
  FilterMode MipmapFilter = FilterMode::UNDEFINED;

  SamplerMode SamplerBindingType = SamplerMode::UNDEFINED;
  CompareFunction CompareFunc = CompareFunction::UNDEFINED;

  float LODMinClamp = 0.0f;
  float LODMaxClamp = 32.0f;
  vtkTypeUInt16 MaxAnisotropy = 1;

  vtkTypeUInt32 SampleCount = 1;
  vtkTypeUInt32 BaseMipLevel = 0;

  std::string Label;

  wgpu::TextureDescriptor TextureDescriptor;
  wgpu::Texture Texture;
  wgpu::SamplerDescriptor SamplerDescriptor;
  wgpu::Sampler Sampler;
  wgpu::TextureViewDescriptor TextureViewDescriptor;
  wgpu::TextureView TextureView;
};

VTK_ABI_NAMESPACE_END
#endif