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
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
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
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
|
/****************************************************************************
**
** Copyright (C) 2008-2012 NVIDIA Corporation.
** Copyright (C) 2017 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of Qt 3D Studio.
**
** $QT_BEGIN_LICENSE:GPL$
** 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 General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3 or (at your option) 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.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-3.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/
#pragma once
#ifndef QT3DS_RENDER_CUSTOM_MATERIAL_SYSTEM_H
#define QT3DS_RENDER_CUSTOM_MATERIAL_SYSTEM_H
#include "Qt3DSRender.h"
#include "foundation/Qt3DSRefCounted.h"
#include "Qt3DSRenderDynamicObjectSystem.h"
#include "rendererimpl/Qt3DSVertexPipelineImpl.h"
namespace qt3ds {
namespace render {
namespace dynamic {
struct SCommand; // UICRenderEffectCommands.h
}
struct SCustomMaterialRenderContext;
class ICustomMaterialSystemCore : public NVRefCounted
{
public:
virtual bool IsMaterialRegistered(CRegisteredString inStr) = 0;
virtual bool
RegisterMaterialClass(CRegisteredString inName,
NVConstDataRef<dynamic::SPropertyDeclaration> inProperties) = 0;
virtual NVConstDataRef<dynamic::SPropertyDefinition>
GetCustomMaterialProperties(CRegisteredString inCustomMaterialName) const = 0;
virtual void SetCustomMaterialRefraction(CRegisteredString inName,
bool inHasRefraction) = 0;
virtual void SetCustomMaterialTransparency(CRegisteredString inName,
bool inHasTransparency) = 0;
virtual void SetCustomMaterialAlwaysDirty(CRegisteredString inName,
bool inIsAlwaysDirty) = 0;
virtual void SetCustomMaterialShaderKey(CRegisteredString inName, QT3DSU32 inShaderKey) = 0;
virtual void SetCustomMaterialLayerCount(CRegisteredString inName, QT3DSU32 inLayerCount) = 0;
// The custom material commands are the actual commands that run for a given material
// effect. The tell the system exactly
// explicitly things like bind this shader, bind this render target, apply this property,
// run this shader
// See UICRenderEffectCommands.h for the list of commands.
// These commands are copied into the effect.
virtual void SetCustomMaterialCommands(CRegisteredString inName,
NVConstDataRef<dynamic::SCommand *> inCommands) = 0;
virtual void SetMaterialClassShader(CRegisteredString inName, const char8_t *inShaderType,
const char8_t *inShaderVersion,
const char8_t *inShaderData, bool inHasGeomShader,
bool inIsComputeShader) = 0;
virtual SCustomMaterial *
CreateCustomMaterial(CRegisteredString inName,
NVAllocatorCallback &inSceneGraphAllocator) = 0;
virtual void SetPropertyEnumNames(CRegisteredString inName, CRegisteredString inPropName,
NVConstDataRef<CRegisteredString> inNames) = 0;
virtual void SetPropertyTextureSettings(CRegisteredString inEffectName,
CRegisteredString inPropName,
CRegisteredString inPropPath,
NVRenderTextureTypeValue::Enum inTexType,
NVRenderTextureCoordOp::Enum inCoordOp,
NVRenderTextureMagnifyingOp::Enum inMagFilterOp,
NVRenderTextureMinifyingOp::Enum inMinFilterOp) = 0;
virtual void Save(qt3ds::render::SWriteBuffer &ioBuffer,
const qt3ds::render::SStrRemapMap &inRemapMap,
const char8_t *inProjectDir) const = 0;
virtual void Load(NVDataRef<QT3DSU8> inData, CStrTableOrDataRef inStrDataBlock,
const char8_t *inProjectDir) = 0;
virtual ICustomMaterialSystem &GetCustomMaterialSystem(IQt3DSRenderContext &inContext) = 0;
static ICustomMaterialSystemCore &
CreateCustomMaterialSystemCore(IQt3DSRenderContextCore &inContext);
};
// How to handle blend modes?
class ICustomMaterialSystem : public ICustomMaterialSystemCore
{
public:
// Returns true if the material is dirty and thus will produce a different render result
// than previously. This effects things like progressive AA.
virtual bool PrepareForRender(const SModel &inModel, const SRenderSubset &inSubset,
SCustomMaterial &inMaterial) = 0;
virtual bool RenderDepthPrepass(const QT3DSMat44 &inMVP, const SCustomMaterial &inMaterial,
const SRenderSubset &inSubset) = 0;
virtual void RenderSubset(SCustomMaterialRenderContext &inRenderContext,
TShaderFeatureSet inFeatureSet) = 0;
virtual void OnMaterialActivationChange(const SCustomMaterial &inMaterial,
bool inActive) = 0;
// get shader name
virtual const char *GetShaderName(const SCustomMaterial &inMaterial) = 0;
// apply property values
virtual void ApplyShaderPropertyValues(const SCustomMaterial &inMaterial,
NVRenderShaderProgram &inProgram) = 0;
virtual void renderSubpresentations(SCustomMaterial &inMaterial) = 0;
// Called by the uiccontext so this system can clear any per-frame render information.
virtual void EndFrame() = 0;
};
struct QT3DS_AUTOTEST_EXPORT SCustomMaterialVertexPipeline : public SVertexPipelineImpl
{
IQt3DSRenderContext *m_Context;
TessModeValues::Enum m_TessMode;
SCustomMaterialVertexPipeline(IQt3DSRenderContext *inContext, TessModeValues::Enum inTessMode);
void InitializeTessControlShader();
void InitializeTessEvaluationShader();
void FinalizeTessControlShader();
void FinalizeTessEvaluationShader();
// Responsible for beginning all vertex and fragment generation (void main() { etc).
virtual void BeginVertexGeneration(QT3DSU32 displacementImageIdx,
SRenderableImage *displacementImage) override;
// The fragment shader expects a floating point constant, object_opacity to be defined
// post this method.
virtual void BeginFragmentGeneration() override;
// Output variables may be mangled in some circumstances so the shader generation
// system needs an abstraction mechanism around this.
virtual void AssignOutput(const char8_t *inVarName, const char8_t *inVarValue) override;
virtual void GenerateEnvMapReflection() override {}
virtual void GenerateViewVector() override {}
virtual void GenerateUVCoords(QT3DSU32 inUVSet) override;
virtual void GenerateWorldNormal() override;
virtual void GenerateObjectNormal() override;
virtual void GenerateVarTangentAndBinormal() override;
virtual void GenerateWorldPosition() override;
// responsible for closing all vertex and fragment generation
virtual void EndVertexGeneration(bool customShader) override;
virtual void EndFragmentGeneration(bool customShader) override;
virtual IShaderStageGenerator &ActiveStage() override;
virtual void AddInterpolationParameter(const char8_t *inName, const char8_t *inType) override;
virtual void DoGenerateUVCoords(QT3DSU32 inUVSet) override;
virtual void DoGenerateWorldNormal() override;
virtual void DoGenerateObjectNormal() override;
virtual void DoGenerateWorldPosition() override;
virtual void DoGenerateVarTangentAndBinormal() override;
virtual void DoGenerateVertexColor() override;
};
}
}
#endif
|
