1/****************************************************************************
2**
3** Copyright (C) 2016 The Qt Company Ltd.
4** Contact: https://www.qt.io/licensing/
5**
6** This file is part of the QtQuick 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 The Qt Company. For licensing terms
14** and conditions see https://www.qt.io/terms-conditions. For further
15** information use the contact form at https://www.qt.io/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 3 as published by the Free Software
20** Foundation and appearing in the file LICENSE.LGPL3 included in the
21** packaging of this file. Please review the following information to
22** ensure the GNU Lesser General Public License version 3 requirements
23** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
24**
25** GNU General Public License Usage
26** Alternatively, this file may be used under the terms of the GNU
27** General Public License version 2.0 or (at your option) the GNU General
28** Public license version 3 or any later version approved by the KDE Free
29** Qt Foundation. The licenses are as published by the Free Software
30** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
31** included in the packaging of this file. Please review the following
32** information to ensure the GNU General Public License requirements will
33** be met: https://www.gnu.org/licenses/gpl-2.0.html and
34** https://www.gnu.org/licenses/gpl-3.0.html.
35**
36** $QT_END_LICENSE$
37**
38****************************************************************************/
39
40#ifndef QQUICKSHADEREFFECT_P_H
41#define QQUICKSHADEREFFECT_P_H
42
43//
44// W A R N I N G
45// -------------
46//
47// This file is not part of the Qt API. It exists purely as an
48// implementation detail. This header file may change from version to
49// version without notice, or even be removed.
50//
51// We mean it.
52//
53
54#include <private/qtquickglobal_p.h>
55
56QT_REQUIRE_CONFIG(quick_shadereffect);
57
58#include <QtQuick/qquickitem.h>
59#include <private/qtquickglobal_p.h>
60
61QT_BEGIN_NAMESPACE
62
63class QQuickOpenGLShaderEffect;
64class QQuickGenericShaderEffect;
65class QQuickShaderEffectPrivate;
66
67class Q_QUICK_PRIVATE_EXPORT QQuickShaderEffect : public QQuickItem
68{
69 Q_OBJECT
70 Q_PROPERTY(QByteArray fragmentShader READ fragmentShader WRITE setFragmentShader NOTIFY fragmentShaderChanged)
71 Q_PROPERTY(QByteArray vertexShader READ vertexShader WRITE setVertexShader NOTIFY vertexShaderChanged)
72 Q_PROPERTY(bool blending READ blending WRITE setBlending NOTIFY blendingChanged)
73 Q_PROPERTY(QVariant mesh READ mesh WRITE setMesh NOTIFY meshChanged)
74 Q_PROPERTY(CullMode cullMode READ cullMode WRITE setCullMode NOTIFY cullModeChanged)
75 Q_PROPERTY(QString log READ log NOTIFY logChanged)
76 Q_PROPERTY(Status status READ status NOTIFY statusChanged)
77 Q_PROPERTY(bool supportsAtlasTextures READ supportsAtlasTextures WRITE setSupportsAtlasTextures NOTIFY supportsAtlasTexturesChanged REVISION 1)
78
79public:
80 enum CullMode {
81 NoCulling,
82 BackFaceCulling,
83 FrontFaceCulling
84 };
85 Q_ENUM(CullMode)
86
87 enum Status {
88 Compiled,
89 Uncompiled,
90 Error
91 };
92 Q_ENUM(Status)
93
94 QQuickShaderEffect(QQuickItem *parent = nullptr);
95 ~QQuickShaderEffect() override;
96
97 QByteArray fragmentShader() const;
98 void setFragmentShader(const QByteArray &code);
99
100 QByteArray vertexShader() const;
101 void setVertexShader(const QByteArray &code);
102
103 bool blending() const;
104 void setBlending(bool enable);
105
106 QVariant mesh() const;
107 void setMesh(const QVariant &mesh);
108
109 CullMode cullMode() const;
110 void setCullMode(CullMode face);
111
112 bool supportsAtlasTextures() const;
113 void setSupportsAtlasTextures(bool supports);
114
115 QString log() const;
116 Status status() const;
117
118 bool isComponentComplete() const;
119 QString parseLog();
120
121#if QT_CONFIG(opengl)
122 bool isOpenGLShaderEffect() const;
123#endif
124
125Q_SIGNALS:
126 void fragmentShaderChanged();
127 void vertexShaderChanged();
128 void blendingChanged();
129 void meshChanged();
130 void cullModeChanged();
131 void logChanged();
132 void statusChanged();
133 void supportsAtlasTexturesChanged();
134
135protected:
136 bool event(QEvent *e) override;
137 void geometryChanged(const QRectF &newGeometry, const QRectF &oldGeometry) override;
138 QSGNode *updatePaintNode(QSGNode *oldNode, UpdatePaintNodeData *updatePaintNodeData) override;
139 void componentComplete() override;
140 void itemChange(ItemChange change, const ItemChangeData &value) override;
141
142private:
143#if QT_CONFIG(opengl)
144 QQuickOpenGLShaderEffect *m_glImpl;
145#endif
146 QQuickGenericShaderEffect *m_impl;
147
148 Q_DECLARE_PRIVATE(QQuickShaderEffect)
149};
150
151QT_END_NAMESPACE
152
153#endif // QQUICKSHADEREFFECT_P_H
154