VTK
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 =========================================================================*/
30 #ifndef vtkDataTransferHelper_h
31 #define vtkDataTransferHelper_h
32 
33 #include "vtkRenderingOpenGLModule.h" // For export macro
34 #include "vtkObject.h"
35 #include "vtkWeakPointer.h" // needed for vtkWeakPointer.
36 #include "vtkSmartPointer.h" // needed for vtkSmartPointer.
37 
38 class vtkDataArray;
40 class vtkTextureObject;
42 class vtkRenderWindow;
43 
45 {
46 public:
49  void PrintSelf(ostream& os, vtkIndent indent);
50 
52 
56  void SetContext(vtkRenderWindow* context);
59 
61 
68  vtkSetVector6Macro(CPUExtent, int);
69  vtkGetVector6Macro(CPUExtent, int);
71 
73 
78  vtkSetVector6Macro(GPUExtent, int);
79  vtkGetVector6Macro(GPUExtent, int);
81 
83 
87  vtkSetVector6Macro(TextureExtent, int);
88  vtkGetVector6Macro(TextureExtent, int);
90 
94 
97 
100 
103 
105 
115  vtkSetMacro(MinTextureDimension,int);
116  vtkGetMacro(MinTextureDimension,int);
118 
120 
122  void SetArray(vtkDataArray* array);
124 
126 
130 
132 
154  bool Upload(int components=0,
155  int *componentList=NULL);
157 
180  bool Download();
181 
183 
189 
192 
194 
195  static bool IsSupported(vtkRenderWindow* renWin);
196 //BTX
197 protected:
201 
204 
205  int CPUExtent[6];
206  int GPUExtent[6];
207  int TextureExtent[6];
208 
214 
216 
218 
219  // We try to reuse the PBO if possible.
221 private:
222  vtkDataTransferHelper(const vtkDataTransferHelper&); // Not implemented.
223  void operator=(const vtkDataTransferHelper&); // Not implemented.
224 //ETX
225 };
226 
227 #endif
vtkGetVector6Macro
#define vtkGetVector6Macro(name, type)
Definition: vtkSetGet.h:380
vtkDataTransferHelper::SetTexture
void SetTexture(vtkTextureObject *texture)
vtkGetObjectMacro
#define vtkGetObjectMacro(name, type)
Definition: vtkSetGet.h:232
vtkDataTransferHelper::ShaderSupportsTextureInt
bool ShaderSupportsTextureInt
Definition: vtkDataTransferHelper.h:212
vtkDataTransferHelper::SetShaderSupportsTextureInt
void SetShaderSupportsTextureInt(bool value)
vtkDataTransferHelper
is a helper class that aids in transferring data between CPU memory and GPU memory.
Definition: vtkDataTransferHelper.h:45
vtkDataTransferHelper::SetContext
void SetContext(vtkRenderWindow *context)
vtkDataTransferHelper::Download
bool Download()
vtkRenderingOpenGLModule.h
vtkDataTransferHelper::Texture
vtkTextureObject * Texture
Definition: vtkDataTransferHelper.h:210
vtkTypeMacro
#define vtkTypeMacro(thisClass, superclass)
Definition: vtkSetGet.h:642
vtkSmartPointer< vtkPixelBufferObject >
vtkObject
abstract base class for most VTK objects
Definition: vtkObject.h:62
vtkDataTransferHelper::GetExtentIsValid
bool GetExtentIsValid(int *extent)
vtkDataArray
abstract superclass for arrays of numeric data
Definition: vtkDataArray.h:55
vtkDataTransferHelper::PBO
vtkSmartPointer< vtkPixelBufferObject > PBO
Definition: vtkDataTransferHelper.h:220
vtkDataTransferHelper::GetCPUExtentIsValid
bool GetCPUExtentIsValid()
vtkDataTransferHelper::LoadRequiredExtensions
bool LoadRequiredExtensions(vtkOpenGLExtensionManager *)
vtkDataTransferHelper::~vtkDataTransferHelper
~vtkDataTransferHelper()
vtkDataTransferHelper::DownloadAsync1
bool DownloadAsync1()
vtkDataTransferHelper::IsSupported
static bool IsSupported(vtkRenderWindow *renWin)
vtkDataTransferHelper::Upload
bool Upload(int components=0, int *componentList=NULL)
vtkDataTransferHelper::SetArray
void SetArray(vtkDataArray *array)
vtkDataTransferHelper::GetGPUExtentIsValid
bool GetGPUExtentIsValid()
vtkDataTransferHelper::MinTextureDimension
int MinTextureDimension
Definition: vtkDataTransferHelper.h:213
vtkDataTransferHelper::GetTextureExtentIsValid
bool GetTextureExtentIsValid()
vtkOpenGLExtensionManager
Interface class for querying and using OpenGL extensions.
vtkgl::value
GLsizei const GLfloat * value
Definition: vtkgl.h:12021
vtkgl::texture
GLenum GLuint texture
Definition: vtkgl.h:12500
vtkDataTransferHelper::GetShaderSupportsTextureInt
bool GetShaderSupportsTextureInt()
vtkDataTransferHelper::GetPBO
vtkPixelBufferObject * GetPBO()
vtkDataTransferHelper::New
static vtkDataTransferHelper * New()
vtkDataTransferHelper::Array
vtkDataArray * Array
Definition: vtkDataTransferHelper.h:211
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:39
vtkTextureObject
abstracts an OpenGL texture object.
Definition: vtkTextureObject.h:40
vtkSmartPointer.h
vtkWeakPointer.h
vtkGetMacro
#define vtkGetMacro(name, type)
Definition: vtkSetGet.h:93
vtkObject.h
vtkSetMacro
vtkSetMacro(IgnoreDriverBugs, bool)
vtkDataTransferHelper::vtkDataTransferHelper
vtkDataTransferHelper()
vtkDataTransferHelper::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent)
vtkSetVector6Macro
#define vtkSetVector6Macro(name, type)
Definition: vtkSetGet.h:360
vtkDataTransferHelper::DownloadAsync2
bool DownloadAsync2()
vtkX3D::extent
@ extent
Definition: vtkX3D.h:345
vtkRenderWindow
create a window for renderers to draw into
Definition: vtkRenderWindow.h:89
vtkgl::components
GLenum GLenum GLuint components
Definition: vtkgl.h:16909
vtkDataTransferHelper::AsyncDownloadPBO
vtkSmartPointer< vtkPixelBufferObject > AsyncDownloadPBO
Definition: vtkDataTransferHelper.h:215
vtkPixelBufferObject
abstracts an OpenGL pixel buffer object.
Definition: vtkPixelBufferObject.h:43
vtkWeakPointer< vtkRenderWindow >
VTKRENDERINGOPENGL_EXPORT
#define VTKRENDERINGOPENGL_EXPORT
Definition: vtkRenderingOpenGLModule.h:15
vtkDataTransferHelper::Context
vtkWeakPointer< vtkRenderWindow > Context
Definition: vtkDataTransferHelper.h:209
vtkDataTransferHelper::GetContext
vtkRenderWindow * GetContext()