Qt 4.8
qglbuffer.h
Go to the documentation of this file.
1 /****************************************************************************
2 **
3 ** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
4 ** Contact: http://www.qt-project.org/legal
5 **
6 ** This file is part of the QtOpenGL module of the Qt Toolkit.
7 **
8 ** $QT_BEGIN_LICENSE:LGPL$
9 ** Commercial License Usage
10 ** Licensees holding valid commercial Qt licenses may use this file in
11 ** accordance with the commercial license agreement provided with the
12 ** Software or, alternatively, in accordance with the terms contained in
13 ** a written agreement between you and Digia. For licensing terms and
14 ** conditions see http://qt.digia.com/licensing. For further information
15 ** use the contact form at http://qt.digia.com/contact-us.
16 **
17 ** GNU Lesser General Public License Usage
18 ** Alternatively, this file may be used under the terms of the GNU Lesser
19 ** General Public License version 2.1 as published by the Free Software
20 ** Foundation and appearing in the file LICENSE.LGPL included in the
21 ** packaging of this file. Please review the following information to
22 ** ensure the GNU Lesser General Public License version 2.1 requirements
23 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
24 **
25 ** In addition, as a special exception, Digia gives you certain additional
26 ** rights. These rights are described in the Digia Qt LGPL Exception
27 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
28 **
29 ** GNU General Public License Usage
30 ** Alternatively, this file may be used under the terms of the GNU
31 ** General Public License version 3.0 as published by the Free Software
32 ** Foundation and appearing in the file LICENSE.GPL included in the
33 ** packaging of this file. Please review the following information to
34 ** ensure the GNU General Public License version 3.0 requirements will be
35 ** met: http://www.gnu.org/copyleft/gpl.html.
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  QGLBuffer();
68  explicit QGLBuffer(QGLBuffer::Type type);
69  QGLBuffer(const QGLBuffer &other);
70  ~QGLBuffer();
71 
72  QGLBuffer &operator=(const QGLBuffer &other);
73 
74  enum UsagePattern
75  {
76  StreamDraw = 0x88E0, // GL_STREAM_DRAW
77  StreamRead = 0x88E1, // GL_STREAM_READ
78  StreamCopy = 0x88E2, // GL_STREAM_COPY
79  StaticDraw = 0x88E4, // GL_STATIC_DRAW
80  StaticRead = 0x88E5, // GL_STATIC_READ
81  StaticCopy = 0x88E6, // GL_STATIC_COPY
82  DynamicDraw = 0x88E8, // GL_DYNAMIC_DRAW
83  DynamicRead = 0x88E9, // GL_DYNAMIC_READ
84  DynamicCopy = 0x88EA // GL_DYNAMIC_COPY
85  };
86 
87  enum Access
88  {
89  ReadOnly = 0x88B8, // GL_READ_ONLY
90  WriteOnly = 0x88B9, // GL_WRITE_ONLY
91  ReadWrite = 0x88BA // GL_READ_WRITE
92  };
93 
94  QGLBuffer::Type type() const;
95 
96  QGLBuffer::UsagePattern usagePattern() const;
97  void setUsagePattern(QGLBuffer::UsagePattern value);
98 
99  bool create();
100  bool isCreated() const;
101 
102  void destroy();
103 
104  bool bind();
105  void release();
106 
107  static void release(QGLBuffer::Type type);
108 
109  GLuint bufferId() const;
110 
111  int size() const;
112 
113  bool read(int offset, void *data, int count);
114  void write(int offset, const void *data, int count);
115 
116  void allocate(const void *data, int count);
117  inline void allocate(int count) { allocate(0, count); }
118 
119  void *map(QGLBuffer::Access access);
120  bool unmap();
121 
122 private:
123  QGLBufferPrivate *d_ptr;
124 
125  Q_DECLARE_PRIVATE(QGLBuffer)
126 };
127 
128 QT_END_NAMESPACE
129 
130 QT_END_HEADER
131 
132 #endif
type
int type
Definition: qmetatype.cpp:239
QT_END_NAMESPACE
#define QT_END_NAMESPACE
This macro expands to.
Definition: qglobal.h:90
QT_MODULE
#define QT_MODULE(x)
Definition: qglobal.h:2783
QT_BEGIN_HEADER
#define QT_BEGIN_HEADER
Definition: qglobal.h:136
Q_OPENGL_EXPORT
#define Q_OPENGL_EXPORT
Definition: qglobal.h:1455
QPatternist::create
static Expression::Ptr create(Expression *const expr, const YYLTYPE &sourceLocator, const ParserContext *const parseInfo)
Definition: qquerytransformparser.cpp:355
QGLBuffer::Type
Type
This enum defines the type of GL buffer object to create with QGLBuffer.
Definition: qglbuffer.h:59
QGLBuffer::d_ptr
QGLBufferPrivate * d_ptr
Definition: qglbuffer.h:123
QtConcurrent::map
QFuture< void > map(Sequence &sequence, MapFunction function)
QT_BEGIN_NAMESPACE
#define QT_BEGIN_NAMESPACE
This macro expands to.
Definition: qglobal.h:89
QGLBuffer::UsagePattern
UsagePattern
This enum defines the usage pattern of a QGLBuffer object.
Definition: qglbuffer.h:74
access
int access(const char *, int)
Definition: qfunctions_nacl.cpp:133
data
static const char * data(const QByteArray &arr)
Definition: qdbusmessage.cpp:60
QGLBuffer::Access
Access
This enum defines the access mode for QGLBuffer::map().
Definition: qglbuffer.h:87
QGLBuffer
The QGLBuffer class provides functions for creating and managing GL buffer objects.
Definition: qglbuffer.h:56
Q_DECLARE_PRIVATE
#define Q_DECLARE_PRIVATE(Class)
Definition: qglobal.h:2467
QT_END_HEADER
#define QT_END_HEADER
Definition: qglobal.h:137
QGLBuffer::allocate
void allocate(int count)
Allocates count bytes of space to the buffer.
Definition: qglbuffer.h:117
Qt 4.8 Source Code Browser