vtkOpenGLTextureNormalizationHelper.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 vtkOpenGLTextureNormalizationHelper_h
#define vtkOpenGLTextureNormalizationHelper_h

#include "vtkObject.h"
#include "vtkRenderingOpenGL2Module.h" // For export macro
#include "vtkSmartPointer.h"           // For ivar
#include "vtkWrappingHints.h"          // For VTK_MARSHALAUTO

VTK_ABI_NAMESPACE_BEGIN
class vtkOpenGLRenderWindow;

class VTKRENDERINGOPENGL2_EXPORT VTK_MARSHALAUTO vtkOpenGLTextureNormalizationHelper
  : public vtkObject
{
public:
  vtkAbstractTypeMacro(vtkOpenGLTextureNormalizationHelper, vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  enum class ConversionMode
  {
    CPU,           // CPU conversion (fallback)
    ComputeShader, // Compute shader (fastest if available)
    CopyTexImage,  // Framebuffer blit with shader conversion
    Unsupported    // No conversion available
  };

  static vtkSmartPointer<vtkOpenGLTextureNormalizationHelper> Create(
    vtkOpenGLRenderWindow* context);

  ConversionMode GetConversionMode() const { return this->Mode; }

  bool IsGPUConversionAvailable() const
  {
    return this->Mode != ConversionMode::CPU && this->Mode != ConversionMode::Unsupported;
  }

  virtual bool ConvertUShortToFloat(const void* sourceData, size_t numValues, int numComps,
    unsigned int targetTexture, unsigned int width, unsigned int height) = 0;

  virtual bool ConvertShortToFloat(const void* sourceData, size_t numValues, int numComps,
    unsigned int targetTexture, unsigned int width, unsigned int height) = 0;

protected:
  vtkOpenGLTextureNormalizationHelper() = default;
  ~vtkOpenGLTextureNormalizationHelper() override = default;

  ConversionMode Mode = ConversionMode::CPU;

private:
  vtkOpenGLTextureNormalizationHelper(const vtkOpenGLTextureNormalizationHelper&) = delete;
  void operator=(const vtkOpenGLTextureNormalizationHelper&) = delete;
};

VTK_ABI_NAMESPACE_END
#endif // vtkOpenGLTextureNormalizationHelper_h