qsgd3d11material_p.h

/****************************************************************************
**
** Copyright (C) 2016 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the QtQuick module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** 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 https://www.qt.io/terms-conditions. For further
** information use the contact form at https://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.LGPL3 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-3.0.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 (at your option) the GNU General
** Public license version 3 or any later version approved by the KDE Free
** Qt Foundation. The licenses are as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-2.0.html and
** https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/

#ifndef QSGD3D11MATERIAL_P_H
#define QSGD3D11MATERIAL_P_H

//
//  W A R N I N G
//  -------------
//
// This file is not part of the Qt API.  It exists purely as an
// implementation detail.  This header file may change from version to
// version without notice, or even be removed.
//
// We mean it.
//

#include <QtQuick/qsgmaterial.h>
#include "qsgd3d11engine_p.h"

QT_BEGIN_NAMESPACE

class QSGRenderer;

// The D3D renderer works with QSGD3D11Material as the "base" class since
// QSGMaterial and its GL program related bits are not suitable. Also, there is
// no split like with QSGMaterialShader.

typedef QSGMaterialShader::RenderState QSGD3D11MaterialRenderState;

class QSGD3D11Material : public QSGMaterial
{
public:
    struct ExtraState {
        QVector4D blendFactor;
    };

    enum UpdateResult {
        UpdatedShaders = 0x0001,
        UpdatedConstantBuffer = 0x0002,
        UpdatedBlendFactor = 0x0004
    };
    Q_DECLARE_FLAGS(UpdateResults, UpdateResult)

    virtual int constantBufferSize() const = 0;
    virtual void preparePipeline(QSGD3D11PipelineState *pipelineState) = 0;
    virtual UpdateResults updatePipeline(const QSGD3D11MaterialRenderState &state,
                                         QSGD3D11PipelineState *pipelineState,
                                         ExtraState *extraState,
                                         quint8 *constantBuffer) = 0;

private:
    QSGMaterialShader *createShader() const override; // dummy, QSGMaterialShader is too GL dependent
};

Q_DECLARE_OPERATORS_FOR_FLAGS(QSGD3D11Material::UpdateResults)

QT_END_NAMESPACE

#endif // QSGD3D11MATERIAL_P_H