Qt
Internal/Contributor docs for the Qt SDK. <b>Note:</b> These are NOT official API docs; those are found <a href='https://doc.qt.io/'>here</a>.
Loading...
Searching...
No Matches
qquick3dtexture_p.h
Go to the documentation of this file.
1// Copyright (C) 2019 The Qt Company Ltd.
2// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only
3
4#ifndef QSSGIMAGE_H
5#define QSSGIMAGE_H
6
7//
8// W A R N I N G
9// -------------
10//
11// This file is not part of the Qt API. It exists purely as an
12// implementation detail. This header file may change from version to
13// version without notice, or even be removed.
14//
15// We mean it.
16//
17
18#include <QtQuick3D/qquick3dobject.h>
19#include <QtQuick3D/QQuick3DTextureData>
20#include <QtQuick/private/qquickitemchangelistener_p.h>
21#include <QtQuick/QQuickItem>
22#include <QtQuick/QSGNode>
23#include <QtCore/QUrl>
24#include <QtCore/QPointer>
25
26QT_BEGIN_NAMESPACE
27
28class QSGLayer;
29struct QSSGRenderImage;
30class QQuick3DRenderExtension;
31
32class Q_QUICK3D_EXPORT QQuick3DTexture : public QQuick3DObject, public QQuickItemChangeListener
33{
34 Q_OBJECT
35 Q_PROPERTY(QUrl source READ source WRITE setSource NOTIFY sourceChanged)
36 Q_PROPERTY(QQuickItem *sourceItem READ sourceItem WRITE setSourceItem NOTIFY sourceItemChanged)
37 Q_PROPERTY(QQuick3DTextureData *textureData READ textureData WRITE setTextureData NOTIFY textureDataChanged)
38 Q_PROPERTY(QQuick3DRenderExtension *textureProvider READ textureProvider WRITE setTextureProvider NOTIFY textureProviderChanged FINAL REVISION(6, 7))
39 Q_PROPERTY(float scaleU READ scaleU WRITE setScaleU NOTIFY scaleUChanged)
40 Q_PROPERTY(float scaleV READ scaleV WRITE setScaleV NOTIFY scaleVChanged)
41 Q_PROPERTY(MappingMode mappingMode READ mappingMode WRITE setMappingMode NOTIFY mappingModeChanged)
42 Q_PROPERTY(TilingMode tilingModeHorizontal READ horizontalTiling WRITE setHorizontalTiling NOTIFY horizontalTilingChanged)
43 Q_PROPERTY(TilingMode tilingModeVertical READ verticalTiling WRITE setVerticalTiling NOTIFY verticalTilingChanged)
44 Q_PROPERTY(TilingMode tilingModeDepth READ depthTiling WRITE setDepthTiling NOTIFY depthTilingChanged REVISION(6, 7))
45 Q_PROPERTY(float rotationUV READ rotationUV WRITE setRotationUV NOTIFY rotationUVChanged)
46 Q_PROPERTY(float positionU READ positionU WRITE setPositionU NOTIFY positionUChanged)
47 Q_PROPERTY(float positionV READ positionV WRITE setPositionV NOTIFY positionVChanged)
48 Q_PROPERTY(float pivotU READ pivotU WRITE setPivotU NOTIFY pivotUChanged)
49 Q_PROPERTY(float pivotV READ pivotV WRITE setPivotV NOTIFY pivotVChanged)
50 Q_PROPERTY(bool flipU READ flipU WRITE setFlipU NOTIFY flipUChanged)
51 Q_PROPERTY(bool flipV READ flipV WRITE setFlipV NOTIFY flipVChanged)
52 Q_PROPERTY(int indexUV READ indexUV WRITE setIndexUV NOTIFY indexUVChanged)
53 Q_PROPERTY(Filter magFilter READ magFilter WRITE setMagFilter NOTIFY magFilterChanged)
54 Q_PROPERTY(Filter minFilter READ minFilter WRITE setMinFilter NOTIFY minFilterChanged)
55 Q_PROPERTY(Filter mipFilter READ mipFilter WRITE setMipFilter NOTIFY mipFilterChanged)
56 Q_PROPERTY(bool generateMipmaps READ generateMipmaps WRITE setGenerateMipmaps NOTIFY generateMipmapsChanged)
57 Q_PROPERTY(bool autoOrientation READ autoOrientation WRITE setAutoOrientation NOTIFY autoOrientationChanged REVISION(6, 2))
58
59 QML_NAMED_ELEMENT(Texture)
60
61public:
62 enum MappingMode
63 {
64 UV = 0,
65 Environment = 1,
66 LightProbe = 2,
67 };
68 Q_ENUM(MappingMode)
69
70 enum TilingMode // must match QSSGRenderTextureCoordOp
71 {
72 ClampToEdge = 1,
73 MirroredRepeat,
74 Repeat
75 };
76 Q_ENUM(TilingMode)
77
78 enum Filter { // must match QSSGRenderTextureFilterOp
79 None = 0,
80 Nearest,
81 Linear
82 };
83 Q_ENUM(Filter)
84
85 explicit QQuick3DTexture(QQuick3DObject *parent = nullptr);
86 ~QQuick3DTexture() override;
87
88 QUrl source() const;
89 QQuickItem *sourceItem() const;
90 float scaleU() const;
91 float scaleV() const;
92 MappingMode mappingMode() const;
93 TilingMode horizontalTiling() const;
94 TilingMode verticalTiling() const;
95 Q_REVISION(6, 7) TilingMode depthTiling() const;
96 float rotationUV() const;
97 float positionU() const;
98 float positionV() const;
99 float pivotU() const;
100 float pivotV() const;
101 bool flipU() const;
102 bool flipV() const;
103 int indexUV() const;
104 Filter magFilter() const;
105 Filter minFilter() const;
106 Filter mipFilter() const;
107 QQuick3DTextureData *textureData() const;
108 bool generateMipmaps() const;
109 bool autoOrientation() const;
110
111 QSSGRenderImage *getRenderImage();
112
113 Q_REVISION(6, 7) QQuick3DRenderExtension *textureProvider() const;
114 Q_REVISION(6, 7) void setTextureProvider(QQuick3DRenderExtension *newRenderTexture);
115
116 bool extensionDirty() const { return m_dirtyFlags.testFlag(DirtyFlag::ExtensionDirty); }
117
118public Q_SLOTS:
119 void setSource(const QUrl &source);
120 void setSourceItem(QQuickItem *sourceItem);
121 void setScaleU(float scaleU);
122 void setScaleV(float scaleV);
123 void setMappingMode(QQuick3DTexture::MappingMode mappingMode);
124 void setHorizontalTiling(QQuick3DTexture::TilingMode tilingModeHorizontal);
125 void setVerticalTiling(QQuick3DTexture::TilingMode tilingModeVertical);
126 Q_REVISION(6, 7) void setDepthTiling(QQuick3DTexture::TilingMode tilingModeDepth);
127 void setRotationUV(float rotationUV);
128 void setPositionU(float positionU);
129 void setPositionV(float positionV);
130 void setPivotU(float pivotU);
131 void setPivotV(float pivotV);
132 void setFlipU(bool flipU);
133 void setFlipV(bool flipV);
134 void setIndexUV(int indexUV);
135 void setMagFilter(QQuick3DTexture::Filter magFilter);
136 void setMinFilter(QQuick3DTexture::Filter minFilter);
137 void setMipFilter(QQuick3DTexture::Filter mipFilter);
138 void setTextureData(QQuick3DTextureData * textureData);
139 void setGenerateMipmaps(bool generateMipmaps);
140 void setAutoOrientation(bool autoOrientation);
141
142Q_SIGNALS:
143 void sourceChanged();
144 void sourceItemChanged();
145 void scaleUChanged();
146 void scaleVChanged();
147 void mappingModeChanged();
148 void horizontalTilingChanged();
149 void verticalTilingChanged();
150 Q_REVISION(6, 7) void depthTilingChanged();
151 void rotationUVChanged();
152 void positionUChanged();
153 void positionVChanged();
154 void pivotUChanged();
155 void pivotVChanged();
156 void flipUChanged();
157 void flipVChanged();
158 void indexUVChanged();
159 void magFilterChanged();
160 void minFilterChanged();
161 void mipFilterChanged();
162 void textureDataChanged();
163 void generateMipmapsChanged();
164 void autoOrientationChanged();
165 Q_REVISION(6, 7) void textureProviderChanged();
166
167protected:
168 QSSGRenderGraphObject *updateSpatialNode(QSSGRenderGraphObject *node) override;
169 void markAllDirty() override;
170 void itemChange(ItemChange change, const ItemChangeData &value) override;
171
172 void itemGeometryChanged(QQuickItem *item, QQuickGeometryChange change, const QRectF &geometry) override;
173
174 explicit QQuick3DTexture(QQuick3DObjectPrivate &dd, QQuick3DObject *parent = nullptr);
175
176private Q_SLOTS:
177 void sourceItemDestroyed(QObject *item);
178
179private:
180 enum class DirtyFlag {
181 TransformDirty = (1 << 0),
182 SourceDirty = (1 << 1),
183 IndexUVDirty = (1 << 2),
184 TextureDataDirty = (1 << 3),
185 SamplerDirty = (1 << 4),
186 SourceItemDirty = (1 << 5),
187 FlipVDirty = (1 << 6),
188 ExtensionDirty = (1 << 7)
189 };
190 Q_DECLARE_FLAGS(DirtyFlags, DirtyFlag)
191 void markDirty(DirtyFlag type);
192 void trySetSourceParent();
193 bool effectiveFlipV(const QSSGRenderImage &imageNode) const;
194
195 QUrl m_source;
196 QQuickItem *m_sourceItem = nullptr;
197 bool m_sourceItemReparented = false;
198 bool m_sourceItemRefed = false;
199 QSGLayer *m_layer = nullptr;
200 float m_scaleU = 1.0f;
201 float m_scaleV = 1.0f;
202 MappingMode m_mappingMode = UV;
203 TilingMode m_tilingModeHorizontal = Repeat;
204 TilingMode m_tilingModeVertical = Repeat;
205 TilingMode m_tilingModeDepth = Repeat;
206 float m_rotationUV = 0;
207 float m_positionU = 0;
208 float m_positionV = 0;
209 float m_pivotU = 0;
210 float m_pivotV = 0;
211 bool m_flipU = false;
212 bool m_flipV = false;
213 int m_indexUV = 0;
214 Filter m_magFilter = Linear;
215 Filter m_minFilter = Linear;
216 Filter m_mipFilter = None;
217 DirtyFlags m_dirtyFlags = DirtyFlags(DirtyFlag::TransformDirty)
218 | DirtyFlags(DirtyFlag::SourceDirty)
219 | DirtyFlags(DirtyFlag::IndexUVDirty)
220 | DirtyFlags(DirtyFlag::TextureDataDirty);
221 QMetaObject::Connection m_textureProviderConnection;
222 QMetaObject::Connection m_textureUpdateConnection;
223 QQuick3DSceneManager *m_sceneManagerForLayer = nullptr;
224 QMetaObject::Connection m_sceneManagerWindowChangeConnection;
225 QQuickItem *m_initializedSourceItem = nullptr;
226 QSizeF m_initializedSourceItemSize;
227 QHash<QByteArray, QMetaObject::Connection> m_connections;
228 QMetaObject::Connection m_textureDataConnection;
229 QQuick3DTextureData *m_textureData = nullptr;
230 bool m_generateMipmaps = false;
231 bool m_autoOrientation = true;
232 QMetaMethod m_updateSlot;
233 QQuick3DRenderExtension *m_renderExtension = nullptr;
234};
235
236QT_END_NAMESPACE
237
238#endif // QSSGIMAGE_H
QMetaMethod
\inmodule QtCore
Definition qmetaobject.h:19
Connection
\inmodule QtCore Represents a handle to a signal-slot (or signal-functor) connection.
QObject
\inmodule QtCore
Definition qobject.h:103
QQuick3DObject
\qmltype Object3D \inqmlmodule QtQuick3D \instantiates QQuick3DObject \inherits QtObject
Definition qquick3dobject.h:22
QQuick3DTextureData
\qmltype TextureData \inherits Object3D \inqmlmodule QtQuick3D \instantiates QQuick3DTextureData
Definition qquick3dtexturedata.h:14
QQuick3DTexture::Q_REVISION
Q_REVISION(6, 7) TilingMode depthTiling() const
QQuickItem
The QQuickItem class provides the most basic of all visual items in \l {Qt Quick}.
Definition qquickitem.h:63
QRectF
\inmodule QtCore\reentrant
Definition qrect.h:484
QSizeF
\inmodule QtCore
Definition qsize.h:208
QUrl
\inmodule QtCore
Definition qurl.h:94
QT_BEGIN_NAMESPACE
Combined button and popup list for selecting options.
Definition qstandardpaths_haiku.cpp:21
QT_END_NAMESPACE
Definition qsharedpointer.cpp:1590
void
DBusConnection const char DBusError DBusBusType DBusError return DBusConnection DBusHandleMessageFunction void DBusFreeFunction return DBusConnection return DBusConnection return const char DBusError return DBusConnection DBusMessage dbus_uint32_t return DBusConnection dbus_bool_t DBusConnection DBusAddWatchFunction DBusRemoveWatchFunction DBusWatchToggledFunction void DBusFreeFunction return DBusConnection DBusDispatchStatusFunction void DBusFreeFunction DBusTimeout return DBusTimeout return DBusWatch return DBusWatch unsigned int return DBusError const DBusError return const DBusMessage return DBusMessage return DBusMessage return DBusMessage return DBusMessage return DBusMessage return DBusMessageIter int const void return DBusMessageIter DBusMessageIter return DBusMessageIter void DBusMessageIter void int return DBusMessage DBusMessageIter return DBusMessageIter return DBusMessageIter DBusMessageIter const char const char const char const char return DBusMessage return DBusMessage const char return DBusMessage dbus_bool_t return DBusMessage dbus_uint32_t return DBusMessage void
Definition qdbus_symbols_p.h:409
value
EGLOutputLayerEXT EGLint EGLAttrib value
[5]
Definition qeglstreamconvenience_p.h:46
Q_DECLARE_FLAGS
#define Q_DECLARE_FLAGS(Flags, Enum)
Definition qflags.h:174
Repeat
@ Repeat
Definition qfontsubset.cpp:655
None
@ None
Definition qhash.cpp:531
type
GLenum type
Definition qopengles2ext.h:150
source
GLsizei GLsizei GLchar * source
Definition qopengles2ext.h:952
QML_NAMED_ELEMENT
#define QML_NAMED_ELEMENT(NAME)
Definition qqmlintegration.h:60
QSSGRenderTextureCoordOp::ClampToEdge
@ ClampToEdge
QSSGRenderImageTextureFlagValue::Linear
@ Linear
QSSGRhiSamplerBindingHints::LightProbe
@ LightProbe
Q_ENUM
#define Q_ENUM(x)
Definition qtmetamacros.h:68
Q_PROPERTY
#define Q_PROPERTY(...)
Definition qtmetamacros.h:56
Q_OBJECT
#define Q_OBJECT
Definition qtmetamacros.h:119
Q_REVISION
#define Q_REVISION(...)
Definition qtmetamacros.h:59
Q_SLOTS
#define Q_SLOTS
Definition qtmetamacros.h:44
Q_SIGNALS
#define Q_SIGNALS
Definition qtmetamacros.h:45
explicit
#define explicit
Definition qxcbconnection.cpp:33
item
QGraphicsItem * item
Definition src_gui_graphicsview_qgraphicsitem.cpp:107