bufferedRenderer.h

Go to the documentation of this file.

// -*- Mode: C++; tab-width: 2; -*-
// vi: set ts=2:
//

#ifndef BALL_VIEW_RENDERING_RENDERERS_BUFFEREDRENDERER_H
#define BALL_VIEW_RENDERING_RENDERERS_BUFFEREDRENDERER_H

#ifndef BALL_VIEW_RENDERING_RENDERERS_RENDERER_H
# include <BALL/VIEW/RENDERING/RENDERERS/renderer.h>
#endif

#ifndef BALL_VIEW_RENDERING_RENDERTARGET_H
# include <BALL/VIEW/RENDERING/renderTarget.h>
#endif

namespace BALL
{
  namespace VIEW
  {
    class BALL_VIEW_EXPORT BufferedRenderer
      : public Renderer
    {
      public:

        BufferedRenderer()
          : offset_(0),
            stride_(0)
        { }

        bool setFrameBufferFormat(const FrameBufferFormat &format)
        {
          if (supports(format))
          {
            bufferFormat = format;
            formatUpdated();          

            return true;
          }

          return false;
        }

        void renderToBuffer(RenderTarget* renderTarget, const Stage& stage)
        {
          prepareBufferedRendering(stage);

          FrameBufferPtr buffer = renderTarget->getBuffer();
          assert(buffer);

          if (buffer->getFormat() != bufferFormat)
          {
            throw Exception::InvalidFormat(__FILE__, __LINE__, "Buffer with wrong framebuffer format supplied");
          }

          renderToBufferImpl( buffer );

          renderTarget->releaseBuffer(buffer);
        }

        virtual bool supports(const PixelFormat &format) const = 0;

        virtual Resolution getSupportedResolution(const Resolution &min, const Resolution &max,
                                                  const PixelFormat &format) const = 0;

        virtual void setOffset(Size offset) {offset_ = offset;}

        virtual void setStride(Size stride) {stride_ = stride;}

      protected:

        virtual bool supports(const FrameBufferFormat &format) const = 0;

        virtual void formatUpdated() = 0;

        virtual void prepareBufferedRendering(const Stage& stage) = 0;

        virtual void renderToBufferImpl(FrameBufferPtr buffer) = 0;            

        const FrameBufferFormat &getFrameBufferFormat() const { return bufferFormat; }

        Size offset_;
        Size stride_;

      private:

        FrameBufferFormat bufferFormat;
    };
  } //namespace VIEW

} //namespace BALL


#endif // BALL_VIEW_RENDERING_BUFFEREDRENDERER_H