Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
Loading...
Searching...
No Matches
qssgrenderdefaultmaterial_p.h
Go to the documentation of this file.
1// Copyright (C) 2008-2012 NVIDIA Corporation.
2// Copyright (C) 2019 The Qt Company Ltd.
3// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only
4// Qt-Security score:significant reason:default
5
6
7#ifndef QSSG_RENDER_DEFAULT_MATERIAL_H
8#define QSSG_RENDER_DEFAULT_MATERIAL_H
9
10//
11// W A R N I N G
12// -------------
13//
14// This file is not part of the Qt API. It exists purely as an
15// implementation detail. This header file may change from version to
16// version without notice, or even be removed.
17//
18// We mean it.
19//
20
21#include <QtQuick3DRuntimeRender/private/qssgrendergraphobject_p.h>
22
23#include <QtQuick3DUtils/private/qssgrenderbasetypes_p.h>
24
25#include <QtGui/QVector3D>
26
27QT_BEGIN_NAMESPACE
28
29struct QSSGRenderImage;
30struct QSSGRenderModel;
31struct QSSGShaderMaterialAdapter;
32
33struct Q_QUICK3DRUNTIMERENDER_EXPORT QSSGRenderDefaultMaterial : QSSGRenderGraphObject
34{
35 enum class MaterialLighting : quint8
36 {
37 NoLighting = 0,
38 FragmentLighting
39 };
40 enum class MaterialBlendMode : quint8
41 {
42 SourceOver = 0,
43 Screen,
44 Multiply
45 };
46 enum class MaterialSpecularModel : quint8
47 {
48 BlinnPhong = 0,
49 SchlickGGX
50 };
51
52 enum class MaterialDiffuseModel : quint8
53 {
54 Burley = 0,
55 Lambert,
56 LambertWrap
57 };
58
59 enum MaterialAlphaMode : quint8
60 {
61 Default = 0,
62 Mask,
63 Blend,
64 Opaque
65 };
66 enum TextureChannelMapping : quint8
67 {
68 R = 0,
69 G,
70 B,
71 A
72 };
73
74 enum VertexColorMask : quint16
75 {
76 NoMask = 0,
77 RoughnessMask = 1,
78 NormalStrengthMask = 2,
79 SpecularAmountMask = 4,
80 ClearcoatAmountMask = 8,
81 ClearcoatRoughnessAmountMask = 16,
82 ClearcoatNormalStrengthMask = 32,
83 HeightAmountMask = 64,
84 MetalnessMask = 128,
85 OcclusionAmountMask = 256,
86 ThicknessFactorMask = 512,
87 TransmissionFactorMask = 1024
88 };
89 Q_DECLARE_FLAGS(VertexColorMaskFlags, VertexColorMask)
90
91 QSSGRenderImage *colorMap = nullptr;
92 // material section
93 QSSGRenderImage *iblProbe = nullptr;
94 QSSGRenderImage *emissiveMap = nullptr;
95 QSSGRenderImage *specularReflection = nullptr;
96 QSSGRenderImage *specularMap = nullptr;
97 QSSGRenderImage *roughnessMap = nullptr;
98 QSSGRenderImage *opacityMap = nullptr;
99 QSSGRenderImage *bumpMap = nullptr;
100 QSSGRenderImage *normalMap = nullptr;
101 QSSGRenderImage *translucencyMap = nullptr;
102 QSSGRenderImage *metalnessMap = nullptr;
103 QSSGRenderImage *occlusionMap = nullptr;
104 QSSGRenderImage *heightMap = nullptr;
105 QSSGRenderImage *clearcoatMap = nullptr;
106 QSSGRenderImage *clearcoatRoughnessMap = nullptr;
107 QSSGRenderImage *clearcoatNormalMap = nullptr;
108 QSSGRenderImage *transmissionMap = nullptr;
109 QSSGRenderImage *thicknessMap = nullptr;
110
111 // Note that most default values here are irrelevant as the material
112 // (Default or Principled) will write its own defaults or actual values
113 // during sync.
114 QVector3D specularTint{ 1.0f, 1.0f, 1.0f };
115 float ior = 1.45f; // relevant for Default only
116 QVector3D emissiveColor = { 1.0f, 1.0f, 1.0f };
117 QVector4D color{ 1.0f, 1.0f, 1.0f, 1.0f }; // colors are 0-1 normalized
118 float diffuseLightWrap = 0.0f; // 0 - 1
119 float fresnelScaleBiasEnabled = false;
120 float fresnelScale = 1.0f;
121 float fresnelBias = 0.0f;
122 float fresnelPower = 0.0f;
123 float clearcoatFresnelScaleBiasEnabled = false;
124 float clearcoatFresnelScale = 1.0f;
125 float clearcoatFresnelBias = 0.0f;
126 float clearcoatFresnelPower = 5.0f;
127 float specularAmount = 1.0f; // 0-1
128 float specularRoughness = 0.0f; // 0-1
129 float metalnessAmount = 0.0f;
130 float opacity = 1.0f; // 0-1
131 bool invertOpacityMapValue = false;
132 bool baseColorSingleChannelEnabled = false;
133 bool specularAmountSingleChannelEnabled = false;
134 bool emissiveSingleChannelEnabled = false;
135 float bumpAmount = 0.0f; // 0-??
136 float translucentFalloff = 0.0f; // 0 - ??
137 float occlusionAmount = 1.0f; // 0 - 1
138 float alphaCutoff = 0.5f; // 0 - 1
139 float heightAmount = 0.0f; // 0 - 1
140 int minHeightSamples = 8;
141 int maxHeightSamples = 32;
142 float clearcoatAmount = 0.0f; // 0 - 1
143 float clearcoatRoughnessAmount = 0.0f; // 0 - 1
144 float clearcoatNormalStrength = 1.0f; // 0 - 1
145 float transmissionFactor = 0.0f; // 0 - 1
146 float thicknessFactor = 0.0f; // 0 - 1
147 float attenuationDistance = std::numeric_limits<float>::infinity();
148 QVector3D attenuationColor { 1.0f, 1.0f, 1.0f };
149
150 MaterialLighting lighting = MaterialLighting::FragmentLighting;
151 QSSGRenderDefaultMaterial::MaterialBlendMode blendMode = QSSGRenderDefaultMaterial::MaterialBlendMode::SourceOver;
152 QSSGRenderDefaultMaterial::MaterialSpecularModel specularModel = QSSGRenderDefaultMaterial::MaterialSpecularModel::SchlickGGX;
153 QSSGRenderDefaultMaterial::MaterialDiffuseModel diffuseModel = QSSGRenderDefaultMaterial::MaterialDiffuseModel::Burley;
154 QSSGRenderDefaultMaterial::MaterialAlphaMode alphaMode = QSSGRenderDefaultMaterial::Default;
155 QSSGCullFaceMode cullMode = QSSGCullFaceMode::Back;
156 QSSGDepthDrawMode depthDrawMode = QSSGDepthDrawMode::OpaqueOnly;
157 bool vertexColorsEnabled = false;
158 bool vertexColorsMaskEnabled = false;
159 bool dirty = true;
160 TextureChannelMapping roughnessChannel = TextureChannelMapping::R;
161 TextureChannelMapping opacityChannel = TextureChannelMapping::A;
162 TextureChannelMapping translucencyChannel = TextureChannelMapping::A;
163 TextureChannelMapping metalnessChannel = TextureChannelMapping::R;
164 TextureChannelMapping occlusionChannel = TextureChannelMapping::R;
165 TextureChannelMapping heightChannel = TextureChannelMapping::R;
166 TextureChannelMapping clearcoatChannel = TextureChannelMapping::R;
167 TextureChannelMapping clearcoatRoughnessChannel = TextureChannelMapping::G;
168 TextureChannelMapping transmissionChannel = TextureChannelMapping::R;
169 TextureChannelMapping thicknessChannel = TextureChannelMapping::G;
170 TextureChannelMapping baseColorChannel = TextureChannelMapping::R;
171 TextureChannelMapping specularAmountChannel = TextureChannelMapping::R;
172 TextureChannelMapping emissiveChannel = TextureChannelMapping::R;
173 float pointSize = 1.0f;
174 float lineWidth = 1.0f;
175 VertexColorMaskFlags vertexColorRedMask = VertexColorMask::NoMask;
176 VertexColorMaskFlags vertexColorGreenMask = VertexColorMask::NoMask;
177 VertexColorMaskFlags vertexColorBlueMask = VertexColorMask::NoMask;
178 VertexColorMaskFlags vertexColorAlphaMask = VertexColorMask::NoMask;
179
180 QSSGRenderDefaultMaterial(Type type = Type::DefaultMaterial);
181 ~QSSGRenderDefaultMaterial();
182
183 bool isSpecularEnabled() const { return specularAmount > .01f; }
184 bool isMetalnessEnabled() const { return metalnessAmount > 0.01f; }
185 bool isFresnelScaleBiasEnabled() const { return fresnelScaleBiasEnabled; }
186 bool isClearcoatFresnelScaleBiasEnabled() const { return clearcoatFresnelScaleBiasEnabled; }
187 bool isFresnelEnabled() const { return fresnelPower > 0.0f; }
188 bool isVertexColorsEnabled() const { return vertexColorsEnabled; }
189 bool isVertexColorsMaskEnabled() const { return vertexColorsMaskEnabled; }
190 bool isInvertOpacityMapValue() const { return invertOpacityMapValue; }
191 bool isBaseColorSingleChannelEnabled() const { return baseColorSingleChannelEnabled; }
192 bool isSpecularAmountSingleChannelEnabled() const { return specularAmountSingleChannelEnabled; }
193 bool isEmissiveSingleChannelEnabled() const { return emissiveSingleChannelEnabled; }
194 bool hasLighting() const { return lighting != MaterialLighting::NoLighting; }
195 bool isClearcoatEnabled() const { return clearcoatAmount > 0.01f; }
196 bool isTransmissionEnabled() const { return transmissionFactor > 0.01f; }
197
198 [[nodiscard]] inline bool isDirty() const { return dirty; }
199 void clearDirty();
200
201 QSSGShaderMaterialAdapter *adapter = nullptr;
202
203 QString debugObjectName;
204};
205
206QT_END_NAMESPACE
207
208#endif