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 =========================================================================*/
25 #ifndef vtkOpenGLRenderWindow_h
26 #define vtkOpenGLRenderWindow_h
27 
28 #include "vtkRenderingOpenGL2Module.h" // For export macro
29 #include "vtkRenderWindow.h"
30 #include <string> // for ivar
31 #include <map> // for ivar
32 #include <set> // for ivar
33 #include "vtkType.h" // for ivar
34 
35 class vtkIdList;
39 class vtkShaderProgram;
40 class vtkStdString;
41 class vtkTexture;
42 class vtkTextureObject;
45 
46 class VTKRENDERINGOPENGL2_EXPORT vtkOpenGLRenderWindow : public vtkRenderWindow
47 {
48 public:
50  void PrintSelf(ostream& os, vtkIndent indent);
51 
55  virtual const char *GetRenderingBackend();
56 
58 
61  static void SetGlobalMaximumNumberOfMultiSamples(int val);
62  static int GetGlobalMaximumNumberOfMultiSamples();
64 
68  virtual void StereoUpdate();
69 
71 
74  virtual unsigned char *GetPixelData(int x,int y,int x2,int y2,int front);
75  virtual int GetPixelData(int x,int y,int x2,int y2, int front,
77  virtual int SetPixelData(int x,int y,int x2,int y2,unsigned char *data,
78  int front);
79  virtual int SetPixelData(int x,int y,int x2,int y2,
80  vtkUnsignedCharArray *data, int front);
82 
84 
87  virtual float *GetRGBAPixelData(int x,int y,int x2,int y2,int front);
88  virtual int GetRGBAPixelData(int x,int y,int x2,int y2, int front,
90  virtual int SetRGBAPixelData(int x,int y,int x2,int y2, float *data,
91  int front, int blend=0);
92  virtual int SetRGBAPixelData(int x,int y,int x2,int y2, vtkFloatArray *data,
93  int front, int blend=0);
94  virtual void ReleaseRGBAPixelData(float *data);
95  virtual unsigned char *GetRGBACharPixelData(int x,int y,int x2,int y2,
96  int front);
97  virtual int GetRGBACharPixelData(int x,int y,int x2,int y2, int front,
99  virtual int SetRGBACharPixelData(int x, int y, int x2, int y2,
100  unsigned char *data, int front,
101  int blend=0);
102  virtual int SetRGBACharPixelData(int x,int y,int x2,int y2,
103  vtkUnsignedCharArray *data, int front,
104  int blend=0);
106 
108 
111  virtual float *GetZbufferData( int x1, int y1, int x2, int y2 );
112  virtual int GetZbufferData( int x1, int y1, int x2, int y2, float* z );
113  virtual int GetZbufferData( int x1, int y1, int x2, int y2,
114  vtkFloatArray* z );
115  virtual int SetZbufferData( int x1, int y1, int x2, int y2, float *buffer );
116  virtual int SetZbufferData( int x1, int y1, int x2, int y2,
117  vtkFloatArray *buffer );
119 
120 
124  void ActivateTexture(vtkTextureObject *);
125 
129  void DeactivateTexture(vtkTextureObject *);
130 
134  int GetTextureUnitForTexture(vtkTextureObject *);
135 
139  int GetDepthBufferSize();
140 
145  int GetColorBufferSizes(int *rgba);
146 
148 
151  virtual void SetSize(int a[2]);
152  virtual void SetSize(int,int);
154 
158  virtual void OpenGLInit();
159 
160  // Initialize the state of OpenGL that VTK wants for this window
161  virtual void OpenGLInitState();
162 
163  // Initialize VTK for rendering in a new OpenGL context
164  virtual void OpenGLInitContext();
165 
167 
170  static bool GetContextSupportsOpenGL32();
171  void SetContextSupportsOpenGL32(bool val);
173 
179  void GetOpenGLVersion(int &major, int &minor);
180 
188  unsigned int GetBackLeftBuffer();
189 
197  unsigned int GetBackRightBuffer();
198 
206  unsigned int GetFrontLeftBuffer();
207 
215  unsigned int GetFrontRightBuffer();
216 
224  unsigned int GetBackBuffer();
225 
233  unsigned int GetFrontBuffer();
234 
238  virtual vtkMTimeType GetContextCreationTime();
239 
241 
244  vtkGetObjectMacro(ShaderCache,vtkOpenGLShaderCache);
246 
248 
251  vtkGetMacro(FrameBufferObject, unsigned int);
253 
258  vtkTextureUnitManager *GetTextureUnitManager();
259 
264  virtual void WaitForCompletion();
265 
269  virtual void DrawPixels(int x1, int y1, int x2, int y2,
270  int numComponents, int dataType, void *data);
271 
276  virtual void DrawPixels(
277  int dstXmin, int dstYmin, int dstXmax, int dstYmax,
278  int srcXmin, int srcYmin, int srcXmax, int srcYmax,
279  int srcWidth, int srcHeight, int numComponents, int dataType, void *data);
280 
285  virtual void DrawPixels(
286  int srcWidth, int srcHeight, int numComponents, int dataType, void *data);
287 
291  virtual float GetMaximumHardwareLineWidth() {
292  return this->MaximumHardwareLineWidth; };
293 
300  virtual bool IsPointSpriteBugPresent()
301  {
302  return 0;
303  }
304 
310  int GetDefaultTextureInternalFormat(
311  int vtktype, int numComponents,
312  bool needInteger, bool needFloat);
313 
320  {
321  return this->OpenGLSupportMessage;
322  }
323 
324  // Create and bind offscreen rendering buffers without destroying the current
325  // OpenGL context. This allows to temporary switch to offscreen rendering
326  // (ie. to make a screenshot even if the window is hidden).
327  // Return if the creation was successful (1) or not (0).
328  // Note: This function requires that the device supports OpenGL framebuffer extension.
329  // The function has no effect if OffScreenRendering is ON.
330  virtual int SetUseOffScreenBuffers(bool offScreen);
331  virtual bool GetUseOffScreenBuffers();
332 
336  virtual int SupportsOpenGL();
337 
344  virtual void Initialize(void) {};
345 
346  std::set<vtkGenericOpenGLResourceFreeCallback *> Resources;
347 
349  std::set<vtkGenericOpenGLResourceFreeCallback *>::iterator it
350  = this->Resources.find(cb);
351  if (it == this->Resources.end())
352  {
353  this->Resources.insert(cb);
354  }
355  }
356 
358  std::set<vtkGenericOpenGLResourceFreeCallback *>::iterator it
359  = this->Resources.find(cb);
360  if (it != this->Resources.end())
361  {
362  this->Resources.erase(it);
363  }
364  }
365 
375  virtual void PushContext() { this->MakeCurrent(); }
376  virtual void PopContext() {}
377 
378 protected:
381 
383 
384  // used in testing for opengl support
385  // in the SupportsOpenGL() method
389 
390  int TextureInternalFormats[VTK_UNICODE_STRING][3][5];
391  void InitializeTextureInternalFormats();
392 
393  std::map<const vtkTextureObject *, int> TextureResourceIds;
394 
395  virtual int GetPixelData(int x, int y, int x2, int y2, int front, unsigned char* data);
396  int GetRGBAPixelData(int x, int y, int x2, int y2, int front, float* data);
397  int GetRGBACharPixelData(int x, int y, int x2, int y2, int front,
398  unsigned char* data);
399 
409  int CreateHardwareOffScreenWindow(int width, int height);
410 
411  int CreateHardwareOffScreenBuffers(int width, int height, bool bind = false);
412  void BindHardwareOffScreenBuffers();
413 
419  void DestroyHardwareOffScreenWindow();
420 
421  void UnbindHardwareOffScreenBuffers();
422  void DestroyHardwareOffScreenBuffers();
423 
427  int OffScreenUseFrameBuffer;
428 
430 
433  int NumberOfFrameBuffers;
434  unsigned int TextureObjects[4]; // really GLuint
435  unsigned int FrameBufferObject; // really GLuint
436  unsigned int DepthRenderBufferObject; // really GLuint
437  int HardwareBufferSize[2];
438  bool HardwareOffScreenBuffersBind;
440 
444  virtual void CreateAWindow() = 0;
445 
449  virtual void DestroyWindow() = 0;
450 
455  virtual void ReleaseGraphicsResources(vtkRenderWindow *);
456 
460  void SetTextureUnitManager(vtkTextureUnitManager *textureUnitManager);
461 
462 
466  void SaveGLState();
467 
471  void RestoreGLState();
472 
473  std::map<std::string, int> GLStateIntegers;
474 
475  unsigned int BackLeftBuffer;
476  unsigned int BackRightBuffer;
477  unsigned int FrontLeftBuffer;
478  unsigned int FrontRightBuffer;
479  unsigned int FrontBuffer;
480  unsigned int BackBuffer;
481 
482  #ifndef VTK_LEGACY_REMOVE
483 
487  unsigned int LastGraphicError;
488  #endif
489 
493  int OwnContext;
494 
495  vtkTimeStamp ContextCreationTime;
496 
497  vtkTextureUnitManager *TextureUnitManager;
498 
500 
501  bool Initialized; // ensure glewinit has been called
502 
504 
505 private:
506  vtkOpenGLRenderWindow(const vtkOpenGLRenderWindow&) VTK_DELETE_FUNCTION;
507  void operator=(const vtkOpenGLRenderWindow&) VTK_DELETE_FUNCTION;
508 };
509 
510 #endif
OpenGL rendering window.
Wrapper around std::string to keep symbols short.
Definition: vtkStdString.h:47
virtual int SetUseOffScreenBuffers(bool)
Create and bind offscreen rendering buffers without destroying the current OpenGL context...
manage Shader Programs within a context
virtual unsigned char * GetPixelData(int x, int y, int x2, int y2, int front)=0
Get the pixel data of an image, transmitted as RGBRGBRGB.
void UnregisterGraphicsResources(vtkGenericOpenGLResourceFreeCallback *cb)
record modification and/or execution time
Definition: vtkTimeStamp.h:35
dynamic, self-adjusting array of float
Definition: vtkFloatArray.h:41
std::string GetOpenGLSupportMessage()
Return a message profiding additional details about the results of calling SupportsOpenGL() This can ...
virtual int GetColorBufferSizes(int *rgba)=0
Get the size of the color buffer.
#define VTK_UNICODE_STRING
Definition: vtkType.h:81
virtual int SetRGBAPixelData(int x, int y, int x2, int y2, float *, int front, int blend=0)=0
Same as Get/SetPixelData except that the image also contains an alpha component.
vtkTypeUInt64 vtkMTimeType
Definition: vtkType.h:248
virtual void SetSize(int, int)
Set/Get the size of the window in screen coordinates in pixels.
virtual unsigned char * GetRGBACharPixelData(int x, int y, int x2, int y2, int front)=0
Same as Get/SetPixelData except that the image also contains an alpha component.
virtual int SupportsOpenGL()
Does this render window support OpenGL? 0-false, 1-true.
std::map< const vtkTextureObject *, int > TextureResourceIds
a simple class to control print indentation
Definition: vtkIndent.h:39
The VertexArrayObject class uses, or emulates, vertex array objects.
virtual void ReleaseRGBAPixelData(float *data)=0
Same as Get/SetPixelData except that the image also contains an alpha component.
vtkTextureObject * DrawPixelsTextureObject
list of point or cell ids
Definition: vtkIdList.h:36
virtual void MakeCurrent()=0
Attempt to make this window the current graphics context for the calling thread.
virtual int GetDepthBufferSize()=0
This method should be defined by the subclass.
void PrintSelf(ostream &os, vtkIndent indent)
Methods invoked by print to print information about the object including superclasses.
void RegisterGraphicsResources(vtkGenericOpenGLResourceFreeCallback *cb)
virtual int SetZbufferData(int x, int y, int x2, int y2, float *z)=0
Set/Get the zbuffer data from the frame buffer.
virtual float * GetRGBAPixelData(int x, int y, int x2, int y2, int front)=0
Same as Get/SetPixelData except that the image also contains an alpha component.
handles properties associated with a texture map
Definition: vtkTexture.h:70
virtual void StereoUpdate()
Update the system, if needed, due to stereo rendering.
virtual void PushContext()
Ability to push and pop this window&#39;s context as the current context.
dynamic, self-adjusting array of unsigned char
allocate/free texture units.
vtkOpenGLShaderCache * ShaderCache
abstracts an OpenGL texture object.
create a window for renderers to draw into
OpenGL rendering window.
virtual const char * GetRenderingBackend()
What rendering backend has the user requested.
std::set< vtkGenericOpenGLResourceFreeCallback * > Resources
virtual float GetMaximumHardwareLineWidth()
Return the largest line width supported by the hardware.
virtual float * GetZbufferData(int x, int y, int x2, int y2)=0
Set/Get the zbuffer data from the frame buffer.
virtual int SetPixelData(int x, int y, int x2, int y2, unsigned char *data, int front)=0
Set/Get the pixel data of an image, transmitted as RGBRGBRGB.
virtual int SetRGBACharPixelData(int x, int y, int x2, int y2, unsigned char *data, int front, int blend=0)=0
Same as Get/SetPixelData except that the image also contains an alpha component.
virtual bool GetUseOffScreenBuffers()
virtual void WaitForCompletion()=0
Block the thread until the actual rendering is finished().
virtual bool IsPointSpriteBugPresent()
Returns true if driver has an EGL/OpenGL bug that makes vtkChartsCoreCxx-TestChartDoubleColors and ot...
std::map< std::string, int > GLStateIntegers
The ShaderProgram uses one or more Shader objects.