- Main Page
- Related Pages
- Modules
- Namespaces
- Classes
- Files
- Directories
- Examples

- File List
- File Members

# qglbuffer.h

Go to the documentation of this file.

    00001 /****************************************************************************
    00002 **
    00003 ** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
    00004 ** All rights reserved.
    00005 ** Contact: Nokia Corporation (qt-info@nokia.com)
    00006 **
    00007 ** This file is part of the QtOpenGL module of the Qt Toolkit.
    00008 **
    00009 ** $QT_BEGIN_LICENSE:LGPL$
    00010 ** Commercial Usage
    00011 ** Licensees holding valid Qt Commercial licenses may use this file in
    00012 ** accordance with the Qt Commercial License Agreement provided with the
    00013 ** Software or, alternatively, in accordance with the terms contained in
    00014 ** a written agreement between you and Nokia.
    00015 **
    00016 ** GNU Lesser General Public License Usage
    00017 ** Alternatively, this file may be used under the terms of the GNU Lesser
    00018 ** General Public License version 2.1 as published by the Free Software
    00019 ** Foundation and appearing in the file LICENSE.LGPL included in the
    00020 ** packaging of this file.  Please review the following information to
    00021 ** ensure the GNU Lesser General Public License version 2.1 requirements
    00022 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
    00023 **
    00024 ** In addition, as a special exception, Nokia gives you certain additional
    00025 ** rights.  These rights are described in the Nokia Qt LGPL Exception
    00026 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this module.
    00027 **
    00028 ** GNU General Public License Usage
    00029 ** Alternatively, this file may be used under the terms of the GNU
    00030 ** General Public License version 3.0 as published by the Free Software
    00031 ** Foundation and appearing in the file LICENSE.GPL included in the
    00032 ** packaging of this file.  Please review the following information to
    00033 ** ensure the GNU General Public License version 3.0 requirements will be
    00034 ** met: http://www.gnu.org/copyleft/gpl.html.
    00035 **
    00036 ** If you have questions regarding the use of this file, please contact
    00037 ** Nokia at qt-info@nokia.com.
    00038 ** $QT_END_LICENSE$
    00039 **
    00040 ****************************************************************************/
    00041
    00042 #ifndef QGLBUFFER_H
    00043 #define QGLBUFFER_H
    00044
    00045 #include <QtCore/qscopedpointer.h>
    00046 #include <QtOpenGL/qgl.h>
    00047
    00048 QT_BEGIN_HEADER
    00049
    00050 QT_BEGIN_NAMESPACE
    00051
    00052 QT_MODULE(OpenGL)
    00053
    00054 class QGLBufferPrivate;
    00055
    00056 class Q_OPENGL_EXPORT QGLBuffer
    00057 {
    00058 public:
    00059     enum Type
    00060     {
    00061         VertexBuffer        = 0x8892, // GL_ARRAY_BUFFER
    00062         IndexBuffer         = 0x8893, // GL_ELEMENT_ARRAY_BUFFER
    00063         PixelPackBuffer     = 0x88EB, // GL_PIXEL_PACK_BUFFER
    00064         PixelUnpackBuffer   = 0x88EC  // GL_PIXEL_UNPACK_BUFFER
    00065     };
    00066
    00067     QGLBuffer();
    00068     explicit QGLBuffer(QGLBuffer::Type type);
    00069     QGLBuffer(const QGLBuffer &other);
    00070     ~QGLBuffer();
    00071
    00072     QGLBuffer &operator=(const QGLBuffer &other);
    00073
    00074     enum UsagePattern
    00075     {
    00076         StreamDraw          = 0x88E0, // GL_STREAM_DRAW
    00077         StreamRead          = 0x88E1, // GL_STREAM_READ
    00078         StreamCopy          = 0x88E2, // GL_STREAM_COPY
    00079         StaticDraw          = 0x88E4, // GL_STATIC_DRAW
    00080         StaticRead          = 0x88E5, // GL_STATIC_READ
    00081         StaticCopy          = 0x88E6, // GL_STATIC_COPY
    00082         DynamicDraw         = 0x88E8, // GL_DYNAMIC_DRAW
    00083         DynamicRead         = 0x88E9, // GL_DYNAMIC_READ
    00084         DynamicCopy         = 0x88EA  // GL_DYNAMIC_COPY
    00085     };
    00086
    00087     enum Access
    00088     {
    00089         ReadOnly            = 0x88B8, // GL_READ_ONLY
    00090         WriteOnly           = 0x88B9, // GL_WRITE_ONLY
    00091         ReadWrite           = 0x88BA  // GL_READ_WRITE
    00092     };
    00093
    00094     QGLBuffer::Type type() const;
    00095
    00096     QGLBuffer::UsagePattern usagePattern() const;
    00097     void setUsagePattern(QGLBuffer::UsagePattern value);
    00098
    00099     bool create();
    00100     bool isCreated() const;
    00101
    00102     void destroy();
    00103
    00104     bool bind();
    00105     void release();
    00106
    00107     static void release(QGLBuffer::Type type);
    00108
    00109     GLuint bufferId() const;
    00110
    00111     int size() const;
    00112
    00113     bool read(int offset, void *data, int count);
    00114     void write(int offset, const void *data, int count);
    00115
    00116     void allocate(const void *data, int count);
    00117     inline void allocate(int count) { allocate(0, count); }
    00118
    00119     void *map(QGLBuffer::Access access);
    00120     bool unmap();
    00121
    00122 private:
    00123     QGLBufferPrivate *d_ptr;
    00124
    00125     Q_DECLARE_PRIVATE(QGLBuffer)
    00126 };
    00127
    00128 QT_END_NAMESPACE
    00129
    00130 QT_END_HEADER
    00131
    00132 #endif