VRS - The Virtual Rendering System

version 3.3

offscreencanvasgl.h

Go to the documentation of this file.

 /**********************************************************************
 VRS - The Virtual Rendering System
 Copyright (C) 2001 Computer Graphics Systems Group at the 
 Hasso-Plattner-Institute, Potsdam, Germany.
 This library is free software; you can redistribute it and/or 
 modify it under the terms of the GNU Lesser General Public 
 License as published by the Free Software Foundation; either 
 version 2.1 of the License, or (at your option) any later version.
 This library is distributed in the hope that it will be useful, but 
 WITHOUT ANY WARRANTY; without even the implied warranty of 
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. 
 See the GNU Lesser General Public License for more details.
 You should have received a copy of the GNU Lesser+ General Public
 License along with this library; if not, write to the FreeSoftware 
 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA, 02111-1307, USA.
 **********************************************************************/
// $Id: offscreencanvasgl.h 6632 2009-01-15 10:55:19Z Manuel_Wellmann $
// $Date: 2009-01-15 11:55:19 +0100 (Thu, 15 Jan 2009) $
// $Revision: 6632 $
// $State$
// $Author: Manuel_Wellmann $
//
// $Log$
// Revision 1.14  2005/01/03 01:43:09  klimetschek
// - modified win32 project layout, splitted vrs.vcproj into vrs_container, vrs_core, vrs_sg, vrs_image, vrs_opengl and vrs_io
// - removed vrs.vcproj
// minor things:
// - added all glutexamples to vrs4glut.sln
// - fixed some problems in glutexamples
// - removed all project references from all VS projects (using solution wide project dependencies instead)
//
// Revision 1.13  2004/11/03 14:45:06  saar
// Class comment changed (Doxygen style)
//
// Revision 1.12  2004/03/12 16:28:40  baumann
// macros VRS_NAMESPACE_BEGIN/_END expanded and removed
//
// Revision 1.11  2003/12/11 15:11:07  kirsch
// made prepareRedisplay() and finishRedisplay() public
//
// Revision 1.10  2003/11/07 14:19:25  kirsch
// removed leading underscore from include guards
//
// Revision 1.9  2003/10/27 13:40:38  skirsch
// added canvas query functionality to the engine, restructured canvas redisplay, and added dpi query functionality to the canvas
//
// Revision 1.8  2003/10/21 16:25:29  baumann
// callback removed from method largeScaleSnapshot(); using VRS::Progress instead
//
// Revision 1.7  2002/11/01 11:43:05  kirsch
// windows impl and includes cleanup
//
// Revision 1.6  2002/10/24 15:49:19  kirsch
// added missing getProperties-method
//
// Revision 1.5  2002/10/24 14:15:25  kirsch
// made canvas width and height unsigned
// added getProperties to GLCanvas and subclasses
//
// Revision 1.4  2002/09/25 11:41:53  baumann
// using GLCanvas:: prefix for CanvasProperties
//
// Revision 1.3  2002/09/24 11:18:20  baumann
// - renamed GLCanvas::copy() to GLCanvas::snapshot()
// - renamed GLCanvas::renderToImage() to GLCanvas::largeScaleSnapshot()
// - argument "format" changed to "buffer" using GLCanvas::RGB_BUFFER,
//     GLCanvas::RGBA_BUFFER, GLCanvas::STENCIL_BUFFER, or GLCanvas::DEPTH_BUFFER
//     as possible values (for methods GLCanvas::snapshot() and
//     GLCanvas::largeScaleSnapshot())
// - argument "frontBuffer" changed to "readBuffer" using GLCanvas::CURRENT_BUFFER,
//     GLCanvas::FRONT_BUFFER, and GLCanvas::BACK_BUFFER as possible values (for
//     methods GLCanvas::snapshot() and GLCanvas::largeScaleSnapshot())
// - methods FrameBufferGL::getFormat() and FrameBufferGL::setFormat() renamed
//     to FrameBufferGL::getBuffer() and FrameBufferGL::setBuffer() using the
//     same values described above
// - method EngineGL::captureFrame() removed (use one of the GLCanvas::snapshot()
//     methods instead)
//
// Revision 1.2  2002/09/19 07:44:19  kirsch
// added GLCanvas::create() and GLCanvas::destroy()
// all sub-classes use those methods to create and destroy engine and processor
//
// Revision 1.1  2002/08/22 14:41:55  baumann
// renamed class OffscreenCanvas to OffscreenCanvasGL
// and moved it from "vrs/sg" to "vrs/opengl"
//
// Revision 1.16  2002/08/22 14:07:54  baumann
// using new method GLCanvas::largeScaleSnapshot()
//
// Revision 1.15  2002/06/28 09:47:10  baumann
// class Texture, TextureOldGL and TexturePainterOldGL removed
//
// Revision 1.14  2002/05/26 12:07:41  baumann
// method prepare() is now public (was private)
//
// Revision 1.13  2002/03/03 21:44:26  kosta
// VRS_TYPEINFO-macro rewritten
//
// Revision 1.12  2002/02/19 10:34:20  kosta
// undone all changes since 2002-02-15
//
// Revision 1.9  2002/01/15 16:25:55  kosta
// macros rewritten for a better namespace support
//
// Revision 1.8  2002/01/07 07:33:02  kirsch
// Removed Windows-style line endings
//
// Revision 1.7  2002/01/04 13:09:43  doellner
// Redesign of canvas classes. Studio merged into Canvas, and removed.
//
// Revision 1.6  2001/11/13 16:36:31  kirsch
// changed line feed to unix style (removed control-M)
//
// Revision 1.5  2001/08/29 12:09:10  kirsch
// removed background color from canvas, use BackgroundGL instead
//
// Revision 1.4  2001/08/27 08:44:40  kersting
// added OpenGLCanvas base class
//
// Revision 1.3  2001/07/30 13:14:00  kirsch
// fixed typos in comments
//
// Revision 1.2  2001/07/02 10:14:29  kersting
// changes due to enum definition
//
// Revision 1.1.1.1  2001/06/08 08:09:21  kirsch
// imported alpha-version by olli 
//

#ifndef VRS_OPENGL_OFFSCREENCANVASGL_H_
#define VRS_OPENGL_OFFSCREENCANVASGL_H_

#include <vrs/opengl/glcanvas.h>

namespace VRS {

class Image;

class VRS_CORE_API OffscreenCanvasImplBase : public SharedObj
{
public:
    virtual bool isInitialized() const = 0;
    virtual void destroyContext() = 0;
    virtual void makeContextCurrent() = 0;
    virtual void releaseContext() = 0;
    virtual void createContext(unsigned int width, unsigned int height) = 0;

    virtual unsigned int width() const = 0;
    virtual unsigned int height() const = 0;

    VRS_TYPEINFO(OffscreenCanvasImplBase, SharedObj);
};

class VRS_CORE_API OffscreenCanvasFactoryBase : public SharedObj
{
public:
    virtual SO<OffscreenCanvasImplBase> create() const = 0;

    VRS_TYPEINFO(OffscreenCanvasFactoryBase, SharedObj);
};


class VRS_CORE_API OffscreenCanvasGL : public GLCanvas {
public:
    OffscreenCanvasGL(unsigned int width, unsigned int height, bool luminanceOnly = false);
    OffscreenCanvasGL(Image* targetImage);
    virtual ~OffscreenCanvasGL();

    virtual Image* getTarget() const;
    virtual void setTarget(Image* targetImage);
    virtual bool prepareRedisplay();
    virtual void finishRedisplay();

    virtual void makeContextCurrent();
    virtual void releaseContext();

        virtual void setSize(unsigned int width, unsigned int height);
    virtual unsigned int getWidth() const;
    virtual unsigned int getHeight() const;
    virtual int getProperties() const;
    virtual bool largeScaleSnapshot(Image* destination,
                                    GLCanvas::CanvasProperties buffer = GLCanvas::RGB_BUFFER);

    static void setOffscreenCanvasFactory(
        const SO<OffscreenCanvasFactoryBase>& factory);

    static SO<OffscreenCanvasFactoryBase> getOffscreenCanvasFactory();
    
    VRS_TYPEINFO(OffscreenCanvasGL, GLCanvas);



private:
    SO<Image> target_;
        unsigned int width_;
        unsigned int height_;
    bool mapped_;
    bool luminanceOnly_;

    SO<OffscreenCanvasImplBase> impl_;

    static SO<OffscreenCanvasImplBase> createImpl();
    static SO<OffscreenCanvasFactoryBase> g_factory;
};

} // namespace VRS

#endif // VRS_OPENGL_OFFSCREENCANVASGL_H_

---

Generated on Wed May 23 06:00:13 2012 by Doxygen 1.5.6

© 2001-2010 Hasso-Plattner-Institut | Impressum | Contact