mlOffscreenRender.h

Go to the documentation of this file.

/*************************************************************************************
**
** Copyright 2007, MeVis Medical Solutions AG
**
** The user may use this file in accordance with the license agreement provided with
** the Software or, alternatively, in accordance with the terms contained in a
** written agreement between the user and MeVis Medical Solutions AG.
**
** For further information use the contact form at https://www.mevislab.de/contact
**
**************************************************************************************/
 
#ifndef ML_OFFSCREEN_RENDER_H
#define ML_OFFSCREEN_RENDER_H
 
// Include specific settings.
#include "MLOffscreenRenderSystem.h"
 
// Include most ml specific things.
#include "mlModuleIncludes.h"
 
 
#include <GL/glew.h>
 
// inventor include goes here
#include <Inventor/actions/SoGLRenderAction.h>
 
// Forward declaration
class SoOffscreenViewerProxyNode;
class SoOffscreenViewerProxy;
class SoPBuffer;
class SoGLRenderAction;
class SoGLFramebufferObject;
class SoGLTexture;
class SoGLRenderbuffer;
 
ML_START_NAMESPACE
 
class MLOFFSCREENRENDER_EXPORT OffscreenRenderer : public Module
{
   ML_MODULE_CLASS_HEADER(OffscreenRenderer)
 
public:
 
   enum ImageType {
      IMG_RGB = 0,
      IMG_RGBA,
      IMG_RGBA_FLOAT,
      NUM_IMAGE_TYPES
   };
 
   // Various levels of transparency rendering quality
   enum TransparencyType {
      SCREEN_DOOR          = SoGLRenderAction::SCREEN_DOOR,
      ADD                  = SoGLRenderAction::ADD,
      DELAYED_ADD          = SoGLRenderAction::DELAYED_ADD,
      SORTED_OBJECT_ADD    = SoGLRenderAction::SORTED_OBJECT_ADD,
      BLEND                = SoGLRenderAction::BLEND,
      DELAYED_BLEND        = SoGLRenderAction::DELAYED_BLEND,
      SORTED_OBJECT_BLEND  = SoGLRenderAction::SORTED_OBJECT_BLEND,
      NUM_TRANSPARENCY_TYPES
   };
 
   enum BufferType {
     AUTO,
     PIXEL_BUFFER,
     NUM_BUFFER_TYPES
   };
 
   static const char *ImageTypeStrings[NUM_IMAGE_TYPES];
 
   static const char *TransparencyTypeStrings[NUM_TRANSPARENCY_TYPES];
 
   static const char *BufferTypeStrings[NUM_BUFFER_TYPES];
 
   OffscreenRenderer(ImageType imgType = IMG_RGB, const Vector2 &size = Vector2(64.,64.), int numInputImages=0, int numOutputImages=1);
 
   ~OffscreenRenderer() override;
 
 
   void handleNotification(Field *) override;
#if ML_DEPRECATED_SINCE(3,6,0)
   using Module::calculateOutputImageProperties;
#endif
   void calculateOutputImageProperties(int outputIndex, PagedImage* outputImage) override;
 
   void calculateOutputSubImage(SubImage *outSubImg, int outIndex, SubImage *inSubImgs) override;
 
   void activateAttachments() override;
 
   void* takeMemoryImage();
 
protected:
 
   BoolField*   _supportedFld;
   SoNodeField* _sceneGraphFld;
   EnumField*   _imageTypeFld;
   EnumField*   _transparencyTypeFld;
   EnumField*   _bufferTypeFld;
   // (we should use an integer type here, but we have no corresponding field type)
   Vector2Field*  _sizeFld;
   FloatField*  _pixelScaleFld;
   ColorField*  _bgColorFld;
   BoolField*   _createStencilBufferFld;
   NotifyField* _updateFld;
   BoolField*   _enableMultiSampling;
   IntField*    _multiSampling;
 
 
protected:
 
   bool _bufferUpToDate;
   bool _useFBO;
 
   SoGLRenderAction* _glRenderAction;
 
   SoRef<SoOffscreenViewerProxyNode> _root;
 
   SoOffscreenViewerProxy *_offscreenProxy;
 
   SoPBuffer*   _pBuffer;
   int          _mode;
   ImageType    _curImgType;
 
   SoGLFramebufferObject*    _fbo;
   SoGLTexture*              _colorTextureBuffer;
   SoGLRenderbuffer*         _depthRenderBuffer;
   bool                      _frameBufferCompletionTested;
   GLuint                    _depthComponent;
   GLenum                    _colorFormat;
 
   SoGLFramebufferObject*    _msaaFbo;
   SoGLRenderbuffer*         _msaaColorBuffer;
 
   unsigned char      *_memImage;
   unsigned int        _memImgBytes;
 
   bool _fboSupportsNonPowerOfTwoDimensions;
   bool _pBufferSupportsNonPowerOfTwoDimensions;
 
protected:
   void _setMode();
 
   bool _createOffscreenBuffer();
 
   bool _createPBuffer(const SbVec2s&);
 
   bool _createFBO(const SbVec2s&);
 
   void _resetOffscreenBuffer();
 
   bool _activateOffscreenBuffer();
   void _deactivateOffscreenBuffer();
 
   bool _renderToOutImage(bool& hasSceneAndUpdatedBuffer);
 
   bool _render(bool& hasSceneAndUpdatedBuffer);
 
   void _updateBufferType();
};
 
 
ML_END_NAMESPACE
 
#endif // of __OFFSCREENRENDER_H