1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
|
/****************************************************************************
**
** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
** All rights reserved.
** Contact: Nokia Corporation (qt-info@nokia.com)
**
** This file is part of the QtQuick3D module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** GNU Lesser General Public License Usage
** This file may be used under the terms of the GNU Lesser General Public
** License version 2.1 as published by the Free Software Foundation and
** appearing in the file LICENSE.LGPL included in the packaging of this
** file. Please review the following information to ensure the GNU Lesser
** General Public License version 2.1 requirements will be met:
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Nokia gives you certain additional
** rights. These rights are described in the Nokia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU General
** Public License version 3.0 as published by the Free Software Foundation
** and appearing in the file LICENSE.GPL included in the packaging of this
** file. Please review the following information to ensure the GNU General
** Public License version 3.0 requirements will be met:
** http://www.gnu.org/copyleft/gpl.html.
**
** Other Usage
** Alternatively, this file may be used in accordance with the terms and
** conditions contained in a signed written agreement between you and Nokia.
**
**
**
**
**
** $QT_END_LICENSE$
**
****************************************************************************/
#include "qglattributevalue.h"
#include "qopenglfunctions.h"
QT_BEGIN_NAMESPACE
/*!
\class QGLAttributeValue
\brief The QGLAttributeValue class encapsulates information about an OpenGL attribute value.
\since 4.8
\ingroup qt3d
\ingroup qt3d::arrays
OpenGL has many functions that take a pointer to vertex attribute
values: \c{glVertexPointer()}, \c{glNormalPointer()},
\c{glVertexAttribPointer()}, etc. These functions typically
take four arguments: tuple size (1, 2, 3, or 4), component type
(e.g. GL_FLOAT), stride, and data pointer (\c{glNormalPointer()}
does not use tuple size, assuming that it is 3). When used with
vertex buffers, the data pointer may be an offset into the vertex
buffer instead.
QGLAttributeValue encapsulates these four values so that they can
be easily manipulated as a set during OpenGL painting operations.
Constructors are provided for converting QArray and
QCustomDataArray objects into an attribute value.
Because the data() value is a raw pointer to arbitrary memory,
care should be taken that the memory remains valid until the
QGLAttributeValue is no longer required.
\sa QGLAttributeDescription, QArray, QCustomDataArray
*/
/*!
\fn QGLAttributeValue::QGLAttributeValue()
Constructs a null attribute value with default parameters of
tupleSize(), and stride() set to zero, type() set to GL_FLOAT,
and data() set to null.
\sa isNull()
*/
/*!
\fn QGLAttributeValue::QGLAttributeValue(const QArray<float>& array)
Constructs an attribute value that refers to the contents of \a array,
setting tupleSize() to 1, type() to GL_FLOAT, and stride() to zero.
The \a array must not be destroyed or modified until the attribute
value is no longer required.
*/
/*!
\fn QGLAttributeValue::QGLAttributeValue(const QArray<QVector2D>& array)
Constructs an attribute value that refers to the contents of \a array,
setting tupleSize() to 2, type() to GL_FLOAT, and stride() to zero.
The \a array must not be destroyed or modified until the attribute
value is no longer required.
*/
/*!
\fn QGLAttributeValue::QGLAttributeValue(const QArray<QVector3D>& array)
Constructs an attribute value that refers to the contents of \a array,
setting tupleSize() to 3, type() to GL_FLOAT, and stride() to zero.
The \a array must not be destroyed or modified until the attribute
value is no longer required.
*/
/*!
\fn QGLAttributeValue::QGLAttributeValue(const QArray<QVector4D>& array)
Constructs an attribute value that refers to the contents of \a array,
setting tupleSize() to 4, type() to GL_FLOAT, and stride() to zero.
The \a array must not be destroyed or modified until the attribute
value is no longer required.
*/
/*!
\fn QGLAttributeValue::QGLAttributeValue(const QArray<QColor4ub>& array)
Constructs an attribute value that refers to the contents of \a array,
setting tupleSize() to 4, type() to GL_UNSIGNED_BYTE, and stride() to zero.
The \a array must not be destroyed or modified until the attribute
value is no longer required.
*/
/*!
Constructs an attribute value that refers to the contents of \a array.
The tupleSize() and type() of the attribute value will be set according
to the QCustomDataArray::elementType() of \a array.
The \a array must not be destroyed or modified until the attribute
value is no longer required.
*/
QGLAttributeValue::QGLAttributeValue(const QCustomDataArray& array)
: m_tupleSize(0), m_type(GL_FLOAT), m_stride(0)
, m_data(array.data()), m_count(array.count())
{
switch (array.elementType()) {
case QCustomDataArray::Float:
m_tupleSize = 1;
break;
case QCustomDataArray::Vector2D:
m_tupleSize = 2;
break;
case QCustomDataArray::Vector3D:
m_tupleSize = 3;
break;
case QCustomDataArray::Vector4D:
m_tupleSize = 4;
break;
case QCustomDataArray::Color:
m_tupleSize = 4;
m_type = GL_UNSIGNED_BYTE;
break;
}
}
/*!
\fn QGLAttributeValue::QGLAttributeValue(int tupleSize, GLenum type, int stride, const void *data, int count)
Constructs an attribute value with the fields \a tupleSize, \a type,
\a stride, \a data, and \a count.
*/
/*!
\fn QGLAttributeValue::QGLAttributeValue(int tupleSize, GLenum type, int stride, int offset, int count)
Constructs an attribute value with the fields \a tupleSize, \a type,
\a stride, \a offset, and \a count.
*/
/*!
\fn QGLAttributeValue::QGLAttributeValue(const QGLAttributeDescription& description, const void *data, int count)
Constructs an attribute value with the supplied \a description,
\a data, and \a count.
*/
/*!
\fn QGLAttributeValue::QGLAttributeValue(const QGLAttributeDescription& description, int offset, int count)
Constructs an attribute value with the supplied \a description,
\a offset, and \a count.
*/
/*!
\fn bool QGLAttributeValue::isNull() const
Returns true if tupleSize() is zero, which indicates an unset
attribute value; false otherwise.
Note: it is possible for data() to be null, but isNull() returns true.
This can happen when data() is actually a zero offset into a
vertex buffer.
*/
/*!
\fn QGLAttributeDescription QGLAttributeValue::description(QGL::VertexAttribute attribute) const
Returns the description of this value, tagged with \a attribute.
\sa type()
*/
/*!
\fn GLenum QGLAttributeValue::type() const
Returns the component type for this attribute value. The default
value is GL_FLOAT.
\sa sizeOfType(), description()
*/
/*!
Returns the size in bytes of type().
\sa type(), tupleSize()
*/
int QGLAttributeValue::sizeOfType() const
{
switch (m_type) {
case GL_BYTE: return int(sizeof(GLbyte));
case GL_UNSIGNED_BYTE: return int(sizeof(GLubyte));
case GL_SHORT: return int(sizeof(GLshort));
case GL_UNSIGNED_SHORT: return int(sizeof(GLushort));
case GL_INT: return int(sizeof(GLint));
case GL_UNSIGNED_INT: return int(sizeof(GLuint));
case GL_FLOAT: return int(sizeof(GLfloat));
#if defined(GL_DOUBLE) && !defined(QT_OPENGL_ES)
case GL_DOUBLE: return int(sizeof(GLdouble));
#endif
default: return 0;
}
}
/*!
\fn int QGLAttributeValue::tupleSize() const
Returns the tuple size of this attribute in components. For example,
a return value of 3 indicates a vector of 3-dimensional values.
If tupleSize() is zero, then this attribute value is null.
\sa isNull(), sizeOfType()
*/
/*!
\fn int QGLAttributeValue::stride() const
Returns the stride in bytes from one vertex element to the
next for this attribute value. The default value of 0 indicates
that the elements are tightly packed within the data() array.
*/
/*!
\fn const void *QGLAttributeValue::data() const
Returns the data pointer for the elements in this attribute value.
*/
/*!
\fn int QGLAttributeValue::count() const
Returns the count of vertex elements in this attribute value;
zero if the count is unknown.
*/
QT_END_NAMESPACE
|
