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