VTK  9.0.1
vtkOpenGLFramebufferObject.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkOpenGLFramebufferObject.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 =========================================================================*/
129 #ifndef vtkOpenGLFramebufferObject_h
130 #define vtkOpenGLFramebufferObject_h
131 
132 /* Dec 2018 this class has been cleaned up such that
133  * AddColorAttachment and AddDepthAttachment no longer
134  * take a mode argument. The mode is determined by how
135  * the framebuffer is bound. If you are using these methods
136  * and need to support both the old and new signatures you
137  * can check for the following define in your code.
138  */
139 #define VTK_UPDATED_FRAMEBUFFER
140 
147 #ifdef NDEBUG
148 #define vtkCheckFrameBufferStatusMacro(mode)
149 #define vtkStaticCheckFrameBufferStatusMacro(mode)
150 #else
151 #define vtkCheckFrameBufferStatusMacroImpl(macro, mode) \
152  { \
153  const char* eStr; \
154  bool ok = vtkOpenGLFramebufferObject::GetFrameBufferStatus(mode, eStr); \
155  if (!ok) \
156  { \
157  macro(<< "OpenGL ERROR. The FBO is incomplete : " << eStr); \
158  } \
159  }
160 #define vtkCheckFrameBufferStatusMacro(mode) vtkCheckFrameBufferStatusMacroImpl(vtkErrorMacro, mode)
161 #define vtkStaticCheckFrameBufferStatusMacro(mode) \
162  vtkCheckFrameBufferStatusMacroImpl(vtkGenericWarningMacro, mode)
163 #endif
164 
166 #include "vtkRenderingOpenGL2Module.h" // For export macro
167 #include <map> // for the maps
168 #include <vector> // for the lists of logical buffers.
169 
170 class vtkFOInfo;
175 class vtkRenderWindow;
176 class vtkRenderbuffer;
177 class vtkShaderProgram;
178 class vtkTextureObject;
179 class vtkWindow;
180 
181 class VTKRENDERINGOPENGL2_EXPORT vtkOpenGLFramebufferObject : public vtkFrameBufferObjectBase
182 {
183 public:
186  void PrintSelf(ostream& os, vtkIndent indent) override;
187 
189 
196  void SetContext(vtkRenderWindow* context);
197  vtkOpenGLRenderWindow* GetContext();
199 
203  void Bind();
204  void Bind(unsigned int mode);
205 
209  void UnBind();
210  void UnBind(unsigned int mode);
211 
213 
216  void SaveCurrentBindingsAndBuffers();
217  void SaveCurrentBindingsAndBuffers(unsigned int mode);
218  void RestorePreviousBindingsAndBuffers();
219  void RestorePreviousBindingsAndBuffers(unsigned int mode);
221 
223 
232  bool Start(int width, int height);
233  bool StartNonOrtho(int width, int height);
235 
240  void InitializeViewport(int width, int height);
241 
243  // activate deactivate draw/read buffers (color buffers)
244  void ActivateDrawBuffers(unsigned int n);
245  void ActivateDrawBuffers(unsigned int* ids, int n);
246  void ActivateDrawBuffer(unsigned int id);
247  void ActivateReadBuffer(unsigned int id);
248  void ActivateBuffer(unsigned int id)
249  {
250  this->ActivateDrawBuffer(id);
251  this->ActivateReadBuffer(id);
252  }
253  void DeactivateDrawBuffers();
254  void DeactivateReadBuffer();
256 
257  vtkGetMacro(ActiveReadBuffer, unsigned int);
258  unsigned int GetActiveDrawBuffer(unsigned int id);
259 
270  void RenderQuad(int minX, int maxX, int minY, int maxY, vtkShaderProgram* program,
272 
274 
277  void AddColorAttachment(unsigned int attId, vtkTextureObject* tex, unsigned int zslice = 0,
278  unsigned int format = 0, unsigned int mipmapLevel = 0);
279  void AddColorAttachment(unsigned int attId, vtkRenderbuffer* tex);
280  void RemoveColorAttachment(unsigned int index);
281  void RemoveColorAttachments(unsigned int num);
283 
287  int GetNumberOfColorAttachments();
288 
290 
293  void AddDepthAttachment();
294  void AddDepthAttachment(vtkTextureObject* tex);
295  void AddDepthAttachment(vtkRenderbuffer* tex);
296  void RemoveDepthAttachment();
298 
300 
305  bool PopulateFramebuffer(int width, int height);
306  bool PopulateFramebuffer(int width, int height, bool useTextures, int numberOfColorAttachments,
307  int colorDataType, bool wantDepthAttachment, int depthBitplanes, int multisamples,
308  bool wantStencilAttachment = false);
310 
316  unsigned int GetMaximumNumberOfActiveTargets();
317 
323  unsigned int GetMaximumNumberOfRenderTargets();
324 
326 
329  int* GetLastSize() override
330  {
331  vtkDebugMacro(<< this->GetClassName() << " (" << this << "): returning LastSize pointer "
332  << this->LastSize);
333  return this->LastSize;
334  }
335  void GetLastSize(int& _arg1, int& _arg2) override
336  {
337  _arg1 = this->LastSize[0];
338  _arg2 = this->LastSize[1];
339  vtkDebugMacro(<< this->GetClassName() << " (" << this << "): returning LastSize (" << _arg1
340  << "," << _arg2 << ")");
341  }
342  void GetLastSize(int _arg[2]) override { this->GetLastSize(_arg[0], _arg[1]); }
344 
349  static bool IsSupported(vtkOpenGLRenderWindow*) { return true; }
350 
355  int CheckFrameBufferStatus(unsigned int mode);
356 
360  virtual void ReleaseGraphicsResources(vtkWindow* win);
361 
368  static bool GetFrameBufferStatus(unsigned int mode, const char*& desc);
369 
370  vtkGetMacro(FBOIndex, unsigned int);
371 
378  static int Blit(
379  const int srcExt[4], const int destExt[4], unsigned int bits, unsigned int mapping);
380 
389  vtkPixelBufferObject* DownloadColor1(int extent[4], int vtkType, int channel);
390 
391  vtkPixelBufferObject* DownloadColor3(int extent[4], int vtkType);
392 
393  vtkPixelBufferObject* DownloadColor4(int extent[4], int vtkType);
394 
400  vtkPixelBufferObject* DownloadDepth(int extent[4], int vtkType);
401 
409  vtkPixelBufferObject* Download(
410  int extent[4], int vtkType, int nComps, int oglType, int oglFormat);
411 
412  static void Download(
413  int extent[4], int vtkType, int nComps, int oglType, int oglFormat, vtkPixelBufferObject* pbo);
414 
415  // returns the mode values for draw/read/both
416  // Can be used in cases where you do not
417  // want to have OpenGL code mixed in.
418  static unsigned int GetDrawMode();
419  static unsigned int GetReadMode();
420  static unsigned int GetBothMode();
421 
425  void Resize(int width, int height);
426 
427  int GetMultiSamples();
428 
429 protected:
433  void AttachColorBuffer(unsigned int index);
434  void AttachDepthBuffer();
435 
439  static bool LoadRequiredExtensions(vtkOpenGLRenderWindow*) { return true; }
440 
442 
443  // gen buffer (occurs when context is set)
444  void CreateFBO();
445 
446  // delete buffer (occurs during destruction or context switch)
447  void DestroyFBO();
448 
449  // detach and delete our reference(s)
450  void DestroyDepthBuffer(vtkWindow* win);
451  void DestroyColorBuffers(vtkWindow* win);
452 
453  // glDrawBuffers
454  void ActivateBuffers();
455 
456  // examine attachments to see if they have the same size
457  void UpdateSize();
458 
462  void DisplayFrameBufferAttachments();
463 
467  void DisplayFrameBufferAttachment(unsigned int uattachment);
468 
472  void DisplayDrawBuffers();
473 
477  void DisplayReadBuffer();
478 
482  void DisplayBuffer(int value);
483 
487  int GetOpenGLType(int vtkType);
488 
490  ~vtkOpenGLFramebufferObject() override;
491 
493 
494  unsigned int FBOIndex;
495 
500 
501  int LastSize[2];
502  std::vector<unsigned int> ActiveBuffers;
503  unsigned int ActiveReadBuffer;
504 
505  vtkFOInfo* DepthBuffer;
506  std::map<unsigned int, vtkFOInfo*> ColorBuffers;
507 
508 private:
510  void operator=(const vtkOpenGLFramebufferObject&) = delete;
511 };
512 
513 #endif
vtkOpenGLFramebufferObject::GetLastSize
int * GetLastSize() override
Dimensions in pixels of the framebuffer.
Definition: vtkOpenGLFramebufferObject.h:329
vtkFrameBufferObjectBase::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkOpenGLFramebufferObject::DrawBufferSaved
bool DrawBufferSaved
Definition: vtkOpenGLFramebufferObject.h:498
vtkX3D::value
@ value
Definition: vtkX3D.h:226
vtkOpenGLFramebufferObject::DrawBindingSaved
bool DrawBindingSaved
Definition: vtkOpenGLFramebufferObject.h:496
vtkObject::New
static vtkObject * New()
Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
vtkOpenGLFramebufferObject
Internal class which encapsulates OpenGL FramebufferObject.
Definition: vtkOpenGLFramebufferObject.h:181
vtkOpenGLFramebufferObject::GetLastSize
void GetLastSize(int _arg[2]) override
Definition: vtkOpenGLFramebufferObject.h:342
vtkOpenGLFramebufferObject::LoadRequiredExtensions
static bool LoadRequiredExtensions(vtkOpenGLRenderWindow *)
Load all necessary extensions.
Definition: vtkOpenGLFramebufferObject.h:439
vtkFrameBufferObjectBase
abstract interface to OpenGL FBOs
Definition: vtkFrameBufferObjectBase.h:32
vtkWindow
window superclass for vtkRenderWindow
Definition: vtkWindow.h:37
vtkObjectBase::GetClassName
const char * GetClassName() const
Return the class name as a string.
vtkX3D::height
@ height
Definition: vtkX3D.h:260
vtkOpenGLFramebufferObject::ReadBufferSaved
bool ReadBufferSaved
Definition: vtkOpenGLFramebufferObject.h:499
vtkShaderProgram
The ShaderProgram uses one or more Shader objects.
Definition: vtkShaderProgram.h:44
vtkGenericOpenGLResourceFreeCallback
Definition: vtkOpenGLResourceFreeCallback.h:25
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:33
vtkTextureObject
abstracts an OpenGL texture object.
Definition: vtkTextureObject.h:40
vtkOpenGLFramebufferObject::IsSupported
static bool IsSupported(vtkOpenGLRenderWindow *)
Returns if the context supports the required extensions.
Definition: vtkOpenGLFramebufferObject.h:349
vtkOpenGLFramebufferObject::DepthBuffer
vtkFOInfo * DepthBuffer
Definition: vtkOpenGLFramebufferObject.h:505
vtkOpenGLFramebufferObject::ResourceCallback
vtkGenericOpenGLResourceFreeCallback * ResourceCallback
Definition: vtkOpenGLFramebufferObject.h:441
vtkOpenGLFramebufferObject::ActiveReadBuffer
unsigned int ActiveReadBuffer
Definition: vtkOpenGLFramebufferObject.h:503
vtkOpenGLFramebufferObject::ReadBindingSaved
bool ReadBindingSaved
Definition: vtkOpenGLFramebufferObject.h:497
vtkOpenGLFramebufferObject::FBOIndex
unsigned int FBOIndex
Definition: vtkOpenGLFramebufferObject.h:494
vtkFrameBufferObjectBase.h
vtkOpenGLFramebufferObject::ColorBuffers
std::map< unsigned int, vtkFOInfo * > ColorBuffers
Definition: vtkOpenGLFramebufferObject.h:506
vtkX3D::mode
@ mode
Definition: vtkX3D.h:253
vtkOpenGLRenderWindow
OpenGL rendering window.
Definition: vtkOpenGLRenderWindow.h:51
vtkX3D::extent
@ extent
Definition: vtkX3D.h:351
vtkRenderWindow
create a window for renderers to draw into
Definition: vtkRenderWindow.h:93
vtkOpenGLFramebufferObject::GetLastSize
void GetLastSize(int &_arg1, int &_arg2) override
Definition: vtkOpenGLFramebufferObject.h:335
vtkOpenGLFramebufferObject::ActiveBuffers
std::vector< unsigned int > ActiveBuffers
Definition: vtkOpenGLFramebufferObject.h:502
vtkX3D::index
@ index
Definition: vtkX3D.h:252
vtkOpenGLVertexArrayObject
The VertexArrayObject class uses, or emulates, vertex array objects.
Definition: vtkOpenGLVertexArrayObject.h:36
vtkPixelBufferObject
abstracts an OpenGL pixel buffer object.
Definition: vtkPixelBufferObject.h:43
vtkRenderbuffer
Storage for FBO's.
Definition: vtkRenderbuffer.h:32
vtkOpenGLFramebufferObject::ActivateBuffer
void ActivateBuffer(unsigned int id)
Definition: vtkOpenGLFramebufferObject.h:248
vtkOpenGLFramebufferObject::Context
vtkOpenGLRenderWindow * Context
Definition: vtkOpenGLFramebufferObject.h:492