vtkFrameBufferObject2.h

Go to the documentation of this file.

/*=========================================================================
 
  Program:   Visualization Toolkit
  Module:    vtkFrameBufferObject2.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 vtkFrameBufferObject2_h
#define vtkFrameBufferObject2_h
 
#include "vtkObject.h"
#include "vtkRenderingOpenGL2Module.h" // For export macro
#include "vtkSmartPointer.h" // needed for vtkSmartPointer.
#include "vtkWeakPointer.h" // needed for vtkWeakPointer.
 
 
#ifdef NDEBUG
# define vtkCheckFrameBufferStatusMacro(mode)
# define vtkStaticCheckFrameBufferStatusMacro(mode)
#else
# define vtkCheckFrameBufferStatusMacroImpl(macro, mode)           \
{                                                                  \
const char *eStr;                                                  \
bool ok = vtkFrameBufferObject2::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
 
 
class vtkRenderWindow;
class vtkTextureObject;
class vtkRenderbuffer;
class vtkPixelBufferObject;
class vtkOpenGLRenderWindow;
 
class VTKRENDERINGOPENGL2_EXPORT vtkFrameBufferObject2 : public vtkObject
{
public:
  static vtkFrameBufferObject2* New();
  vtkTypeMacro(vtkFrameBufferObject2, vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent);
 
 
  void SetContext(vtkRenderWindow *context);
  vtkRenderWindow *GetContext();
 
  static bool IsSupported(vtkRenderWindow *renWin);
 
  void Bind(unsigned int mode);
 
  void UnBind(unsigned int mode);
 
  void SaveCurrentBindings();
 
 
  void SaveCurrentBuffers();
  void RestorePreviousBuffers(unsigned int mode);
 
 
  void AddColorAttachment(
        unsigned int mode,
        unsigned int attId,
        vtkTextureObject* tex);
 
  void AddTexColorAttachment(
        unsigned int mode,
        unsigned int attId,
        unsigned int handle);
 
  void RemoveTexColorAttachments(unsigned int mode, unsigned int num);
  void RemoveTexColorAttachment(unsigned int mode, unsigned int attId)
    { this->AddTexColorAttachment(mode, attId, 0U); }
 
 
  void AddColorAttachment(
        unsigned int mode,
        unsigned int attId,
        vtkRenderbuffer* tex);
 
  void AddRenColorAttachment(
        unsigned int mode,
        unsigned int attId,
        unsigned int handle);
 
  void RemoveRenColorAttachments(unsigned int mode, unsigned int num);
  void RemoveRenColorAttachment(unsigned int mode, unsigned int attId)
    { this->AddRenColorAttachment(mode, attId, 0U); }
 
 
  void AddDepthAttachment(unsigned int mode, vtkTextureObject* tex);
  void AddTexDepthAttachment(unsigned int mode, unsigned int handle);
  void RemoveTexDepthAttachment(unsigned int mode)
    { this->AddTexDepthAttachment(mode, 0U); }
 
 
  void AddDepthAttachment(unsigned int mode, vtkRenderbuffer* tex);
  void AddRenDepthAttachment(unsigned int mode, unsigned int handle);
  void RemoveRenDepthAttachment(unsigned int mode)
    { this->AddRenDepthAttachment(mode, 0U); }
 
 
  void ActivateDrawBuffer(unsigned int id);
  void ActivateReadBuffer(unsigned int id);
  void DeactivateReadBuffer();
 
 
  void ActivateDrawBuffers(unsigned int n);
  void ActivateDrawBuffers(unsigned int *ids, int n);
  void DeactivateDrawBuffers();
 
 
  static
  void InitializeViewport(int width, int height);
 
  int CheckFrameBufferStatus(unsigned int mode);
 
 
  static
  bool GetFrameBufferStatus(
        unsigned int mode,
        const char *&desc);
 
 
  static
  int Blit(
        int srcExt[4],
        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);
 
//BTX
protected:
 
  static
  bool LoadRequiredExtensions(vtkRenderWindow *renWin);
 
  // gen buffer (occurs when context is set)
  void CreateFBO();
 
  // delete buffer (occurs during destruction or context swicth)
  void DestroyFBO();
 
 
  int GetOpenGLType(int vtkType);
 
  vtkFrameBufferObject2();
  ~vtkFrameBufferObject2();
 
  vtkWeakPointer<vtkRenderWindow> Context;
 
  unsigned int FBOIndex;
  unsigned int PreviousDrawFBO;
  unsigned int PreviousReadFBO;
  unsigned int DepthBuffer;
  unsigned int PreviousDrawBuffer;
  unsigned int PreviousReadBuffer;
 
private:
  vtkFrameBufferObject2(const vtkFrameBufferObject2&); // Not implemented.
  void operator=(const vtkFrameBufferObject2&); // Not implemented.
 
  friend class vtkRenderbuffer; // needs access to LoadRequiredExtentsions
//ETX
};
 
#endif