VTK
vtkOpenGLRenderWindow.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkOpenGLRenderWindow.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 =========================================================================*/
28 #ifndef vtkOpenGLRenderWindow_h
29 #define vtkOpenGLRenderWindow_h
30 
31 #include "vtkRenderingOpenGL2Module.h" // For export macro
32 #include "vtkRenderWindow.h"
33 #include <string> // for ivar
34 #include <map> // for ivar
35 #include <set> // for ivar
36 #include "vtkType.h" // for ivar
37 
38 class vtkIdList;
42 class vtkShaderProgram;
43 class vtkStdString;
44 class vtkTexture;
45 class vtkTextureObject;
48 
49 class VTKRENDERINGOPENGL2_EXPORT vtkOpenGLRenderWindow : public vtkRenderWindow
50 {
51 public:
53  void PrintSelf(ostream& os, vtkIndent indent);
54 
58  virtual const char *GetRenderingBackend();
59 
61 
67 
71  virtual void StereoUpdate();
72 
74 
77  virtual unsigned char *GetPixelData(int x,int y,int x2,int y2,int front);
78  virtual int GetPixelData(int x,int y,int x2,int y2, int front,
80  virtual int SetPixelData(int x,int y,int x2,int y2,unsigned char *data,
81  int front);
82  virtual int SetPixelData(int x,int y,int x2,int y2,
83  vtkUnsignedCharArray *data, int front);
85 
87 
90  virtual float *GetRGBAPixelData(int x,int y,int x2,int y2,int front);
91  virtual int GetRGBAPixelData(int x,int y,int x2,int y2, int front,
93  virtual int SetRGBAPixelData(int x,int y,int x2,int y2, float *data,
94  int front, int blend=0);
95  virtual int SetRGBAPixelData(int x,int y,int x2,int y2, vtkFloatArray *data,
96  int front, int blend=0);
97  virtual void ReleaseRGBAPixelData(float *data);
98  virtual unsigned char *GetRGBACharPixelData(int x,int y,int x2,int y2,
99  int front);
100  virtual int GetRGBACharPixelData(int x,int y,int x2,int y2, int front,
102  virtual int SetRGBACharPixelData(int x, int y, int x2, int y2,
103  unsigned char *data, int front,
104  int blend=0);
105  virtual int SetRGBACharPixelData(int x,int y,int x2,int y2,
106  vtkUnsignedCharArray *data, int front,
107  int blend=0);
109 
111 
114  virtual float *GetZbufferData( int x1, int y1, int x2, int y2 );
115  virtual int GetZbufferData( int x1, int y1, int x2, int y2, float* z );
116  virtual int GetZbufferData( int x1, int y1, int x2, int y2,
117  vtkFloatArray* z );
118  virtual int SetZbufferData( int x1, int y1, int x2, int y2, float *buffer );
119  virtual int SetZbufferData( int x1, int y1, int x2, int y2,
120  vtkFloatArray *buffer );
122 
123 
128 
133 
138 
143 
148  int GetColorBufferSizes(int *rgba);
149 
151 
154  virtual void SetSize(int a[2]);
155  virtual void SetSize(int,int);
157 
161  virtual void OpenGLInit();
162 
163  // Initialize the state of OpenGL that VTK wants for this window
164  virtual void OpenGLInitState();
165 
166  // Initialize VTK for rendering in a new OpenGL context
167  virtual void OpenGLInitContext();
168 
170 
176 
182  void GetOpenGLVersion(int &major, int &minor);
183 
191  unsigned int GetBackLeftBuffer();
192 
200  unsigned int GetBackRightBuffer();
201 
209  unsigned int GetFrontLeftBuffer();
210 
218  unsigned int GetFrontRightBuffer();
219 
227  unsigned int GetBackBuffer();
228 
236  unsigned int GetFrontBuffer();
237 
242 
244 
247  vtkGetObjectMacro(ShaderCache,vtkOpenGLShaderCache);
249 
251 
254  vtkGetMacro(FrameBufferObject, unsigned int);
256 
262 
267  virtual void WaitForCompletion();
268 
272  virtual void DrawPixels(int x1, int y1, int x2, int y2,
273  int numComponents, int dataType, void *data);
274 
279  virtual void DrawPixels(
280  int dstXmin, int dstYmin, int dstXmax, int dstYmax,
281  int srcXmin, int srcYmin, int srcXmax, int srcYmax,
282  int srcWidth, int srcHeight, int numComponents, int dataType, void *data);
283 
288  virtual void DrawPixels(
289  int srcWidth, int srcHeight, int numComponents, int dataType, void *data);
290 
294  virtual float GetMaximumHardwareLineWidth() {
295  return this->MaximumHardwareLineWidth; };
296 
303  virtual bool IsPointSpriteBugPresent()
304  {
305  return 0;
306  }
307 
314  int vtktype, int numComponents,
315  bool needInteger, bool needFloat);
316 
323  {
324  return this->OpenGLSupportMessage;
325  }
326 
327  // Create and bind offscreen rendering buffers without destroying the current
328  // OpenGL context. This allows to temporary switch to offscreen rendering
329  // (ie. to make a screenshot even if the window is hidden).
330  // Return if the creation was successful (1) or not (0).
331  // Note: This function requires that the device supports OpenGL framebuffer extension.
332  // The function has no effect if OffScreenRendering is ON.
333  virtual int SetUseOffScreenBuffers(bool offScreen);
334  virtual bool GetUseOffScreenBuffers();
335 
339  virtual int SupportsOpenGL();
340 
347  virtual void Initialize(void) {};
348 
349  std::set<vtkGenericOpenGLResourceFreeCallback *> Resources;
350 
352  std::set<vtkGenericOpenGLResourceFreeCallback *>::iterator it
353  = this->Resources.find(cb);
354  if (it == this->Resources.end())
355  {
356  this->Resources.insert(cb);
357  }
358  }
359 
361  std::set<vtkGenericOpenGLResourceFreeCallback *>::iterator it
362  = this->Resources.find(cb);
363  if (it != this->Resources.end())
364  {
365  this->Resources.erase(it);
366  }
367  }
368 
378  virtual void PushContext() { this->MakeCurrent(); }
379  virtual void PopContext() {}
380 
381 protected:
384 
386 
387  // used in testing for opengl support
388  // in the SupportsOpenGL() method
392 
393  int TextureInternalFormats[VTK_UNICODE_STRING][3][5];
395 
396  std::map<const vtkTextureObject *, int> TextureResourceIds;
397 
398  virtual int GetPixelData(int x, int y, int x2, int y2, int front, unsigned char* data);
399  int GetRGBAPixelData(int x, int y, int x2, int y2, int front, float* data);
400  int GetRGBACharPixelData(int x, int y, int x2, int y2, int front,
401  unsigned char* data);
402 
413 
414  int CreateHardwareOffScreenBuffers(int width, int height, bool bind = false);
416 
423 
426 
430  int OffScreenUseFrameBuffer;
431 
433 
436  int NumberOfFrameBuffers;
437  unsigned int TextureObjects[4]; // really GLuint
438  unsigned int FrameBufferObject; // really GLuint
439  unsigned int DepthRenderBufferObject; // really GLuint
440  int HardwareBufferSize[2];
441  bool HardwareOffScreenBuffersBind;
443 
447  virtual void CreateAWindow() = 0;
448 
452  virtual void DestroyWindow() = 0;
453 
459 
463  void SetTextureUnitManager(vtkTextureUnitManager *textureUnitManager);
464 
465 
469  void SaveGLState();
470 
475 
476  std::map<std::string, int> GLStateIntegers;
477 
478  unsigned int BackLeftBuffer;
479  unsigned int BackRightBuffer;
480  unsigned int FrontLeftBuffer;
481  unsigned int FrontRightBuffer;
482  unsigned int FrontBuffer;
483  unsigned int BackBuffer;
484 
485  #ifndef VTK_LEGACY_REMOVE
490  unsigned int LastGraphicError;
491  #endif
492 
496  int OwnContext;
497 
498  vtkTimeStamp ContextCreationTime;
499 
500  vtkTextureUnitManager *TextureUnitManager;
501 
503 
504  bool Initialized; // ensure glewinit has been called
505 
507 
508 private:
509  vtkOpenGLRenderWindow(const vtkOpenGLRenderWindow&) VTK_DELETE_FUNCTION;
510  void operator=(const vtkOpenGLRenderWindow&) VTK_DELETE_FUNCTION;
511 };
512 
513 #endif
dynamic, self-adjusting array of float
Definition: vtkFloatArray.h:42
list of point or cell ids
Definition: vtkIdList.h:37
a simple class to control print indentation
Definition: vtkIndent.h:40
OpenGL rendering window.
OpenGL rendering window.
virtual void DrawPixels(int dstXmin, int dstYmin, int dstXmax, int dstYmax, int srcXmin, int srcYmin, int srcXmax, int srcYmax, int srcWidth, int srcHeight, int numComponents, int dataType, void *data)
Replacement for the old glDrawPixels function, but it allows for scaling the data and using only part...
virtual unsigned char * GetPixelData(int x, int y, int x2, int y2, int front)
Set/Get the pixel data of an image, transmitted as RGBRGB...
std::map< std::string, int > GLStateIntegers
virtual int GetZbufferData(int x1, int y1, int x2, int y2, vtkFloatArray *z)
std::string GetOpenGLSupportMessage()
Return a message profiding additional details about the results of calling SupportsOpenGL() This can ...
virtual bool GetUseOffScreenBuffers()
static bool GetContextSupportsOpenGL32()
Get if the context includes opengl core profile 3.2 support.
virtual void DrawPixels(int x1, int y1, int x2, int y2, int numComponents, int dataType, void *data)
Replacement for the old glDrawPixels function.
int GetColorBufferSizes(int *rgba)
Get the size of the color buffer.
vtkOpenGLShaderCache * ShaderCache
virtual int GetRGBAPixelData(int x, int y, int x2, int y2, int front, vtkFloatArray *data)
virtual void SetSize(int a[2])
Set the size of the window in screen coordinates in pixels.
int GetTextureUnitForTexture(vtkTextureObject *)
Get the texture unit for a given texture object.
void SetTextureUnitManager(vtkTextureUnitManager *textureUnitManager)
Set the texture unit manager.
unsigned int GetBackRightBuffer()
Return the OpenGL name of the back right buffer.
void RegisterGraphicsResources(vtkGenericOpenGLResourceFreeCallback *cb)
virtual void DestroyWindow()=0
Destroy a not-off-screen window.
std::set< vtkGenericOpenGLResourceFreeCallback * > Resources
virtual void WaitForCompletion()
Block the thread until the actual rendering is finished().
virtual int SetZbufferData(int x1, int y1, int x2, int y2, float *buffer)
virtual void ReleaseRGBAPixelData(float *data)
static void SetGlobalMaximumNumberOfMultiSamples(int val)
Set/Get the maximum number of multisamples.
virtual float GetMaximumHardwareLineWidth()
Return the largest line width supported by the hardware.
int GetRGBACharPixelData(int x, int y, int x2, int y2, int front, unsigned char *data)
vtkTextureUnitManager * GetTextureUnitManager()
Returns its texture unit manager object.
virtual int SetRGBAPixelData(int x, int y, int x2, int y2, vtkFloatArray *data, int front, int blend=0)
void BindHardwareOffScreenBuffers()
void DestroyHardwareOffScreenBuffers()
virtual int SetPixelData(int x, int y, int x2, int y2, unsigned char *data, int front)
Set/Get the pixel data of an image, transmitted as RGBRGBRGB.
int GetDepthBufferSize()
Get the size of the depth buffer.
void ActivateTexture(vtkTextureObject *)
Activate a texture unit for this texture.
unsigned int GetBackBuffer()
Return the OpenGL name of the back left buffer.
vtkTextureObject * DrawPixelsTextureObject
virtual void SetSize(int, int)
void SetContextSupportsOpenGL32(bool val)
virtual int SetRGBACharPixelData(int x, int y, int x2, int y2, unsigned char *data, int front, int blend=0)
virtual void ReleaseGraphicsResources(vtkRenderWindow *)
Free up any graphics resources associated with this window a value of NULL means the context may alre...
virtual int SetRGBACharPixelData(int x, int y, int x2, int y2, vtkUnsignedCharArray *data, int front, int blend=0)
virtual int GetPixelData(int x, int y, int x2, int y2, int front, unsigned char *data)
int CreateHardwareOffScreenBuffers(int width, int height, bool bind=false)
void UnregisterGraphicsResources(vtkGenericOpenGLResourceFreeCallback *cb)
unsigned int GetFrontRightBuffer()
Return the OpenGL name of the front right buffer.
virtual const char * GetRenderingBackend()
What rendering backend has the user requested.
virtual int SupportsOpenGL()
Does this render window support OpenGL? 0-false, 1-true.
virtual bool IsPointSpriteBugPresent()
Returns true if driver has an EGL/OpenGL bug that makes vtkChartsCoreCxx-TestChartDoubleColors and ot...
unsigned int GetFrontBuffer()
Return the OpenGL name of the front left buffer.
virtual void OpenGLInitContext()
virtual int GetPixelData(int x, int y, int x2, int y2, int front, vtkUnsignedCharArray *data)
virtual int SetRGBAPixelData(int x, int y, int x2, int y2, float *data, int front, int blend=0)
unsigned int GetBackLeftBuffer()
Return the OpenGL name of the back left buffer.
void InitializeTextureInternalFormats()
virtual void PushContext()
Ability to push and pop this window's context as the current context.
virtual void OpenGLInitState()
static int GetGlobalMaximumNumberOfMultiSamples()
virtual void CreateAWindow()=0
Create a not-off-screen window.
int GetRGBAPixelData(int x, int y, int x2, int y2, int front, float *data)
int GetDefaultTextureInternalFormat(int vtktype, int numComponents, bool needInteger, bool needFloat)
Get a mapping of vtk data types to native texture formats for this window we put this on the RenderWi...
int CreateHardwareOffScreenWindow(int width, int height)
Create an offScreen window based on OpenGL framebuffer extension.
unsigned int GetFrontLeftBuffer()
Return the OpenGL name of the front left buffer.
virtual unsigned char * GetRGBACharPixelData(int x, int y, int x2, int y2, int front)
virtual vtkMTimeType GetContextCreationTime()
Get the time when the OpenGL context was created.
void PrintSelf(ostream &os, vtkIndent indent)
Methods invoked by print to print information about the object including superclasses.
virtual void StereoUpdate()
Update system if needed due to stereo rendering.
void UnbindHardwareOffScreenBuffers()
virtual int SetZbufferData(int x1, int y1, int x2, int y2, vtkFloatArray *buffer)
virtual void Initialize(void)
Initialize the rendering window.
virtual void OpenGLInit()
Initialize OpenGL for this window.
virtual float * GetRGBAPixelData(int x, int y, int x2, int y2, int front)
Set/Get the pixel data of an image, transmitted as RGBARGBA...
void DestroyHardwareOffScreenWindow()
Destroy an offscreen window based on OpenGL framebuffer extension.
void DeactivateTexture(vtkTextureObject *)
Deactive a previously activated texture.
void RestoreGLState()
Restore OpenGL state at end of the rendering.
void GetOpenGLVersion(int &major, int &minor)
Get the major and minor version numbers of the OpenGL context we are using ala 3.2,...
void SaveGLState()
Query and save OpenGL state.
virtual float * GetZbufferData(int x1, int y1, int x2, int y2)
Set/Get the zbuffer data from an image.
std::map< const vtkTextureObject *, int > TextureResourceIds
virtual int GetRGBACharPixelData(int x, int y, int x2, int y2, int front, vtkUnsignedCharArray *data)
virtual int SetUseOffScreenBuffers(bool offScreen)
Create and bind offscreen rendering buffers without destroying the current OpenGL context.
virtual void DrawPixels(int srcWidth, int srcHeight, int numComponents, int dataType, void *data)
Replacement for the old glDrawPixels function.
virtual int GetZbufferData(int x1, int y1, int x2, int y2, float *z)
virtual int SetPixelData(int x, int y, int x2, int y2, vtkUnsignedCharArray *data, int front)
manage Shader Programs within a context
The VertexArrayObject class uses, or emulates, vertex array objects.
create a window for renderers to draw into
virtual void MakeCurrent()=0
Attempt to make this window the current graphics context for the calling thread.
The ShaderProgram uses one or more Shader objects.
Wrapper around std::string to keep symbols short.
Definition: vtkStdString.h:49
abstracts an OpenGL texture object.
allocate/free texture units.
handles properties associated with a texture map
Definition: vtkTexture.h:71
record modification and/or execution time
Definition: vtkTimeStamp.h:36
dynamic, self-adjusting array of unsigned char
@ height
Definition: vtkX3D.h:254
@ data
Definition: vtkX3D.h:315
@ string
Definition: vtkX3D.h:490
vtkTypeUInt64 vtkMTimeType
Definition: vtkType.h:248
#define VTK_UNICODE_STRING
Definition: vtkType.h:81