diff options
Diffstat (limited to 'src/gui/rhi/qshader.cpp')
| -rw-r--r-- | src/gui/rhi/qshader.cpp | 541 |
1 files changed, 479 insertions, 62 deletions
diff --git a/src/gui/rhi/qshader.cpp b/src/gui/rhi/qshader.cpp index 1992708ba4..d5fb53e7e6 100644 --- a/src/gui/rhi/qshader.cpp +++ b/src/gui/rhi/qshader.cpp @@ -1,7 +1,7 @@ -// Copyright (C) 2019 The Qt Company Ltd. +// Copyright (C) 2023 The Qt Company Ltd. // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only -#include "qshader_p_p.h" +#include "qshader_p.h" #include <QDataStream> #include <QBuffer> @@ -9,8 +9,9 @@ QT_BEGIN_NAMESPACE /*! \class QShader - \internal + \ingroup painting-3D \inmodule QtGui + \since 6.6 \brief Contains multiple versions of a shader translated to multiple shading languages, together with reflection metadata. @@ -21,6 +22,16 @@ QT_BEGIN_NAMESPACE as, Vulkan, Metal, Direct3D, and OpenGL, take QShader as their input whenever a shader needs to be specified. + \warning The QRhi family of classes in the Qt Gui module, including QShader + and QShaderDescription, offer limited compatibility guarantees. There are + no source or binary compatibility guarantees for these classes, meaning the + API is only guaranteed to work with the Qt version the application was + developed against. Source incompatible changes are however aimed to be kept + at a minimum and will only be made in minor releases (6.7, 6.8, and so on). + To use these classes in an application, link to + \c{Qt::GuiPrivate} (if using CMake), and include the headers with the \c + rhi prefix, for example \c{#include <rhi/qshader.h>}. + A QShader instance is empty and thus invalid by default. To get a useful instance, the two typical methods are: @@ -68,8 +79,9 @@ QT_BEGIN_NAMESPACE can be returned or passed by value. Detach happens implicitly when calling a setter. - For reference, QRhi expects that a QShader suitable for all its - backends contains at least the following: + For reference, a typical, portable QRhi expects that a QShader suitable for + all its backends contains at least the following. (this excludes support + for core profile OpenGL contexts, add GLSL 150 or newer for that) \list @@ -77,11 +89,11 @@ QT_BEGIN_NAMESPACE \li GLSL/ES 100 source code suitable for OpenGL ES 2.0 or newer - \li GLSL 120 source code suitable for OpenGL 2.1 + \li GLSL 120 source code suitable for OpenGL 2.1 or newer - \li HLSL Shader Model 5.0 source code or the corresponding DXBC bytecode suitable for Direct3D 11 + \li HLSL Shader Model 5.0 source code or the corresponding DXBC bytecode suitable for Direct3D 11/12 - \li Metal Shading Language 1.2 source code or the corresponding bytecode suitable for Metal + \li Metal Shading Language 1.2 source code or the corresponding bytecode suitable for Metal 1.2 or newer \endlist @@ -102,8 +114,8 @@ QT_BEGIN_NAMESPACE /*! \class QShaderVersion - \internal \inmodule QtGui + \since 6.6 \brief Specifies the shading language version. @@ -128,6 +140,9 @@ QT_BEGIN_NAMESPACE A default constructed QShaderVersion contains a version of 100 and no flags set. + + \note This is a RHI API with limited compatibility guarantees, see \l QShader + for details. */ /*! @@ -140,13 +155,16 @@ QT_BEGIN_NAMESPACE /*! \class QShaderKey - \internal \inmodule QtGui + \since 6.6 \brief Specifies the shading language, the version with flags, and the variant. A default constructed QShaderKey has source set to SpirvShader and sourceVersion set to 100. sourceVariant defaults to StandardShader. + + \note This is a RHI API with limited compatibility guarantees, see \l QShader + for details. */ /*! @@ -160,6 +178,7 @@ QT_BEGIN_NAMESPACE \value MslShader Metal Shading Language \value DxilShader Direct3D bytecode (HLSL compiled by \c dxc) \value MetalLibShader Pre-compiled Metal bytecode + \value WgslShader WGSL */ /*! @@ -167,25 +186,74 @@ QT_BEGIN_NAMESPACE Describes what kind of shader code an entry contains. \value StandardShader The normal, unmodified version of the shader code. + \value BatchableVertexShader Vertex shader rewritten to be suitable for Qt Quick scenegraph batching. + + \value UInt16IndexedVertexAsComputeShader A vertex shader meant to be used + in a Metal pipeline with tessellation in combination with indexed draw + calls sourcing index data from a uint16 index buffer. To support the Metal + tessellation pipeline, the vertex shader is translated to a compute shader + that may be dependent on the index buffer usage in the draw calls (e.g. if + the shader is using gl_VertexIndex), hence the need for three dedicated + variants. + + \value UInt32IndexedVertexAsComputeShader A vertex shader meant to be used + in a Metal pipeline with tessellation in combination with indexed draw + calls sourcing index data from a uint32 index buffer. To support the Metal + tessellation pipeline, the vertex shader is translated to a compute shader + that may be dependent on the index buffer usage in the draw calls (e.g. if + the shader is using gl_VertexIndex), hence the need for three dedicated + variants. + + \value NonIndexedVertexAsComputeShader A vertex shader meant to be used in + a Metal pipeline with tessellation in combination with non-indexed draw + calls. To support the Metal tessellation pipeline, the vertex shader is + translated to a compute shader that may be dependent on the index buffer + usage in the draw calls (e.g. if the shader is using gl_VertexIndex), hence + the need for three dedicated variants. + */ + +/*! + \enum QShader::SerializedFormatVersion + Describes the desired output format when serializing the QShader. + + The default value for the \c version argument of serialized() is \c Latest. + This is sufficient in the vast majority of cases. Specifying another value + is needed only when the intention is to generate serialized data that can + be loaded by earlier Qt versions. For example, the \c qsb tool uses these + enum values when the \c{--qsbversion} command-line argument is given. + + \note Targeting earlier versions will make certain features disfunctional + with the generated asset. This is not an issue when using the asset with + the specified, older Qt version, given that that Qt version does not have + the newer features in newer Qt versions that rely on additional data + generated in the QShader and the serialized data stream, but may become a + problem if the generated asset is then used with a newer Qt version. + + \value Latest The current Qt version + \value Qt_6_5 Qt 6.5 + \value Qt_6_4 Qt 6.4 */ /*! \class QShaderCode - \internal \inmodule QtGui + \since 6.6 \brief Contains source or binary code for a shader and additional metadata. When shader() is empty after retrieving a QShaderCode instance from QShader, it indicates no shader code was found for the requested key. + + \note This is a RHI API with limited compatibility guarantees, see \l QShader + for details. */ /*! Constructs a new, empty (and thus invalid) QShader instance. */ QShader::QShader() - : d(new QShaderPrivate) + : d(nullptr) { } @@ -194,42 +262,87 @@ QShader::QShader() */ void QShader::detach() { - qAtomicDetach(d); + if (d) + qAtomicDetach(d); + else + d = new QShaderPrivate; } /*! - \internal + Constructs a copy of \a other. */ QShader::QShader(const QShader &other) : d(other.d) { - d->ref.ref(); + if (d) + d->ref.ref(); } /*! - \internal + Assigns \a other to this object. */ QShader &QShader::operator=(const QShader &other) { - qAtomicAssign(d, other.d); + if (d) { + if (other.d) { + qAtomicAssign(d, other.d); + } else { + if (!d->ref.deref()) + delete d; + d = nullptr; + } + } else if (other.d) { + other.d->ref.ref(); + d = other.d; + } return *this; } /*! + \fn QShader::QShader(QShader &&other) noexcept + \since 6.7 + + Move-constructs a new QShader from \a other. + + \note The moved-from object \a other is placed in a + partially-formed state, in which the only valid operations are + destruction and assignment of a new value. +*/ + +/*! + \fn QShader &QShader::operator=(QShader &&other) + \since 6.7 + + Move-assigns \a other to this QShader instance. + + \note The moved-from object \a other is placed in a + partially-formed state, in which the only valid operations are + destruction and assignment of a new value. +*/ + +/*! Destructor. */ QShader::~QShader() { - if (!d->ref.deref()) + if (d && !d->ref.deref()) delete d; } /*! + \fn void QShader::swap(QShader &other) + \since 6.7 + + Swaps shader \a other with this shader. This operation is very fast and + never fails. +*/ + +/*! \return true if the QShader contains at least one shader version. */ bool QShader::isValid() const { - return !d->shaders.isEmpty(); + return d ? !d->shaders.isEmpty() : false; } /*! @@ -237,7 +350,7 @@ bool QShader::isValid() const */ QShader::Stage QShader::stage() const { - return d->stage; + return d ? d->stage : QShader::VertexStage; } /*! @@ -245,7 +358,7 @@ QShader::Stage QShader::stage() const */ void QShader::setStage(Stage stage) { - if (stage != d->stage) { + if (!d || stage != d->stage) { detach(); d->stage = stage; } @@ -256,7 +369,7 @@ void QShader::setStage(Stage stage) */ QShaderDescription QShader::description() const { - return d->desc; + return d ? d->desc : QShaderDescription(); } /*! @@ -273,7 +386,7 @@ void QShader::setDescription(const QShaderDescription &desc) */ QList<QShaderKey> QShader::availableShaders() const { - return d->shaders.keys().toVector(); + return d ? d->shaders.keys().toVector() : QList<QShaderKey>(); } /*! @@ -281,7 +394,7 @@ QList<QShaderKey> QShader::availableShaders() const */ QShaderCode QShader::shader(const QShaderKey &key) const { - return d->shaders.value(key); + return d ? d->shaders.value(key) : QShaderCode(); } /*! @@ -289,7 +402,7 @@ QShaderCode QShader::shader(const QShaderKey &key) const */ void QShader::setShader(const QShaderKey &key, const QShaderCode &shader) { - if (d->shaders.value(key) == shader) + if (d && d->shaders.value(key) == shader) return; detach(); @@ -302,6 +415,9 @@ void QShader::setShader(const QShaderKey &key, const QShaderCode &shader) */ void QShader::removeShader(const QShaderKey &key) { + if (!d) + return; + auto it = d->shaders.find(key); if (it == d->shaders.end()) return; @@ -322,51 +438,78 @@ static void writeShaderKey(QDataStream *ds, const QShaderKey &k) \return a serialized binary version of all the data held by the QShader, suitable for writing to files or other I/O devices. + By default the latest serialization format is used. Use \a version + parameter to serialize for a compatibility Qt version. Only when it is + known that the generated data stream must be made compatible with an older + Qt version at the expense of making it incompatible with features + introduced since that Qt version, should another value (for example, + \l{SerializedFormatVersion}{Qt_6_5} for Qt 6.5) be used. + \sa fromSerialized() */ -QByteArray QShader::serialized() const +QByteArray QShader::serialized(SerializedFormatVersion version) const { + static QShaderPrivate sd; + QShaderPrivate *dd = d ? d : &sd; + QBuffer buf; QDataStream ds(&buf); ds.setVersion(QDataStream::Qt_5_10); if (!buf.open(QIODevice::WriteOnly)) return QByteArray(); - ds << QShaderPrivate::QSB_VERSION; - ds << int(d->stage); - d->desc.serialize(&ds); - ds << int(d->shaders.count()); - for (auto it = d->shaders.cbegin(), itEnd = d->shaders.cend(); it != itEnd; ++it) { + const int qsbVersion = QShaderPrivate::qtQsbVersion(version); + ds << qsbVersion; + + ds << int(dd->stage); + dd->desc.serialize(&ds, qsbVersion); + ds << int(dd->shaders.size()); + for (auto it = dd->shaders.cbegin(), itEnd = dd->shaders.cend(); it != itEnd; ++it) { const QShaderKey &k(it.key()); writeShaderKey(&ds, k); - const QShaderCode &shader(d->shaders.value(k)); + const QShaderCode &shader(dd->shaders.value(k)); ds << shader.shader(); ds << shader.entryPoint(); } - ds << int(d->bindings.count()); - for (auto it = d->bindings.cbegin(), itEnd = d->bindings.cend(); it != itEnd; ++it) { + ds << int(dd->bindings.size()); + for (auto it = dd->bindings.cbegin(), itEnd = dd->bindings.cend(); it != itEnd; ++it) { const QShaderKey &k(it.key()); writeShaderKey(&ds, k); const NativeResourceBindingMap &map(it.value()); - ds << int(map.count()); + ds << int(map.size()); for (auto mapIt = map.cbegin(), mapItEnd = map.cend(); mapIt != mapItEnd; ++mapIt) { ds << mapIt.key(); ds << mapIt.value().first; ds << mapIt.value().second; } } - ds << int(d->combinedImageMap.count()); - for (auto it = d->combinedImageMap.cbegin(), itEnd = d->combinedImageMap.cend(); it != itEnd; ++it) { + ds << int(dd->combinedImageMap.size()); + for (auto it = dd->combinedImageMap.cbegin(), itEnd = dd->combinedImageMap.cend(); it != itEnd; ++it) { const QShaderKey &k(it.key()); writeShaderKey(&ds, k); const SeparateToCombinedImageSamplerMappingList &list(it.value()); - ds << int(list.count()); + ds << int(list.size()); for (auto listIt = list.cbegin(), listItEnd = list.cend(); listIt != listItEnd; ++listIt) { ds << listIt->combinedSamplerName; ds << listIt->textureBinding; ds << listIt->samplerBinding; } } + if (qsbVersion > QShaderPrivate::QSB_VERSION_WITHOUT_NATIVE_SHADER_INFO) { + ds << int(dd->nativeShaderInfoMap.size()); + for (auto it = dd->nativeShaderInfoMap.cbegin(), itEnd = dd->nativeShaderInfoMap.cend(); it != itEnd; ++it) { + const QShaderKey &k(it.key()); + writeShaderKey(&ds, k); + ds << it->flags; + ds << int(it->extraBufferBindings.size()); + for (auto mapIt = it->extraBufferBindings.cbegin(), mapItEnd = it->extraBufferBindings.cend(); + mapIt != mapItEnd; ++mapIt) + { + ds << mapIt.key(); + ds << mapIt.value(); + } + } + } return qCompress(buf.buffer()); } @@ -389,6 +532,9 @@ static void readShaderKey(QDataStream *ds, QShaderKey *k) /*! Creates a new QShader instance from the given \a data. + If \a data cannot be deserialized successfully, the result is a default + constructed QShader for which isValid() returns \c false. + \sa serialized() */ QShader QShader::fromSerialized(const QByteArray &data) @@ -401,12 +547,16 @@ QShader QShader::fromSerialized(const QByteArray &data) return QShader(); QShader bs; + bs.detach(); // to get d created QShaderPrivate *d = QShaderPrivate::get(&bs); Q_ASSERT(d->ref.loadRelaxed() == 1); // must be detached int intVal; ds >> intVal; d->qsbVersion = intVal; if (d->qsbVersion != QShaderPrivate::QSB_VERSION + && d->qsbVersion != QShaderPrivate::QSB_VERSION_WITHOUT_INPUT_OUTPUT_INTERFACE_BLOCKS + && d->qsbVersion != QShaderPrivate::QSB_VERSION_WITHOUT_EXTENDED_STORAGE_BUFFER_INFO + && d->qsbVersion != QShaderPrivate::QSB_VERSION_WITHOUT_NATIVE_SHADER_INFO && d->qsbVersion != QShaderPrivate::QSB_VERSION_WITHOUT_SEPARATE_IMAGES_AND_SAMPLERS && d->qsbVersion != QShaderPrivate::QSB_VERSION_WITHOUT_VAR_ARRAYDIMS && d->qsbVersion != QShaderPrivate::QSB_VERSION_WITH_CBOR @@ -484,19 +634,102 @@ QShader QShader::fromSerialized(const QByteArray &data) } } + if (d->qsbVersion > QShaderPrivate::QSB_VERSION_WITHOUT_NATIVE_SHADER_INFO) { + ds >> count; + for (int i = 0; i < count; ++i) { + QShaderKey k; + readShaderKey(&ds, &k); + int flags; + ds >> flags; + QMap<int, int> extraBufferBindings; + int mapSize; + ds >> mapSize; + for (int b = 0; b < mapSize; ++b) { + int k, v; + ds >> k; + ds >> v; + extraBufferBindings.insert(k, v); + } + d->nativeShaderInfoMap.insert(k, { flags, extraBufferBindings }); + } + } + return bs; } +/*! + \fn QShaderVersion::QShaderVersion() = default + */ + +/*! + Constructs a new QShaderVersion with version \a v and flags \a f. + */ QShaderVersion::QShaderVersion(int v, Flags f) : m_version(v), m_flags(f) { } +/*! + \fn int QShaderVersion::version() const + \return the version. + */ + +/*! + \fn void QShaderVersion::setVersion(int v) + Sets the shading language version to \a v. + */ + +/*! + \fn QShaderVersion::Flags QShaderVersion::flags() const + \return the flags. + */ + +/*! + \fn void QShaderVersion::setFlags(Flags f) + Sets the flags \a f. + */ + +/*! + \fn QShaderCode::QShaderCode() = default + */ + +/*! + Constructs a new QShaderCode with the specified shader source \a code and + \a entry point name. + */ QShaderCode::QShaderCode(const QByteArray &code, const QByteArray &entry) : m_shader(code), m_entryPoint(entry) { } +/*! + \fn QByteArray QShaderCode::shader() const + \return the shader source or bytecode. + */ + +/*! + \fn void QShaderCode::setShader(const QByteArray &code) + Sets the shader source or byte \a code. + */ + +/*! + \fn QByteArray QShaderCode::entryPoint() const + \return the entry point name. + */ + +/*! + \fn void QShaderCode::setEntryPoint(const QByteArray &entry) + Sets the \a entry point name. + */ + +/*! + \fn QShaderKey::QShaderKey() = default + */ + +/*! + Constructs a new QShaderKey with shader type \a s, version \a sver, and + variant \a svar. + */ QShaderKey::QShaderKey(QShader::Source s, const QShaderVersion &sver, QShader::Variant svar) @@ -507,6 +740,36 @@ QShaderKey::QShaderKey(QShader::Source s, } /*! + \fn QShader::Source QShaderKey::source() const + \return the shader type. + */ + +/*! + \fn void QShaderKey::setSource(QShader::Source s) + Sets the shader type \a s. + */ + +/*! + \fn QShaderVersion QShaderKey::sourceVersion() const + \return the shading language version. + */ + +/*! + \fn void QShaderKey::setSourceVersion(const QShaderVersion &sver) + Sets the shading language version \a sver. + */ + +/*! + \fn QShader::Variant QShaderKey::sourceVariant() const + \return the type of the variant to use. + */ + +/*! + \fn void QShaderKey::setSourceVariant(QShader::Variant svar) + Sets the type of variant to use to \a svar. + */ + +/*! Returns \c true if the two QShader objects \a lhs and \a rhs are equal, meaning they are for the same stage with matching sets of shader source or binary code. @@ -515,16 +778,18 @@ QShaderKey::QShaderKey(QShader::Source s, */ bool operator==(const QShader &lhs, const QShader &rhs) noexcept { + if (!lhs.d || !rhs.d) + return lhs.d == rhs.d; + return lhs.d->stage == rhs.d->stage - && lhs.d->shaders == rhs.d->shaders; - // do not bother with desc and bindings, if the shader code is the same, the description must match too + && lhs.d->shaders == rhs.d->shaders + && lhs.d->bindings == rhs.d->bindings; } /*! - \internal \fn bool operator!=(const QShader &lhs, const QShader &rhs) - Returns \c false if the values in the two QShader objects \a a and \a b + Returns \c false if the values in the two QShader objects \a lhs and \a rhs are equal; otherwise returns \c true. \relates QShader @@ -537,11 +802,14 @@ bool operator==(const QShader &lhs, const QShader &rhs) noexcept */ size_t qHash(const QShader &s, size_t seed) noexcept { - QtPrivate::QHashCombine hash; - seed = hash(seed, s.stage()); - seed = qHashRange(s.d->shaders.keyValueBegin(), - s.d->shaders.keyValueEnd(), - seed); + if (s.d) { + QtPrivate::QHashCombine hash; + seed = hash(seed, s.stage()); + if (!s.d->shaders.isEmpty()) { + seed = hash(seed, s.d->shaders.firstKey()); + seed = hash(seed, std::as_const(s.d->shaders).first()); + } + } return seed; } @@ -564,11 +832,28 @@ size_t qHash(const QShaderVersion &s, size_t seed) noexcept #endif /*! - \internal + \return true if \a lhs is smaller than \a rhs. + + Establishes a sorting order between the two QShaderVersion \a lhs and \a rhs. + + \relates QShaderVersion + */ +bool operator<(const QShaderVersion &lhs, const QShaderVersion &rhs) noexcept +{ + if (lhs.version() < rhs.version()) + return true; + + if (lhs.version() == rhs.version()) + return int(lhs.flags()) < int(rhs.flags()); + + return false; +} + +/*! \fn bool operator!=(const QShaderVersion &lhs, const QShaderVersion &rhs) - Returns \c false if the values in the two QShaderVersion objects \a a - and \a b are equal; otherwise returns \c true. + Returns \c false if the values in the two QShaderVersion objects \a lhs + and \a rhs are equal; otherwise returns \c true. \relates QShaderVersion */ @@ -585,11 +870,34 @@ bool operator==(const QShaderKey &lhs, const QShaderKey &rhs) noexcept } /*! - \internal + \return true if \a lhs is smaller than \a rhs. + + Establishes a sorting order between the two keys \a lhs and \a rhs. + + \relates QShaderKey + */ +bool operator<(const QShaderKey &lhs, const QShaderKey &rhs) noexcept +{ + if (int(lhs.source()) < int(rhs.source())) + return true; + + if (int(lhs.source()) == int(rhs.source())) { + if (lhs.sourceVersion() < rhs.sourceVersion()) + return true; + if (lhs.sourceVersion() == rhs.sourceVersion()) { + if (int(lhs.sourceVariant()) < int(rhs.sourceVariant())) + return true; + } + } + + return false; +} + +/*! \fn bool operator!=(const QShaderKey &lhs, const QShaderKey &rhs) - Returns \c false if the values in the two QShaderKey objects \a a - and \a b are equal; otherwise returns \c true. + Returns \c false if the values in the two QShaderKey objects \a lhs + and \a rhs are equal; otherwise returns \c true. \relates QShaderKey */ @@ -619,11 +927,10 @@ bool operator==(const QShaderCode &lhs, const QShaderCode &rhs) noexcept } /*! - \internal \fn bool operator!=(const QShaderCode &lhs, const QShaderCode &rhs) - Returns \c false if the values in the two QShaderCode objects \a a - and \a b are equal; otherwise returns \c true. + Returns \c false if the values in the two QShaderCode objects \a lhs + and \a rhs are equal; otherwise returns \c true. \relates QShaderCode */ @@ -644,11 +951,15 @@ QDebug operator<<(QDebug dbg, const QShader &bs) const QShaderPrivate *d = bs.d; QDebugStateSaver saver(dbg); - dbg.nospace() << "QShader(" - << "stage=" << d->stage - << " shaders=" << d->shaders.keys() - << " desc.isValid=" << d->desc.isValid() - << ')'; + if (d) { + dbg.nospace() << "QShader(" + << "stage=" << d->stage + << " shaders=" << d->shaders.keys() + << " desc.isValid=" << d->desc.isValid() + << ')'; + } else { + dbg.nospace() << "QShader()"; + } return dbg; } @@ -673,7 +984,7 @@ QDebug operator<<(QDebug dbg, const QShaderVersion &v) /*! \typedef QShader::NativeResourceBindingMap - Synonym for QHash<int, QPair<int, int>>. + Synonym for QMap<int, QPair<int, int>>. The resource binding model QRhi assumes is based on SPIR-V. This means that uniform buffers, storage buffers, combined image samplers, and storage @@ -712,6 +1023,9 @@ QDebug operator<<(QDebug dbg, const QShaderVersion &v) */ QShader::NativeResourceBindingMap QShader::nativeResourceBindingMap(const QShaderKey &key) const { + if (!d) + return {}; + auto it = d->bindings.constFind(key); if (it == d->bindings.cend()) return {}; @@ -735,6 +1049,9 @@ void QShader::setResourceBindingMap(const QShaderKey &key, const NativeResourceB */ void QShader::removeResourceBindingMap(const QShaderKey &key) { + if (!d) + return; + auto it = d->bindings.find(key); if (it == d->bindings.end()) return; @@ -751,6 +1068,8 @@ void QShader::removeResourceBindingMap(const QShaderKey &key) /*! \struct QShader::SeparateToCombinedImageSamplerMapping + \inmodule QtGui + \brief Mapping metadata for sampler uniforms. Describes a mapping from a traditional combined image sampler uniform to binding points for a separate texture and sampler. @@ -760,15 +1079,33 @@ void QShader::removeResourceBindingMap(const QShaderKey &key) contains a \c sampler2D (or sampler3D, etc.) uniform with the name of \c{_54} which corresponds to two separate resource bindings (\c 1 and \c 2) in the original shader. + + \note This is a RHI API with limited compatibility guarantees, see \l QShader + for details. */ /*! + \variable QShader::SeparateToCombinedImageSamplerMapping::combinedSamplerName +*/ + +/*! + \variable QShader::SeparateToCombinedImageSamplerMapping::textureBinding +*/ + +/*! + \variable QShader::SeparateToCombinedImageSamplerMapping::samplerBinding +*/ + +/*! \return the combined image sampler mapping list for \a key, or an empty list if there is no data available for \a key, for example because such a mapping is not applicable for the shading language. */ QShader::SeparateToCombinedImageSamplerMappingList QShader::separateToCombinedImageSamplerMappingList(const QShaderKey &key) const { + if (!d) + return {}; + auto it = d->combinedImageMap.constFind(key); if (it == d->combinedImageMap.cend()) return {}; @@ -793,6 +1130,9 @@ void QShader::setSeparateToCombinedImageSamplerMappingList(const QShaderKey &key */ void QShader::removeSeparateToCombinedImageSamplerMappingList(const QShaderKey &key) { + if (!d) + return; + auto it = d->combinedImageMap.find(key); if (it == d->combinedImageMap.end()) return; @@ -801,4 +1141,81 @@ void QShader::removeSeparateToCombinedImageSamplerMappingList(const QShaderKey & d->combinedImageMap.erase(it); } +/*! + \struct QShader::NativeShaderInfo + \inmodule QtGui + \brief Additional metadata about the native shader code. + + Describes information about the native shader code, if applicable. This + becomes relevant with certain shader languages for certain shader stages, + in case the translation from SPIR-V involves the introduction of + additional, "magic" inputs, outputs, or resources in the generated shader. + Such additions may be dependent on the original source code (i.e. the usage + of various GLSL language constructs or built-ins), and therefore it needs + to be indicated in a dynamic manner if certain features got added to the + generated shader code. + + As an example, consider a tessellation control shader with a per-patch (not + per-vertex) output variable. This is translated to a Metal compute shader + outputting (among others) into an spvPatchOut buffer. But this buffer would + not be present at all if per-patch output variables were not used. The fact + that the shader code relies on such a buffer present can be indicated by + the data in this struct. + + \note This is a RHI API with limited compatibility guarantees, see \l QShader + for details. + */ + +/*! + \variable QShader::NativeShaderInfo::flags +*/ + +/*! + \variable QShader::NativeShaderInfo::extraBufferBindings +*/ + +/*! + \return the native shader info struct for \a key, or an empty object if + there is no data available for \a key, for example because such a mapping + is not applicable for the shading language or the shader stage. + */ +QShader::NativeShaderInfo QShader::nativeShaderInfo(const QShaderKey &key) const +{ + if (!d) + return {}; + + auto it = d->nativeShaderInfoMap.constFind(key); + if (it == d->nativeShaderInfoMap.cend()) + return {}; + + return it.value(); +} + +/*! + Stores the given native shader \a info associated with \a key. + + \sa nativeShaderInfo() + */ +void QShader::setNativeShaderInfo(const QShaderKey &key, const NativeShaderInfo &info) +{ + detach(); + d->nativeShaderInfoMap[key] = info; +} + +/*! + Removes the native shader information for \a key. + */ +void QShader::removeNativeShaderInfo(const QShaderKey &key) +{ + if (!d) + return; + + auto it = d->nativeShaderInfoMap.find(key); + if (it == d->nativeShaderInfoMap.end()) + return; + + detach(); + d->nativeShaderInfoMap.erase(it); +} + QT_END_NAMESPACE |