blob: a048c0861c671b302ee43c62a1424ed4d2d3989d (
plain)
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
|
// Copyright (C) 2015 Klaralvdalens Datakonsult AB (KDAB).
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only
#include "qabstracttextureimage.h"
#include "qabstracttextureimage_p.h"
#include <Qt3DRender/qtextureimagedatagenerator.h>
QT_BEGIN_NAMESPACE
namespace Qt3DRender {
using namespace Qt3DCore;
QTextureImageDataGenerator::~QTextureImageDataGenerator() = default;
/*!
\class Qt3DRender::QTextureImageDataGenerator
\inmodule Qt3DRender
\since 5.7
\brief Provides texture image data for QAbstractTextureImage.
QTextureImageDataGenerator is a data provider for QAbstractTexture.
QTextureImageDataGenerator can be used to expand Qt3D with more ways to load
texture image data as well as support user-defined formats and formats Qt3D
does not natively support. The data is returned by the QTextureImageDataPtr
which contains the data that will be loaded to the texture.
QTextureImageDataGenerator is executed by Aspect jobs in the backend.
*/
/*!
\typedef Qt3DRender::QTextureImageDataPtr
\relates Qt3DRender::QTextureImageDataGenerator
Shared pointer to \l QTextureImageData.
*/
/*!
\fn Qt3DRender::QTextureImageDataPtr Qt3DRender::QTextureImageDataGenerator::operator()()
Implement the method to return the texture image data.
*/
/*!
\fn bool Qt3DRender::QTextureImageDataGenerator::operator ==(const QTextureImageDataGenerator &other) const
Implement the method to compare this texture data generator to \a other.
Returns a boolean that indicates whether the \l QAbstractTextureImage needs to reload
the \l QTextureImageData.
*/
QAbstractTextureImagePrivate::QAbstractTextureImagePrivate()
: QNodePrivate(),
m_mipLevel(0),
m_layer(0),
m_face(QAbstractTexture::CubeMapPositiveX)
{
}
QAbstractTextureImagePrivate::~QAbstractTextureImagePrivate()
{
}
QTextureImageDataGeneratorPtr QAbstractTextureImagePrivate::dataGenerator() const
{
Q_Q(const QAbstractTextureImage);
return q->dataGenerator();
}
/*!
\qmltype AbstractTextureImage
\nativetype Qt3DRender::QAbstractTextureImage
\inherits Node
\inqmlmodule Qt3D.Render
\qmlabstract
\since 5.5
\brief Encapsulates the necessary information to create an OpenGL texture image.
*/
/*!
\class Qt3DRender::QAbstractTextureImage
\inmodule Qt3DRender
\since 5.5
\brief Encapsulates the necessary information to create an OpenGL texture image.
QAbstractTextureImage should be used as the means of providing image data to a
QAbstractTexture. It contains the necessary information: mipmap
level, layer, cube face load at the proper place data into an OpenGL texture.
The actual data is provided through a QTextureImageDataGenerator that will be
executed by Aspect jobs in the backend. QAbstractTextureImage should be
subclassed to provide a functor and eventual additional properties needed by
the functor to load actual data.
\note: QAbstractTextureImage should never be shared. Expect crashes, undefined
behavior at best if this rule is not respected.
*/
/*!
\fn Qt3DRender::QTextureImageDataGeneratorPtr Qt3DRender::QAbstractTextureImage::dataGenerator() const
Implement this method to return the QTextureImageDataGeneratorPtr instance,
which will provide the data for the texture image.
*/
/*!
Constructs a new QAbstractTextureImage instance with \a parent as parent.
*/
QAbstractTextureImage::QAbstractTextureImage(QNode *parent)
: QNode(*new QAbstractTextureImagePrivate, parent)
{
}
/*! \internal */
QAbstractTextureImage::~QAbstractTextureImage()
{
}
/*!
\qmlproperty int Qt3D.Render::AbstractTextureImage::mipLevel
Holds the mipmap level of the texture image.
*/
/*!
\property Qt3DRender::QAbstractTextureImage::mipLevel
Holds the mipmap level of the texture image.
*/
int QAbstractTextureImage::mipLevel() const
{
Q_D(const QAbstractTextureImage);
return d->m_mipLevel;
}
/*!
\qmlproperty int Qt3D.Render::AbstractTextureImage::layer
Holds the layer of the texture image.
*/
/*!
\property Qt3DRender::QAbstractTextureImage::layer
\return the layer of the texture image.
*/
int QAbstractTextureImage::layer() const
{
Q_D(const QAbstractTextureImage);
return d->m_layer;
}
/*!
\qmlproperty enumeration Qt3D.Render::AbstractTextureImage::face
Holds the cube map face of the texture image.
\value CubeMapPositiveX 0x8515 GL_TEXTURE_CUBE_MAP_POSITIVE_X
\value CubeMapNegativeX 0x8516 GL_TEXTURE_CUBE_MAP_NEGATIVE_X
\value CubeMapPositiveY 0x8517 GL_TEXTURE_CUBE_MAP_POSITIVE_Y
\value CubeMapNegativeY 0x8518 GL_TEXTURE_CUBE_MAP_NEGATIVE_Y
\value CubeMapPositiveZ 0x8519 GL_TEXTURE_CUBE_MAP_POSITIVE_Z
\value CubeMapNegativeZ 0x851A GL_TEXTURE_CUBE_MAP_NEGATIVE_Z
\note The cube map face has a meaning only for
\l [CPP] {Qt3DRender::QAbstractTexture::}{TargetCubeMap} and
\l [CPP] {Qt3DRender::QAbstractTexture::}{TargetCubeMapArray}.
*/
/*!
\property Qt3DRender::QAbstractTextureImage::face
Holds the cube map face of the texture image.
\note The cube map face has a meaning only for
\l {QAbstractTexture::}{TargetCubeMap} and
\l {QAbstractTexture::}{TargetCubeMapArray}.
*/
QAbstractTexture::CubeMapFace QAbstractTextureImage::face() const
{
Q_D(const QAbstractTextureImage);
return d->m_face;
}
/*!
* Sets the mip level of a texture to \a level.
* \param level
*/
void QAbstractTextureImage::setMipLevel(int level)
{
Q_D(QAbstractTextureImage);
if (level != d->m_mipLevel) {
d->m_mipLevel = level;
emit mipLevelChanged(level);
}
}
/*!
* Sets the layer of a texture to \a layer.
* \param layer
*/
void QAbstractTextureImage::setLayer(int layer)
{
Q_D(QAbstractTextureImage);
if (layer != d->m_layer) {
d->m_layer = layer;
emit layerChanged(layer);
}
}
/*!
* Sets the texture image face to \a face.
* \param face
*/
void QAbstractTextureImage::setFace(QAbstractTexture::CubeMapFace face)
{
Q_D(QAbstractTextureImage);
if (face != d->m_face) {
d->m_face = face;
emit faceChanged(face);
}
}
/*!
Triggers an update of the data generator that is sent to the backend.
*/
void QAbstractTextureImage::notifyDataGeneratorChanged()
{
Q_D(QAbstractTextureImage);
d->update();
}
/*! \internal */
QAbstractTextureImage::QAbstractTextureImage(QAbstractTextureImagePrivate &dd, QNode *parent)
: QNode(dd, parent)
{
}
} // namespace Qt3DRender
QT_END_NAMESPACE
#include "moc_qabstracttextureimage.cpp"
|
