VTK  9.1.0
vtkDataTransferHelper.h
Go to the documentation of this file.
1/*=========================================================================
2
3 Program: Visualization Toolkit
4 Module: vtkDataTransferHelper.h
5
6 Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7 All rights reserved.
8 See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
9
10 This software is distributed WITHOUT ANY WARRANTY; without even
11 the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12 PURPOSE. See the above copyright notice for more information.
13
14=========================================================================*/
31#ifndef vtkDataTransferHelper_h
32#define vtkDataTransferHelper_h
33
34#include "vtkObject.h"
35#include "vtkRenderingOpenGL2Module.h" // For export macro
36#include "vtkSmartPointer.h" // needed for vtkSmartPointer.
37#include "vtkWeakPointer.h" // needed for vtkWeakPointer.
38
39class vtkDataArray;
42class vtkRenderWindow;
43
44class VTKRENDERINGOPENGL2_EXPORT vtkDataTransferHelper : public vtkObject
45{
46public:
49 void PrintSelf(ostream& os, vtkIndent indent) override;
50
52
62
64
74 vtkSetVector6Macro(CPUExtent, int);
75 vtkGetVector6Macro(CPUExtent, int);
77
79
86 vtkSetVector6Macro(GPUExtent, int);
87 vtkGetVector6Macro(GPUExtent, int);
89
91
98 vtkSetVector6Macro(TextureExtent, int);
99 vtkGetVector6Macro(TextureExtent, int);
101
107 bool GetExtentIsValid(int* extent);
108
113
118
123
125
138 vtkSetMacro(MinTextureDimension, int);
139 vtkGetMacro(MinTextureDimension, int);
141
143
146 vtkGetObjectMacro(Array, vtkDataArray);
147 void SetArray(vtkDataArray* array);
149
151
154 vtkGetObjectMacro(Texture, vtkTextureObject);
157
183 bool Upload(int components = 0, int* componentList = nullptr);
184
211 bool Download();
212
214
222
225
229 static bool IsSupported(vtkRenderWindow* renWin);
230
231protected:
234
235 int CPUExtent[6];
236 int GPUExtent[6];
237 int TextureExtent[6];
238
244
246
248
249 // We try to reuse the PBO if possible.
251
252private:
254 void operator=(const vtkDataTransferHelper&) = delete;
255};
256
257#endif
abstract superclass for arrays of numeric data
Definition: vtkDataArray.h:159
is a helper class that aids in transferring data between CPU memory and GPU memory.
vtkWeakPointer< vtkRenderWindow > Context
bool GetTextureExtentIsValid()
Tells if TextureExtent is valid.
bool GetGPUExtentIsValid()
Tells if GPUExtent is valid.
vtkTextureObject * Texture
void SetContext(vtkRenderWindow *context)
Get/Set the context.
static vtkDataTransferHelper * New()
bool Upload(int components=0, int *componentList=nullptr)
Old comment.
vtkSmartPointer< vtkPixelBufferObject > PBO
bool Download()
old comment: Download Extent from GPU data buffer to CPU.
vtkRenderWindow * GetContext()
Get/Set the context.
vtkSmartPointer< vtkPixelBufferObject > AsyncDownloadPBO
bool GetExtentIsValid(int *extent)
Tells if the given extent (6 int) is valid.
bool GetCPUExtentIsValid()
Tells if CPUExtent is valid.
bool DownloadAsync1()
Splits the download in two operations.
bool GetShaderSupportsTextureInt()
static bool IsSupported(vtkRenderWindow *renWin)
Returns if the context supports the required extensions.
~vtkDataTransferHelper() override
bool DownloadAsync2()
Splits the download in two operations.
void SetTexture(vtkTextureObject *texture)
Get/Set the GPU data buffer.
void SetArray(vtkDataArray *array)
Get/Set the CPU data buffer.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkPixelBufferObject * GetPBO()
void SetShaderSupportsTextureInt(bool value)
a simple class to control print indentation
Definition: vtkIndent.h:113
abstract base class for most VTK objects
Definition: vtkObject.h:82
abstracts an OpenGL pixel buffer object.
create a window for renderers to draw into
Hold a reference to a vtkObjectBase instance.
abstracts an OpenGL texture object.
a weak reference to a vtkObject.