1 /****************************************************************************

     2 **

     3 ** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).

     4 ** All rights reserved.

     5 ** Contact: Nokia Corporation (qt-info@nokia.com)

     6 **

     7 ** This file is part of the QtOpenGL module of the Qt Toolkit.

     8 **

     9 ** $QT_BEGIN_LICENSE:LGPL$

    10 ** No Commercial Usage

    11 ** This file contains pre-release code and may not be distributed.

    12 ** You may use this file in accordance with the terms and conditions

    13 ** contained in the Technology Preview License Agreement accompanying

    14 ** this package.

    15 **

    16 ** GNU Lesser General Public License Usage

    17 ** Alternatively, this file may be used under the terms of the GNU Lesser

    18 ** General Public License version 2.1 as published by the Free Software

    19 ** Foundation and appearing in the file LICENSE.LGPL included in the

    20 ** packaging of this file.  Please review the following information to

    21 ** ensure the GNU Lesser General Public License version 2.1 requirements

    22 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.

    23 **

    24 ** In addition, as a special exception, Nokia gives you certain additional

    25 ** rights.  These rights are described in the Nokia Qt LGPL Exception

    26 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.

    27 **

    28 ** If you have questions regarding the use of this file, please contact

    29 ** Nokia at qt-info@nokia.com.

    30 **

    31 **

    32 **

    33 **

    34 **

    35 **

    36 **

    37 **

    38 ** $QT_END_LICENSE$

    39 **

    40 ****************************************************************************/

    41 

    42 #ifndef QGLBUFFER_H

    43 #define QGLBUFFER_H

    44 

    45 #include <QtCore/qscopedpointer.h>

    46 #include <QtOpenGL/qgl.h>

    47 

    48 QT_BEGIN_HEADER

    49 

    50 QT_BEGIN_NAMESPACE

    51 

    52 QT_MODULE(OpenGL)

    53 

    54 class QGLBufferPrivate;

    55 

    56 class Q_OPENGL_EXPORT QGLBuffer

    57 {

    58 public:

    59     enum Type

    60     {

    61         VertexBuffer        = 0x8892, // GL_ARRAY_BUFFER

    62         IndexBuffer         = 0x8893, // GL_ELEMENT_ARRAY_BUFFER

    63         PixelPackBuffer     = 0x88EB, // GL_PIXEL_PACK_BUFFER

    64         PixelUnpackBuffer   = 0x88EC  // GL_PIXEL_UNPACK_BUFFER

    65     };

    66 

    67     explicit QGLBuffer(QGLBuffer::Type type);

    68     ~QGLBuffer();

    69 

    70     enum UsagePattern

    71     {

    72         StreamDraw          = 0x88E0, // GL_STREAM_DRAW

    73         StreamRead          = 0x88E1, // GL_STREAM_READ

    74         StreamCopy          = 0x88E2, // GL_STREAM_COPY

    75         StaticDraw          = 0x88E4, // GL_STATIC_DRAW

    76         StaticRead          = 0x88E5, // GL_STATIC_READ

    77         StaticCopy          = 0x88E6, // GL_STATIC_COPY

    78         DynamicDraw         = 0x88E8, // GL_DYNAMIC_DRAW

    79         DynamicRead         = 0x88E9, // GL_DYNAMIC_READ

    80         DynamicCopy         = 0x88EA  // GL_DYNAMIC_COPY

    81     };

    82 

    83     enum Access

    84     {

    85         ReadOnly            = 0x88B8, // GL_READ_ONLY

    86         WriteOnly           = 0x88B9, // GL_WRITE_ONLY

    87         ReadWrite           = 0x88BA  // GL_READ_WRITE

    88     };

    89 

    90     QGLBuffer::Type type() const;

    91 

    92     QGLBuffer::UsagePattern usagePattern() const;

    93     void setUsagePattern(QGLBuffer::UsagePattern value);

    94 

    95     bool create();

    96     bool isCreated() const;

    97 

    98     bool bind() const;

    99     void release() const;

   100 

   101     static void release(QGLBuffer::Type type);

   102 

   103     GLuint bufferId() const;

   104 

   105     int size() const;

   106 

   107     bool read(int offset, void *data, int count);

   108     void write(int offset, const void *data, int count);

   109 

   110     void allocate(const void *data, int count);

   111     inline void allocate(int count) { allocate(0, count); }

   112 

   113     void *map(QGLBuffer::Access access);

   114     bool unmap();

   115 

   116 private:

   117     QScopedPointer<QGLBufferPrivate> d_ptr;

   118 

   119     Q_DISABLE_COPY(QGLBuffer)

   120     Q_DECLARE_PRIVATE(QGLBuffer)

   121 };

   122 

   123 QT_END_NAMESPACE

   124 

   125 QT_END_HEADER

   126 

   127 #endif