vtkWebGPUTextureDeviceResource.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 vtkWebGPUTextureDeviceResource_h
#define vtkWebGPUTextureDeviceResource_h

#include "vtkObject.h"
#include "vtkRenderingWebGPUModule.h" // For export macro
#include "vtkWrappingHints.h"         // For VTK_MARSHALAUTO

VTK_ABI_NAMESPACE_BEGIN

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

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

  enum TextureFormat
  {
    R8_UNORM = 0,
    RG8_UNORM,
    RGBA8_UNORM,
    BGRA8_UNORM,
    R16_UINT,
    RG16_UINT,
    RGBA16_UINT,
    R32_FLOAT,
    RG32_FLOAT,
    RGBA32_FLOAT,
    DEPTH_24_PLUS,
    DEPTH_24_PLUS_8_STENCIL
  };

  enum TextureDimension
  {
    DIMENSION_1D = 0,
    DIMENSION_2D,
    DIMENSION_3D
  };

  enum TextureMode
  {
    UNDEFINED = 0,
    READ_ONLY,
    WRITE_ONLY_STORAGE,
    WRITE_ONLY_RENDER_ATTACHMENT,
    READ_WRITE_STORAGE,
    READ_WRITE_RENDER_ATTACHMENT,
    READ_WRITE_RENDER_ATTACHMENT_STORAGE,
  };

  enum TextureSampleType
  {
    FLOAT = 0,
    UNFILTERABLE_FLOAT,
    DEPTH,
    SIGNED_INT,
    UNSIGNED_INT
  };

  enum TextureDataType
  {
    VTK_DATA_ARRAY = 0,
    STD_VECTOR
  };

  virtual unsigned int GetBytesPerPixel() const;

  unsigned int GetPixelComponentsCount() const;


  unsigned int GetWidth() const { return Extents[0]; }
  void SetWidth(unsigned int width) { Extents[0] = width; }


  unsigned int GetHeight() const { return Extents[1]; }
  void SetHeight(unsigned int height) { Extents[1] = height; }


  unsigned int GetDepth() const { return Extents[2]; }
  void SetDepth(unsigned int depth) { Extents[2] = depth; }


  VTK_WRAPEXCLUDE void GetSize(unsigned int& x, unsigned int& y, unsigned int& z) const;
  VTK_WRAPEXCLUDE void GetSize(unsigned int& x, unsigned int& y) const;
  VTK_WRAPEXCLUDE void GetSize(unsigned int* xyz);
  unsigned int* GetSize() VTK_SIZEHINT(3);

  VTK_WRAPEXCLUDE virtual void SetSize(unsigned int x, unsigned int y, unsigned int z = 1);
  virtual void SetSize(unsigned int* xyz) VTK_SIZEHINT(3);


  vtkGetEnumMacro(Dimension, TextureDimension);
  vtkSetEnumMacro(Dimension, TextureDimension);


  vtkGetEnumMacro(Format, TextureFormat);
  vtkSetEnumMacro(Format, TextureFormat);


  vtkGetEnumMacro(Mode, TextureMode);
  vtkSetEnumMacro(Mode, TextureMode);


  vtkGetEnumMacro(SampleType, TextureSampleType);
  vtkSetEnumMacro(SampleType, TextureSampleType);


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

protected:
  vtkWebGPUTextureDeviceResource();
  ~vtkWebGPUTextureDeviceResource() override;

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

  // Number of pixels in X, Y and Z direction.
  // Defaulting to 1 in the Z direction because 2D textures are assumed to be the common case.
  unsigned int Extents[3] = { 0, 0, 1 };

  // Is the texture 1D, 2D or 3D
  TextureDimension Dimension = TextureDimension::DIMENSION_2D;

  // The format of the texture: RGB or RGBA?
  TextureFormat Format = TextureFormat::RGBA8_UNORM;

  // The read/write mode of the texture
  TextureMode Mode = TextureMode::UNDEFINED;

  // The type of value produced when sampling the texture in the shader
  TextureSampleType SampleType = TextureSampleType::FLOAT;

  // Maximum number of mipmap levels supported by the texture
  unsigned int MipLevelCount = 1;
};

VTK_ABI_NAMESPACE_END

#endif