VRS - The Virtual Rendering System

version 3.3

bufferobjectgl.h

Go to the documentation of this file.

/******************************************************************************
 * VRS - The Virtual Rendering System
 * Copyright (C) 2003 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: bufferobjectgl.h 6689 2009-04-15 15:01:26Z Matthias_Trapp $
// $Date: 2009-04-15 17:01:26 +0200 (Wed, 15 Apr 2009) $
// $Revision: 6689 $
// $State$
// $Author: Matthias_Trapp $
//
// $Log$
// Revision 1.18  2006/05/16 14:11:09  baumann
// added new method changeType()
//
// Revision 1.17  2006/05/16 13:30:58  baumann
// added support for EXT_pbo
//
// Revision 1.16  2005/10/14 10:14:38  baumann
// enabled VBOs per default
//
// Revision 1.15  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.14  2004/12/03 16:26:40  buchholz
// dataType() method added
//
// Revision 1.13  2004/11/03 14:45:06  saar
// Class comment changed (Doxygen style)
//
// Revision 1.12  2004/09/19 15:30:32  baumann
// parameter offset added to methods boundAddress()
//
// Revision 1.11  2004/03/12 16:28:40  baumann
// macros VRS_NAMESPACE_BEGIN/_END expanded and removed
//
// Revision 1.10  2004/01/19 11:43:58  baumann
// serialization mechanism improved
//
// Revision 1.9  2004/01/19 07:28:02  baumann
// serialization mechanism improved
//
// Revision 1.8  2003/12/09 14:56:54  buchholz
// serialization for self-contained buffer-objects added
//
// Revision 1.7  2003/11/24 10:38:18  baumann
// - general code cleanup
// - new method replace() added
//
// Revision 1.6  2003/06/03 09:04:46  baumann
// new static methods getMinimumVBOSize()/setMinimumVBOSize()/
// isVBOEnabled()/enableVBO() added to BufferObjectGL; defaults are:
// minimum VBO size = 1024 bytes; VBO disabled
//
// Revision 1.5  2003/05/26 17:02:10  baumann
// BufferObjectGL tries to transfer the data to the graphics memory
// for a second time (during the bind()-call) if no EngineGL was
// specified during the construction of the BufferObjectGL object
//
// Revision 1.4  2003/04/13 15:33:30  baumann
// typo in comment fixed
//
// Revision 1.3  2003/04/04 08:02:09  baumann
// comments added
//
// Revision 1.2  2003/04/02 06:55:50  baumann
// interface improved
//
// Revision 1.1  2003/03/31 17:00:14  baumann
// initial version of BufferObjectGL and VertexAttributeBufferObjectGL
//

#ifndef VRS_OPENGL_BUFFEROBJECTGL_H
#define VRS_OPENGL_BUFFEROBJECTGL_H

#include <vrs/sharedobj.h>

namespace VRS {

class EngineGL;

class VRS_CORE_API BufferObjectGL : public SharedObj {

public:
    enum DataType {
        UNCLASSIFIED, VERTEX_DATA, VERTEX_INDICES, PIXEL_PACK, PIXEL_UNPACK, UNIFORM_DATA, TEXTURE_BUFFER_DATA
    };
    VRS_SERIALIZABLE_CLASS_ENUM(DataType);
    enum UsagePattern {
        STREAM_DRAW, STATIC_DRAW, DYNAMIC_DRAW,
        STREAM_READ, STATIC_READ, DYNAMIC_READ,
        STREAM_COPY, STATIC_COPY, DYNAMIC_COPY
    };
    VRS_SERIALIZABLE_CLASS_ENUM(UsagePattern);
    enum MapAccess {
        READ_ONLY, WRITE_ONLY, READ_WRITE
    };
    BufferObjectGL(
        EngineGL*    engine,
        unsigned int bytes,
        const void*  pointer,
        DataType     type,
        UsagePattern usagePattern
    );
    BufferObjectGL(
        unsigned int bytes,
        const void*  pointer,
        SharedObj*   owner = NULL
    );
    virtual ~BufferObjectGL();

    unsigned int bytes() const;

    void*       mapPointer(MapAccess access);
    const void* mapPointer(MapAccess access) const; // can only be used with READ_ONLY!
    bool        unmapPointer() const;
    bool        pointerIsMapped() const;
    void update(
        unsigned int bytes,
        const void*  pointer,
        unsigned int byteOffset = 0
    );
    void replace(
        unsigned int bytes,
        const void*  pointer
    );
    void        bind(EngineGL* engine) const;
    void*       boundAddress(unsigned int offset = 0);       // for e.g. glVertexPointer(..., buffer->boundAddress());
    const void* boundAddress(unsigned int offset = 0) const; // for e.g. glVertexPointer(..., buffer->boundAddress());
    void        unbind(EngineGL* engine) const;
    void changeType(DataType newDataType);
    static unsigned int getMinimumVBOSize();
    static void setMimimumVBOSize(unsigned int vboSize = 0);
    static bool isVBOEnabled();
    static void enableVBO(bool yesNo = true);

    DataType dataType() const;

    VRS_TYPEINFO(BufferObjectGL, SharedObj);
    VRS_SERIALIZABLE(BufferObjectGL);

    class Impl;

protected:
    BufferObjectGL(); // for serialization only

private:
    // disable copy constructor and assignment operator
    BufferObjectGL(const BufferObjectGL&);
    BufferObjectGL& operator=(const BufferObjectGL&);

    UINT bytes_;
    DataType type_;
    UsagePattern usage_;

    mutable bool tryToOptimize_;
    mutable Impl* impl_;
    bool serializable_;
}; // class BufferObjectGL

} // namespace VRS

#endif // VRS_OPENGL_BUFFEROBJECTGL_H

---

Generated on Fri May 18 06:00:13 2012 by Doxygen 1.5.6

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