Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
Loading...
Searching...
No Matches
qssgrenderbuffermanager.cpp
Go to the documentation of this file.
1// Copyright (C) 2008-2012 NVIDIA Corporation.
2// Copyright (C) 2019 The Qt Company Ltd.
3// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only
4// Qt-Security score:significant reason:default
5
6
8
9#include <QtQuick3DRuntimeRender/private/qssgrenderloadedtexture_p.h>
10
11#include <QtQuick3DRuntimeRender/private/qssgruntimerenderlogging_p.h>
12#include <QtQuick3DUtils/private/qssgmeshbvhbuilder_p.h>
13#include <QtQuick3DUtils/private/qssgbounds3_p.h>
14#include <QtQuick3DUtils/private/qssgassert_p.h>
16#include <QtQuick/QSGTexture>
17
18#include <QtCore/QDir>
19#include <QtGui/private/qimage_p.h>
20#include <QtQuick/private/qsgtexture_p.h>
21#include <QtQuick/private/qsgcompressedtexture_p.h>
22#include <QBuffer>
23
24#include "../utils/qssgrenderbasetypes_p.h"
25#include <QtQuick3DRuntimeRender/private/qssgrendergeometry_p.h>
26#include <QtQuick3DRuntimeRender/private/qssgrendermodel_p.h>
27#include <QtQuick3DRuntimeRender/private/qssgrenderimage_p.h>
28#include <QtQuick3DRuntimeRender/private/qssgrendertexturedata_p.h>
29#include "../qssgrendercontextcore.h"
30#include <QtQuick3DRuntimeRender/private/qssglightmapper_p.h>
31#include <QtQuick3DRuntimeRender/private/qssgrenderresourceloader_p.h>
32#include <qtquick3d_tracepoints_p.h>
33#include "../extensionapi/qssgrenderextensions.h"
35
37
38using namespace Qt::StringLiterals;
39
41{
42enum class Level
43{
44 Debug = 0x1,
45 Usage = 0x2,
46 // 0x3 DebugAndUsage
47};
48
49#ifdef QT_DEBUG
50static bool enabled(Level level)
51{
53 static auto v = qEnvironmentVariableIntValue("QSSG_BUFFERMANAGER_DEBUG");
54 return v && Level{v} <= DebugAndUsage && (v & quint8(level));
55}
56#else
57static constexpr bool enabled(Level) { return false; }
58#endif
59
60}
61
78
84using AssetMeshMap = QHash<QString, MeshStorageRef>;
85
86Q_GLOBAL_STATIC(AssetMeshMap, g_assetMeshMap)
87
88// Returns !idx@asset_id
89QString QSSGBufferManager::runtimeMeshSourceName(const QString &assetId, qsizetype meshId)
90{
91 return QString::fromUtf16(u"!%1@%2").arg(QString::number(meshId), assetId);
92}
93
94using MeshIdxNamePair = QPair<qsizetype, QString>;
95static MeshIdxNamePair splitRuntimeMeshPath(const QSSGRenderPath &rpath)
96{
97 const auto &path = rpath.path();
98 Q_ASSERT(path.startsWith(u'!'));
99 const auto strings = path.mid(1).split(u'@');
100 const bool hasData = (strings.size() == 2) && !strings[0].isEmpty() && !strings[1].isEmpty();
101 qsizetype idx = -1;
102 bool ok = false;
103 if (hasData)
104 idx = strings.at(0).toLongLong(&ok);
105
106 return (ok) ? qMakePair(idx, strings.at(1)) : qMakePair(qsizetype(-1), QString());
107}
108
109namespace {
110struct PrimitiveEntry
111{
112 // Name of the primitive as it will be in e.g., the QML file
113 const char *primitive;
114 // Name of the primitive file on the filesystem
115 const char *file;
116};
117}
118
119static const int nPrimitives = 5;
120static const PrimitiveEntry primitives[nPrimitives] = {
121 {"#Rectangle", "/Rectangle.mesh"},
122 {"#Sphere","/Sphere.mesh"},
123 {"#Cube","/Cube.mesh"},
124 {"#Cone","/Cone.mesh"},
125 {"#Cylinder","/Cylinder.mesh"},
126};
127
128static const char *primitivesDirectory = "res//primitives";
129
130static constexpr QSize sizeForMipLevel(int mipLevel, const QSize &baseLevelSize)
131{
132 return QSize(qMax(1, baseLevelSize.width() >> mipLevel), qMax(1, baseLevelSize.height() >> mipLevel));
133}
134
135static QPair<QSSGMesh::Mesh, QString> loadFromLightmapFile(const QString &lightmapPath, const QString &lightmapKey)
136{
137 QPair<QSSGMesh::Mesh, QString> retVal;
138
139 if (lightmapPath.isEmpty() || lightmapKey.isEmpty())
140 return retVal;
141
142 if (const auto io = QSSGLightmapLoader::open(lightmapPath)) {
143 const QVariantMap metadata = io->readMap(lightmapKey, QSSGLightmapIODataTag::Metadata);
144 if (metadata.isEmpty())
145 return retVal;
146
147 const QString meshKey = metadata[QStringLiteral("mesh_key")].toString();
148 if (meshKey.isEmpty())
149 return retVal;
150
151 QByteArray meshData = io->readData(meshKey, QSSGLightmapIODataTag::Mesh);
152 if (meshData.isEmpty())
153 return retVal;
154
155 QBuffer buffer(&meshData);
156 buffer.open(QIODevice::ReadOnly);
157 retVal.first = QSSGMesh::Mesh::loadMesh(&buffer, 1);
158 retVal.second = QFileInfo(lightmapPath).fileName() + " ["_L1 + lightmapKey + u']';
159 }
160
161 return retVal;
162}
163
164QSSGBufferManager::QSSGBufferManager()
165{
166}
167
168QSSGBufferManager::~QSSGBufferManager()
169{
170 clear();
171 m_contextInterface = nullptr;
172}
173
174void QSSGBufferManager::setRenderContextInterface(QSSGRenderContextInterface *ctx)
175{
176 m_contextInterface = ctx;
177}
178
179void QSSGBufferManager::releaseCachedResources()
180{
181 clear();
182}
183
184void QSSGBufferManager::releaseResourcesForLayer(QSSGRenderLayer *layer)
185{
186 // frameResetIndex must be +1 since it's depending on being the
187 // next frame and this is the cleanup after the final frame as
188 // the layer is destroyed
189 resetUsageCounters(frameResetIndex + 1, layer);
190 cleanupUnreferencedBuffers(frameResetIndex + 1, layer);
191}
192
193QSSGRenderImageTexture QSSGBufferManager::loadRenderImage(const QSSGRenderImage *image,
194 MipMode inMipMode,
195 LoadRenderImageFlags flags)
196{
197 if (inMipMode == MipModeFollowRenderImage)
198 inMipMode = image->m_generateMipmaps ? MipModeEnable : MipModeDisable;
199
200 const auto &context = m_contextInterface->rhiContext();
201 QSSGRenderImageTexture result;
202 if (image->m_qsgTexture) {
203 QRhi *rhi = context->rhi();
204 QSGTexture *qsgTexture = image->m_qsgTexture;
205 QRhiTexture *rhiTex = qsgTexture->rhiTexture(); // this may not be valid until commit and that's ok
206 if (!rhiTex || rhiTex->rhi() == rhi) {
207 // A QSGTexture from a textureprovider that is not a QSGDynamicTexture
208 // needs to be pushed to get its content updated (or even to create a
209 // QRhiTexture in the first place).
210 QRhiResourceUpdateBatch *rub = rhi->nextResourceUpdateBatch();
211 if (qsgTexture->isAtlasTexture()) {
212 // This returns a non-atlased QSGTexture (or does nothing if the
213 // extraction has already been done), the ownership of which stays with
214 // the atlas. As we do not store (and do not own) qsgTexture below,
215 // apart from using it as a cache key and querying its QRhiTexture
216 // (which we again do not own), we can just pretend we got the
217 // non-atlased QSGTexture in the first place.
218 qsgTexture = qsgTexture->removedFromAtlas(rub);
219 }
220 qsgTexture->commitTextureOperations(rhi, rub);
221 context->commandBuffer()->resourceUpdate(rub);
222 auto theImage = qsgImageMap.find(qsgTexture);
223 if (theImage == qsgImageMap.end())
224 theImage = qsgImageMap.insert(qsgTexture, ImageData());
225 theImage.value().renderImageTexture.m_texture = qsgTexture->rhiTexture();
226 theImage.value().renderImageTexture.m_flags.setHasTransparency(qsgTexture->hasAlphaChannel());
227 // If a texture from Qt Quick has an alpha channel, it is always pre-multiplied
228 theImage.value().renderImageTexture.m_flags.setPreMultipliedAlpha(qsgTexture->hasAlphaChannel());
229 theImage.value().usageCounts[currentLayer]++;
230 result = theImage.value().renderImageTexture;
231 // inMipMode is ignored completely when sourcing the texture from a
232 // QSGTexture. Mipmap generation is not supported, whereas
233 // attempting to use such a texture as a light probe will fail. (no
234 // mip levels, no pre-filtering) In the latter case, print a warning
235 // because that will definitely lead to visual problems in the result.
236 if (inMipMode == MipModeBsdf)
237 qWarning("Cannot use QSGTexture from Texture.sourceItem as light probe.");
238 } else {
239 qWarning("Cannot use QSGTexture (presumably from Texture.sourceItem) created in another "
240 "window that was using a different graphics device/context. "
241 "Avoid using View3D.importScene between multiple windows.");
242 }
243
244 } else if (image->m_rawTextureData) {
245 Q_TRACE_SCOPE(QSSG_textureLoad);
246 Q_QUICK3D_PROFILE_START(QQuick3DProfiler::Quick3DTextureLoad);
247 result = loadTextureData(image->m_rawTextureData, inMipMode);
248 Q_QUICK3D_PROFILE_END_WITH_ID(QQuick3DProfiler::Quick3DTextureLoad, stats.imageDataSize, image->profilingId);
249 } else if (!image->m_imagePath.isEmpty()) {
250
251 const ImageCacheKey imageKey = { image->m_imagePath, inMipMode, int(image->type), QString() };
252 auto foundIt = imageMap.find(imageKey);
253 if (foundIt != imageMap.cend()) {
254 result = foundIt.value().renderImageTexture;
255 } else {
256 Q_QUICK3D_PROFILE_START(QQuick3DProfiler::Quick3DTextureLoad);
257 QScopedPointer<QSSGLoadedTexture> theLoadedTexture;
258 const auto &path = image->m_imagePath.path();
259 const bool flipY = flags.testFlag(LoadWithFlippedY);
260 Q_TRACE_SCOPE(QSSG_textureLoadPath, path);
261 theLoadedTexture.reset(QSSGLoadedTexture::load(path, image->m_format, flipY));
262 if (theLoadedTexture) {
263 foundIt = imageMap.insert(imageKey, ImageData());
264 CreateRhiTextureFlags rhiTexFlags = ScanForTransparency;
265 if (image->type == QSSGRenderGraphObject::Type::ImageCube)
266 rhiTexFlags |= CubeMap;
267 if (!setRhiTexture(foundIt.value().renderImageTexture, theLoadedTexture.data(), inMipMode, rhiTexFlags, QFileInfo(path).fileName())) {
268 foundIt.value() = ImageData();
269 } else if (QSSGBufferManagerStat::enabled(QSSGBufferManagerStat::Level::Debug)) {
270 qDebug() << "+ uploadTexture: " << image->m_imagePath.path() << currentLayer;
271 }
272 result = foundIt.value().renderImageTexture;
273 increaseMemoryStat(result.m_texture);
274 } else {
275 // We want to make sure that bad path fails once and doesn't fail over and over
276 // again
277 // which could slow down the system quite a bit.
278 foundIt = imageMap.insert(imageKey, ImageData());
279 qCWarning(WARNING, "Failed to load image: %s", qPrintable(path));
280 }
281 Q_QUICK3D_PROFILE_END_WITH_STRING(QQuick3DProfiler::Quick3DTextureLoad, stats.imageDataSize, path.toUtf8());
282 }
283 foundIt.value().usageCounts[currentLayer]++;
284 } else if (image->m_extensionsSource) {
285 auto it = renderExtensionTexture.find(image->m_extensionsSource);
286 if (it != renderExtensionTexture.end()) {
287 it->usageCounts[currentLayer]++;
288 result = it->renderImageTexture;
289 }
290 }
291 return result;
292}
293
294QSSGRenderImageTexture QSSGBufferManager::loadTextureData(QSSGRenderTextureData *data, MipMode inMipMode)
295{
296 QSSG_ASSERT(data != nullptr, return {});
297
298 const CustomImageCacheKey imageKey = { data, data->size(), inMipMode };
299 auto theImageData = customTextureMap.find(imageKey);
300 if (theImageData == customTextureMap.end()) {
301 theImageData = customTextureMap.insert(imageKey, ImageData{{}, {}, data->version()});
302 } else if (data->version() == theImageData->version) {
303 // Return the currently loaded texture
304 theImageData.value().usageCounts[currentLayer]++;
305 return theImageData.value().renderImageTexture;
306 } else {
307 // Optimization: If only the version number has changed, we can attempt to reuse the texture.
308 // Just update the version number and let setRhiTexture handle the rest.
309 theImageData->version = data->version();
310 }
311
312 // Load the texture
313 QScopedPointer<QSSGLoadedTexture> theLoadedTexture;
314 if (!data->textureData().isNull()) {
315 theLoadedTexture.reset(QSSGLoadedTexture::loadTextureData(data));
316 theLoadedTexture->ownsData = false;
317 CreateRhiTextureFlags rhiTexFlags = {};
318 if (theLoadedTexture->depth > 0)
319 rhiTexFlags |= Texture3D;
320
321 bool wasTextureCreated = false;
322
323 if (setRhiTexture(theImageData.value().renderImageTexture, theLoadedTexture.data(), inMipMode, rhiTexFlags, data->debugObjectName, &wasTextureCreated)) {
324 if (wasTextureCreated) {
325 if (QSSGBufferManagerStat::enabled(QSSGBufferManagerStat::Level::Debug))
326 qDebug() << "+ uploadTexture: " << data << theImageData.value().renderImageTexture.m_texture << currentLayer;
327 increaseMemoryStat(theImageData.value().renderImageTexture.m_texture);
328 }
329 } else {
330 theImageData.value() = ImageData();
331 }
332 }
333
334 theImageData.value().usageCounts[currentLayer]++;
335 return theImageData.value().renderImageTexture;
336}
337
338QSSGRenderImageTexture QSSGBufferManager::loadLightmap(const QSSGRenderModel &model)
339{
340 Q_ASSERT(currentLayer);
341
342 if (model.lightmapKey.isEmpty() || currentlyLightmapBaking || !validateLightmap())
343 return {};
344
345 Q_ASSERT(!lightmapSource.isEmpty());
346 static const QSSGRenderTextureFormat format = QSSGRenderTextureFormat::RGBA16F;
347 QSSGRenderImageTexture result;
348 const ImageCacheKey imageKey = { QSSGRenderPath(lightmapSource), MipModeDisable, int(QSSGRenderGraphObject::Type::Image2D), model.lightmapKey };
349 auto foundIt = imageMap.find(imageKey);
350 if (foundIt != imageMap.end()) {
351 result = foundIt.value().renderImageTexture;
352 } else {
353 Q_QUICK3D_PROFILE_START(QQuick3DProfiler::Quick3DTextureLoad);
354 Q_TRACE_SCOPE(QSSG_textureLoadPath, lightmapSource);
355 QScopedPointer<QSSGLoadedTexture> theLoadedTexture;
356 theLoadedTexture.reset(QSSGLoadedTexture::loadLightmapImage(lightmapSource, format, model.lightmapKey));
357 if (!theLoadedTexture) {
358 qCWarning(WARNING, "Failed to load lightmap image for %s", qPrintable(model.lightmapKey));
359 }
360 foundIt = imageMap.insert(imageKey, ImageData());
361 if (theLoadedTexture) {
362 const QString debugOjbectName = lightmapSource + QStringLiteral(" [%1]").arg(model.lightmapKey);
363 if (!setRhiTexture(foundIt.value().renderImageTexture, theLoadedTexture.data(), MipModeDisable, {}, debugOjbectName))
364 foundIt.value() = ImageData();
365 else if (QSSGBufferManagerStat::enabled(QSSGBufferManagerStat::Level::Debug))
366 qDebug() << "+ uploadTexture: " << debugOjbectName << currentLayer;
367 result = foundIt.value().renderImageTexture;
368 }
369 increaseMemoryStat(result.m_texture);
370 Q_QUICK3D_PROFILE_END_WITH_STRING(QQuick3DProfiler::Quick3DTextureLoad, stats.imageDataSize, lightmapSource.toUtf8());
371 }
372 foundIt.value().usageCounts[currentLayer]++;
373 return result;
374}
375
376QSSGRenderImageTexture QSSGBufferManager::loadSkinmap(QSSGRenderTextureData *skin)
377{
378 return loadTextureData(skin, MipModeDisable);
379}
380
381QSSGRenderMesh *QSSGBufferManager::getMeshForPicking(const QSSGRenderModel &model, const QString &lightmap) const
382{
383 if (!model.meshPath.isNull()) {
384 auto key = std::make_pair(model.meshPath, lightmap);
385 const auto foundIt = meshMap.constFind(key);
386 if (foundIt != meshMap.constEnd())
387 return foundIt->mesh;
388 }
389
390 if (model.geometry) {
391 auto key = std::make_pair(model.geometry, lightmap);
392 const auto foundIt = customMeshMap.constFind(key);
393 if (foundIt != customMeshMap.constEnd())
394 return foundIt->mesh;
395 }
396
397 return nullptr;
398}
399
400QRhiTexture::Format QSSGBufferManager::toRhiFormat(const QSSGRenderTextureFormat format)
401{
402 switch (format.format) {
403
404 case QSSGRenderTextureFormat::RGBA8:
405 return QRhiTexture::RGBA8;
406 case QSSGRenderTextureFormat::R8:
407 return QRhiTexture::R8;
408 case QSSGRenderTextureFormat::Luminance16: //???
409 case QSSGRenderTextureFormat::R16:
410 return QRhiTexture::R16;
411 case QSSGRenderTextureFormat::LuminanceAlpha8:
412 case QSSGRenderTextureFormat::Luminance8:
413 case QSSGRenderTextureFormat::Alpha8:
414 return QRhiTexture::RED_OR_ALPHA8;
415 case QSSGRenderTextureFormat::RGBA16F:
416 return QRhiTexture::RGBA16F;
417 case QSSGRenderTextureFormat::RGBA32F:
418 return QRhiTexture::RGBA32F;
419 case QSSGRenderTextureFormat::R16F:
420 return QRhiTexture::R16F;
421 case QSSGRenderTextureFormat::R32F:
422 return QRhiTexture::R32F;
423 case QSSGRenderTextureFormat::RGBE8:
424 return QRhiTexture::RGBA8;
425 case QSSGRenderTextureFormat::R32UI:
426 return QRhiTexture::R32UI;
427 case QSSGRenderTextureFormat::RGBA32UI:
428 return QRhiTexture::RGBA32UI;
429 case QSSGRenderTextureFormat::RGB_DXT1:
430 return QRhiTexture::BC1;
431 case QSSGRenderTextureFormat::RGBA_DXT3:
432 return QRhiTexture::BC2;
433 case QSSGRenderTextureFormat::RGBA_DXT5:
434 return QRhiTexture::BC3;
435 case QSSGRenderTextureFormat::RGBA8_ETC2_EAC:
436 return QRhiTexture::ETC2_RGBA8;
437 case QSSGRenderTextureFormat::RGBA_ASTC_4x4:
438 case QSSGRenderTextureFormat::SRGB8_Alpha8_ASTC_4x4:
439 return QRhiTexture::ASTC_4x4;
440 case QSSGRenderTextureFormat::RGBA_ASTC_5x4:
441 case QSSGRenderTextureFormat::SRGB8_Alpha8_ASTC_5x4:
442 return QRhiTexture::ASTC_5x4;
443 case QSSGRenderTextureFormat::RGBA_ASTC_5x5:
444 case QSSGRenderTextureFormat::SRGB8_Alpha8_ASTC_5x5:
445 return QRhiTexture::ASTC_5x5;
446 case QSSGRenderTextureFormat::RGBA_ASTC_6x5:
447 case QSSGRenderTextureFormat::SRGB8_Alpha8_ASTC_6x5:
448 return QRhiTexture::ASTC_6x5;
449 case QSSGRenderTextureFormat::RGBA_ASTC_6x6:
450 case QSSGRenderTextureFormat::SRGB8_Alpha8_ASTC_6x6:
451 return QRhiTexture::ASTC_6x6;
452 case QSSGRenderTextureFormat::RGBA_ASTC_8x5:
453 case QSSGRenderTextureFormat::SRGB8_Alpha8_ASTC_8x5:
454 return QRhiTexture::ASTC_8x5;
455 case QSSGRenderTextureFormat::RGBA_ASTC_8x6:
456 case QSSGRenderTextureFormat::SRGB8_Alpha8_ASTC_8x6:
457 return QRhiTexture::ASTC_8x6;
458 case QSSGRenderTextureFormat::RGBA_ASTC_8x8:
459 case QSSGRenderTextureFormat::SRGB8_Alpha8_ASTC_8x8:
460 return QRhiTexture::ASTC_8x8;
461 case QSSGRenderTextureFormat::RGBA_ASTC_10x5:
462 case QSSGRenderTextureFormat::SRGB8_Alpha8_ASTC_10x5:
463 return QRhiTexture::ASTC_10x5;
464 case QSSGRenderTextureFormat::RGBA_ASTC_10x6:
465 case QSSGRenderTextureFormat::SRGB8_Alpha8_ASTC_10x6:
466 return QRhiTexture::ASTC_10x6;
467 case QSSGRenderTextureFormat::RGBA_ASTC_10x8:
468 case QSSGRenderTextureFormat::SRGB8_Alpha8_ASTC_10x8:
469 return QRhiTexture::ASTC_10x8;
470 case QSSGRenderTextureFormat::RGBA_ASTC_10x10:
471 case QSSGRenderTextureFormat::SRGB8_Alpha8_ASTC_10x10:
472 return QRhiTexture::ASTC_10x10;
473 case QSSGRenderTextureFormat::RGBA_ASTC_12x10:
474 case QSSGRenderTextureFormat::SRGB8_Alpha8_ASTC_12x10:
475 return QRhiTexture::ASTC_12x10;
476 case QSSGRenderTextureFormat::RGBA_ASTC_12x12:
477 case QSSGRenderTextureFormat::SRGB8_Alpha8_ASTC_12x12:
478 return QRhiTexture::ASTC_12x12;
479
480 case QSSGRenderTextureFormat::Depth16:
481 return QRhiTexture::D16;
482 case QSSGRenderTextureFormat::Depth24:
483 return QRhiTexture::D24;
484 case QSSGRenderTextureFormat::Depth32:
485 return QRhiTexture::D32F;
486 case QSSGRenderTextureFormat::Depth24Stencil8:
487 return QRhiTexture::D24S8;
488
489 case QSSGRenderTextureFormat::SRGB8A8:
490 return QRhiTexture::RGBA8; // Note: user must keep track of color space manually
491
492 default:
493 qWarning() << "Unsupported texture format" << format.format;
494 return QRhiTexture::UnknownFormat;
495 }
496
497}
498
499// Vertex data for rendering environment cube map
500static const float cube[] = {
501 -1.0f,-1.0f,-1.0f, // -X side
502 -1.0f,-1.0f, 1.0f,
503 -1.0f, 1.0f, 1.0f,
504 -1.0f, 1.0f, 1.0f,
505 -1.0f, 1.0f,-1.0f,
506 -1.0f,-1.0f,-1.0f,
507
508 -1.0f,-1.0f,-1.0f, // -Z side
509 1.0f, 1.0f,-1.0f,
510 1.0f,-1.0f,-1.0f,
511 -1.0f,-1.0f,-1.0f,
512 -1.0f, 1.0f,-1.0f,
513 1.0f, 1.0f,-1.0f,
514
515 -1.0f,-1.0f,-1.0f, // -Y side
516 1.0f,-1.0f,-1.0f,
517 1.0f,-1.0f, 1.0f,
518 -1.0f,-1.0f,-1.0f,
519 1.0f,-1.0f, 1.0f,
520 -1.0f,-1.0f, 1.0f,
521
522 -1.0f, 1.0f,-1.0f, // +Y side
523 -1.0f, 1.0f, 1.0f,
524 1.0f, 1.0f, 1.0f,
525 -1.0f, 1.0f,-1.0f,
526 1.0f, 1.0f, 1.0f,
527 1.0f, 1.0f,-1.0f,
528
529 1.0f, 1.0f,-1.0f, // +X side
530 1.0f, 1.0f, 1.0f,
531 1.0f,-1.0f, 1.0f,
532 1.0f,-1.0f, 1.0f,
533 1.0f,-1.0f,-1.0f,
534 1.0f, 1.0f,-1.0f,
535
536 -1.0f, 1.0f, 1.0f, // +Z side
537 -1.0f,-1.0f, 1.0f,
538 1.0f, 1.0f, 1.0f,
539 -1.0f,-1.0f, 1.0f,
540 1.0f,-1.0f, 1.0f,
541 1.0f, 1.0f, 1.0f,
542
543 0.0f, 1.0f, // -X side
544 1.0f, 1.0f,
545 1.0f, 0.0f,
546 1.0f, 0.0f,
547 0.0f, 0.0f,
548 0.0f, 1.0f,
549
550 1.0f, 1.0f, // -Z side
551 0.0f, 0.0f,
552 0.0f, 1.0f,
553 1.0f, 1.0f,
554 1.0f, 0.0f,
555 0.0f, 0.0f,
556
557 1.0f, 0.0f, // -Y side
558 1.0f, 1.0f,
559 0.0f, 1.0f,
560 1.0f, 0.0f,
561 0.0f, 1.0f,
562 0.0f, 0.0f,
563
564 1.0f, 0.0f, // +Y side
565 0.0f, 0.0f,
566 0.0f, 1.0f,
567 1.0f, 0.0f,
568 0.0f, 1.0f,
569 1.0f, 1.0f,
570
571 1.0f, 0.0f, // +X side
572 0.0f, 0.0f,
573 0.0f, 1.0f,
574 0.0f, 1.0f,
575 1.0f, 1.0f,
576 1.0f, 0.0f,
577
578 0.0f, 0.0f, // +Z side
579 0.0f, 1.0f,
580 1.0f, 0.0f,
581 0.0f, 1.0f,
582 1.0f, 1.0f,
583 1.0f, 0.0f,
584};
585
586bool QSSGBufferManager::createEnvironmentMap(const QSSGLoadedTexture *inImage, QSSGRenderImageTexture *outTexture, const QString &debugObjectName)
587{
588 // The objective of this method is to take the equirectangular texture
589 // provided by inImage and create a cubeMap that contains both pre-filtered
590 // specular environment maps, as well as a irradiance map for diffuse
591 // operations.
592 // To achieve this though we first convert convert the Equirectangular texture
593 // to a cubeMap with genereated mip map levels (no filtering) to make the
594 // process of creating the prefiltered and irradiance maps eaiser. This
595 // intermediate texture as well as the original equirectangular texture are
596 // destroyed after this frame completes, and all further associations with
597 // the source lightProbe texture are instead associated with the final
598 // generated environment map.
599 // The intermediate environment cubemap is used to generate the final
600 // cubemap. This cubemap will generate 6 mip levels for each face
601 // (the remaining faces are unused). This is what the contents of each
602 // face mip level looks like:
603 // 0: Pre-filtered with roughness 0 (basically unfiltered)
604 // 1: Pre-filtered with roughness 0.25
605 // 2: Pre-filtered with roughness 0.5
606 // 3: Pre-filtered with roughness 0.75
607 // 4: Pre-filtered with rougnness 1.0
608 // 5: Irradiance map (ideally at least 16x16)
609 // It would be better if we could use a separate cubemap for irradiance, but
610 // right now there is a 1:1 association between texture sources on the front-
611 // end and backend.
612 const auto &context = m_contextInterface->rhiContext();
613 auto *rhi = context->rhi();
614 // Right now minimum face size needs to be 512x512 to be able to have 6 reasonably sized mips
615 int suggestedSize = inImage->height * 0.5f;
616 suggestedSize = qMax(512, suggestedSize);
617 const QSize environmentMapSize(suggestedSize, suggestedSize);
618 const bool isRGBE = inImage->format.format == QSSGRenderTextureFormat::Format::RGBE8;
619 const QRhiTexture::Format sourceTextureFormat = toRhiFormat(inImage->format.format);
620 // Check if we can use the source texture at all
621 if (!rhi->isTextureFormatSupported(sourceTextureFormat))
622 return false;
623
624 QRhiTexture::Format cubeTextureFormat = inImage->format.isCompressedTextureFormat()
625 ? QRhiTexture::RGBA16F // let's just assume that if compressed textures are available, then it's at least a GLES 3.0 level API
626 : sourceTextureFormat;
627#ifdef Q_OS_IOS
628 // iOS doesn't support mip map filtering on RGBA32F textures
629 if (cubeTextureFormat == QRhiTexture::RGBA32F)
630 cubeTextureFormat = QRhiTexture::RGBA16F;
631#endif
632
633 const int colorSpace = inImage->isSRGB ? 1 : 0; // 0 Linear | 1 sRGB
634
635 // Phase 1: Convert the Equirectangular texture to a Cubemap
636 QRhiTexture *envCubeMap = rhi->newTexture(cubeTextureFormat, environmentMapSize, 1,
637 QRhiTexture::RenderTarget | QRhiTexture::CubeMap | QRhiTexture::MipMapped | QRhiTexture::UsedWithGenerateMips);
638 if (!envCubeMap->create()) {
639 qWarning("Failed to create Environment Cube Map");
640 return false;
641 }
642 envCubeMap->deleteLater();
643
644 // Create a renderbuffer the size of a the cubeMap face
645 QRhiRenderBuffer *envMapRenderBuffer = rhi->newRenderBuffer(QRhiRenderBuffer::Color, environmentMapSize);
646 if (!envMapRenderBuffer->create()) {
647 qWarning("Failed to create Environment Map Render Buffer");
648 return false;
649 }
650 envMapRenderBuffer->deleteLater();
651
652 const QByteArray rtName = debugObjectName.toLatin1();
653
654 // Setup the 6 render targets for each cube face
655 QVarLengthArray<QRhiTextureRenderTarget *, 6> renderTargets;
656 QRhiRenderPassDescriptor *renderPassDesc = nullptr;
657 for (const auto face : QSSGRenderTextureCubeFaces) {
658 QRhiColorAttachment att(envCubeMap);
659 att.setLayer(quint8(face));
660 QRhiTextureRenderTargetDescription rtDesc;
661 rtDesc.setColorAttachments({att});
662 auto renderTarget = rhi->newTextureRenderTarget(rtDesc);
663 renderTarget->setName(rtName + QByteArrayLiteral(" env cube face: ") + QSSGBaseTypeHelpers::displayName(face));
664 renderTarget->setDescription(rtDesc);
665 if (!renderPassDesc)
666 renderPassDesc = renderTarget->newCompatibleRenderPassDescriptor();
667 renderTarget->setRenderPassDescriptor(renderPassDesc);
668 if (!renderTarget->create()) {
669 qWarning("Failed to build env map render target");
670 return false;
671 }
672 renderTarget->deleteLater();
673 renderTargets << renderTarget;
674 }
675 renderPassDesc->deleteLater();
676
677 // Setup the sampler for reading the equirectangular loaded texture
678 QSize size(inImage->width, inImage->height);
679 auto *sourceTexture = rhi->newTexture(sourceTextureFormat, size, 1);
680 if (!sourceTexture->create()) {
681 qWarning("failed to create source env map texture");
682 return false;
683 }
684 sourceTexture->deleteLater();
685
686 // Upload the equirectangular texture
687 const auto desc = inImage->textureFileData.isValid()
688 ? QRhiTextureUploadDescription(
689 { 0, 0, QRhiTextureSubresourceUploadDescription(inImage->textureFileData.getDataView().toByteArray()) })
690 : QRhiTextureUploadDescription({ 0, 0, { inImage->data, inImage->dataSizeInBytes } });
691
692 auto *rub = rhi->nextResourceUpdateBatch();
693 rub->uploadTexture(sourceTexture, desc);
694
695 const QSSGRhiSamplerDescription samplerDesc {
696 QRhiSampler::Linear,
697 QRhiSampler::Linear,
698 QRhiSampler::None,
699 QRhiSampler::ClampToEdge,
700 QRhiSampler::ClampToEdge,
701 QRhiSampler::Repeat
702 };
703 QRhiSampler *sampler = context->sampler(samplerDesc);
704
705 // Load shader and setup render pipeline
706 const auto &shaderCache = m_contextInterface->shaderCache();
707 const auto &envMapShaderStages = shaderCache->getBuiltInRhiShaders().getRhiEnvironmentmapShader();
708
709 // Vertex Buffer - Just a single cube that will be viewed from inside
710 QRhiBuffer *vertexBuffer = rhi->newBuffer(QRhiBuffer::Immutable, QRhiBuffer::VertexBuffer, sizeof(cube));
711 vertexBuffer->create();
712 vertexBuffer->deleteLater();
713 rub->uploadStaticBuffer(vertexBuffer, cube);
714
715 // Uniform Buffer - 2x mat4
716 int ubufElementSize = rhi->ubufAligned(128);
717 QRhiBuffer *uBuf = rhi->newBuffer(QRhiBuffer::Dynamic, QRhiBuffer::UniformBuffer, ubufElementSize * 6);
718 uBuf->create();
719 uBuf->deleteLater();
720
721 int ubufEnvMapElementSize = rhi->ubufAligned(4);
722 QRhiBuffer *uBufEnvMap = rhi->newBuffer(QRhiBuffer::Dynamic, QRhiBuffer::UniformBuffer, ubufEnvMapElementSize * 6);
723 uBufEnvMap->create();
724 uBufEnvMap->deleteLater();
725
726 // Shader Resource Bindings
727 QRhiShaderResourceBindings *envMapSrb = rhi->newShaderResourceBindings();
728 envMapSrb->setBindings({
729 QRhiShaderResourceBinding::uniformBufferWithDynamicOffset(0, QRhiShaderResourceBinding::VertexStage, uBuf, 128),
730 QRhiShaderResourceBinding::uniformBufferWithDynamicOffset(2, QRhiShaderResourceBinding::FragmentStage, uBufEnvMap, ubufEnvMapElementSize),
731 QRhiShaderResourceBinding::sampledTexture(1, QRhiShaderResourceBinding::FragmentStage, sourceTexture, sampler)
732 });
733 envMapSrb->create();
734 envMapSrb->deleteLater();
735
736 // Pipeline
737 QRhiGraphicsPipeline *envMapPipeline = rhi->newGraphicsPipeline();
738 envMapPipeline->setCullMode(QRhiGraphicsPipeline::Front);
739 envMapPipeline->setFrontFace(QRhiGraphicsPipeline::CCW);
740 envMapPipeline->setShaderStages({
741 *envMapShaderStages->vertexStage(),
742 *envMapShaderStages->fragmentStage()
743 });
744
745 QRhiVertexInputLayout inputLayout;
746 inputLayout.setBindings({
747 { 3 * sizeof(float) }
748 });
749 inputLayout.setAttributes({
750 { 0, 0, QRhiVertexInputAttribute::Float3, 0 }
751 });
752
753 envMapPipeline->setVertexInputLayout(inputLayout);
754 envMapPipeline->setShaderResourceBindings(envMapSrb);
755 envMapPipeline->setRenderPassDescriptor(renderPassDesc);
756 if (!envMapPipeline->create()) {
757 qWarning("failed to create source env map pipeline state");
758 return false;
759 }
760 envMapPipeline->deleteLater();
761
762 // Do the actual render passes
763 auto *cb = context->commandBuffer();
764 cb->debugMarkBegin("Environment Cubemap Generation");
765 Q_QUICK3D_PROFILE_START(QQuick3DProfiler::Quick3DRenderPass);
766 Q_TRACE(QSSG_renderPass_entry, QStringLiteral("Environment Cubemap Generation"));
767 const QRhiCommandBuffer::VertexInput vbufBinding(vertexBuffer, 0);
768
769 // Set the Uniform Data
770 QMatrix4x4 mvp = rhi->clipSpaceCorrMatrix();
771 mvp.perspective(90.0f, 1.0f, 0.1f, 10.0f);
772
773 auto lookAt = [](const QVector3D &eye, const QVector3D &center, const QVector3D &up) {
774 QMatrix4x4 viewMatrix;
775 viewMatrix.lookAt(eye, center, up);
776 return viewMatrix;
777 };
778 QVarLengthArray<QMatrix4x4, 6> views;
779 views.append(lookAt(QVector3D(0.0f, 0.0f, 0.0f), QVector3D(1.0, 0.0, 0.0), QVector3D(0.0f, -1.0f, 0.0f)));
780 views.append(lookAt(QVector3D(0.0f, 0.0f, 0.0f), QVector3D(-1.0, 0.0, 0.0), QVector3D(0.0f, -1.0f, 0.0f)));
781 if (rhi->isYUpInFramebuffer()) {
782 views.append(lookAt(QVector3D(0.0f, 0.0f, 0.0f), QVector3D(0.0, 1.0, 0.0), QVector3D(0.0f, 0.0f, 1.0f)));
783 views.append(lookAt(QVector3D(0.0f, 0.0f, 0.0f), QVector3D(0.0, -1.0, 0.0), QVector3D(0.0f, 0.0f, -1.0f)));
784 } else {
785 views.append(lookAt(QVector3D(0.0f, 0.0f, 0.0f), QVector3D(0.0, -1.0, 0.0), QVector3D(0.0f, 0.0f, -1.0f)));
786 views.append(lookAt(QVector3D(0.0f, 0.0f, 0.0f), QVector3D(0.0, 1.0, 0.0), QVector3D(0.0f, 0.0f, 1.0f)));
787 }
788 views.append(lookAt(QVector3D(0.0f, 0.0f, 0.0f), QVector3D(0.0, 0.0, 1.0), QVector3D(0.0f, -1.0f, 0.0f)));
789 views.append(lookAt(QVector3D(0.0f, 0.0f, 0.0f), QVector3D(0.0, 0.0, -1.0), QVector3D(0.0f, -1.0f, 0.0f)));
790 for (const auto face : QSSGRenderTextureCubeFaces) {
791 rub->updateDynamicBuffer(uBuf, quint8(face) * ubufElementSize, 64, mvp.constData());
792 rub->updateDynamicBuffer(uBuf, quint8(face) * ubufElementSize + 64, 64, views[quint8(face)].constData());
793 rub->updateDynamicBuffer(uBufEnvMap, quint8(face) * ubufEnvMapElementSize, 4, &colorSpace);
794 }
795 cb->resourceUpdate(rub);
796
797 for (const auto face : QSSGRenderTextureCubeFaces) {
798 cb->beginPass(renderTargets[quint8(face)], QColor(0, 0, 0, 1), { 1.0f, 0 }, nullptr, context->commonPassFlags());
799 Q_QUICK3D_PROFILE_START(QQuick3DProfiler::Quick3DRenderPass);
800 QSSGRHICTX_STAT(context, beginRenderPass(renderTargets[quint8(face)]));
801
802 // Execute render pass
803 cb->setGraphicsPipeline(envMapPipeline);
804 cb->setVertexInput(0, 1, &vbufBinding);
805 cb->setViewport(QRhiViewport(0, 0, environmentMapSize.width(), environmentMapSize.height()));
806 QVector<QPair<int, quint32>> dynamicOffset = {
807 { 0, quint32(ubufElementSize * quint8(face)) },
808 { 2, quint32(ubufEnvMapElementSize * quint8(face) )}
809 };
810 cb->setShaderResources(envMapSrb, 2, dynamicOffset.constData());
811 Q_QUICK3D_PROFILE_START(QQuick3DProfiler::Quick3DRenderCall);
812 cb->draw(36);
813 QSSGRHICTX_STAT(context, draw(36, 1));
814 Q_QUICK3D_PROFILE_END_WITH_STRING(QQuick3DProfiler::Quick3DRenderCall, 36llu | (1llu << 32), QByteArrayLiteral("environment_map"));
815
816 cb->endPass();
817 QSSGRHICTX_STAT(context, endRenderPass());
818 Q_QUICK3D_PROFILE_END_WITH_STRING(QQuick3DProfiler::Quick3DRenderPass, 0, QSSG_RENDERPASS_NAME("environment_map", 0, face));
819 }
820 cb->debugMarkEnd();
821 Q_QUICK3D_PROFILE_END_WITH_STRING(QQuick3DProfiler::Quick3DRenderPass, 0, QByteArrayLiteral("environment_cube_generation"));
822 Q_TRACE(QSSG_renderPass_exit);
823
824 if (!isRGBE) {
825 // Generate mipmaps for envMap
826 rub = rhi->nextResourceUpdateBatch();
827 rub->generateMips(envCubeMap);
828 cb->resourceUpdate(rub);
829 }
830
831 // Phase 2: Generate the pre-filtered environment cubemap
832 cb->debugMarkBegin("Pre-filtered Environment Cubemap Generation");
833 Q_QUICK3D_PROFILE_START(QQuick3DProfiler::Quick3DRenderPass);
834 Q_TRACE(QSSG_renderPass_entry, QStringLiteral("Pre-filtered Environment Cubemap Generation"));
835 QRhiTexture *preFilteredEnvCubeMap = rhi->newTexture(cubeTextureFormat, environmentMapSize, 1, QRhiTexture::RenderTarget | QRhiTexture::CubeMap| QRhiTexture::MipMapped);
836 if (!preFilteredEnvCubeMap->create())
837 qWarning("Failed to create Pre-filtered Environment Cube Map");
838 preFilteredEnvCubeMap->setName(rtName);
839 // The texture is created with QRhiTexture::MipMapped, so the graphics API
840 // allocates the full mip chain even though only the first few levels are
841 // prefiltered below.
842 const int fullMipCount = rhi->mipLevelsForSize(environmentMapSize);
843 const int mipmapCount = qMin(fullMipCount, 6); // don't create more than 6 mip levels
844 QMap<int, QSize> mipLevelSizes;
845 QMap<int, QVarLengthArray<QRhiTextureRenderTarget *, 6>> renderTargetsMap;
846 QRhiRenderPassDescriptor *renderPassDescriptorPhase2 = nullptr;
847
848 // Create a renderbuffer for each mip level
849 for (int mipLevel = 0; mipLevel < mipmapCount; ++mipLevel) {
850 const QSize levelSize = QSize(environmentMapSize.width() * std::pow(0.5, mipLevel),
851 environmentMapSize.height() * std::pow(0.5, mipLevel));
852 mipLevelSizes.insert(mipLevel, levelSize);
853 // Setup Render targets (6 * mipmapCount)
854 QVarLengthArray<QRhiTextureRenderTarget *, 6> renderTargets;
855 for (const auto face : QSSGRenderTextureCubeFaces) {
856 QRhiColorAttachment att(preFilteredEnvCubeMap);
857 att.setLayer(quint8(face));
858 att.setLevel(mipLevel);
859 QRhiTextureRenderTargetDescription rtDesc;
860 rtDesc.setColorAttachments({att});
861 auto renderTarget = rhi->newTextureRenderTarget(rtDesc);
862 renderTarget->setName(rtName + QByteArrayLiteral(" env prefilter mip/face: ")
863 + QByteArray::number(mipLevel) + QByteArrayLiteral("/") + QSSGBaseTypeHelpers::displayName(face));
864 renderTarget->setDescription(rtDesc);
865 if (!renderPassDescriptorPhase2)
866 renderPassDescriptorPhase2 = renderTarget->newCompatibleRenderPassDescriptor();
867 renderTarget->setRenderPassDescriptor(renderPassDescriptorPhase2);
868 if (!renderTarget->create())
869 qWarning("Failed to build prefilter env map render target");
870 renderTarget->deleteLater();
871 renderTargets << renderTarget;
872 }
873 renderTargetsMap.insert(mipLevel, renderTargets);
874 renderPassDescriptorPhase2->deleteLater();
875 }
876
877 // Load the prefilter shader stages
878 const auto &prefilterShaderStages = shaderCache->getBuiltInRhiShaders().getRhienvironmentmapPreFilterShader(isRGBE);
879
880 // Create a new Sampler
881 const QSSGRhiSamplerDescription samplerMipMapDesc {
882 QRhiSampler::Linear,
883 QRhiSampler::Linear,
884 QRhiSampler::Linear,
885 QRhiSampler::ClampToEdge,
886 QRhiSampler::ClampToEdge,
887 QRhiSampler::Repeat
888 };
889
890 QRhiSampler *envMapCubeSampler = nullptr;
891 // Only use mipmap interpoliation if not using RGBE
892 if (!isRGBE)
893 envMapCubeSampler = context->sampler(samplerMipMapDesc);
894 else
895 envMapCubeSampler = sampler;
896
897 // Reuse Vertex Buffer from phase 1
898 // Reuse UniformBuffer from phase 1 (for vertex shader)
899
900 // UniformBuffer
901 // float roughness;
902 // float resolution;
903 // float lodBias;
904 // int sampleCount;
905 // int distribution;
906
907 int ubufPrefilterElementSize = rhi->ubufAligned(20);
908 QRhiBuffer *uBufPrefilter = rhi->newBuffer(QRhiBuffer::Dynamic, QRhiBuffer::UniformBuffer, ubufPrefilterElementSize * mipmapCount);
909 uBufPrefilter->create();
910 uBufPrefilter->deleteLater();
911
912 // Shader Resource Bindings
913 QRhiShaderResourceBindings *preFilterSrb = rhi->newShaderResourceBindings();
914 preFilterSrb->setBindings({
915 QRhiShaderResourceBinding::uniformBufferWithDynamicOffset(0, QRhiShaderResourceBinding::VertexStage, uBuf, 128),
916 QRhiShaderResourceBinding::uniformBufferWithDynamicOffset(2, QRhiShaderResourceBinding::FragmentStage, uBufPrefilter, 20),
917 QRhiShaderResourceBinding::sampledTexture(1, QRhiShaderResourceBinding::FragmentStage, envCubeMap, envMapCubeSampler)
918 });
919 preFilterSrb->create();
920 preFilterSrb->deleteLater();
921
922 // Pipeline
923 QRhiGraphicsPipeline *prefilterPipeline = rhi->newGraphicsPipeline();
924 prefilterPipeline->setCullMode(QRhiGraphicsPipeline::Front);
925 prefilterPipeline->setFrontFace(QRhiGraphicsPipeline::CCW);
926 prefilterPipeline->setDepthOp(QRhiGraphicsPipeline::LessOrEqual);
927 prefilterPipeline->setShaderStages({
928 *prefilterShaderStages->vertexStage(),
929 *prefilterShaderStages->fragmentStage()
930 });
931 // same as phase 1
932 prefilterPipeline->setVertexInputLayout(inputLayout);
933 prefilterPipeline->setShaderResourceBindings(preFilterSrb);
934 prefilterPipeline->setRenderPassDescriptor(renderPassDescriptorPhase2);
935 if (!prefilterPipeline->create()) {
936 qWarning("failed to create pre-filter env map pipeline state");
937 return false;
938 }
939 prefilterPipeline->deleteLater();
940
941 // Uniform Data
942 // set the roughness uniform buffer data
943 rub = rhi->nextResourceUpdateBatch();
944 const float resolution = environmentMapSize.width();
945 const float lodBias = 0.0f;
946 const int sampleCount = 1024;
947 for (int mipLevel = 0; mipLevel < mipmapCount; ++mipLevel) {
948 Q_ASSERT(mipmapCount - 2);
949 const float roughness = float(mipLevel) / float(mipmapCount - 2);
950 const int distribution = mipLevel == (mipmapCount - 1) ? 0 : 1; // last mip level is for irradiance
951 rub->updateDynamicBuffer(uBufPrefilter, mipLevel * ubufPrefilterElementSize, 4, &roughness);
952 rub->updateDynamicBuffer(uBufPrefilter, mipLevel * ubufPrefilterElementSize + 4, 4, &resolution);
953 rub->updateDynamicBuffer(uBufPrefilter, mipLevel * ubufPrefilterElementSize + 4 + 4, 4, &lodBias);
954 rub->updateDynamicBuffer(uBufPrefilter, mipLevel * ubufPrefilterElementSize + 4 + 4 + 4, 4, &sampleCount);
955 rub->updateDynamicBuffer(uBufPrefilter, mipLevel * ubufPrefilterElementSize + 4 + 4 + 4 + 4, 4, &distribution);
956 }
957
958 cb->resourceUpdate(rub);
959
960 // Render
961 for (int mipLevel = 0; mipLevel < mipmapCount; ++mipLevel) {
962 for (const auto face : QSSGRenderTextureCubeFaces) {
963 cb->beginPass(renderTargetsMap[mipLevel][quint8(face)], QColor(0, 0, 0, 1), { 1.0f, 0 }, nullptr, context->commonPassFlags());
964 QSSGRHICTX_STAT(context, beginRenderPass(renderTargetsMap[mipLevel][quint8(face)]));
965 Q_QUICK3D_PROFILE_START(QQuick3DProfiler::Quick3DRenderPass);
966 cb->setGraphicsPipeline(prefilterPipeline);
967 cb->setVertexInput(0, 1, &vbufBinding);
968 cb->setViewport(QRhiViewport(0, 0, mipLevelSizes[mipLevel].width(), mipLevelSizes[mipLevel].height()));
969 QVector<QPair<int, quint32>> dynamicOffsets = {
970 { 0, quint32(ubufElementSize * quint8(face)) },
971 { 2, quint32(ubufPrefilterElementSize * mipLevel) }
972 };
973 Q_QUICK3D_PROFILE_START(QQuick3DProfiler::Quick3DRenderCall);
974
975 cb->setShaderResources(preFilterSrb, 2, dynamicOffsets.constData());
976 cb->draw(36);
977 QSSGRHICTX_STAT(context, draw(36, 1));
978 Q_QUICK3D_PROFILE_END_WITH_STRING(QQuick3DProfiler::Quick3DRenderCall, 36llu | (1llu << 32), QByteArrayLiteral("environment_map"));
979 cb->endPass();
980 QSSGRHICTX_STAT(context, endRenderPass());
981 Q_QUICK3D_PROFILE_END_WITH_STRING(QQuick3DProfiler::Quick3DRenderPass, 0, QSSG_RENDERPASS_NAME("environment_map", mipLevel, face));
982 }
983 }
984
985 // Nothing renders into the mip levels past mipmapCount, but they exist:
986 // the texture is MipMapped, so the full chain is allocated and the shader
987 // resource view covers all of it. Some APIs require every subresource of a
988 // render target to be initialized by a clear, discard or copy before the
989 // resource is used, even when the shader never samples those levels.
990 for (int mipLevel = mipmapCount; mipLevel < fullMipCount; ++mipLevel) {
991 for (const auto face : QSSGRenderTextureCubeFaces) {
992 QRhiColorAttachment att(preFilteredEnvCubeMap);
993 att.setLayer(quint8(face));
994 att.setLevel(mipLevel);
995 QRhiTextureRenderTargetDescription rtDesc;
996 rtDesc.setColorAttachments({att});
997 auto renderTarget = rhi->newTextureRenderTarget(rtDesc);
998 renderTarget->setDescription(rtDesc);
999 renderTarget->setRenderPassDescriptor(renderPassDescriptorPhase2);
1000 if (!renderTarget->create()) {
1001 qWarning("Failed to build prefilter env map render target for unused mip level");
1002 delete renderTarget;
1003 continue;
1004 }
1005 renderTarget->deleteLater();
1006 cb->beginPass(renderTarget, QColor(0, 0, 0, 1), { 1.0f, 0 }, nullptr, context->commonPassFlags());
1007 QSSGRHICTX_STAT(context, beginRenderPass(renderTarget));
1008 cb->endPass();
1009 QSSGRHICTX_STAT(context, endRenderPass());
1010 }
1011 }
1012
1013 cb->debugMarkEnd();
1014 Q_QUICK3D_PROFILE_END_WITH_STRING(QQuick3DProfiler::Quick3DRenderPass, 0, QByteArrayLiteral("environment_cube_prefilter"));
1015 Q_TRACE(QSSG_renderPass_exit);
1016
1017 outTexture->m_texture = preFilteredEnvCubeMap;
1018 outTexture->m_mipmapCount = mipmapCount;
1019 return true;
1020}
1021
1022bool QSSGBufferManager::setRhiTexture(QSSGRenderImageTexture &texture,
1023 const QSSGLoadedTexture *inTexture,
1024 MipMode inMipMode,
1025 CreateRhiTextureFlags inFlags,
1026 const QString &debugObjectName,
1027 bool *wasTextureCreated)
1028{
1029 Q_ASSERT(inMipMode != MipModeFollowRenderImage);
1030 QVarLengthArray<QRhiTextureUploadEntry, 16> textureUploads;
1031 int textureSampleCount = 1;
1032 QRhiTexture::Flags textureFlags;
1033 const bool checkTransp = inFlags.testFlag(ScanForTransparency);
1034 bool hasTransp = false;
1035
1036 const auto &context = m_contextInterface->rhiContext();
1037 QSSGRhiContextPrivate *rhiCtxD = QSSGRhiContextPrivate::get(context.get());
1038 auto *rhi = context->rhi();
1039 QRhiTexture::Format rhiFormat = toRhiFormat(inTexture->format.format);
1040 const QTextureFileData &texFileData = inTexture->textureFileData;
1041 QSize size = texFileData.isValid() ? texFileData.size() : QSize(inTexture->width, inTexture->height);
1042 int mipmapCount = texFileData.isValid() ? texFileData.numLevels() : 1;
1043 int depth = inFlags.testFlag(Texture3D) ? inTexture->depth : 0;
1044 bool generateMipmaps = false;
1045
1046 if (size.isEmpty()) {
1047 qWarning() << "Could not use 0 sized texture";
1048 return false;
1049 } else if (!rhi->isTextureFormatSupported(rhiFormat)) {
1050 qWarning() << "Unsupported texture format" << rhiFormat;
1051 return false;
1052 }
1053
1054
1055 if (wasTextureCreated)
1056 *wasTextureCreated = false;
1057
1058 if (texture.m_texture == nullptr) {
1059 if (inTexture->format.format == QSSGRenderTextureFormat::Format::RGBE8)
1060 texture.m_flags.setRgbe8(true);
1061 if (!inTexture->isSRGB)
1062 texture.m_flags.setLinear(true);
1063 if (inMipMode == MipModeBsdf && (inTexture->data || texFileData.isValid())) {
1064 // Before creating an environment map, check if the provided texture is a
1065 // pre-baked environment map
1066 if (texFileData.isValid() && texFileData.keyValueMetadata().contains("QT_IBL_BAKER_VERSION")) {
1067 Q_ASSERT(texFileData.numFaces() == 6);
1068 Q_ASSERT(texFileData.numLevels() >= 5);
1069
1070 QRhiTexture *environmentCubeMap = rhi->newTexture(rhiFormat, size, 1, QRhiTexture::CubeMap | QRhiTexture::MipMapped);
1071 environmentCubeMap->setName(debugObjectName.toLatin1());
1072 environmentCubeMap->create();
1073 texture.m_texture = environmentCubeMap;
1074 rhiCtxD->registerTexture(texture.m_texture);
1075 if (wasTextureCreated)
1076 *wasTextureCreated = true;
1077 // If we get this far then we need to create an environment map at runtime.
1078 } else if (createEnvironmentMap(inTexture, &texture, debugObjectName)) {
1079 rhiCtxD->registerTexture(texture.m_texture);
1080 if (wasTextureCreated)
1081 *wasTextureCreated = true;
1082 return true;
1083 } else {
1084 qWarning() << "Failed to create environment map";
1085 return false;
1086 }
1087 } else {
1088 if (inMipMode == MipModeEnable && mipmapCount == 1) {
1089 textureFlags |= QRhiTexture::Flag::UsedWithGenerateMips;
1090 generateMipmaps = true;
1091 mipmapCount = rhi->mipLevelsForSize(size);
1092 }
1093
1094 if (mipmapCount > 1)
1095 textureFlags |= QRhiTexture::Flag::MipMapped;
1096
1097 if (inFlags.testFlag(CubeMap))
1098 textureFlags |= QRhiTexture::CubeMap;
1099
1100 if (inFlags.testFlag(Texture3D) && depth > 0)
1101 texture.m_texture = rhi->newTexture(rhiFormat, size.width(), size.height(), depth, textureSampleCount, textureFlags);
1102 else
1103 texture.m_texture = rhi->newTexture(rhiFormat, size, textureSampleCount, textureFlags);
1104
1105 texture.m_texture->setName(debugObjectName.toLatin1());
1106 texture.m_texture->create();
1107 rhiCtxD->registerTexture(texture.m_texture);
1108 if (wasTextureCreated)
1109 *wasTextureCreated = true;
1110 }
1111 }
1112
1113 // Update resources
1114 if (inMipMode == MipModeBsdf && (inTexture->data || texFileData.isValid())) {
1115 if (texFileData.isValid() && texFileData.keyValueMetadata().contains("QT_IBL_BAKER_VERSION")) {
1116 const int faceCount = texFileData.numFaces();
1117 for (int layer = 0; layer < faceCount; ++layer) {
1118 for (int level = 0; level < mipmapCount; ++level) {
1119 QRhiTextureSubresourceUploadDescription subDesc;
1120 subDesc.setSourceSize(sizeForMipLevel(level, size));
1121 subDesc.setData(texFileData.getDataView(level, layer).toByteArray());
1122 textureUploads << QRhiTextureUploadEntry { layer, level, subDesc };
1123 }
1124 }
1125
1126 QRhiTextureUploadDescription uploadDescription;
1127 uploadDescription.setEntries(textureUploads.cbegin(), textureUploads.cend());
1128 auto *rub = rhi->nextResourceUpdateBatch();
1129 rub->uploadTexture(texture.m_texture, uploadDescription);
1130 context->commandBuffer()->resourceUpdate(rub);
1131 texture.m_mipmapCount = mipmapCount;
1132 return true;
1133 }
1134 } else if (texFileData.isValid()) {
1135 int numFaces = 1;
1136 // Just having a container with 6 faces is not enough, we only treat it
1137 // as a cubemap if it was requested to be treated as such. Otherwise
1138 // only face 0 is used.
1139 if (texFileData.numFaces() == 6 && inFlags.testFlag(CubeMap))
1140 numFaces = 6;
1141
1142 for (int level = 0; level < texFileData.numLevels(); ++level) {
1143 QRhiTextureSubresourceUploadDescription subDesc;
1144 subDesc.setSourceSize(sizeForMipLevel(level, size));
1145 for (int face = 0; face < numFaces; ++face) {
1146 subDesc.setData(texFileData.getDataView(level, face).toByteArray());
1147 textureUploads << QRhiTextureUploadEntry{ face, level, subDesc };
1148 }
1149 }
1150 if (checkTransp) {
1151 auto glFormat = texFileData.glInternalFormat() ? texFileData.glInternalFormat() : texFileData.glFormat();
1152 hasTransp = !QSGCompressedTexture::formatIsOpaque(glFormat);
1153 }
1154 } else if (inFlags.testFlag(Texture3D)) {
1155 // 3D textures are currently only setup via QQuick3DTextureData
1156 quint32 formatSize = (quint32)inTexture->format.getSizeofFormat();
1157 quint32 size2D = inTexture->width * inTexture->height * formatSize;
1158 if (inTexture->dataSizeInBytes >= (quint32)(size2D * inTexture->depth)) {
1159 for (int slice = 0; slice < inTexture->depth; ++slice) {
1160 QRhiTextureSubresourceUploadDescription sliceUpload((char *)inTexture->data + slice * size2D, size2D);
1161 textureUploads << QRhiTextureUploadEntry(slice, 0, sliceUpload);
1162 }
1163 } else {
1164 qWarning() << "Texture size set larger than the data";
1165 }
1166 } else {
1167 QRhiTextureSubresourceUploadDescription subDesc;
1168 if (!inTexture->image.isNull()) {
1169 subDesc.setImage(inTexture->image);
1170 if (checkTransp)
1171 hasTransp = QImageData::get(inTexture->image)->checkForAlphaPixels();
1172 } else if (inTexture->data) {
1173 QByteArray buf(static_cast<const char *>(inTexture->data), qMax(0, int(inTexture->dataSizeInBytes)));
1174 subDesc.setData(buf);
1175 if (checkTransp)
1176 hasTransp = inTexture->scanForTransparency();
1177 }
1178 subDesc.setSourceSize(size);
1179 if (!subDesc.data().isEmpty() || !subDesc.image().isNull())
1180 textureUploads << QRhiTextureUploadEntry{0, 0, subDesc};
1181 }
1182
1183 static const auto textureSizeWarning = [](QSize requestedSize, qsizetype maxSize) {
1184 return QStringLiteral("Requested texture width and height (%1x%2) exceeds the maximum allowed size (%3)!")
1185 .arg(requestedSize.width()).arg(requestedSize.height()).arg(maxSize);
1186 };
1187 static auto maxTextureSize = rhi->resourceLimit(QRhi::ResourceLimit::TextureSizeMax);
1188 const auto validTexSize = size.width() <= maxTextureSize && size.height() <= maxTextureSize;
1189 QSSG_ASSERT_X(validTexSize, qPrintable(textureSizeWarning(size, maxTextureSize)), return false);
1190
1191 QSSG_ASSERT(texture.m_texture != nullptr, return false);
1192
1193 if (checkTransp)
1194 texture.m_flags.setHasTransparency(hasTransp);
1195
1196 QRhiTextureUploadDescription uploadDescription;
1197 uploadDescription.setEntries(textureUploads.cbegin(), textureUploads.cend());
1198 auto *rub = rhi->nextResourceUpdateBatch(); // TODO: optimize
1199 rub->uploadTexture(texture.m_texture, uploadDescription);
1200 if (generateMipmaps)
1201 rub->generateMips(texture.m_texture);
1202 context->commandBuffer()->resourceUpdate(rub);
1203
1204 texture.m_mipmapCount = mipmapCount;
1205 return true;
1206}
1207
1208QString QSSGBufferManager::primitivePath(const QString &primitive)
1209{
1210 QByteArray theName = primitive.toUtf8();
1211 for (size_t idx = 0; idx < nPrimitives; ++idx) {
1212 if (primitives[idx].primitive == theName) {
1213 QString pathBuilder = QString::fromLatin1(primitivesDirectory);
1214 pathBuilder += QLatin1String(primitives[idx].file);
1215 return pathBuilder;
1216 }
1217 }
1218 return {};
1219}
1220
1221QMutex *QSSGBufferManager::meshUpdateMutex()
1222{
1223 return &meshBufferMutex;
1224}
1225
1226QSSGMesh::Mesh QSSGBufferManager::loadPrimitive(const QString &inRelativePath)
1227{
1228 QString path = primitivePath(inRelativePath);
1229 const quint32 id = 1;
1230 QSharedPointer<QIODevice> device(QSSGInputUtil::getStreamForFile(path));
1231 if (device) {
1232 QSSGMesh::Mesh mesh = QSSGMesh::Mesh::loadMesh(device.data(), id);
1233 if (mesh.isValid())
1234 return mesh;
1235 }
1236
1237 qCCritical(INTERNAL_ERROR, "Unable to find mesh primitive %s", qPrintable(path));
1238 return QSSGMesh::Mesh();
1239}
1240
1241QSSGRenderMesh *QSSGBufferManager::loadMesh(const QSSGRenderModel &model)
1242{
1243 // When baking lightmaps we need to make sure that the original mesh is loaded instead of the already baked mesh.
1244
1245 QSSGMeshProcessingOptions options;
1246 QSSGRenderMesh *theMesh = nullptr;
1247
1248 if (model.hasLightmap() && !currentlyLightmapBaking && validateLightmap()) {
1249 options.lightmapPath = lightmapSource;
1250 options.lightmapKey = model.lightmapKey;
1251 }
1252
1253 if (model.meshPath.isNull() && model.geometry) {
1254 theMesh = loadRenderMesh(model.geometry, options);
1255 } else {
1256 theMesh = loadRenderMesh(model.meshPath, options);
1257 }
1258
1259 return theMesh;
1260}
1261
1262QSSGMesh::Mesh QSSGBufferManager::loadLightmapMesh(const QSSGRenderModel &model)
1263{
1264 // When baking lightmaps we need to make sure that the original mesh is loaded instead of the already baked mesh.
1265 if (model.hasLightmap() && !currentlyLightmapBaking && validateLightmap() ) {
1266 auto [meshLightmap, _] = loadFromLightmapFile(lightmapSource, model.lightmapKey);
1267 if (meshLightmap.isValid())
1268 return meshLightmap;
1269 }
1270
1271 return {};
1272}
1273
1274QSSGBounds3 QSSGBufferManager::getModelBounds(const QSSGRenderModel *model)
1275{
1276 QSSGBounds3 retval;
1277
1278 if (model->hasLightmap() && !currentlyLightmapBaking && validateLightmap()) {
1279 auto [meshLightmap, _] = loadFromLightmapFile(lightmapSource, model->lightmapKey);
1280 if (meshLightmap.isValid()) {
1281 const QVector<QSSGMesh::Mesh::Subset> subsets = meshLightmap.subsets();
1282 for (const QSSGMesh::Mesh::Subset &subset : std::as_const(subsets)) {
1283 retval.include(QSSGBounds3(subset.bounds.min, subset.bounds.max));
1284 }
1285 return retval;
1286 } else {
1287 qWarning() << "Could not load lightmap" << lightmapSource << model->lightmapKey;
1288 }
1289 }
1290
1291 // Custom Geometry
1292 if (model->geometry) {
1293 retval = QSSGBounds3(model->geometry->boundsMin(), model->geometry->boundsMax());
1294 } else if (!model->meshPath.isNull()){
1295 // Check if the Mesh is already loaded
1296 QSSGRenderMesh *theMesh = nullptr;
1297 auto key = std::make_pair(model->meshPath, QString());
1298 auto meshItr = meshMap.constFind(key);
1299 if (meshItr != meshMap.cend())
1300 theMesh = meshItr.value().mesh;
1301 if (theMesh) {
1302 // The mesh was already loaded, so calculate the
1303 // bounds from subsets of the QSSGRenderMesh
1304 const auto &subSets = theMesh->subsets;
1305 for (const auto &subSet : subSets)
1306 retval.include(subSet.bounds);
1307 } else {
1308 // The model has not been loaded yet, load it without uploading the geometry
1309 // TODO: Try to do this without loading the whole mesh struct
1310 QSSGMesh::Mesh mesh = loadMeshData(model->meshPath);
1311 if (mesh.isValid()) {
1312 auto const &subsets = mesh.subsets();
1313 for (const auto &subset : subsets)
1314 retval.include(QSSGBounds3(subset.bounds.min, subset.bounds.max));
1315 }
1316 }
1317 }
1318 return retval;
1319}
1320
1321QSSGRenderMesh *QSSGBufferManager::createRenderMesh(const QSSGMesh::Mesh &mesh, const QString &debugObjectName)
1322{
1323 QSSGRenderMesh *newMesh = new QSSGRenderMesh(QSSGRenderDrawMode(mesh.drawMode()),
1324 QSSGRenderWinding(mesh.winding()));
1325 const QSSGMesh::Mesh::VertexBuffer vertexBuffer = mesh.vertexBuffer();
1326 const QSSGMesh::Mesh::IndexBuffer indexBuffer = mesh.indexBuffer();
1327 const QSSGMesh::Mesh::TargetBuffer targetBuffer = mesh.targetBuffer();
1328
1329 QSSGRenderComponentType indexBufComponentType = QSSGRenderComponentType::UnsignedInt16;
1330 QRhiCommandBuffer::IndexFormat rhiIndexFormat = QRhiCommandBuffer::IndexUInt16;
1331 if (!indexBuffer.data.isEmpty()) {
1332 indexBufComponentType = QSSGRenderComponentType(indexBuffer.componentType);
1333 const quint32 sizeofType = quint32(QSSGBaseTypeHelpers::getSizeOfType(indexBufComponentType));
1334 if (sizeofType == 2 || sizeofType == 4) {
1335 // Ensure type is unsigned; else things will fail in rendering pipeline.
1336 if (indexBufComponentType == QSSGRenderComponentType::Int16)
1337 indexBufComponentType = QSSGRenderComponentType::UnsignedInt16;
1338 if (indexBufComponentType == QSSGRenderComponentType::Int32)
1339 indexBufComponentType = QSSGRenderComponentType::UnsignedInt32;
1340 rhiIndexFormat = indexBufComponentType == QSSGRenderComponentType::UnsignedInt32
1341 ? QRhiCommandBuffer::IndexUInt32 : QRhiCommandBuffer::IndexUInt16;
1342 } else {
1343 Q_ASSERT(false);
1344 }
1345 }
1346
1347 struct {
1348 QSSGRhiBufferPtr vertexBuffer;
1349 QSSGRhiBufferPtr indexBuffer;
1350 QSSGRhiInputAssemblerState ia;
1351 QRhiTexture *targetsTexture = nullptr;
1352 } rhi;
1353
1354 QRhiResourceUpdateBatch *rub = meshBufferUpdateBatch();
1355 const auto &context = m_contextInterface->rhiContext();
1356 QSSGRhiContextPrivate *rhiCtxD = QSSGRhiContextPrivate::get(context.get());
1357 rhi.vertexBuffer = std::make_shared<QSSGRhiBuffer>(*context.get(),
1358 QRhiBuffer::Static,
1359 QRhiBuffer::VertexBuffer,
1360 vertexBuffer.stride,
1361 vertexBuffer.data.size());
1362 rhi.vertexBuffer->buffer()->setName(debugObjectName.toLatin1()); // this is what shows up in DebugView
1363 rub->uploadStaticBuffer(rhi.vertexBuffer->buffer(), vertexBuffer.data);
1364
1365 if (!indexBuffer.data.isEmpty()) {
1366 rhi.indexBuffer = std::make_shared<QSSGRhiBuffer>(*context.get(),
1367 QRhiBuffer::Static,
1368 QRhiBuffer::IndexBuffer,
1369 0,
1370 indexBuffer.data.size(),
1371 rhiIndexFormat);
1372 rub->uploadStaticBuffer(rhi.indexBuffer->buffer(), indexBuffer.data);
1373 }
1374
1375 if (!targetBuffer.data.isEmpty()) {
1376 const int arraySize = targetBuffer.entries.size() * targetBuffer.numTargets;
1377 const int numTexels = (targetBuffer.data.size() / arraySize) >> 4; // byte size to vec4
1378 const int texWidth = qCeil(qSqrt(numTexels));
1379 const QSize texSize(texWidth, texWidth);
1380 if (!rhi.targetsTexture) {
1381 rhi.targetsTexture = context->rhi()->newTextureArray(QRhiTexture::RGBA32F, arraySize, texSize);
1382 rhi.targetsTexture->create();
1383 rhiCtxD->registerTexture(rhi.targetsTexture);
1384 } else if (rhi.targetsTexture->pixelSize() != texSize
1385 || rhi.targetsTexture->arraySize() != arraySize) {
1386 rhi.targetsTexture->setPixelSize(texSize);
1387 rhi.targetsTexture->setArraySize(arraySize);
1388 rhi.targetsTexture->create();
1389 }
1390
1391 const quint32 layerSize = texWidth * texWidth * 4 * 4;
1392 for (int arrayId = 0; arrayId < arraySize; ++arrayId) {
1393 QRhiTextureSubresourceUploadDescription targetDesc(targetBuffer.data + arrayId * layerSize, layerSize);
1394 QRhiTextureUploadDescription desc(QRhiTextureUploadEntry(arrayId, 0, targetDesc));
1395 rub->uploadTexture(rhi.targetsTexture, desc);
1396 }
1397
1398 for (quint32 entryIdx = 0, entryEnd = targetBuffer.entries.size(); entryIdx < entryEnd; ++entryIdx) {
1399 const char *nameStr = targetBuffer.entries[entryIdx].name.constData();
1400 if (!strcmp(nameStr, QSSGMesh::MeshInternal::getPositionAttrName())) {
1401 rhi.ia.targetOffsets[QSSGRhiInputAssemblerState::PositionSemantic] = entryIdx * targetBuffer.numTargets;
1402 } else if (!strcmp(nameStr, QSSGMesh::MeshInternal::getNormalAttrName())) {
1403 rhi.ia.targetOffsets[QSSGRhiInputAssemblerState::NormalSemantic] = entryIdx * targetBuffer.numTargets;
1404 } else if (!strcmp(nameStr, QSSGMesh::MeshInternal::getUV0AttrName())) {
1405 rhi.ia.targetOffsets[QSSGRhiInputAssemblerState::TexCoord0Semantic] = entryIdx * targetBuffer.numTargets;
1406 } else if (!strcmp(nameStr, QSSGMesh::MeshInternal::getUV1AttrName())) {
1407 rhi.ia.targetOffsets[QSSGRhiInputAssemblerState::TexCoord1Semantic] = entryIdx * targetBuffer.numTargets;
1408 } else if (!strcmp(nameStr, QSSGMesh::MeshInternal::getTexTanAttrName())) {
1409 rhi.ia.targetOffsets[QSSGRhiInputAssemblerState::TangentSemantic] = entryIdx * targetBuffer.numTargets;
1410 } else if (!strcmp(nameStr, QSSGMesh::MeshInternal::getTexBinormalAttrName())) {
1411 rhi.ia.targetOffsets[QSSGRhiInputAssemblerState::BinormalSemantic] = entryIdx * targetBuffer.numTargets;
1412 } else if (!strcmp(nameStr, QSSGMesh::MeshInternal::getColorAttrName())) {
1413 rhi.ia.targetOffsets[QSSGRhiInputAssemblerState::ColorSemantic] = entryIdx * targetBuffer.numTargets;
1414 }
1415 }
1416 rhi.ia.targetCount = targetBuffer.numTargets;
1417 } else if (rhi.targetsTexture) {
1418 rhiCtxD->releaseTexture(rhi.targetsTexture);
1419 rhi.targetsTexture = nullptr;
1420 rhi.ia.targetOffsets = { UINT8_MAX, UINT8_MAX, UINT8_MAX, UINT8_MAX,
1421 UINT8_MAX, UINT8_MAX, UINT8_MAX };
1422 rhi.ia.targetCount = 0;
1423 }
1424
1425 QVector<QSSGRenderVertexBufferEntry> entryBuffer;
1426 entryBuffer.resize(vertexBuffer.entries.size());
1427 for (quint32 entryIdx = 0, entryEnd = vertexBuffer.entries.size(); entryIdx < entryEnd; ++entryIdx)
1428 entryBuffer[entryIdx] = vertexBuffer.entries[entryIdx].toRenderVertexBufferEntry();
1429
1430 QVarLengthArray<QRhiVertexInputAttribute, 4> inputAttrs;
1431 for (quint32 entryIdx = 0, entryEnd = entryBuffer.size(); entryIdx < entryEnd; ++entryIdx) {
1432 const QSSGRenderVertexBufferEntry &vbe(entryBuffer[entryIdx]);
1433 const int binding = 0;
1434 const int location = 0; // for now, will be resolved later, hence the separate inputLayoutInputNames list
1435 const QRhiVertexInputAttribute::Format format = QSSGRhiHelpers::toVertexInputFormat(vbe.m_componentType, vbe.m_numComponents);
1436 const int offset = int(vbe.m_firstItemOffset);
1437
1438 bool ok = true;
1439 const char *nameStr = vbe.m_name.constData();
1440 if (!strcmp(nameStr, QSSGMesh::MeshInternal::getPositionAttrName())) {
1441 rhi.ia.inputs << QSSGRhiInputAssemblerState::PositionSemantic;
1442 } else if (!strcmp(nameStr, QSSGMesh::MeshInternal::getNormalAttrName())) {
1443 rhi.ia.inputs << QSSGRhiInputAssemblerState::NormalSemantic;
1444 } else if (!strcmp(nameStr, QSSGMesh::MeshInternal::getUV0AttrName())) {
1445 rhi.ia.inputs << QSSGRhiInputAssemblerState::TexCoord0Semantic;
1446 } else if (!strcmp(nameStr, QSSGMesh::MeshInternal::getUV1AttrName())) {
1447 rhi.ia.inputs << QSSGRhiInputAssemblerState::TexCoord1Semantic;
1448 } else if (!strcmp(nameStr, QSSGMesh::MeshInternal::getLightmapUVAttrName())) {
1449 rhi.ia.inputs << QSSGRhiInputAssemblerState::TexCoordLightmapSemantic;
1450 } else if (!strcmp(nameStr, QSSGMesh::MeshInternal::getTexTanAttrName())) {
1451 rhi.ia.inputs << QSSGRhiInputAssemblerState::TangentSemantic;
1452 } else if (!strcmp(nameStr, QSSGMesh::MeshInternal::getTexBinormalAttrName())) {
1453 rhi.ia.inputs << QSSGRhiInputAssemblerState::BinormalSemantic;
1454 } else if (!strcmp(nameStr, QSSGMesh::MeshInternal::getColorAttrName())) {
1455 rhi.ia.inputs << QSSGRhiInputAssemblerState::ColorSemantic;
1456 } else if (!strcmp(nameStr, QSSGMesh::MeshInternal::getJointAttrName())) {
1457 rhi.ia.inputs << QSSGRhiInputAssemblerState::JointSemantic;
1458 } else if (!strcmp(nameStr, QSSGMesh::MeshInternal::getWeightAttrName())) {
1459 rhi.ia.inputs << QSSGRhiInputAssemblerState::WeightSemantic;
1460 } else {
1461 qWarning("Unknown vertex input %s in mesh", nameStr);
1462 ok = false;
1463 }
1464 if (ok) {
1465 QRhiVertexInputAttribute inputAttr(binding, location, format, offset);
1466 inputAttrs.append(inputAttr);
1467 }
1468 }
1469 rhi.ia.inputLayout.setAttributes(inputAttrs.cbegin(), inputAttrs.cend());
1470 rhi.ia.inputLayout.setBindings({ vertexBuffer.stride });
1471 rhi.ia.topology = QSSGRhiHelpers::toTopology(QSSGRenderDrawMode(mesh.drawMode()));
1472
1473 if (rhi.ia.topology == QRhiGraphicsPipeline::TriangleFan && !context->rhi()->isFeatureSupported(QRhi::TriangleFanTopology))
1474 qWarning("Mesh topology is TriangleFan but this is not supported with the active graphics API. Rendering will be incorrect.");
1475
1476 QVector<QSSGMesh::Mesh::Subset> meshSubsets = mesh.subsets();
1477 for (quint32 subsetIdx = 0, subsetEnd = meshSubsets.size(); subsetIdx < subsetEnd; ++subsetIdx) {
1478 QSSGRenderSubset subset;
1479 const QSSGMesh::Mesh::Subset &source(meshSubsets[subsetIdx]);
1480 subset.bounds = QSSGBounds3(source.bounds.min, source.bounds.max);
1481 subset.count = source.count;
1482 subset.offset = source.offset;
1483 for (auto &lod : source.lods)
1484 subset.lods.append(QSSGRenderSubset::Lod({lod.count, lod.offset, lod.distance}));
1485
1486
1487 if (rhi.vertexBuffer) {
1488 subset.rhi.vertexBuffer = rhi.vertexBuffer;
1489 subset.rhi.ia = rhi.ia;
1490 }
1491 if (rhi.indexBuffer)
1492 subset.rhi.indexBuffer = rhi.indexBuffer;
1493 if (rhi.targetsTexture)
1494 subset.rhi.targetsTexture = rhi.targetsTexture;
1495
1496 newMesh->subsets.push_back(subset);
1497 }
1498
1499 if (!meshSubsets.isEmpty())
1500 newMesh->lightmapSizeHint = meshSubsets.first().lightmapSizeHint;
1501
1502 return newMesh;
1503}
1504
1505void QSSGBufferManager::releaseGeometry(QSSGRenderGeometry *geometry, const QString &lightmapSource)
1506{
1507 QMutexLocker meshMutexLocker(&meshBufferMutex);
1508 auto key = std::make_pair(geometry, lightmapSource);
1509 const auto meshItr = customMeshMap.constFind(key);
1510 if (meshItr != customMeshMap.cend()) {
1511 if (QSSGBufferManagerStat::enabled(QSSGBufferManagerStat::Level::Debug))
1512 qDebug() << "- releaseGeometry: " << geometry << currentLayer;
1513 Q_QUICK3D_PROFILE_START(QQuick3DProfiler::Quick3DCustomMeshLoad);
1514 Q_TRACE_SCOPE(QSSG_customMeshUnload);
1515 decreaseMemoryStat(meshItr.value().mesh);
1516 QSSGRhiContextPrivate *rhiCtxD = QSSGRhiContextPrivate::get(m_contextInterface->rhiContext().get());
1517 rhiCtxD->releaseMesh(meshItr.value().mesh);
1518 customMeshMap.erase(meshItr);
1519 Q_QUICK3D_PROFILE_END_WITH_ID(QQuick3DProfiler::Quick3DCustomMeshLoad,
1520 stats.meshDataSize, geometry->profilingId);
1521 }
1522}
1523
1524void QSSGBufferManager::releaseTextureData(const QSSGRenderTextureData *data)
1525{
1526 QVarLengthArray<CustomImageCacheKey, 4> keys;
1527 for (auto it = customTextureMap.cbegin(), end = customTextureMap.cend(); it != end; ++it) {
1528 if (it.key().data == data)
1529 keys.append(it.key());
1530 }
1531 for (const CustomImageCacheKey &key : keys)
1532 releaseTextureData(key);
1533}
1534
1535void QSSGBufferManager::releaseTextureData(const CustomImageCacheKey &key)
1536{
1537 const auto textureDataItr = customTextureMap.constFind(key);
1538 if (textureDataItr != customTextureMap.cend()) {
1539 auto rhiTexture = textureDataItr.value().renderImageTexture.m_texture;
1540 if (rhiTexture) {
1541 if (QSSGBufferManagerStat::enabled(QSSGBufferManagerStat::Level::Debug))
1542 qDebug() << "- releaseTextureData: " << rhiTexture << currentLayer;
1543 Q_QUICK3D_PROFILE_START(QQuick3DProfiler::Quick3DTextureLoad);
1544 Q_TRACE_SCOPE(QSSG_textureUnload);
1545 decreaseMemoryStat(rhiTexture);
1546 QSSGRhiContextPrivate *rhiCtxD = QSSGRhiContextPrivate::get(m_contextInterface->rhiContext().get());
1547 rhiCtxD->releaseTexture(rhiTexture);
1548 Q_QUICK3D_PROFILE_END_WITH_ID(QQuick3DProfiler::Quick3DTextureLoad,
1549 stats.imageDataSize, 0);
1550
1551 }
1552 customTextureMap.erase(textureDataItr);
1553 }
1554}
1555
1556void QSSGBufferManager::releaseExtensionResult(const QSSGRenderExtension &rext)
1557{
1558 renderExtensionTexture.remove(&rext);
1559}
1560
1561void QSSGBufferManager::releaseUserRenderPass(const QSSGRenderUserPass &upass)
1562{
1563 // Go through the user pass managers and tell them to unschedule this pass
1564 std::vector<QSSGUserRenderPassManagerWeakPtr> activeManagers;
1565 activeManagers.reserve(userRenderPassManagers.size());
1566 for (const auto &wmptr : std::as_const(userRenderPassManagers)) {
1567 if (const auto &mng = wmptr.lock()) {
1568 mng->unscheduleUserPass(&upass);
1569 activeManagers.push_back(wmptr);
1570 }
1571 }
1572
1573 userRenderPassManagers = std::move(activeManagers);
1574}
1575
1576void QSSGBufferManager::releaseMesh(const QSSGRenderPath &inSourcePath)
1577{
1578 QMutexLocker meshMutexLocker(&meshBufferMutex);
1579 auto key = std::make_pair(inSourcePath, lightmapSource);
1580 const auto meshItr = meshMap.constFind(key);
1581 if (meshItr != meshMap.cend()) {
1582 if (QSSGBufferManagerStat::enabled(QSSGBufferManagerStat::Level::Debug))
1583 qDebug() << "- releaseMesh: " << inSourcePath.path() << currentLayer;
1584 Q_QUICK3D_PROFILE_START(QQuick3DProfiler::Quick3DMeshLoad);
1585 Q_TRACE_SCOPE(QSSG_meshUnload);
1586 decreaseMemoryStat(meshItr.value().mesh);
1587 QSSGRhiContextPrivate *rhiCtxD = QSSGRhiContextPrivate::get(m_contextInterface->rhiContext().get());
1588 rhiCtxD->releaseMesh(meshItr.value().mesh);
1589 meshMap.erase(meshItr);
1590 Q_QUICK3D_PROFILE_END_WITH_STRING(QQuick3DProfiler::Quick3DMeshLoad,
1591 stats.meshDataSize, inSourcePath.path().toUtf8());
1592 }
1593}
1594
1595void QSSGBufferManager::releaseImage(const ImageCacheKey &key)
1596{
1597 const auto imageItr = imageMap.constFind(key);
1598 if (imageItr != imageMap.cend()) {
1599 auto rhiTexture = imageItr.value().renderImageTexture.m_texture;
1600 if (rhiTexture) {
1601 if (QSSGBufferManagerStat::enabled(QSSGBufferManagerStat::Level::Debug))
1602 qDebug() << "- releaseTexture: " << key.path.path() << currentLayer;
1603 Q_QUICK3D_PROFILE_START(QQuick3DProfiler::Quick3DTextureLoad);
1604 Q_TRACE_SCOPE(QSSG_textureUnload);
1605 decreaseMemoryStat(rhiTexture);
1606 QSSGRhiContextPrivate *rhiCtxD = QSSGRhiContextPrivate::get(m_contextInterface->rhiContext().get());
1607 rhiCtxD->releaseTexture(rhiTexture);
1608 Q_QUICK3D_PROFILE_END_WITH_STRING(QQuick3DProfiler::Quick3DTextureLoad,
1609 stats.imageDataSize, key.path.path().toUtf8());
1610 }
1611 imageMap.erase(imageItr);
1612 }
1613}
1614
1615bool QSSGBufferManager::validateLightmap()
1616{
1617 if (lightmapSourceDirty) {
1618 lightmapSourceDirty = false;
1619 if (lightmapSource.isEmpty()) {
1620 lightmapFileValid = false;
1621 } else {
1622 QSharedPointer<QSSGLightmapLoader> loader = QSSGLightmapLoader::open(lightmapSource);
1623 lightmapFileValid = loader != nullptr;
1624 if (!lightmapFileValid)
1625 qCWarning(WARNING, "Lightmaps are disabled.");
1626 }
1627 }
1628 return lightmapFileValid;
1629}
1630
1631void QSSGBufferManager::cleanupUnreferencedBuffers(quint32 frameId, QSSGRenderLayer *currentLayer)
1632{
1633 Q_UNUSED(currentLayer);
1634
1635 QSSGRhiContextPrivate *rhiCtxD = QSSGRhiContextPrivate::get(m_contextInterface->rhiContext().get());
1636
1637 // Don't cleanup if
1638 if (frameId == frameCleanupIndex)
1639 return;
1640
1641 auto isUnused = [] (const QHash<QSSGRenderLayer*, uint32_t> &usages) -> bool {
1642 for (const auto &value : std::as_const(usages))
1643 if (value != 0)
1644 return false;
1645 return true;
1646 };
1647
1648 {
1649 QMutexLocker meshMutexLocker(&meshBufferMutex);
1650 // Meshes (by path)
1651 auto meshIterator = meshMap.cbegin();
1652 while (meshIterator != meshMap.cend()) {
1653 if (isUnused(meshIterator.value().usageCounts)) {
1654 if (QSSGBufferManagerStat::enabled(QSSGBufferManagerStat::Level::Debug))
1655 qDebug() << "- releaseGeometry: " << meshIterator.key().first.path() << currentLayer;
1656 decreaseMemoryStat(meshIterator.value().mesh);
1657 rhiCtxD->releaseMesh(meshIterator.value().mesh);
1658 meshIterator = meshMap.erase(meshIterator);
1659 } else {
1660 ++meshIterator;
1661 }
1662 }
1663
1664 // Meshes (custom)
1665 auto customMeshIterator = customMeshMap.cbegin();
1666 while (customMeshIterator != customMeshMap.cend()) {
1667 if (isUnused(customMeshIterator.value().usageCounts)) {
1668 if (QSSGBufferManagerStat::enabled(QSSGBufferManagerStat::Level::Debug))
1669 qDebug() << "- releaseGeometry: " << customMeshIterator.key() << currentLayer;
1670 decreaseMemoryStat(customMeshIterator.value().mesh);
1671 rhiCtxD->releaseMesh(customMeshIterator.value().mesh);
1672 customMeshIterator = customMeshMap.erase(customMeshIterator);
1673 } else {
1674 ++customMeshIterator;
1675 }
1676 }
1677 }
1678
1679 // SG Textures
1680 auto sgIterator = qsgImageMap.cbegin();
1681 while (sgIterator != qsgImageMap.cend()) {
1682 if (isUnused(sgIterator.value().usageCounts)) {
1683 // Texture is no longer uses, so stop tracking
1684 // We do not need to delete/release the texture
1685 // because we don't own it.
1686 sgIterator = qsgImageMap.erase(sgIterator);
1687 } else {
1688 ++sgIterator;
1689 }
1690 }
1691
1692 // Images
1693 auto imageKeyIterator = imageMap.cbegin();
1694 while (imageKeyIterator != imageMap.cend()) {
1695 if (isUnused(imageKeyIterator.value().usageCounts)) {
1696 auto rhiTexture = imageKeyIterator.value().renderImageTexture.m_texture;
1697 if (rhiTexture) {
1698 if (QSSGBufferManagerStat::enabled(QSSGBufferManagerStat::Level::Debug))
1699 qDebug() << "- releaseTexture: " << imageKeyIterator.key().path.path() << currentLayer;
1700 decreaseMemoryStat(rhiTexture);
1701 rhiCtxD->releaseTexture(rhiTexture);
1702 }
1703 imageKeyIterator = imageMap.erase(imageKeyIterator);
1704 } else {
1705 ++imageKeyIterator;
1706 }
1707 }
1708
1709 // Custom Texture Data
1710 auto textureDataIterator = customTextureMap.cbegin();
1711 while (textureDataIterator != customTextureMap.cend()) {
1712 if (isUnused(textureDataIterator.value().usageCounts)) {
1713 auto rhiTexture = textureDataIterator.value().renderImageTexture.m_texture;
1714 if (rhiTexture) {
1715 if (QSSGBufferManagerStat::enabled(QSSGBufferManagerStat::Level::Debug))
1716 qDebug() << "- releaseTextureData: " << rhiTexture << currentLayer;
1717 decreaseMemoryStat(rhiTexture);
1718 rhiCtxD->releaseTexture(rhiTexture);
1719 }
1720 textureDataIterator = customTextureMap.erase(textureDataIterator);
1721 } else {
1722 ++textureDataIterator;
1723 }
1724 }
1725
1726 // Textures from render extensions
1727 auto renderExtensionTextureKeyIterator = renderExtensionTexture.cbegin();
1728 while (renderExtensionTextureKeyIterator != renderExtensionTexture.cend()) {
1729 // We do not own the textures, so we just keep track of usage, but
1730 // if the texture is no longer valid it means that the extension
1731 // has unregistered it, so we can remove it from the map.
1732 auto rhiTexture = renderExtensionTextureKeyIterator.value().renderImageTexture.m_texture;
1733 if (!rhiTexture)
1734 renderExtensionTextureKeyIterator = renderExtensionTexture.erase(renderExtensionTextureKeyIterator);
1735 else
1736 ++renderExtensionTextureKeyIterator;
1737 }
1738
1739 // Resource Tracking Debug Code
1740 frameCleanupIndex = frameId;
1741 if (QSSGBufferManagerStat::enabled(QSSGBufferManagerStat::Level::Usage)) {
1742 qDebug() << "QSSGBufferManager::cleanupUnreferencedBuffers()" << this << "frame:" << frameCleanupIndex << currentLayer;
1743 qDebug() << "Textures(by path): " << imageMap.count();
1744 qDebug() << "Textures(custom): " << customTextureMap.count();
1745 qDebug() << "Textures(Extension)" << renderExtensionTexture.count();
1746 qDebug() << "Textures(qsg): " << qsgImageMap.count();
1747 qDebug() << "Geometry(by path): " << meshMap.count();
1748 qDebug() << "Geometry(custom): " << customMeshMap.count();
1749 }
1750}
1751
1752void QSSGBufferManager::resetUsageCounters(quint32 frameId, QSSGRenderLayer *layer)
1753{
1754 currentLayer = layer;
1755 if (frameResetIndex == frameId)
1756 return;
1757
1758 // SG Textures
1759 for (auto &imageData : qsgImageMap)
1760 imageData.usageCounts[layer] = 0;
1761
1762 // Images
1763 for (auto &imageData : imageMap)
1764 imageData.usageCounts[layer] = 0;
1765
1766 // TextureDatas
1767 for (auto &imageData : customTextureMap)
1768 imageData.usageCounts[layer] = 0;
1769 // Meshes
1770 for (auto &meshData : meshMap)
1771 meshData.usageCounts[layer] = 0;
1772
1773 // Meshes (custom)
1774 for (auto &meshData : customMeshMap)
1775 meshData.usageCounts[layer] = 0;
1776
1777 // Textures from render extensions
1778 // NOTE: We retain the usage count as 1 as long as there is a texture
1779 // registered by a extension.
1780 for (auto &retData : renderExtensionTexture) {
1781 const bool hasTexture = (retData.renderImageTexture.m_texture != nullptr);
1782 retData.usageCounts[layer] = uint32_t(hasTexture) * 1;
1783 }
1784
1785 frameResetIndex = frameId;
1786}
1787
1788void QSSGBufferManager::registerMeshData(const QString &assetId, const QVector<QSSGMesh::Mesh> &meshData)
1789{
1790 auto it = g_assetMeshMap->find(assetId);
1791 if (it != g_assetMeshMap->end())
1792 ++it->ref;
1793 else
1794 g_assetMeshMap->insert(assetId, { meshData, 1 });
1795}
1796
1797void QSSGBufferManager::unregisterMeshData(const QString &assetId)
1798{
1799 auto it = g_assetMeshMap->find(assetId);
1800 if (it != g_assetMeshMap->end() && (--it->ref == 0))
1801 g_assetMeshMap->erase(AssetMeshMap::const_iterator(it));
1802}
1803
1804QSSGRenderMesh *QSSGBufferManager::loadRenderMesh(const QSSGRenderPath &inMeshPath, QSSGMeshProcessingOptions options)
1805{
1806 if (inMeshPath.isNull())
1807 return nullptr;
1808
1809 auto key = std::make_pair(inMeshPath, options.lightmapPath);
1810
1811 // check if it is already loaded
1812 auto meshItr = meshMap.find(key);
1813 if (meshItr != meshMap.cend()) {
1814 if (options.isCompatible(meshItr.value().options)) {
1815 meshItr.value().usageCounts[currentLayer]++;
1816 return meshItr.value().mesh;
1817 } else {
1818 // Re-Insert the mesh with a new name and a "zero" usage count, this will cause the
1819 // mesh to be released before the next frame starts.
1820 auto *mesh = meshItr->mesh;
1821 meshMap.erase(meshItr);
1822 auto keyReaped = std::make_pair(QSSGRenderPath(inMeshPath.path() + u"@reaped"), QString());
1823 meshMap.insert(keyReaped, { mesh, { { currentLayer, 0 } }, 0, { } });
1824 }
1825 }
1826
1827 Q_QUICK3D_PROFILE_START(QQuick3DProfiler::Quick3DMeshLoad);
1828 Q_TRACE_SCOPE(QSSG_meshLoadPath, inMeshPath.path());
1829
1830 auto [mesh, debugObjectName] = loadFromLightmapFile(options.lightmapPath, options.lightmapKey);
1831
1832 if (!mesh.isValid()) {
1833 mesh = loadMeshData(inMeshPath);
1834 debugObjectName = QFileInfo(inMeshPath.path()).fileName();
1835 }
1836
1837 if (!mesh.isValid()) {
1838 qCWarning(WARNING, "Failed to load mesh: %s", qPrintable(inMeshPath.path()));
1839 Q_QUICK3D_PROFILE_END_WITH_PAYLOAD(QQuick3DProfiler::Quick3DMeshLoad,
1840 stats.meshDataSize);
1841 return nullptr;
1842 }
1843 if (QSSGBufferManagerStat::enabled(QSSGBufferManagerStat::Level::Debug))
1844 qDebug() << "+ uploadGeometry: " << inMeshPath.path() << currentLayer;
1845
1846 auto ret = createRenderMesh(mesh, debugObjectName);
1847 meshMap.insert(key, { ret, { { currentLayer, 1 } }, 0, options });
1848 QSSGRhiContextPrivate *rhiCtxD = QSSGRhiContextPrivate::get(m_contextInterface->rhiContext().get());
1849 rhiCtxD->registerMesh(ret);
1850 increaseMemoryStat(ret);
1851 Q_QUICK3D_PROFILE_END_WITH_STRING(QQuick3DProfiler::Quick3DMeshLoad,
1852 stats.meshDataSize, inMeshPath.path().toUtf8());
1853 return ret;
1854}
1855
1856QSSGRenderMesh *QSSGBufferManager::loadRenderMesh(QSSGRenderGeometry *geometry, QSSGMeshProcessingOptions options)
1857{
1858 QSSGRhiContextPrivate *rhiCtxD = QSSGRhiContextPrivate::get(m_contextInterface->rhiContext().get());
1859 auto key = std::make_pair(geometry, options.lightmapPath);
1860 auto meshIterator = customMeshMap.find(key);
1861 if (meshIterator == customMeshMap.end()) {
1862 meshIterator = customMeshMap.insert(key, MeshData());
1863 } else if (geometry->generationId() != meshIterator->generationId || !options.isCompatible(meshIterator->options)) {
1864 // Release old data
1865 releaseGeometry(geometry, options.lightmapPath);
1866 meshIterator = customMeshMap.insert(key, MeshData());
1867 } else {
1868 // An up-to-date mesh was found
1869 meshIterator.value().usageCounts[currentLayer]++;
1870 return meshIterator.value().mesh;
1871 }
1872
1873 Q_QUICK3D_PROFILE_START(QQuick3DProfiler::Quick3DCustomMeshLoad);
1874 Q_TRACE_SCOPE(QSSG_customMeshLoad);
1875
1876 auto [mesh, debugObjectName] = loadFromLightmapFile(options.lightmapPath, options.lightmapKey);
1877
1878 // We have either a valid lightmap mesh or a geometry with data
1879 if (!geometry->meshData().m_vertexBuffer.isEmpty() || mesh.isValid()) {
1880 QString error;
1881
1882 if (!mesh.isValid()) {
1883 mesh = QSSGMesh::Mesh::fromRuntimeData(geometry->meshData(), &error);
1884 debugObjectName = geometry->debugObjectName;
1885 }
1886
1887 if (mesh.isValid()) {
1888 if (QSSGBufferManagerStat::enabled(QSSGBufferManagerStat::Level::Debug))
1889 qDebug() << "+ uploadGeometry: " << geometry << currentLayer;
1890 meshIterator->mesh = createRenderMesh(mesh, debugObjectName);
1891 meshIterator->usageCounts[currentLayer] = 1;
1892 meshIterator->generationId = geometry->generationId();
1893 meshIterator->options = options;
1894 rhiCtxD->registerMesh(meshIterator->mesh);
1895 increaseMemoryStat(meshIterator->mesh);
1896 } else {
1897 qWarning("Mesh building failed: %s", qPrintable(error));
1898 }
1899 }
1900 // else an empty mesh is not an error, leave the QSSGRenderMesh null, it will not be rendered then
1901
1902 Q_QUICK3D_PROFILE_END_WITH_ID(QQuick3DProfiler::Quick3DCustomMeshLoad,
1903 stats.meshDataSize, geometry->profilingId);
1904 return meshIterator->mesh;
1905}
1906
1907std::unique_ptr<QSSGMeshBVH> QSSGBufferManager::loadMeshBVH(const QSSGRenderPath &inSourcePath)
1908{
1909 const QSSGMesh::Mesh mesh = loadMeshData(inSourcePath);
1910 if (!mesh.isValid()) {
1911 qCWarning(WARNING, "Failed to load mesh: %s", qPrintable(inSourcePath.path()));
1912 return nullptr;
1913 }
1914 QSSGMeshBVHBuilder meshBVHBuilder(mesh);
1915 return meshBVHBuilder.buildTree();
1916}
1917
1918std::unique_ptr<QSSGMeshBVH> QSSGBufferManager::loadMeshBVH(QSSGRenderGeometry *geometry)
1919{
1920 if (!geometry)
1921 return nullptr;
1922
1923 // We only support generating a BVH with Triangle primitives
1924 if (geometry->primitiveType() != QSSGMesh::Mesh::DrawMode::Triangles)
1925 return nullptr;
1926
1927 // Build BVH
1928 bool hasIndexBuffer = false;
1929 QSSGRenderComponentType indexBufferFormat = QSSGRenderComponentType::UnsignedInt32;
1930 bool hasUV = false;
1931 int uvOffset = -1;
1932 int posOffset = -1;
1933
1934 for (int i = 0; i < geometry->attributeCount(); ++i) {
1935 auto attribute = geometry->attribute(i);
1936 if (attribute.semantic == QSSGMesh::RuntimeMeshData::Attribute::PositionSemantic) {
1937 posOffset = attribute.offset;
1938 } else if (attribute.semantic == QSSGMesh::RuntimeMeshData::Attribute::TexCoord0Semantic) {
1939 hasUV = true;
1940 uvOffset = attribute.offset;
1941 } else if (!hasUV && attribute.semantic == QSSGMesh::RuntimeMeshData::Attribute::TexCoord1Semantic) {
1942 hasUV = true;
1943 uvOffset = attribute.offset;
1944 } else if (attribute.semantic == QSSGMesh::RuntimeMeshData::Attribute::IndexSemantic) {
1945 hasIndexBuffer = true;
1946 indexBufferFormat = attribute.componentType;
1947 if (indexBufferFormat != QSSGRenderComponentType::Int16
1948 && indexBufferFormat != QSSGRenderComponentType::Int32
1949 && indexBufferFormat != QSSGRenderComponentType::UnsignedInt16
1950 && indexBufferFormat != QSSGRenderComponentType::UnsignedInt32) {
1951 qWarning() << "Unsupported index buffer format for geometry";
1952 return nullptr;
1953 }
1954 }
1955 }
1956
1957 QSSGMeshBVHBuilder meshBVHBuilder(geometry->vertexBuffer(),
1958 geometry->stride(),
1959 posOffset,
1960 hasUV,
1961 uvOffset,
1962 hasIndexBuffer,
1963 geometry->indexBuffer(),
1964 indexBufferFormat);
1965 return meshBVHBuilder.buildTree();
1966}
1967
1968std::unique_ptr<QSSGMeshBVH> QSSGBufferManager::loadMeshBVH(const QSSGMesh::Mesh &mesh)
1969{
1970 QSSGMeshBVHBuilder meshBVHBuilder(mesh);
1971 return meshBVHBuilder.buildTree();
1972}
1973
1974QSSGMesh::Mesh QSSGBufferManager::loadMeshData(const QSSGRenderPath &inMeshPath)
1975{
1976 QSSGMesh::Mesh result;
1977
1978 // check to see if this is a primitive mesh
1979 if (inMeshPath.path().startsWith(QChar::fromLatin1('#')))
1980 result = loadPrimitive(inMeshPath.path());
1981
1982 // check if this is an imported mesh. Expected path format: !name@path_to_asset
1983 if (!result.isValid() && inMeshPath.path().startsWith(u'!')) {
1984 const auto &[idx, assetId] = splitRuntimeMeshPath(inMeshPath);
1985 if (idx >= 0) {
1986 const auto ait = g_assetMeshMap->constFind(assetId);
1987 if (ait != g_assetMeshMap->constEnd()) {
1988 const auto &meshes = ait->meshes;
1989 if (idx < meshes.size())
1990 result = ait->meshes.at(idx);
1991 }
1992 } else {
1993 qWarning("Unexpected mesh path!");
1994 }
1995 }
1996
1997 // Attempt a load from the filesystem otherwise.
1998 if (!result.isValid()) {
1999 QString pathBuilder = inMeshPath.path();
2000 int poundIndex = pathBuilder.lastIndexOf(QChar::fromLatin1('#'));
2001 quint32 id = 0;
2002 if (poundIndex != -1) {
2003 id = QStringView(pathBuilder).mid(poundIndex + 1).toUInt();
2004 pathBuilder = pathBuilder.left(poundIndex);
2005 }
2006 if (!pathBuilder.isEmpty()) {
2007 QSharedPointer<QIODevice> device(QSSGInputUtil::getStreamForFile(pathBuilder));
2008 if (device) {
2009 QSSGMesh::Mesh mesh = QSSGMesh::Mesh::loadMesh(device.data(), id);
2010 if (mesh.isValid())
2011 result = mesh;
2012 }
2013 }
2014 }
2015
2016 return result;
2017}
2018
2019QSSGMesh::Mesh QSSGBufferManager::loadMeshData(const QSSGRenderGeometry *geometry)
2020{
2021 QString error;
2022 QSSGMesh::Mesh mesh = QSSGMesh::Mesh::fromRuntimeData(geometry->meshData(), &error);
2023 if (!mesh.isValid())
2024 qWarning("loadMeshDataForCustomMeshUncached failed: %s", qPrintable(error));
2025
2026 return mesh;
2027}
2028
2029void QSSGBufferManager::registerExtensionResult(const QSSGRenderExtension &extensions,
2030 QRhiTexture *texture)
2031{
2032 if (texture) {
2033 const bool isMipMapped = texture->flags().testFlag(QRhiTexture::Flag::MipMapped);
2034 const auto mipLevels = isMipMapped ? QRhi::mipLevelsForSize(texture->pixelSize()) : 0;
2035 QSSGRenderImageTextureFlags flags;
2036 const bool isSRGB = texture->flags().testFlag(QRhiTexture::Flag::sRGB);
2037 flags.setLinear(!isSRGB);
2038 const bool isRGBA8 = (texture->format() == QRhiTexture::Format::RGBA8);
2039 flags.setRgbe8(isRGBA8);
2040 renderExtensionTexture.insert(&extensions, ImageData { QSSGRenderImageTexture{ texture, mipLevels, flags }, {}, 0 /* version */ });
2041 } else {
2042 renderExtensionTexture.insert(&extensions, {});
2043 }
2044}
2045
2046void QSSGBufferManager::clear()
2047{
2048 QSSGRhiContextPrivate *rhiCtxD = QSSGRhiContextPrivate::get(m_contextInterface->rhiContext().get());
2049
2050 if (meshBufferUpdates) {
2051 meshBufferUpdates->release();
2052 meshBufferUpdates = nullptr;
2053 }
2054
2055 {
2056 QMutexLocker meshMutexLocker(&meshBufferMutex);
2057 // Meshes (by path)
2058 auto meshMapCopy = meshMap;
2059 meshMapCopy.detach();
2060 for (auto iter = meshMapCopy.begin(), end = meshMapCopy.end(); iter != end; ++iter) {
2061 QSSGRenderMesh *theMesh = iter.value().mesh;
2062 if (theMesh) {
2063 if (QSSGBufferManagerStat::enabled(QSSGBufferManagerStat::Level::Debug))
2064 qDebug() << "- releaseGeometry: " << iter.key().first.path() << currentLayer;
2065 decreaseMemoryStat(theMesh);
2066 rhiCtxD->releaseMesh(theMesh);
2067 }
2068 }
2069 meshMap.clear();
2070
2071 // Meshes (custom)
2072 auto customMeshMapCopy = customMeshMap;
2073 customMeshMapCopy.detach();
2074 for (auto iter = customMeshMapCopy.begin(), end = customMeshMapCopy.end(); iter != end; ++iter) {
2075 QSSGRenderMesh *theMesh = iter.value().mesh;
2076 if (theMesh) {
2077 if (QSSGBufferManagerStat::enabled(QSSGBufferManagerStat::Level::Debug))
2078 qDebug() << "- releaseGeometry: " << iter.key() << currentLayer;
2079 decreaseMemoryStat(theMesh);
2080 rhiCtxD->releaseMesh(theMesh);
2081 }
2082 }
2083 customMeshMap.clear();
2084 }
2085
2086 // Textures (by path)
2087 for (auto it = imageMap.constBegin(), end = imageMap.constEnd(); it != end; ++it)
2088 releaseImage(it.key());
2089
2090 imageMap.clear();
2091
2092 // Textures (custom)
2093 for (auto it = customTextureMap.cbegin(), end = customTextureMap.cend(); it != end; ++it)
2094 releaseTextureData(it.key());
2095
2096 customTextureMap.clear();
2097
2098 // Textures (QSG)
2099 // these don't have any owned objects to release so just clearing is fine.
2100 qsgImageMap.clear();
2101
2102 // To allow trying to read the lightmap file again
2103 lightmapSourceDirty = true;
2104}
2105
2106QRhiResourceUpdateBatch *QSSGBufferManager::meshBufferUpdateBatch()
2107{
2108 if (!meshBufferUpdates)
2109 meshBufferUpdates = m_contextInterface->rhiContext()->rhi()->nextResourceUpdateBatch();
2110 return meshBufferUpdates;
2111}
2112
2113void QSSGBufferManager::commitBufferResourceUpdates()
2114{
2115 if (meshBufferUpdates) {
2116 m_contextInterface->rhiContext()->commandBuffer()->resourceUpdate(meshBufferUpdates);
2117 meshBufferUpdates = nullptr;
2118 }
2119}
2120
2121void QSSGBufferManager::processResourceLoader(const QSSGRenderResourceLoader *loader)
2122{
2123 for (auto &mesh : std::as_const(loader->meshes))
2124 loadRenderMesh(mesh, {});
2125
2126 for (auto customMesh : std::as_const(loader->geometries))
2127 loadRenderMesh(static_cast<QSSGRenderGeometry*>(customMesh), {});
2128
2129 for (auto texture : std::as_const(loader->textures)) {
2130 const auto image = static_cast<QSSGRenderImage *>(texture);
2131 loadRenderImage(image);
2132 }
2133
2134 // Make sure the uploads occur
2135 commitBufferResourceUpdates();
2136}
2137
2138static inline quint32 textureFormatSize(QRhiTexture::Format format)
2139{
2140 switch (format) {
2141 case QRhiTexture::UnknownFormat:
2142 return 0;
2143 case QRhiTexture::RGBA8:
2144 return 4;
2145 case QRhiTexture::BGRA8:
2146 return 4;
2147 case QRhiTexture::R8:
2148 return 1;
2149 case QRhiTexture::RG8:
2150 return 2;
2151 case QRhiTexture::R16:
2152 return 2;
2153 case QRhiTexture::RG16:
2154 return 4;
2155 case QRhiTexture::RED_OR_ALPHA8:
2156 return 1;
2157
2158 case QRhiTexture::RGBA16F:
2159 return 8;
2160 case QRhiTexture::RGBA32F:
2161 return 16;
2162 case QRhiTexture::R16F:
2163 return 2;
2164 case QRhiTexture::R32F:
2165 return 4;
2166
2167 case QRhiTexture::RGB10A2:
2168 return 4;
2169
2170 case QRhiTexture::R8SI:
2171 return 1;
2172 case QRhiTexture::R32SI:
2173 return 4;
2174 case QRhiTexture::RG32SI:
2175 return 8;
2176 case QRhiTexture::RGBA32SI:
2177 return 16;
2178
2179 case QRhiTexture::R8UI:
2180 return 1;
2181 case QRhiTexture::R32UI:
2182 return 4;
2183 case QRhiTexture::RG32UI:
2184 return 8;
2185 case QRhiTexture::RGBA32UI:
2186 return 16;
2187
2188 case QRhiTexture::D16:
2189 return 2;
2190 case QRhiTexture::D24:
2191 return 4;
2192 case QRhiTexture::D24S8:
2193 return 4;
2194 case QRhiTexture::D32F:
2195 return 4;
2196 case QRhiTexture::D32FS8:
2197 return 8;
2198
2199 case QRhiTexture::BC1:
2200 return 8;
2201 case QRhiTexture::BC2:
2202 return 16;
2203 case QRhiTexture::BC3:
2204 return 16;
2205 case QRhiTexture::BC4:
2206 return 8;
2207 case QRhiTexture::BC5:
2208 return 16;
2209 case QRhiTexture::BC6H:
2210 return 16;
2211 case QRhiTexture::BC7:
2212 return 16;
2213
2214 case QRhiTexture::ETC2_RGB8:
2215 return 8;
2216 case QRhiTexture::ETC2_RGB8A1:
2217 return 8;
2218 case QRhiTexture::ETC2_RGBA8:
2219 return 16;
2220
2221 case QRhiTexture::ASTC_4x4:
2222 case QRhiTexture::ASTC_5x4:
2223 case QRhiTexture::ASTC_5x5:
2224 case QRhiTexture::ASTC_6x5:
2225 case QRhiTexture::ASTC_6x6:
2226 case QRhiTexture::ASTC_8x5:
2227 case QRhiTexture::ASTC_8x6:
2228 case QRhiTexture::ASTC_8x8:
2229 case QRhiTexture::ASTC_10x5:
2230 case QRhiTexture::ASTC_10x6:
2231 case QRhiTexture::ASTC_10x8:
2232 case QRhiTexture::ASTC_10x10:
2233 case QRhiTexture::ASTC_12x10:
2234 case QRhiTexture::ASTC_12x12:
2235 return 16;
2236 }
2237 Q_UNREACHABLE_RETURN(0);
2238}
2239
2240static inline bool isCompressedTextureFormat(QRhiTexture::Format format)
2241{
2242 return (format >= QRhiTexture::BC1);
2243}
2244
2245static inline quint64 textureMemorySize(QRhiTexture *texture)
2246{
2247 quint64 s = 0;
2248 if (!texture)
2249 return s;
2250
2251 auto format = texture->format();
2252 if (format == QRhiTexture::UnknownFormat)
2253 return 0;
2254
2255 s = texture->pixelSize().width() * texture->pixelSize().height();
2256
2257 const quint32 bytesPerPixel = textureFormatSize(format);
2258 QSSG_ASSERT_X(bytesPerPixel > 0, "Invalid texture format size", return 0);
2259
2260 if (!isCompressedTextureFormat(format)) {
2261 s *= bytesPerPixel;
2262 } else {
2263 s /= bytesPerPixel;
2264 }
2265
2266 if (texture->flags() & QRhiTexture::MipMapped)
2267 s += s / 4;
2268 if (texture->flags() & QRhiTexture::CubeMap)
2269 s *= 6;
2270 return s;
2271}
2272
2273static inline quint64 bufferMemorySize(const QSSGRhiBufferPtr &buffer)
2274{
2275 quint64 s = 0;
2276 if (!buffer)
2277 return s;
2278 s = buffer->buffer()->size();
2279 return s;
2280}
2281
2282void QSSGBufferManager::increaseMemoryStat(QRhiTexture *texture)
2283{
2284 stats.imageDataSize += textureMemorySize(texture);
2285 QSSGRhiContextStats::get(*m_contextInterface->rhiContext()).imageDataSizeChanges(stats.imageDataSize);
2286}
2287
2288void QSSGBufferManager::decreaseMemoryStat(QRhiTexture *texture)
2289{
2290 stats.imageDataSize = qMax(0u, stats.imageDataSize - textureMemorySize(texture));
2291 QSSGRhiContextStats::get(*m_contextInterface->rhiContext()).imageDataSizeChanges(stats.imageDataSize);
2292}
2293
2294void QSSGBufferManager::increaseMemoryStat(QSSGRenderMesh *mesh)
2295{
2296 stats.meshDataSize += bufferMemorySize(mesh->subsets.at(0).rhi.vertexBuffer)
2297 + bufferMemorySize(mesh->subsets.at(0).rhi.indexBuffer);
2298 QSSGRhiContextStats::get(*m_contextInterface->rhiContext()).meshDataSizeChanges(stats.meshDataSize);
2299}
2300
2301void QSSGBufferManager::decreaseMemoryStat(QSSGRenderMesh *mesh)
2302{
2303 quint64 s = 0;
2304 if (mesh)
2305 s = bufferMemorySize(mesh->subsets.at(0).rhi.vertexBuffer)
2306 + bufferMemorySize(mesh->subsets.at(0).rhi.indexBuffer);
2307 stats.meshDataSize = qMax(0u, stats.meshDataSize - s);
2308 QSSGRhiContextStats::get(*m_contextInterface->rhiContext()).meshDataSizeChanges(stats.meshDataSize);
2309}
2310
2311void QSSGBufferManager::setLightmapSource(const QString &source)
2312{
2313 if (lightmapSource != source) {
2314 lightmapSource = source;
2315 lightmapSourceDirty = true;
2316 }
2317}
2318
2319void QSSGBufferManager::setCurrentlyLightmapBaking(bool value)
2320{
2321 currentlyLightmapBaking = value;
2322}
2323
2324void QSSGBufferManager::registerUserRenderPassManager(const QSSGUserRenderPassManagerPtr &userPassManager)
2325{
2326 userRenderPassManagers.push_back(userPassManager);
2327}
2328
2329size_t qHash(const QSSGBufferManager::CustomImageCacheKey &k, size_t seed) noexcept
2330{
2331 // NOTE: The data pointer should never be null, as null data pointers shouldn't be inserted into
2332 // the cached (make sure to check that before inserting!!!)
2333 using MipMap_t = std::underlying_type_t<QSSGBufferManager::MipMode>;
2334 return qHash(*k.data, seed) ^ MipMap_t(k.mipMode);
2335}
2336
2337QT_END_NAMESPACE
Combined button and popup list for selecting options.
Q_TRACE_POINT(qtcore, QCoreApplication_postEvent_exit)
Q_TRACE_POINT(qtcore, QFactoryLoader_update, const QString &fileName)
constexpr size_t qHash(const QSize &s, size_t seed=0) noexcept
Definition qsize.h:192
QSSGLightmapIODataTag
static quint32 textureFormatSize(QRhiTexture::Format format)
static const PrimitiveEntry primitives[nPrimitives]
static constexpr QSize sizeForMipLevel(int mipLevel, const QSize &baseLevelSize)
static const int nPrimitives
static quint64 textureMemorySize(QRhiTexture *texture)
static MeshIdxNamePair splitRuntimeMeshPath(const QSSGRenderPath &rpath)
static const float cube[]
static bool isCompressedTextureFormat(QRhiTexture::Format format)
static const char * primitivesDirectory
static quint64 bufferMemorySize(const QSSGRhiBufferPtr &buffer)
static QPair< QSSGMesh::Mesh, QString > loadFromLightmapFile(const QString &lightmapPath, const QString &lightmapKey)
QVector< QSSGMesh::Mesh > meshes
static constexpr bool enabled(Level)