vtkWebGPUTextureView.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 vtkWebGPUTextureView_h
#define vtkWebGPUTextureView_h

#include "vtkObject.h"
#include "vtkRenderingWebGPUModule.h"       // For export macro
#include "vtkWebGPUTextureDeviceResource.h" // for TextureFormat, TextureDimension, ...
#include "vtkWrappingHints.h"               // For VTK_MARSHALAUTO

VTK_ABI_NAMESPACE_BEGIN

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

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

  enum TextureViewAspect
  {
    ASPECT_ALL = 0,
    ASPECT_DEPTH,
    ASPECT_STENCIL
  };

  enum TextureViewMode
  {
    UNDEFINED = 0,
    READ_ONLY,
    READ_ONLY_STORAGE,
    WRITE_ONLY_STORAGE,
    READ_WRITE_STORAGE
  };


  vtkGetMacro(BaseMipLevel, int);
  vtkSetMacro(BaseMipLevel, int);


  vtkGetMacro(MipLevelCount, int);
  vtkSetMacro(MipLevelCount, int);


  vtkGetMacro(Group, vtkIdType);
  vtkSetMacro(Group, vtkIdType);


  vtkGetMacro(Binding, vtkIdType);
  vtkSetMacro(Binding, vtkIdType);


  vtkGetMacro(Aspect, vtkWebGPUTextureView::TextureViewAspect);
  vtkSetMacro(Aspect, vtkWebGPUTextureView::TextureViewAspect);


  vtkGetMacro(Dimension, vtkWebGPUTextureDeviceResource::TextureDimension);
  vtkSetMacro(Dimension, vtkWebGPUTextureDeviceResource::TextureDimension);


  vtkGetMacro(Format, vtkWebGPUTextureDeviceResource::TextureFormat);
  vtkSetMacro(Format, vtkWebGPUTextureDeviceResource::TextureFormat);


  vtkGetMacro(Mode, vtkWebGPUTextureView::TextureViewMode);
  vtkSetMacro(Mode, vtkWebGPUTextureView::TextureViewMode);


  vtkGetMacro(Label, std::string&);
  vtkSetMacro(Label, std::string);

protected:
  vtkWebGPUTextureView();
  ~vtkWebGPUTextureView() override;

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

  // Mip level of the base texture that this texture view gives a view on
  int BaseMipLevel = 0;
  // How many mip levels this texture view give the shader access to
  int MipLevelCount = 1;

  // Bind group of the texture view
  vtkIdType Group = -1;

  // Binding of the texture view
  vtkIdType Binding = -1;

  // What aspect of the texture is going to be sampled by the samplers in the shaders sampling this
  // texture
  vtkWebGPUTextureView::TextureViewAspect Aspect = TextureViewAspect::ASPECT_ALL;

  // Dimension of the texture view
  vtkWebGPUTextureDeviceResource::TextureDimension Dimension =
    vtkWebGPUTextureDeviceResource::TextureDimension::DIMENSION_2D;

  // Format of the texture view
  vtkWebGPUTextureDeviceResource::TextureFormat Format =
    vtkWebGPUTextureDeviceResource::TextureFormat::RGBA8_UNORM;

  // Mode of the texture view
  vtkWebGPUTextureView::TextureViewMode Mode = vtkWebGPUTextureView::TextureViewMode::UNDEFINED;

  // Label used for debugging if something goes wrong
  std::string Label = "Texture view";
};

VTK_ABI_NAMESPACE_END

#endif