VRS - The Virtual Rendering System

version 3.3

framebuffergl.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: framebuffergl.h 6014 2007-08-09 07:51:16Z Konstantin_Baumann $
// $Date: 2007-08-09 09:51:16 +0200 (Thu, 09 Aug 2007) $
// $Revision: 6014 $
// $State$
// $Author: Konstantin_Baumann $
//
// $Log$
// Revision 1.22  2005/11/28 16:52:00  baumann
// bug fix for color mask settings
//
// Revision 1.21  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.20  2004/11/03 14:45:06  saar
// Class comment changed (Doxygen style)
//
// Revision 1.19  2004/03/12 16:28:40  baumann
// macros VRS_NAMESPACE_BEGIN/_END expanded and removed
//
// Revision 1.18  2004/01/19 11:43:58  baumann
// serialization mechanism improved
//
// Revision 1.17  2004/01/19 07:28:02  baumann
// serialization mechanism improved
//
// Revision 1.16  2003/11/07 14:19:25  kirsch
// removed leading underscore from include guards
//
// Revision 1.15  2002/11/23 09:34:59  baumann
// new method newColorMask() added
//
// Revision 1.14  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.13  2002/08/28 15:06:14  kirsch
// fixed typo
//
// Revision 1.12  2002/06/28 09:47:10  baumann
// class Texture, TextureOldGL and TexturePainterOldGL removed
//
// Revision 1.11  2002/04/24 00:08:24  guenther
// made persistent
//
// Revision 1.10  2002/03/03 21:44:25  kosta
// VRS_TYPEINFO-macro rewritten
//
// Revision 1.9  2002/02/19 10:34:18  kosta
// undone all changes since 2002-02-15
//
// Revision 1.6  2002/01/15 16:25:55  kosta
// macros rewritten for a better namespace support
//
// Revision 1.5  2001/11/13 16:36:31  kirsch
// changed line feed to unix style (removed control-M)
//
// Revision 1.4  2001/10/30 17:20:05  kirsch
// removed MaskAccum (does not exist in OpenGL)
//
// Revision 1.3  2001/10/30 10:50:16  kirsch
// changed Ops to Operations for consistency reasons
//
// Revision 1.2  2001/07/02 10:14:30  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_FRAMEBUFFERGL_H
#define VRS_OPENGL_FRAMEBUFFERGL_H

#include <vrs/monoattribute.h>
#include <vrs/area.h>
#include <vrs/color.h>
#include <vrs/image/image.h>
#include <vrs/opengl/glcanvas.h>
#include <vrs/opengl/openglconfig.h>

namespace VRS {

class VRS_CORE_API FrameBufferGL : public MonoAttribute {
public:
    enum Operations {
        ClearColor             = 1 << 0,
        ClearDepth             = 1 << 1,
        ClearStencil           = 1 << 2,
        ClearAccum             = 1 << 3,
        MaskColor              = 1 << 4,
        MaskDepth              = 1 << 5,
        MaskStencil            = 1 << 6,
        CopyToImage            = 1 << 7,
        CopyFromImage          = 1 << 8
    };
    VRS_SERIALIZABLE_CLASS_ENUM(Operations);
    
    FrameBufferGL(int operations = FrameBufferGL::ClearColor|FrameBufferGL::ClearDepth|FrameBufferGL::ClearStencil);
    void enableOperation(int flagToBeAdded);
    void disableOperation(int flagToBeRemoved);
    int getOperations() const;

    enum OpMode {
        WhenPushed = 1,
        WhenPopped = 2
    };
    VRS_SERIALIZABLE_CLASS_ENUM(OpMode);
    void setOperationMode(int mode);
    int getOperationMode() const;

    void setClearColor(const Color& clr);
    Color getClearColor() const;
    void setMaskColor(bool red, bool green, bool blue, bool alpha);
    int getMaskColor() const;

    void setClearAccum(const Color& acc);
    Color getClearAccum() const;
    
    void setClearDepth(GLclampd depth=1.0);
    GLclampd getClearDepth() const;
    void setMaskDepth(bool onOff);
    bool getMaskDepth() const;
    
    void setClearStencil(int clearValue = 0);
    int getClearStencil() const;
    void setMaskStencil(int stencilMask);
    int getMaskStencil() const;

    void setCopyToImage(Image* image);
    Image* getCopyToImage() const;

    void setCopyFromImage(Image* image);
    Image* getCopyFromImage() const;

    void setBuffer(GLCanvas::CanvasProperties buffer = GLCanvas::RGB_BUFFER);
    GLCanvas::CanvasProperties getBuffer() const;
    void setRegion(const Area& area);
    Area getRegion() const;
    static FrameBufferGL* newColorMask(bool red, bool green, bool blue, bool alpha);
    
    VRS_TYPEINFO(FrameBufferGL, MonoAttribute);
    VRS_SERIALIZABLE(FrameBufferGL);

private:
    int op_;
    int opMode_;

    Color    clearColor_;
    Color    clearAccum_;
    GLclampd clearDepth_; 
    int      clearStencil_;

    bool maskR_, maskG_, maskB_, maskA_;
    bool maskDepth_;
    int maskStencil_;

    SO<Image> copyToImage_;
    SO<Image> copyFromImage_;
    GLCanvas::CanvasProperties buffer_;
    Area region_;
};

inline int FrameBufferGL::getOperations() const { return op_; }
inline int FrameBufferGL::getOperationMode() const { return opMode_; }

inline Color FrameBufferGL::getClearColor() const { return clearColor_; }
inline Color FrameBufferGL::getClearAccum() const { return clearAccum_; }
inline GLclampd FrameBufferGL::getClearDepth() const { return clearDepth_; }
inline int FrameBufferGL::getClearStencil() const { return clearStencil_; }
 
inline bool FrameBufferGL::getMaskDepth() const { return maskDepth_; }
inline int FrameBufferGL::getMaskStencil() const { return maskStencil_; }

inline Image* FrameBufferGL::getCopyToImage() const { return copyToImage_; }
inline Image* FrameBufferGL::getCopyFromImage() const { return copyFromImage_; }

inline GLCanvas::CanvasProperties FrameBufferGL::getBuffer() const { return buffer_; }
inline Area FrameBufferGL::getRegion() const { return region_; }

} // namespace VRS

#endif // VRS_OPENGL_FRAMEBUFFERGL_H

---

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

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