rhi: Add missing enum to QShader docs
Task-number: QTBUG-113331 Change-Id: Ibc792c1d30518efbae5f946360e7470aecc00d9f Reviewed-by: Andy Nichols <andy.nichols@qt.io> (cherry picked from commit 67f1c360b6094a2c3daeb1a5e9bbd63136297ffd) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
This commit is contained in:
parent
2ef4694c0a
commit
6f4f36333b
@ -213,6 +213,28 @@ QT_BEGIN_NAMESPACE
|
||||
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
|
||||
\inmodule QtGui
|
||||
@ -387,7 +409,11 @@ static void writeShaderKey(QDataStream *ds, const QShaderKey &k)
|
||||
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.
|
||||
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()
|
||||
*/
|
||||
@ -476,6 +502,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)
|
||||
|
Loading…
x
Reference in New Issue
Block a user