Debian Codegraph @

tests/auto/buildtimeqsb/tst_buildtimeqsb.cpp

raw
1 // Copyright (C) 2021 The Qt Company Ltd.
2 // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only
3
4 #include <QtTest/QtTest>
5 #include <QFile>
6 #include <rhi/qshader.h>
7 #include <rhi/qrhi.h>
8
9 class tst_BuildTimeQsb : public QObject
10 {
11 Q_OBJECT
12
13 private slots:
14 void defaultAddShaders();
15 void customTargets();
16 void withDefines();
17 void replacements();
18 void createPipeline();
19 void tessellation();
20 void multiviewSimple();
21 void multiviewAutomatic();
22 };
23
24 static QShader getShader(const QString &name)
25 {
26 QFile f(name);
27 if (f.open(QIODevice::ReadOnly))
28 return QShader::fromSerialized(f.readAll());
29
30 return QShader();
31 }
32
33 static const int defaultShaderCount = 6;
34 static const QShaderKey defaultShaderKeys[defaultShaderCount] = {
35 QShaderKey(QShader::SpirvShader, QShaderVersion(100)),
36 QShaderKey(QShader::HlslShader, QShaderVersion(50)),
37 QShaderKey(QShader::MslShader, QShaderVersion(12)),
38 QShaderKey(QShader::GlslShader, QShaderVersion(100, QShaderVersion::GlslEs)),
39 QShaderKey(QShader::GlslShader, QShaderVersion(120)),
40 QShaderKey(QShader::GlslShader, QShaderVersion(150)),
41 };
42
43 void tst_BuildTimeQsb::defaultAddShaders()
44 {
45 // "shaders"
46 QShader color_vert = getShader(QLatin1String(":/test/color.vert.qsb"));
47 QVERIFY(color_vert.isValid());
48 QCOMPARE(color_vert.availableShaders().size(), defaultShaderCount);
49 for (int i = 0; i < defaultShaderCount; ++i)
50 QVERIFY(color_vert.availableShaders().contains(defaultShaderKeys[i]));
51
52 QShader color_frag = getShader(QLatin1String(":/test/color.frag.qsb"));
53 QVERIFY(color_frag.isValid());
54 QCOMPARE(color_frag.availableShaders().size(), defaultShaderCount);
55 for (int i = 0; i < defaultShaderCount; ++i)
56 QVERIFY(color_frag.availableShaders().contains(defaultShaderKeys[i]));
57
58 // "shaders_precompile"
59 QShader color_vert_pre = getShader(QLatin1String(":/test/color_precomp.vert.qsb"));
60 QVERIFY(color_vert_pre.isValid());
61 QCOMPARE(color_vert_pre.availableShaders().size(), defaultShaderCount);
62
63 QShader color_frag_pre = getShader(QLatin1String(":/test/color_precomp.frag.qsb"));
64 QVERIFY(color_frag_pre.isValid());
65 QCOMPARE(color_frag_pre.availableShaders().size(), defaultShaderCount);
66
67 // "shaders_in_subdir"
68 QShader texture_vert = getShader(QLatin1String(":/some/prefix/subdir/texture.vert.qsb"));
69 QVERIFY(texture_vert.isValid());
70 QCOMPARE(texture_vert.availableShaders().size(), defaultShaderCount);
71 for (int i = 0; i < defaultShaderCount; ++i)
72 QVERIFY(texture_vert.availableShaders().contains(defaultShaderKeys[i]));
73
74 QShader texture_frag = getShader(QLatin1String(":/some/prefix/subdir/texture.frag.qsb"));
75 QVERIFY(texture_frag.isValid());
76 QCOMPARE(texture_frag.availableShaders().size(), defaultShaderCount);
77 for (int i = 0; i < defaultShaderCount; ++i)
78 QVERIFY(texture_frag.availableShaders().contains(defaultShaderKeys[i]));
79
80 // "shaders_in_subdir_with_outputs_as_alias"
81 QShader alias_texture_vert = getShader(QLatin1String(":/some/prefix/alias_texture.vert.qsb"));
82 QVERIFY(alias_texture_vert.isValid());
83 QCOMPARE(alias_texture_vert.availableShaders().size(), defaultShaderCount);
84 for (int i = 0; i < defaultShaderCount; ++i)
85 QVERIFY(alias_texture_vert.availableShaders().contains(defaultShaderKeys[i]));
86
87 QShader alias_texture_frag = getShader(QLatin1String(":/some/prefix/x/y/z/alias_texture.frag.qsb"));
88 QVERIFY(alias_texture_frag.isValid());
89 QCOMPARE(alias_texture_frag.availableShaders().size(), defaultShaderCount);
90 for (int i = 0; i < defaultShaderCount; ++i)
91 QVERIFY(alias_texture_frag.availableShaders().contains(defaultShaderKeys[i]));
92
93 // "shaders_in_subdir_with_base"
94 QShader texture2_vert = getShader(QLatin1String(":/base_test/texture2.vert.qsb"));
95 QVERIFY(texture2_vert.isValid());
96 QCOMPARE(texture2_vert.availableShaders().size(), defaultShaderCount * 2); // batchable
97 }
98
99 void tst_BuildTimeQsb::customTargets()
100 {
101 QShader color_vert = getShader(QLatin1String(":/test/color_1.vert.qsb"));
102 QVERIFY(color_vert.isValid());
103 QCOMPARE(color_vert.availableShaders().size(), 3);
104 QVERIFY(color_vert.availableShaders().contains(QShaderKey(QShader::SpirvShader, QShaderVersion(100))));
105 QVERIFY(color_vert.availableShaders().contains(QShaderKey(QShader::GlslShader, QShaderVersion(300, QShaderVersion::GlslEs))));
106 QVERIFY(color_vert.availableShaders().contains(QShaderKey(QShader::GlslShader, QShaderVersion(330))));
107
108 QShader color_frag = getShader(QLatin1String(":/test/color_1.frag.qsb"));
109 QVERIFY(color_frag.isValid());
110 QCOMPARE(color_frag.availableShaders().size(), 3);
111 QVERIFY(color_frag.availableShaders().contains(QShaderKey(QShader::SpirvShader, QShaderVersion(100))));
112 QVERIFY(color_frag.availableShaders().contains(QShaderKey(QShader::GlslShader, QShaderVersion(300, QShaderVersion::GlslEs))));
113 QVERIFY(color_frag.availableShaders().contains(QShaderKey(QShader::GlslShader, QShaderVersion(330))));
114
115 QShader bat_color_vert = getShader(QLatin1String(":/test/color_1b.vert.qsb"));
116 QVERIFY(bat_color_vert.isValid());
117 QCOMPARE(bat_color_vert.availableShaders().size(), 6);
118 QVERIFY(bat_color_vert.availableShaders().contains(QShaderKey(QShader::SpirvShader, QShaderVersion(100))));
119 QVERIFY(bat_color_vert.availableShaders().contains(QShaderKey(QShader::GlslShader, QShaderVersion(300, QShaderVersion::GlslEs))));
120 QVERIFY(bat_color_vert.availableShaders().contains(QShaderKey(QShader::GlslShader, QShaderVersion(330))));
121 QVERIFY(bat_color_vert.availableShaders().contains(QShaderKey(QShader::SpirvShader, QShaderVersion(100), QShader::BatchableVertexShader)));
122 QVERIFY(bat_color_vert.availableShaders().contains(QShaderKey(QShader::GlslShader, QShaderVersion(300, QShaderVersion::GlslEs), QShader::BatchableVertexShader)));
123 QVERIFY(bat_color_vert.availableShaders().contains(QShaderKey(QShader::GlslShader, QShaderVersion(330), QShader::BatchableVertexShader)));
124
125 QShader bat_color_frag = getShader(QLatin1String(":/test/color_1b.frag.qsb"));
126 QVERIFY(bat_color_frag.isValid());
127 QCOMPARE(bat_color_frag.availableShaders().size(), 3); // batchable applies to vertex shaders only
128 QVERIFY(bat_color_frag.availableShaders().contains(QShaderKey(QShader::SpirvShader, QShaderVersion(100))));
129 QVERIFY(bat_color_frag.availableShaders().contains(QShaderKey(QShader::GlslShader, QShaderVersion(300, QShaderVersion::GlslEs))));
130 QVERIFY(bat_color_frag.availableShaders().contains(QShaderKey(QShader::GlslShader, QShaderVersion(330))));
131 }
132
133 void tst_BuildTimeQsb::withDefines()
134 {
135 QShader s = getShader(QLatin1String(":/subdir/test/texture_def.frag.qsb"));
136 QVERIFY(s.isValid());
137 QCOMPARE(s.availableShaders().size(), defaultShaderCount);
138 for (int i = 0; i < defaultShaderCount; ++i)
139 QVERIFY(s.availableShaders().contains(defaultShaderKeys[i]));
140 }
141
142 void tst_BuildTimeQsb::replacements()
143 {
144 QShader s = getShader(QLatin1String(":/test/color_repl.vert.qsb"));
145 QVERIFY(s.isValid());
146 QCOMPARE(s.availableShaders().size(), defaultShaderCount);
147 for (int i = 0; i < defaultShaderCount; ++i)
148 QVERIFY(s.availableShaders().contains(defaultShaderKeys[i]));
149
150 QByteArray src = s.shader(QShaderKey(QShader::SpirvShader, QShaderVersion(100))).shader();
151 QVERIFY(!src.isEmpty());
152 QCOMPARE(src.left(21), QByteArrayLiteral("Not very valid SPIR-V"));
153
154 src = s.shader(QShaderKey(QShader::GlslShader, QShaderVersion(100, QShaderVersion::GlslEs))).shader();
155 QVERIFY(!src.isEmpty());
156 QCOMPARE(src.left(7), QByteArrayLiteral("Test r1"));
157
158 src = s.shader(QShaderKey(QShader::HlslShader, QShaderVersion(50))).shader();
159 QVERIFY(!src.isEmpty());
160 QCOMPARE(src.left(7), QByteArrayLiteral("Test r3"));
161
162 s = getShader(QLatin1String(":/test/x/color_repl.frag.qsb"));
163 QVERIFY(s.isValid());
164 QCOMPARE(s.availableShaders().size(), defaultShaderCount);
165 for (int i = 0; i < defaultShaderCount; ++i)
166 QVERIFY(s.availableShaders().contains(defaultShaderKeys[i]));
167
168 src = s.shader(QShaderKey(QShader::MslShader, QShaderVersion(12))).shader();
169 QVERIFY(!src.isEmpty());
170 QCOMPARE(src.left(7), QByteArrayLiteral("Test r4"));
171 }
172
173 void tst_BuildTimeQsb::createPipeline()
174 {
175 // this focuses on loading up a vertex and fragment shader from .qsb files
176 // that were generated with PRECOMPILE, and may be relevant mainly for D3D
177 // and Metal where the flag may have an actual effect (not guaranteed), so
178 // test only those
179
180 #if defined(Q_OS_MACOS) || defined(Q_OS_IOS) || defined(Q_OS_WIN)
181
182 #if defined(Q_OS_MACOS) || defined(Q_OS_IOS)
183 QRhiMetalInitParams initParams;
184 QRhi::Implementation backend = QRhi::Metal;
185 #elif defined(Q_OS_WIN)
186 QRhiD3D11InitParams initParams;
187 QRhi::Implementation backend = QRhi::D3D11;
188 #endif
189
190 QScopedPointer<QRhi> rhi(QRhi::create(backend, &initParams, {}, nullptr));
191 if (!rhi)
192 QSKIP("Failed to create QRhi, skipping pipeline creation test");
193
194 qDebug() << rhi->driverInfo();
195
196 QScopedPointer<QRhiTexture> texture(rhi->newTexture(QRhiTexture::RGBA8, QSize(256, 256), 1, QRhiTexture::RenderTarget));
197 QVERIFY(texture->create());
198 QScopedPointer<QRhiTextureRenderTarget> rt(rhi->newTextureRenderTarget({ texture.data() }));
199 QScopedPointer<QRhiRenderPassDescriptor> rpDesc(rt->newCompatibleRenderPassDescriptor());
200 rt->setRenderPassDescriptor(rpDesc.data());
201 QVERIFY(rt->create());
202
203 QScopedPointer<QRhiShaderResourceBindings> srb(rhi->newShaderResourceBindings());
204 QVERIFY(srb->create());
205
206 QRhiVertexInputLayout inputLayout;
207 inputLayout.setBindings({ { 6 * sizeof(float) } });
208 inputLayout.setAttributes({ { 0, 0, QRhiVertexInputAttribute::Float3, 0 },
209 { 0, 1, QRhiVertexInputAttribute::Float3, 3 * sizeof(float) }
210 });
211
212 QShader color_vert_pre = getShader(QLatin1String(":/test/color_precomp.vert.qsb"));
213 QVERIFY(color_vert_pre.isValid());
214 QShader color_frag_pre = getShader(QLatin1String(":/test/color_precomp.frag.qsb"));
215 QVERIFY(color_frag_pre.isValid());
216 QScopedPointer<QRhiGraphicsPipeline> pipeline;
217 pipeline.reset(rhi->newGraphicsPipeline());
218 pipeline->setShaderStages({ { QRhiShaderStage::Vertex, color_vert_pre }, { QRhiShaderStage::Fragment, color_frag_pre } });
219 pipeline->setVertexInputLayout(inputLayout);
220 pipeline->setShaderResourceBindings(srb.data());
221 pipeline->setRenderPassDescriptor(rpDesc.data());
222 QVERIFY(pipeline->create());
223
224 #else
225 QSKIP("Skipping pipeline creation test on this platform");
226 #endif
227 }
228
229 void tst_BuildTimeQsb::tessellation()
230 {
231 QShader s = getShader(QLatin1String(":/test/tess.vert.qsb"));
232 QVERIFY(s.isValid());
233 QCOMPARE(s.availableShaders().size(), 8); // SPIR-V, 2xGLSL, HLSL, 4xMSL
234
235 s = getShader(QLatin1String(":/test/tess.tesc.qsb"));
236 QVERIFY(s.isValid());
237 QCOMPARE(s.availableShaders().size(), 5); // SPIR-V, 2xGLSL, HLSL, MSL
238
239 s = getShader(QLatin1String(":/test/tess.tese.qsb"));
240 QVERIFY(s.isValid());
241 QCOMPARE(s.availableShaders().size(), 5); // SPIR-V, 2xGLSL, HLSL, MSL
242
243 s = getShader(QLatin1String(":/test/tess.frag.qsb"));
244 QVERIFY(s.isValid());
245 QCOMPARE(s.availableShaders().size(), 5); // SPIR-V, 2xGLSL, HLSL, MSL
246 }
247
248 void tst_BuildTimeQsb::multiviewSimple()
249 {
250 QShader s = getShader(QLatin1String(":/test/color_multiview.vert.qsb"));
251 QVERIFY(s.isValid());
252 QVERIFY(s.availableShaders().contains(QShaderKey(QShader::GlslShader, QShaderVersion(330))));
253 QVERIFY(s.availableShaders().contains(QShaderKey(QShader::HlslShader, QShaderVersion(61))));
254 QVERIFY(s.availableShaders().contains(QShaderKey(QShader::MslShader, QShaderVersion(12))));
255
256 s = getShader(QLatin1String(":/test/color_multiview.frag.qsb"));
257 QVERIFY(s.isValid());
258 }
259
260 void tst_BuildTimeQsb::multiviewAutomatic()
261 {
262 // these are the non-multiview versions
263 QShader s = getShader(QLatin1String(":/test/color_multiview_def.vert.qsb"));
264 QVERIFY(s.isValid());
265 QVERIFY(s.availableShaders().contains(QShaderKey(QShader::GlslShader, QShaderVersion(120))));
266 QVERIFY(s.availableShaders().contains(QShaderKey(QShader::HlslShader, QShaderVersion(50))));
267 QVERIFY(s.availableShaders().contains(QShaderKey(QShader::MslShader, QShaderVersion(12))));
268
269 s = getShader(QLatin1String(":/test/color_multiview_def.frag.qsb"));
270 QVERIFY(s.isValid());
271 QVERIFY(s.availableShaders().contains(QShaderKey(QShader::GlslShader, QShaderVersion(120))));
272 QVERIFY(s.availableShaders().contains(QShaderKey(QShader::HlslShader, QShaderVersion(50))));
273 QVERIFY(s.availableShaders().contains(QShaderKey(QShader::MslShader, QShaderVersion(12))));
274
275 // the view count 2 versions with the special suffix
276 s = getShader(QLatin1String(":/test/color_multiview_def.vert.qsb.mv2qsb"));
277 QVERIFY(s.isValid());
278 QVERIFY(s.availableShaders().contains(QShaderKey(QShader::SpirvShader, QShaderVersion(100))));
279 QVERIFY(s.availableShaders().contains(QShaderKey(QShader::GlslShader, QShaderVersion(330))));
280 QVERIFY(s.availableShaders().contains(QShaderKey(QShader::HlslShader, QShaderVersion(61))));
281 QVERIFY(s.availableShaders().contains(QShaderKey(QShader::MslShader, QShaderVersion(21))));
282
283 s = getShader(QLatin1String(":/test/color_multiview_def.frag.qsb.mv2qsb"));
284 QVERIFY(s.isValid());
285 QVERIFY(s.availableShaders().contains(QShaderKey(QShader::SpirvShader, QShaderVersion(100))));
286 QVERIFY(s.availableShaders().contains(QShaderKey(QShader::GlslShader, QShaderVersion(330))));
287 QVERIFY(s.availableShaders().contains(QShaderKey(QShader::HlslShader, QShaderVersion(61))));
288 QVERIFY(s.availableShaders().contains(QShaderKey(QShader::MslShader, QShaderVersion(21))));
289 }
290
291 #include <tst_buildtimeqsb.moc>
292 QTEST_MAIN(tst_BuildTimeQsb)