1// Copyright (C) 2020 The Qt Company Ltd.
2// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only
3
4#ifndef QSSG_RENDER_EFFECT_H
5#define QSSG_RENDER_EFFECT_H
6
7//
8// W A R N I N G
9// -------------
10//
11// This file is not part of the Qt API. It exists purely as an
12// implementation detail. This header file may change from version to
13// version without notice, or even be removed.
14//
15// We mean it.
16//
17
18#include <QtQuick3DRuntimeRender/private/qssgrendergraphobject_p.h>
19#include <QtQuick3DRuntimeRender/private/qssgrendernode_p.h>
20
21#include <QtQuick3DRuntimeRender/private/qssgrenderimage_p.h>
22#include <QtQuick3DRuntimeRender/private/qssgrendershaderlibrarymanager_p.h>
23
24#include <QtCore/QVariant>
25
26QT_BEGIN_NAMESPACE
27
28struct QSSGRenderLayer;
29struct QSSGCommand;
30class QSSGRenderContextInterface;
31
32struct Q_QUICK3DRUNTIMERENDER_EXPORT QSSGRenderEffect : public QSSGRenderGraphObject
33{
34 QSSGRenderEffect();
35 ~QSSGRenderEffect();
36
37 void finalizeShaders(const QSSGRenderLayer &layer, QSSGRenderContextInterface *renderContext);
38
39 enum class Flags : quint8
40 {
41 Dirty = 0x1u
42 };
43 using FlagT = std::underlying_type_t<Flags>;
44
45 struct TextureProperty
46 {
47 QSSGRenderImage *texImage = nullptr;
48 QByteArray name;
49 QSSGRenderShaderValue::Type shaderDataType;
50 QSSGRenderTextureFilterOp minFilterType = QSSGRenderTextureFilterOp::Linear;
51 QSSGRenderTextureFilterOp magFilterType = QSSGRenderTextureFilterOp::Linear;
52 QSSGRenderTextureFilterOp mipFilterType = QSSGRenderTextureFilterOp::Linear;
53 QSSGRenderTextureCoordOp horizontalClampType = QSSGRenderTextureCoordOp::ClampToEdge;
54 QSSGRenderTextureCoordOp verticalClampType = QSSGRenderTextureCoordOp::ClampToEdge;
55 QSSGRenderTextureCoordOp zClampType = QSSGRenderTextureCoordOp::ClampToEdge;
56 QSSGRenderTextureTypeValue usageType;
57 };
58
59 QVector<TextureProperty> textureProperties;
60
61 struct Property
62 {
63 Property() = default;
64 Property(const QByteArray &name, const QByteArray &typeName, const QVariant &value, QSSGRenderShaderValue::Type shaderDataType, int pid = -1)
65 : name(name), typeName(typeName), value(value), shaderDataType(shaderDataType), pid(pid)
66 { }
67 QByteArray name;
68 QByteArray typeName;
69 mutable QVariant value;
70 QSSGRenderShaderValue::Type shaderDataType;
71 int pid;
72 };
73
74 QVector<Property> properties;
75
76 QSSGRenderEffect *m_nextEffect = nullptr;
77
78 void markDirty();
79 void clearDirty();
80 [[nodiscard]] inline bool isDirty() const { return ((flags & FlagT(Flags::Dirty)) != 0); }
81
82 struct Command {
83 QSSGCommand *command;
84 quint8 own : 1;
85 };
86 QVector<Command> commands;
87
88 void resetCommands();
89
90 const char *className = nullptr;
91 FlagT flags = FlagT(Flags::Dirty);
92 bool requiresDepthTexture = false;
93 bool incompleteBuildTimeObject = false; // Used by the shadergen tool
94 QSSGRenderTextureFormat::Format outputFormat = QSSGRenderTextureFormat::Unknown;
95
96 struct ShaderPrepPassData
97 {
98 QByteArray shaderPathKeyPrefix; // to be completed in finalizeShaders
99 QByteArray vertexShaderCode[2]; // without main(), to be completed in finalizeShaders
100 QByteArray fragmentShaderCode[2]; // same here
101 QSSGCustomShaderMetaData vertexMetaData[2];
102 QSSGCustomShaderMetaData fragmentMetaData[2];
103 int bindShaderCmdIndex = 0;
104 };
105
106 struct {
107 bool valid = false;
108 QVector<ShaderPrepPassData> passes;
109 } shaderPrepData;
110
111 QString debugObjectName;
112};
113
114QT_END_NAMESPACE
115
116#endif
117

source code of qtquick3d/src/runtimerender/graphobjects/qssgrendereffect_p.h