qshaderbaker.cpp 7.83 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45
/****************************************************************************
**
** Copyright (C) 2017 The Qt Company Ltd.
** Contact: http://www.qt.io/licensing/
**
** This file is part of the Qt Shader Tools module
**
** $QT_BEGIN_LICENSE:LGPL3$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see http://www.qt.io/terms-conditions. For further
** information use the contact form at http://www.qt.io/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 3 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPLv3 included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 3 requirements
** will be met: https://www.gnu.org/licenses/lgpl.html.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 2.0 or later as published by the Free
** Software Foundation and appearing in the file LICENSE.GPL included in
** the packaging of this file. Please review the following information to
** ensure the GNU General Public License version 2.0 requirements will be
** met: http://www.gnu.org/licenses/gpl-2.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/

#include "qshaderbaker.h"
#include "qspirvcompiler.h"
#include "qspirvshader.h"
#include <QFileInfo>
#include <QFile>
#include <QDebug>

QT_BEGIN_NAMESPACE

Laszlo Agocs's avatar
Laszlo Agocs committed
46 47 48 49 50
/*!
    \class QShaderBaker
    \inmodule QtShaderTools
 */

51 52 53 54 55 56 57 58 59 60
struct QShaderBakerPrivate
{
    bool readFile(const QString &fn);

    QString sourceFileName;
    QByteArray source;
    QBakedShader::ShaderStage stage;
    QVector<QShaderBaker::GeneratedShader> reqVersions;
    QVector<QBakedShader::ShaderVariant> variants;
    QSpirvCompiler compiler;
61
    QString errorMessage;
62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139
};

bool QShaderBakerPrivate::readFile(const QString &fn)
{
    QFile f(fn);
    if (!f.open(QIODevice::ReadOnly | QIODevice::Text)) {
        qWarning("QShaderBaker: Failed to open %s", qPrintable(fn));
        return false;
    }
    source = f.readAll();
    sourceFileName = fn;
    return true;
}

QShaderBaker::QShaderBaker()
    : d(new QShaderBakerPrivate)
{
}

QShaderBaker::~QShaderBaker()
{
    delete d;
}

void QShaderBaker::setSourceFileName(const QString &fileName)
{
    if (!d->readFile(fileName))
        return;

    const QString suffix = QFileInfo(fileName).suffix();
    if (suffix == QStringLiteral("vert")) {
        d->stage = QBakedShader::VertexStage;
    } else if (suffix == QStringLiteral("frag")) {
        d->stage = QBakedShader::FragmentStage;
    } else if (suffix == QStringLiteral("tesc")) {
        d->stage = QBakedShader::TessControlStage;
    } else if (suffix == QStringLiteral("tese")) {
        d->stage = QBakedShader::TessEvaluationStage;
    } else if (suffix == QStringLiteral("geom")) {
        d->stage = QBakedShader::GeometryStage;
    } else if (suffix == QStringLiteral("comp")) {
        d->stage = QBakedShader::ComputeStage;
    } else {
        qWarning("QShaderBaker: Unknown shader stage, defaulting to vertex");
        d->stage = QBakedShader::VertexStage;
    }
}

void QShaderBaker::setSourceFileName(const QString &fileName, QBakedShader::ShaderStage stage)
{
    if (d->readFile(fileName))
        d->stage = stage;
}

void QShaderBaker::setSourceDevice(QIODevice *device, QBakedShader::ShaderStage stage, const QString &fileName)
{
    setSourceString(device->readAll(), stage, fileName);
}

void QShaderBaker::setSourceString(const QByteArray &sourceString, QBakedShader::ShaderStage stage, const QString &fileName)
{
    d->sourceFileName = fileName; // for error messages, include handling, etc.
    d->source = sourceString;
    d->stage = stage;
}

void QShaderBaker::setGeneratedShaders(const QVector<GeneratedShader> &v)
{
    d->reqVersions = v;
}

void QShaderBaker::setGeneratedShaderVariants(const QVector<QBakedShader::ShaderVariant> &v)
{
    d->variants = v;
}

QBakedShader QShaderBaker::bake()
{
140 141
    d->errorMessage.clear();

142 143 144 145 146 147 148 149
    if (d->source.isEmpty()) {
        qWarning("QShaderBaker: No source specified");
        return QBakedShader();
    }

    d->compiler.setSourceString(d->source, d->stage, d->sourceFileName);
    d->compiler.setFlags(0);
    QByteArray spirv = d->compiler.compileToSpirv();
150 151
    if (spirv.isEmpty()) {
        d->errorMessage = d->compiler.errorMessage();
152
        return QBakedShader();
153
    }
154 155 156 157 158

    QByteArray batchableSpirv;
    if (d->stage == QBakedShader::VertexStage && d->variants.contains(QBakedShader::BatchableVertexShader)) {
        d->compiler.setFlags(QSpirvCompiler::RewriteToMakeBatchableForSG);
        batchableSpirv = d->compiler.compileToSpirv();
159 160
        if (batchableSpirv.isEmpty()) {
            d->errorMessage = d->compiler.errorMessage();
161
            return QBakedShader();
162
        }
163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196
    }

    QBakedShader bs;
    bs.setStage(d->stage);

    QSpirvShader spirvShader;
    spirvShader.setSpirvBinary(spirv);
    bs.setDescription(spirvShader.shaderDescription());

    QSpirvShader batchableSpirvShader;
    if (!batchableSpirv.isEmpty())
        batchableSpirvShader.setSpirvBinary(batchableSpirv);

    for (const GeneratedShader &req: d->reqVersions) {
        for (const QBakedShader::ShaderVariant &v : d->variants) {
            QByteArray *currentSpirv = &spirv;
            QSpirvShader *currentSpirvShader = &spirvShader;
            if (v == QBakedShader::BatchableVertexShader) {
                if (!batchableSpirv.isEmpty()) {
                    currentSpirv = &batchableSpirv;
                    currentSpirvShader = &batchableSpirvShader;
                } else {
                    continue;
                }
            }
            const QBakedShader::ShaderKey key(req.first, req.second, v);
            QBakedShader::Shader shader;
            shader.entryPoint = QByteArrayLiteral("main");
            switch (req.first) {
            case QBakedShader::SpirvShader:
                shader.shader = *currentSpirv;
                break;
            case QBakedShader::GlslShader:
            {
Laszlo Agocs's avatar
Laszlo Agocs committed
197
                QSpirvShader::GlslFlags flags = 0;
198 199 200
                if (req.second.flags.testFlag(QBakedShader::ShaderSourceVersion::GlslEs))
                    flags |= QSpirvShader::GlslEs;
                shader.shader = currentSpirvShader->translateToGLSL(req.second.version, flags);
201 202 203 204
                if (shader.shader.isEmpty()) {
                    d->errorMessage = currentSpirvShader->translationErrorMessage();
                    return QBakedShader();
                }
205 206 207 208
            }
                break;
            case QBakedShader::HlslShader:
                shader.shader = currentSpirvShader->translateToHLSL(req.second.version);
209 210 211 212
                if (shader.shader.isEmpty()) {
                    d->errorMessage = currentSpirvShader->translationErrorMessage();
                    return QBakedShader();
                }
213 214
                break;
            case QBakedShader::MslShader:
Laszlo Agocs's avatar
Laszlo Agocs committed
215
                shader.shader = currentSpirvShader->translateToMSL(req.second.version);
216 217 218 219
                if (shader.shader.isEmpty()) {
                    d->errorMessage = currentSpirvShader->translationErrorMessage();
                    return QBakedShader();
                }
220 221 222 223 224 225 226 227 228 229 230 231 232 233
                shader.entryPoint = QByteArrayLiteral("main0");
                break;
            default:
                Q_UNREACHABLE();
            }
            bs.setShader(key, shader);
        }
    }

    return bs;
}

QString QShaderBaker::errorMessage() const
{
234
    return d->errorMessage;
235 236 237
}

QT_END_NAMESPACE