VTK  9.2.6
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=========================================================================*/
132#ifndef vtkOpenGLFramebufferObject_h
133#define vtkOpenGLFramebufferObject_h
134
135/* Dec 2018 this class has been cleaned up such that
136 * AddColorAttachment and AddDepthAttachment no longer
137 * take a mode argument. The mode is determined by how
138 * the framebuffer is bound. If you are using these methods
139 * and need to support both the old and new signatures you
140 * can check for the following define in your code.
141 */
142#define VTK_UPDATED_FRAMEBUFFER
143
150#ifdef NDEBUG
151#define vtkCheckFrameBufferStatusMacro(mode)
152#define vtkStaticCheckFrameBufferStatusMacro(mode)
153#else
154#define vtkCheckFrameBufferStatusMacroImpl(macro, mode) \
155 { \
156 const char* eStr; \
157 bool ok = vtkOpenGLFramebufferObject::GetFrameBufferStatus(mode, eStr); \
158 if (!ok) \
159 { \
160 macro(<< "OpenGL ERROR. The FBO is incomplete : " << eStr); \
161 } \
162 }
163#define vtkCheckFrameBufferStatusMacro(mode) vtkCheckFrameBufferStatusMacroImpl(vtkErrorMacro, mode)
164#define vtkStaticCheckFrameBufferStatusMacro(mode) \
165 vtkCheckFrameBufferStatusMacroImpl(vtkGenericWarningMacro, mode)
166#endif
167
169#include "vtkRenderingOpenGL2Module.h" // For export macro
170#include <map> // for the maps
171#include <vector> // for the lists of logical buffers.
172
173class vtkFOInfo;
178class vtkRenderWindow;
179class vtkRenderbuffer;
180class vtkShaderProgram;
181class vtkTextureObject;
182class vtkWindow;
183
184class VTKRENDERINGOPENGL2_EXPORT vtkOpenGLFramebufferObject : public vtkFrameBufferObjectBase
185{
186public:
189 void PrintSelf(ostream& os, vtkIndent indent) override;
190
192
202
206 void Bind();
207 void Bind(unsigned int mode);
208
212 void UnBind();
213 void UnBind(unsigned int mode);
214
216
220 void SaveCurrentBindingsAndBuffers(unsigned int mode);
222 void RestorePreviousBindingsAndBuffers(unsigned int mode);
224
226
235 bool Start(int width, int height);
236 bool StartNonOrtho(int width, int height);
238
243 void InitializeViewport(int width, int height);
244
246 // activate deactivate draw/read buffers (color buffers)
247 void ActivateDrawBuffers(unsigned int n);
248 void ActivateDrawBuffers(unsigned int* ids, int n);
249 void ActivateDrawBuffer(unsigned int id);
250 void ActivateReadBuffer(unsigned int id);
251 void ActivateBuffer(unsigned int id)
252 {
253 this->ActivateDrawBuffer(id);
254 this->ActivateReadBuffer(id);
255 }
259
260 vtkGetMacro(ActiveReadBuffer, unsigned int);
261 unsigned int GetActiveDrawBuffer(unsigned int id);
262
273 void RenderQuad(int minX, int maxX, int minY, int maxY, vtkShaderProgram* program,
275
277
280 void AddColorAttachment(unsigned int attId, vtkTextureObject* tex, unsigned int zslice = 0,
281 unsigned int format = 0, unsigned int mipmapLevel = 0);
282 void AddColorAttachment(unsigned int attId, vtkRenderbuffer* tex);
283 void RemoveColorAttachment(unsigned int index);
284 void RemoveColorAttachments(unsigned int num);
286
292
297
299
308
310
315 bool PopulateFramebuffer(int width, int height);
316 bool PopulateFramebuffer(int width, int height, bool useTextures, int numberOfColorAttachments,
317 int colorDataType, bool wantDepthAttachment, int depthBitplanes, int multisamples,
318 bool wantStencilAttachment = false);
320
327
334
336
339 int* GetLastSize() override
340 {
341 vtkDebugMacro(<< this->GetClassName() << " (" << this << "): returning LastSize pointer "
342 << this->LastSize);
343 return this->LastSize;
344 }
345 void GetLastSize(int& _arg1, int& _arg2) override
346 {
347 _arg1 = this->LastSize[0];
348 _arg2 = this->LastSize[1];
349 vtkDebugMacro(<< this->GetClassName() << " (" << this << "): returning LastSize (" << _arg1
350 << "," << _arg2 << ")");
351 }
352 void GetLastSize(int _arg[2]) override { this->GetLastSize(_arg[0], _arg[1]); }
354
359 static bool IsSupported(vtkOpenGLRenderWindow*) { return true; }
360
365 int CheckFrameBufferStatus(unsigned int mode);
366
371
378 static bool GetFrameBufferStatus(unsigned int mode, const char*& desc);
379
380 vtkGetMacro(FBOIndex, unsigned int);
381
388 static int Blit(
389 const int srcExt[4], const int destExt[4], unsigned int bits, unsigned int mapping);
390
399 vtkPixelBufferObject* DownloadColor1(int extent[4], int vtkType, int channel);
400
401 vtkPixelBufferObject* DownloadColor3(int extent[4], int vtkType);
402
403 vtkPixelBufferObject* DownloadColor4(int extent[4], int vtkType);
404
410 vtkPixelBufferObject* DownloadDepth(int extent[4], int vtkType);
411
420 int extent[4], int vtkType, int nComps, int oglType, int oglFormat);
421
422 static void Download(
423 int extent[4], int vtkType, int nComps, int oglType, int oglFormat, vtkPixelBufferObject* pbo);
424
425 // returns the mode values for draw/read/both
426 // Can be used in cases where you do not
427 // want to have OpenGL code mixed in.
428 static unsigned int GetDrawMode();
429 static unsigned int GetReadMode();
430 static unsigned int GetBothMode();
431
435 void Resize(int width, int height);
436
438
439protected:
443 void AttachColorBuffer(unsigned int index);
445
449 static bool LoadRequiredExtensions(vtkOpenGLRenderWindow*) { return true; }
450
452
453 // gen buffer (occurs when context is set)
454 void CreateFBO();
455
456 // delete buffer (occurs during destruction or context switch)
458
459 // detach and delete our reference(s)
462
463 // glDrawBuffers
465
466 // examine attachments to see if they have the same size
468
473
477 void DisplayFrameBufferAttachment(unsigned int uattachment);
478
483
488
492 void DisplayBuffer(int value);
493
497 int GetOpenGLType(int vtkType);
498
501
503
504 unsigned int FBOIndex;
505
510
511 int LastSize[2];
512 std::vector<unsigned int> ActiveBuffers;
513 unsigned int ActiveReadBuffer;
514
515 vtkFOInfo* DepthBuffer;
516 std::map<unsigned int, vtkFOInfo*> ColorBuffers;
517
518private:
520 void operator=(const vtkOpenGLFramebufferObject&) = delete;
521};
522
523#endif
abstract interface to OpenGL FBOs
a simple class to control print indentation
Definition: vtkIndent.h:40
const char * GetClassName() const
Return the class name as a string.
Internal class which encapsulates OpenGL FramebufferObject.
void Bind()
Make the draw frame buffer active.
void ActivateDrawBuffer(unsigned int id)
~vtkOpenGLFramebufferObject() override
std::vector< unsigned int > ActiveBuffers
void SaveCurrentBindingsAndBuffers(unsigned int mode)
Store/Restore the current framebuffer bindings and buffers.
void AttachColorBuffer(unsigned int index)
Attach a specific buffer.
static bool IsSupported(vtkOpenGLRenderWindow *)
Returns if the context supports the required extensions.
vtkPixelBufferObject * DownloadColor4(int extent[4], int vtkType)
void ActivateDrawBuffers(unsigned int *ids, int n)
void UnBind()
Unbind this buffer.
void InitializeViewport(int width, int height)
Set up ortho viewport with scissor, lighting, blend, and depth disabled.
void RestorePreviousBindingsAndBuffers(unsigned int mode)
Store/Restore the current framebuffer bindings and buffers.
void UnBind(unsigned int mode)
void GetLastSize(int &_arg1, int &_arg2) override
Dimensions in pixels of the framebuffer.
static void Download(int extent[4], int vtkType, int nComps, int oglType, int oglFormat, vtkPixelBufferObject *pbo)
void RemoveColorAttachment(unsigned int index)
Directly assign/remove a texture to color attachments.
int * GetLastSize() override
Dimensions in pixels of the framebuffer.
void Bind(unsigned int mode)
void DisplayFrameBufferAttachment(unsigned int uattachment)
Display a given attachment for the current framebuffer object.
void AddDepthAttachment(vtkTextureObject *tex)
Directly assign/remove a texture/renderbuffer to depth attachments.
void RemoveColorAttachments(unsigned int num)
Directly assign/remove a texture to color attachments.
bool StartNonOrtho(int width, int height)
User must take care that width/height match the dimensions of the user defined texture attachments.
vtkPixelBufferObject * DownloadDepth(int extent[4], int vtkType)
Download data from the depth attachment of the currently bound FBO.
void DisplayDrawBuffers()
Display the draw buffers.
vtkTextureObject * GetDepthAttachmentAsTextureObject()
Directly assign/remove a texture/renderbuffer to depth attachments.
void RenderQuad(int minX, int maxX, int minY, int maxY, vtkShaderProgram *program, vtkOpenGLVertexArrayObject *vao)
Renders a quad at the given location with pixel coordinates.
void DestroyDepthBuffer(vtkWindow *win)
bool PopulateFramebuffer(int width, int height)
Convenience method to populate a framebuffer with attachments created as well.
void GetLastSize(int _arg[2]) override
Dimensions in pixels of the framebuffer.
static unsigned int GetBothMode()
int CheckFrameBufferStatus(unsigned int mode)
Validate the current FBO configuration (attachments, formats, etc) prints detected errors to vtkError...
void DisplayFrameBufferAttachments()
Display all the attachments of the current framebuffer object.
void DisplayReadBuffer()
Display the read buffer.
vtkGenericOpenGLResourceFreeCallback * ResourceCallback
bool PopulateFramebuffer(int width, int height, bool useTextures, int numberOfColorAttachments, int colorDataType, bool wantDepthAttachment, int depthBitplanes, int multisamples, bool wantStencilAttachment=false)
Convenience method to populate a framebuffer with attachments created as well.
static int Blit(const int srcExt[4], const int destExt[4], unsigned int bits, unsigned int mapping)
Copy from the currently bound READ FBO to the currently bound DRAW FBO.
static bool LoadRequiredExtensions(vtkOpenGLRenderWindow *)
Load all necessary extensions.
vtkTextureObject * GetColorAttachmentAsTextureObject(unsigned int num)
Return the texture object bound to the passed attachment number.
int GetOpenGLType(int vtkType)
Given a vtk type get a compatible open gl type.
void Resize(int width, int height)
Resize all FO attachments.
bool Start(int width, int height)
User must take care that width/height match the dimensions of the user defined texture attachments.
void ActivateDrawBuffers(unsigned int n)
static unsigned int GetDrawMode()
unsigned int GetActiveDrawBuffer(unsigned int id)
static bool GetFrameBufferStatus(unsigned int mode, const char *&desc)
Validate the current FBO configuration (attachments, formats, etc) return false if the FBO is incompl...
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
void AddDepthAttachment()
Directly assign/remove a texture/renderbuffer to depth attachments.
vtkPixelBufferObject * Download(int extent[4], int vtkType, int nComps, int oglType, int oglFormat)
Download data from the read buffer of the current FBO.
static vtkOpenGLFramebufferObject * New()
virtual void ReleaseGraphicsResources(vtkWindow *win)
Deactivate and UnBind.
vtkPixelBufferObject * DownloadColor1(int extent[4], int vtkType, int channel)
Download data from the read color attachment of the currently bound FBO into the returned PBO.
std::map< unsigned int, vtkFOInfo * > ColorBuffers
void DestroyColorBuffers(vtkWindow *win)
int GetNumberOfColorAttachments()
Return the number of color attachments for the given mode.
void DisplayBuffer(int value)
Display any buffer (convert value into string).
unsigned int GetMaximumNumberOfRenderTargets()
Returns the maximum number of render targets available.
void SaveCurrentBindingsAndBuffers()
Store/Restore the current framebuffer bindings and buffers.
void AddColorAttachment(unsigned int attId, vtkRenderbuffer *tex)
Directly assign/remove a texture to color attachments.
void AddDepthAttachment(vtkRenderbuffer *tex)
Directly assign/remove a texture/renderbuffer to depth attachments.
vtkPixelBufferObject * DownloadColor3(int extent[4], int vtkType)
void RemoveDepthAttachment()
Directly assign/remove a texture/renderbuffer to depth attachments.
void AddColorAttachment(unsigned int attId, vtkTextureObject *tex, unsigned int zslice=0, unsigned int format=0, unsigned int mipmapLevel=0)
Directly assign/remove a texture to color attachments.
unsigned int GetMaximumNumberOfActiveTargets()
Returns the maximum number of targets that can be rendered to at one time.
void SetContext(vtkRenderWindow *context)
Get/Set the context.
void ActivateReadBuffer(unsigned int id)
void RestorePreviousBindingsAndBuffers()
Store/Restore the current framebuffer bindings and buffers.
vtkOpenGLRenderWindow * GetContext()
Get/Set the context.
static unsigned int GetReadMode()
OpenGL rendering window.
The VertexArrayObject class uses, or emulates, vertex array objects.
abstracts an OpenGL pixel buffer object.
create a window for renderers to draw into
Storage for FBO's.
The ShaderProgram uses one or more Shader objects.
abstracts an OpenGL texture object.
window superclass for vtkRenderWindow
Definition: vtkWindow.h:39