vtkDataTransferHelper.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 vtkDataTransferHelper_h
#define vtkDataTransferHelper_h
 
#include "vtkObject.h"
#include "vtkRenderingOpenGL2Module.h" // For export macro
#include "vtkSmartPointer.h"           // needed for vtkSmartPointer.
#include "vtkWeakPointer.h"            // needed for vtkWeakPointer.
 
VTK_ABI_NAMESPACE_BEGIN
class vtkDataArray;
class vtkPixelBufferObject;
class vtkTextureObject;
class vtkRenderWindow;
 
class VTKRENDERINGOPENGL2_EXPORT vtkDataTransferHelper : public vtkObject
{
public:
  static vtkDataTransferHelper* New();
  vtkTypeMacro(vtkDataTransferHelper, vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;
 
 
  void SetContext(vtkRenderWindow* context);
  vtkRenderWindow* GetContext();
 
 
  vtkSetVector6Macro(CPUExtent, int);
  vtkGetVector6Macro(CPUExtent, int);
 
 
  vtkSetVector6Macro(GPUExtent, int);
  vtkGetVector6Macro(GPUExtent, int);
 
 
  vtkSetVector6Macro(TextureExtent, int);
  vtkGetVector6Macro(TextureExtent, int);
 
  bool GetExtentIsValid(int* extent);
 
  bool GetCPUExtentIsValid();
 
  bool GetGPUExtentIsValid();
 
  bool GetTextureExtentIsValid();
 
 
  vtkSetMacro(MinTextureDimension, int);
  vtkGetMacro(MinTextureDimension, int);
 
 
  vtkGetObjectMacro(Array, vtkDataArray);
  void SetArray(vtkDataArray* array);
 
 
  vtkGetObjectMacro(Texture, vtkTextureObject);
  void SetTexture(vtkTextureObject* texture);
 
  bool Upload(int components = 0, int* componentList = nullptr);
 
  bool Download();
 
 
  bool DownloadAsync1();
  bool DownloadAsync2();
 
  bool GetShaderSupportsTextureInt();
  void SetShaderSupportsTextureInt(bool value);
 
  static bool IsSupported(vtkRenderWindow* renWin);
 
protected:
  vtkDataTransferHelper();
  ~vtkDataTransferHelper() override;
 
  int CPUExtent[6];
  int GPUExtent[6];
  int TextureExtent[6];
 
  vtkWeakPointer<vtkRenderWindow> Context;
  vtkTextureObject* Texture;
  vtkDataArray* Array;
  bool ShaderSupportsTextureInt;
  int MinTextureDimension;
 
  vtkSmartPointer<vtkPixelBufferObject> AsyncDownloadPBO;
 
  vtkPixelBufferObject* GetPBO();
 
  // We try to reuse the PBO if possible.
  vtkSmartPointer<vtkPixelBufferObject> PBO;
 
private:
  vtkDataTransferHelper(const vtkDataTransferHelper&) = delete;
  void operator=(const vtkDataTransferHelper&) = delete;
};
 
VTK_ABI_NAMESPACE_END
#endif