summaryrefslogtreecommitdiffstats
path: root/src/runtimerender/Qt3DSRenderDefaultMaterialShaderGenerator.h
blob: 871ab1bfda16d7bc34fd48d975dc2331b7790424 (plain)
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
/****************************************************************************
**
** 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_DEFAULT_MATERIAL_SHADER_GENERATOR_H
#define QT3DS_RENDER_DEFAULT_MATERIAL_SHADER_GENERATOR_H
#include "Qt3DSRenderMaterialShaderGenerator.h"
#include "Qt3DSRenderLightConstantProperties.h"

namespace qt3ds {
namespace render {

    class Qt3DSShadowMap;
    struct SShaderGeneratorGeneratedShader;

    class IDefaultMaterialVertexPipeline : public IShaderStageGenerator
    {
    protected:
        virtual ~IDefaultMaterialVertexPipeline() {}
    public:
        // Responsible for beginning all vertex and fragment generation (void main() { etc).
        virtual void BeginVertexGeneration(QT3DSU32 displacementImageIdx,
                                           SRenderableImage *displacementImage) = 0;
        // The fragment shader expects a floating point constant, object_opacity to be defined
        // post this method.
        virtual void BeginFragmentGeneration() = 0;
        // 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 *inVarValueExpr) = 0;

        /**
         * @brief Generates UV coordinates in shader code
         *
         * @param[in] inUVSet		index of UV data set
         *
         * @return no return
         */
        virtual void GenerateUVCoords(QT3DSU32 inUVSet = 0) = 0;

        virtual void GenerateEnvMapReflection() = 0;
        virtual void GenerateViewVector() = 0;

        // fragment shader expects varying vertex normal
        // lighting in vertex pipeline expects world_normal
        virtual void GenerateWorldNormal() = 0; // world_normal in both vert and frag shader
        virtual void GenerateObjectNormal() = 0; // object_normal in both vert and frag shader
        virtual void
        GenerateWorldPosition() = 0; // model_world_position in both vert and frag shader
        virtual void GenerateVarTangentAndBinormal() = 0;
        virtual void GenerateVertexColor() = 0;

        virtual bool HasActiveWireframe() = 0; // varEdgeDistance is a valid entity

        // responsible for closing all vertex and fragment generation
        virtual void EndVertexGeneration(bool customShader) = 0;
        virtual void EndFragmentGeneration(bool customShader) = 0;
    };

    class IDefaultMaterialShaderGenerator : public IMaterialShaderGenerator
    {
    public:
        virtual void AddDisplacementImageUniforms(IShaderStageGenerator &inGenerator,
                                                  QT3DSU32 displacementImageIdx,
                                                  SRenderableImage *displacementImage) = 0;
        SImageVariableNames GetImageVariableNames(QT3DSU32 inIdx) override = 0;
        void GenerateImageUVCoordinates(IShaderStageGenerator &inVertexPipeline, QT3DSU32 idx,
                                                QT3DSU32 uvSet, SRenderableImage &image) override = 0;
        // Transforms attr_pos, attr_norm, and attr_uv0.
        virtual void AddDisplacementMappingForDepthPass(IShaderStageGenerator &inShader) = 0;

        // inPipelineName needs to be unique else the shader cache will just return shaders from
        // different pipelines.
        NVRenderShaderProgram *GenerateShader(
            const SGraphObject &inMaterial, SShaderDefaultMaterialKey inShaderDescription,
            IShaderStageGenerator &inVertexPipeline, TShaderFeatureSet inFeatureSet,
            NVDataRef<SLight *> inLights, SRenderableImage *inFirstImage, bool inHasTransparency,
            const char8_t *inVertexPipelineName, const char8_t *inCustomMaterialName = "") override = 0;

        // generate default material shader for depth only pass
        virtual NVRenderShaderProgram *GenerateDepthPassShader(
            const SGraphObject &inMaterial, SShaderDefaultMaterialKey inShaderDescription,
            IShaderStageGenerator &inVertexPipeline, TShaderFeatureSet inFeatureSet,
            SRenderableImage *inFirstImage, bool inHasTransparency,
            const char8_t *inVertexPipelineName, const char8_t *inCustomMaterialName = "") = 0;

        // generate default material shader cube depth shader
        virtual NVRenderShaderProgram *GenerateCubeDepthShader(
            const SGraphObject &inMaterial, SShaderDefaultMaterialKey inShaderDescription,
            IShaderStageGenerator &inVertexPipeline, TShaderFeatureSet inFeatureSet,
            SRenderableImage *inFirstImage, bool inHasTransparency,
            const char8_t *inVertexPipelineName, const char8_t *inCustomMaterialName = "") = 0;

        // generate default material shader orthographic depth shader
        virtual NVRenderShaderProgram *GenerateOrthoDepthShader(
            const SGraphObject &inMaterial, SShaderDefaultMaterialKey inShaderDescription,
            IShaderStageGenerator &inVertexPipeline, TShaderFeatureSet inFeatureSet,
            SRenderableImage *inFirstImage, bool inHasTransparency,
            const char8_t *inVertexPipelineName, const char8_t *inCustomMaterialName = "") = 0;

        // Also sets the blend function on the render context.
        virtual void
        SetMaterialProperties(NVRenderShaderProgram &inProgram, const SGraphObject &inMaterial,
                              const QT3DSVec2 &inCameraVec, const QT3DSMat44 &inModelViewProjection,
                              const QT3DSMat33 &inNormalMatrix, const QT3DSMat44 &inGlobalTransform,
                              SRenderableImage *inFirstImage, QT3DSF32 inOpacity,
                              SLayerGlobalRenderProperties inRenderProperties,
                              const QT3DSVec2 &alphaOpRef) override = 0;

        static IDefaultMaterialShaderGenerator &
        CreateDefaultMaterialShaderGenerator(IQt3DSRenderContext &inRenderContext);

        SLightConstantProperties<SShaderGeneratorGeneratedShader>
            *GetLightConstantProperties(SShaderGeneratorGeneratedShader &shader);
    };
}
}

#endif