vtkOpenGLFramebufferObject.h

Go to the documentation of this file.

/*=========================================================================

  Program:   Visualization Toolkit
  Module:    vtkOpenGLFramebufferObject.h

  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
  All rights reserved.
  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.

     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notice for more information.

=========================================================================*/
#ifndef vtkOpenGLFramebufferObject_h
#define vtkOpenGLFramebufferObject_h

#ifdef NDEBUG
# define vtkCheckFrameBufferStatusMacro(mode)
# define vtkStaticCheckFrameBufferStatusMacro(mode)
#else
# define vtkCheckFrameBufferStatusMacroImpl(macro, mode)           \
{                                                                  \
const char *eStr;                                                  \
bool ok = vtkOpenGLFramebufferObject::GetFrameBufferStatus(mode, eStr); \
if (!ok)                                                           \
{                                                                \
  macro(                                                           \
    << "OpenGL ERROR. The FBO is incomplete : " << eStr);          \
}                                                                \
 }
# define vtkCheckFrameBufferStatusMacro(mode) \
    vtkCheckFrameBufferStatusMacroImpl(vtkErrorMacro, mode)
# define vtkStaticCheckFrameBufferStatusMacro(mode) \
    vtkCheckFrameBufferStatusMacroImpl(vtkGenericWarningMacro, mode)
#endif


#include "vtkFrameBufferObjectBase.h"
#include "vtkRenderingOpenGL2Module.h" // For export macro
#include "vtkWeakPointer.h" // needed for vtkWeakPointer.
#include <vector> // for the lists of logical buffers.
#include <map> // for the maps

class vtkFOInfo;
class vtkGenericOpenGLResourceFreeCallback;
class vtkOpenGLRenderWindow;
class vtkOpenGLVertexArrayObject;
class vtkPixelBufferObject;
class vtkRenderWindow;
class vtkRenderbuffer;
class vtkShaderProgram;
class vtkTextureObject;
class vtkWindow;

class VTKRENDERINGOPENGL2_EXPORT vtkOpenGLFramebufferObject : public vtkFrameBufferObjectBase
{
public:
  static vtkOpenGLFramebufferObject* New();
  vtkTypeMacro(vtkOpenGLFramebufferObject, vtkFrameBufferObjectBase);
  void PrintSelf(ostream& os, vtkIndent indent) override;


  void SetContext(vtkRenderWindow *context);
  vtkOpenGLRenderWindow *GetContext();

  void Bind();
  void Bind(unsigned int mode);

  void UnBind();
  void UnBind(unsigned int mode);


  void SaveCurrentBindings();
  void SaveCurrentBindings(unsigned int mode);
  void SaveCurrentBindingsAndBuffers() {
    this->SaveCurrentBuffers();
    this->SaveCurrentBindings();
  }
  void SaveCurrentBindingsAndBuffers(unsigned int mode) {
    this->SaveCurrentBuffers(mode);
    this->SaveCurrentBindings(mode);
  }
  void RestorePreviousBindings();
  void RestorePreviousBindings(unsigned int mode);
  void RestorePreviousBindingsAndBuffers() {
    this->RestorePreviousBindings();
    this->RestorePreviousBuffers();
  }
  void RestorePreviousBindingsAndBuffers(unsigned int mode) {
    this->RestorePreviousBindings(mode);
    this->RestorePreviousBuffers(mode);
  }


  void SaveCurrentBuffers();
  void SaveCurrentBuffers(unsigned int mode);
  void RestorePreviousBuffers();
  void RestorePreviousBuffers(unsigned int mode);


  bool Start(int width, int height);
  bool StartNonOrtho(int width, int height);

  void InitializeViewport(int width, int height);

  // activate deactivate draw/read buffers (color buffers)
  void ActivateDrawBuffers(unsigned int n);
  void ActivateDrawBuffers(unsigned int *ids, int n);
  void ActivateDrawBuffer(unsigned int id);
  void ActivateReadBuffer(unsigned int id);
  void ActivateBuffer(unsigned int id) {
    this->ActivateDrawBuffer(id);
    this->ActivateReadBuffer(id); }
  void DeactivateDrawBuffers();
  void DeactivateReadBuffer();

  void RenderQuad(int minX, int maxX, int minY, int maxY,
    vtkShaderProgram *program, vtkOpenGLVertexArrayObject *vao);


  void AddColorAttachment(
        unsigned int mode,
        unsigned int attId,
        vtkTextureObject* tex,
        unsigned int zslice = 0,
        unsigned int format = 0,
        unsigned int mipmapLevel = 0);
  void AddColorAttachment(
        unsigned int mode,
        unsigned int attId,
        vtkRenderbuffer* tex);
  void RemoveColorAttachment(unsigned int mode, unsigned int index);
  void RemoveColorAttachments(unsigned int mode, unsigned int num);

  int GetNumberOfColorAttachments(unsigned int mode);


  void AddDepthAttachment() {
    this->AddDepthAttachment(this->GetBothMode()); }
  void AddDepthAttachment(unsigned int mode);
  void AddDepthAttachment(unsigned int mode, vtkTextureObject* tex);
  void AddDepthAttachment(unsigned int mode, vtkRenderbuffer* tex);
  void RemoveDepthAttachment(unsigned int mode);


  bool PopulateFramebuffer(int width, int height);
  bool PopulateFramebuffer(
    int width,
    int height,
    bool useTextures,
    int numberOfColorAttachments,
    int colorDataType,
    bool wantDepthAttachment,
    int depthBitplanes,
    int multisamples);

  unsigned int GetMaximumNumberOfActiveTargets();

  unsigned int GetMaximumNumberOfRenderTargets();


  int *GetLastSize() override
  {
    vtkDebugMacro(<< this->GetClassName() << " (" << this << "): returning LastSize pointer " << this->LastSize);
    return this->LastSize;
  }
  void GetLastSize(int &_arg1, int &_arg2) override
  {
      _arg1 = this->LastSize[0];
      _arg2 = this->LastSize[1];
    vtkDebugMacro(<< this->GetClassName() << " (" << this << "): returning LastSize (" << _arg1 << "," << _arg2 << ")");
  }
  void GetLastSize (int _arg[2]) override
  {
    this->GetLastSize (_arg[0], _arg[1]);
  }

  static bool IsSupported(vtkOpenGLRenderWindow *) {
      return true; }

  int CheckFrameBufferStatus(unsigned int mode);

  virtual void ReleaseGraphicsResources(vtkWindow *win);

  static
  bool GetFrameBufferStatus(
        unsigned int mode,
        const char *&desc);

  static int Blit(
    const int srcExt[4], const int destExt[4], unsigned int bits, unsigned int mapping);

  vtkPixelBufferObject *DownloadColor1(
        int extent[4],
        int vtkType,
        int channel);

  vtkPixelBufferObject *DownloadColor3(
        int extent[4],
        int vtkType);

  vtkPixelBufferObject *DownloadColor4(
        int extent[4],
        int vtkType);

  vtkPixelBufferObject *DownloadDepth(
        int extent[4],
        int vtkType);

  vtkPixelBufferObject *Download(
        int extent[4],
        int vtkType,
        int nComps,
        int oglType,
        int oglFormat);

  static
  void Download(
        int extent[4],
        int vtkType,
        int nComps,
        int oglType,
        int oglFormat,
        vtkPixelBufferObject *pbo);

  // returns the mode values for draw/read/both
  // Can be used in cases where you do not
  // want to have OpenGL code mixed in.
  static unsigned int GetDrawMode();
  static unsigned int GetReadMode();
  static unsigned int GetBothMode();

  void Resize(int width, int height);

  // Deprecated
  void RemoveTexColorAttachments(unsigned int mode, unsigned int num)
    { this->RemoveColorAttachments(mode, num); }
  void RemoveTexColorAttachment(unsigned int mode, unsigned int attId)
    { this->RemoveColorAttachment(mode, attId); }
  void RemoveRenDepthAttachment(unsigned int mode)
    { this->RemoveDepthAttachment(mode); }
  void RemoveTexDepthAttachment(unsigned int mode)
    { this->RemoveDepthAttachment(mode); }

protected:
  void SetColorBuffer(unsigned int mode,
    unsigned int index, vtkTextureObject *texture,
    unsigned int zslice=0, unsigned int format=0, unsigned int mipmapLevel=0);
  void SetColorBuffer(unsigned int mode,
    unsigned int index, vtkRenderbuffer *rb);
  void SetDepthBuffer(unsigned int mode, vtkTextureObject *depthTexture);
  void SetDepthBuffer(unsigned int mode, vtkRenderbuffer *depthBuffer);

  void Attach();

  void AttachColorBuffer(unsigned int mode, unsigned int index);
  void AttachDepthBuffer(unsigned int mode);

  static
  bool LoadRequiredExtensions(vtkOpenGLRenderWindow *) {
    return true; };

  vtkGenericOpenGLResourceFreeCallback *ResourceCallback;

  // gen buffer (occurs when context is set)
  void CreateFBO();

  // delete buffer (occurs during destruction or context swicth)
  void DestroyFBO();

  // detach and delete our reference(s)
  void DestroyDepthBuffer(vtkWindow *win);
  void DestroyColorBuffers(vtkWindow *win);

  // glDrawBuffers
  void ActivateBuffers();

  // examine attachments to see if they have the same size
  void UpdateSize();

  void DisplayFrameBufferAttachments();

  void DisplayFrameBufferAttachment(unsigned int uattachment);

  void DisplayDrawBuffers();

  void DisplayReadBuffer();

  void DisplayBuffer(int value);

  int GetOpenGLType(int vtkType);

  vtkOpenGLFramebufferObject();
  ~vtkOpenGLFramebufferObject() override;

  vtkWeakPointer<vtkOpenGLRenderWindow> Context;

  unsigned int FBOIndex;

  unsigned int PreviousDrawFBO;
  unsigned int PreviousReadFBO;
  bool DrawBindingSaved;
  bool ReadBindingSaved;
  unsigned int PreviousDrawBuffer;
  unsigned int PreviousReadBuffer;
  bool DrawBufferSaved;
  bool ReadBufferSaved;

  int LastSize[2];
  std::vector<unsigned int> ActiveBuffers;

  vtkFOInfo *DrawDepthBuffer;
  vtkFOInfo *ReadDepthBuffer;
  std::map<unsigned int, vtkFOInfo *> DrawColorBuffers;
  std::map<unsigned int, vtkFOInfo *> ReadColorBuffers;

private:
  vtkOpenGLFramebufferObject(const vtkOpenGLFramebufferObject&) = delete;
  void operator=(const vtkOpenGLFramebufferObject&) = delete;
};

#endif