VRS - The Virtual Rendering System

version 3.3

pbuffermanagergl.h

Go to the documentation of this file.

/******************************************************************************
 * VRS - The Virtual Rendering System
 * Copyright (C) 2002 Computer Graphics Systems Group at the 
 * Hasso-Plattner-Institute (HPI), 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: pbuffermanagergl.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.18  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.17  2004/11/03 14:45:06  saar
// Class comment changed (Doxygen style)
//
// Revision 1.16  2004/05/06 15:06:03  kirsch
// code cleanup. keys are now of type sharedobj *const instead of const sharedobj*
//
// Revision 1.15  2004/03/12 16:28:40  baumann
// macros VRS_NAMESPACE_BEGIN/_END expanded and removed
//
// Revision 1.14  2004/01/19 11:43:58  baumann
// serialization mechanism improved
//
// Revision 1.13  2004/01/19 07:28:02  baumann
// serialization mechanism improved
//
// Revision 1.12  2003/11/07 14:19:25  kirsch
// removed leading underscore from include guards
//
// Revision 1.11  2003/02/14 10:32:31  baumann
// parameter "void" removed from argument list (due to iVRS)
//
// Revision 1.10  2003/02/13 14:38:46  kirsch
// added static structure that ensures that during program termination,
// pbuffers get deleted (there was a cyclic dependency before). This
// feature is currently deactivated due to upshowing error when a program
// terminates, which cannot (glut?) or will hopefully (tcl, others?) be fixed.
//
// Revision 1.9  2002/11/23 12:05:30  kirsch
// changed enum values to uppercase
//
// Revision 1.8  2002/11/22 10:33:01  kirsch
// added updateTextureArea
//
// Revision 1.7  2002/10/28 14:21:56  kirsch
// made some methods const, others static
//
// Revision 1.6  2002/10/28 12:53:30  kirsch
// updated comment
//
// Revision 1.5  2002/10/28 12:37:08  kirsch
// moved creation of pbuffermanager to shared context
// removed engine and context attribute from pbuffermanager
// instead the engine is given as argument
//
// Revision 1.4  2002/10/28 10:01:22  kirsch
// bug fixes for CanvasSize-setting. match() revised. Comments updated.
//
// Revision 1.3  2002/10/27 16:56:51  kirsch
// store pbuffers instead of indices in key-dictionary, since the latter might change
//
// Revision 1.2  2002/10/25 14:44:38  kirsch
// added creation and retrieval of pbuffers with sharedobj-keys
//
// Revision 1.1  2002/10/24 09:45:38  kirsch
// added PBufferManagerGL
//

#ifndef VRS_OPENGL_PBUFFERMANAGERGL_H_
#define VRS_OPENGL_PBUFFERMANAGERGL_H_

#include <vrs/sharedobj.h>
#include <vrs/container/array.h>
#include <vrs/opengl/glcanvas.h>
#include <map>
#include <stack>

namespace VRS {

class EngineGL;
class SharedContextGL;
class PBufferCanvasGL;
class Texture2DGL;

class VRS_CORE_API PBufferManagerGL : public SharedObj {
public:

    enum PBufferSizePolicy { 
        CANVAS_SIZE,
        FIXED_SIZE
    };
    VRS_SERIALIZABLE_CLASS_ENUM(PBufferSizePolicy);

    PBufferCanvasGL* reserve(EngineGL* engine,
        PBufferManagerGL::PBufferSizePolicy = PBufferManagerGL::CANVAS_SIZE, 
        unsigned int width = 0, unsigned int height = 0,
        GLCanvas::CanvasProperties = GLCanvas::RGBADS);
    PBufferCanvasGL* reserve(EngineGL* engine, SharedObj *const key,
        PBufferManagerGL::PBufferSizePolicy = PBufferManagerGL::CANVAS_SIZE, 
        unsigned int width = 0, unsigned int height = 0,
        GLCanvas::CanvasProperties = GLCanvas::RGBADS);
    PBufferCanvasGL* get(SharedObj *const key) const;
    void free(PBufferCanvasGL*);
    void free(SharedObj *const key);
    static void prepareContext(EngineGL*, PBufferCanvasGL*);
    static void releaseContext(EngineGL*, PBufferCanvasGL*);
    void updateTextureArea(EngineGL*, PBufferCanvasGL*, Texture2DGL*, Area = Area(0, 0, 0, 0));
    void setCleanUpAtTermination(bool);
    bool getCleanUpAtTermination() const;
    void unconditionalCleanUp();
    static void cleanUp();
    VRS_TYPEINFO(PBufferManagerGL, SharedObj);

protected:

    friend class SharedContextGL;
    PBufferManagerGL();
    ~PBufferManagerGL();

    void perFrameCleanUp(const unsigned int framesBeforeDestruction = 20);
private:

    int find(
        PBufferManagerGL::PBufferSizePolicy, 
        unsigned int width, unsigned int height,
        GLCanvas::CanvasProperties) const;
    unsigned int match(PBufferCanvasGL*,
        PBufferManagerGL::PBufferSizePolicy, 
        unsigned int width, unsigned int height,
        GLCanvas::CanvasProperties) const;
    static GLCanvas* getContext(EngineGL*);
    SO<NonPersistentArray<SO<PBufferCanvasGL> > > m_pbuffer;

    enum UseFlag { UF_True = 1 };
    SO<NonPersistentArray<int> > m_inUse;

    mutable std::map<SharedObj *const, std::stack<PBufferCanvasGL*> > m_objToPBufferMap;
        // key - stack of int dictionary. Note that we do not use
        // an SO<const SharedObj>, since the SharedObj are never dereferenced
        // anyway. Also the PBufferCanvasGL-Objects do not need to be
        // shared objects, since only pbuffer that are in the pbuffer-
        // array (m_pbuffer) can be included in the dictionary, and these
        // are shared.

    bool m_cleanUpAtTermination;
};

} // namespace VRS

#endif // VRS_OPENGL_PBUFFERMANAGERGL_H_

---

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

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