b723e9db871a0c325b07b4de211e13fd1582a28a
[occt.git] / src / Graphic3d / Graphic3d_ShaderProgram.hxx
1 // Created on: 2013-09-20
2 // Created by: Denis BOGOLEPOV
3 // Copyright (c) 2013-2014 OPEN CASCADE SAS
4 //
5 // This file is part of Open CASCADE Technology software library.
6 //
7 // This library is free software; you can redistribute it and/or modify it under
8 // the terms of the GNU Lesser General Public License version 2.1 as published
9 // by the Free Software Foundation, with special exception defined in the file
10 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
11 // distribution for complete text of the license and disclaimer of any warranty.
12 //
13 // Alternatively, this file may be used under the terms of Open CASCADE
14 // commercial license or contractual agreement.
15
16 #ifndef _Graphic3d_ShaderProgram_HeaderFile
17 #define _Graphic3d_ShaderProgram_HeaderFile
18
19 #include <Graphic3d_ShaderAttribute.hxx>
20 #include <Graphic3d_ShaderObject.hxx>
21 #include <Graphic3d_ShaderVariable.hxx>
22 #include <Graphic3d_TextureParams.hxx>
23 #include <NCollection_Sequence.hxx>
24
25 //! List of shader objects.
26 typedef NCollection_Sequence<Handle(Graphic3d_ShaderObject)> Graphic3d_ShaderObjectList;
27
28 //! List of custom uniform shader variables.
29 typedef NCollection_Sequence<Handle(Graphic3d_ShaderVariable)> Graphic3d_ShaderVariableList;
30
31 //! List of custom vertex shader attrubures
32 typedef NCollection_Sequence<Handle(Graphic3d_ShaderAttribute)> Graphic3d_ShaderAttributeList;
33
34 //! This class is responsible for managing shader programs.
35 class Graphic3d_ShaderProgram : public Standard_Transient
36 {
37   DEFINE_STANDARD_RTTIEXT(Graphic3d_ShaderProgram, Standard_Transient)
38 public:
39
40   //! Default value of THE_MAX_LIGHTS macros within GLSL program (see Declarations.glsl).
41   static const Standard_Integer THE_MAX_LIGHTS_DEFAULT = 8;
42
43   //! Default value of THE_MAX_CLIP_PLANES macros within GLSL program (see Declarations.glsl).
44   static const Standard_Integer THE_MAX_CLIP_PLANES_DEFAULT = 8;
45
46 public:
47
48   //! Creates new empty program object.
49   Standard_EXPORT Graphic3d_ShaderProgram();
50
51   //! Releases resources of program object.
52   Standard_EXPORT virtual ~Graphic3d_ShaderProgram();
53
54   //! Checks if the program object is valid or not.
55   Standard_EXPORT virtual Standard_Boolean IsDone() const;
56
57   //! Returns unique ID used to manage resource in graphic driver.
58   const TCollection_AsciiString& GetId() const { return myID; }
59
60   //! Returns GLSL header (version code and extensions).
61   const TCollection_AsciiString& Header() const { return myHeader; }
62
63   //! Setup GLSL header containing language version code and used extensions.
64   //! Will be prepended to the very beginning of the source code.
65   //! Example:
66   //! @code
67   //!   #version 300 es
68   //!   #extension GL_ARB_bindless_texture : require
69   //! @endcode
70   void SetHeader (const TCollection_AsciiString& theHeader) { myHeader = theHeader; }
71
72   //! Append line to GLSL header.
73   void AppendToHeader (const TCollection_AsciiString& theHeaderLine)
74   {
75     if (!myHeader.IsEmpty())
76     {
77       myHeader += "\n";
78     }
79     myHeader += theHeaderLine;
80   }
81
82   //! Return the length of array of light sources (THE_MAX_LIGHTS),
83   //! to be used for initialization occLightSources.
84   //! Default value is THE_MAX_LIGHTS_DEFAULT.
85   Standard_Integer NbLightsMax() const { return myNbLightsMax; }
86
87   //! Specify the length of array of light sources (THE_MAX_LIGHTS).
88   void SetNbLightsMax (Standard_Integer theNbLights) { myNbLightsMax = theNbLights; }
89
90   //! Return the length of array of clipping planes (THE_MAX_CLIP_PLANES),
91   //! to be used for initialization occClipPlaneEquations.
92   //! Default value is THE_MAX_CLIP_PLANES_DEFAULT.
93   Standard_Integer NbClipPlanesMax() const { return myNbClipPlanesMax; }
94
95   //! Specify the length of array of clipping planes (THE_MAX_CLIP_PLANES).
96   void SetNbClipPlanesMax (Standard_Integer theNbPlanes) { myNbClipPlanesMax = theNbPlanes; }
97
98   //! Attaches shader object to the program object.
99   Standard_EXPORT Standard_Boolean AttachShader (const Handle(Graphic3d_ShaderObject)& theShader);
100
101   //! Detaches shader object from the program object.
102   Standard_EXPORT Standard_Boolean DetachShader (const Handle(Graphic3d_ShaderObject)& theShader);
103
104   //! Returns list of attached shader objects.
105   const Graphic3d_ShaderObjectList& ShaderObjects() const { return myShaderObjects; }
106
107   //! The list of currently pushed but not applied custom uniform variables.
108   //! This list is automatically cleared after applying to GLSL program.
109   const Graphic3d_ShaderVariableList& Variables() const { return myVariables; }
110
111   //! Return the list of custom vertex attributes.
112   const Graphic3d_ShaderAttributeList& VertexAttributes() const { return myAttributes; }
113
114   //! Assign the list of custom vertex attributes.
115   //! Should be done before GLSL program initialization.
116   Standard_EXPORT void SetVertexAttributes (const Graphic3d_ShaderAttributeList& theAttributes);
117
118   //! Pushes custom uniform variable to the program.
119   //! The list of pushed variables is automatically cleared after applying to GLSL program.
120   //! Thus after program recreation even unchanged uniforms should be pushed anew.
121   template<class T>
122   Standard_Boolean PushVariable (const TCollection_AsciiString& theName,
123                                  const T&                       theValue);
124
125   //! Removes all custom uniform variables from the program.
126   Standard_EXPORT void ClearVariables();
127
128   //! Pushes float uniform.
129   Standard_Boolean PushVariableFloat (const TCollection_AsciiString& theName, const float theValue)            { return PushVariable (theName, theValue); }
130
131   //! Pushes vec2 uniform.
132   Standard_Boolean PushVariableVec2  (const TCollection_AsciiString& theName, const Graphic3d_Vec2& theValue)  { return PushVariable (theName, theValue); }
133
134   //! Pushes vec3 uniform.
135   Standard_Boolean PushVariableVec3  (const TCollection_AsciiString& theName, const Graphic3d_Vec3& theValue)  { return PushVariable (theName, theValue); }
136
137   //! Pushes vec4 uniform.
138   Standard_Boolean PushVariableVec4  (const TCollection_AsciiString& theName, const Graphic3d_Vec4& theValue)  { return PushVariable (theName, theValue); }
139
140   //! Pushes int uniform.
141   Standard_Boolean PushVariableInt   (const TCollection_AsciiString& theName, const int theValue)              { return PushVariable (theName, theValue); }
142
143   //! Pushes vec2i uniform.
144   Standard_Boolean PushVariableVec2i (const TCollection_AsciiString& theName, const Graphic3d_Vec2i& theValue) { return PushVariable (theName, theValue); }
145
146   //! Pushes vec3i uniform.
147   Standard_Boolean PushVariableVec3i (const TCollection_AsciiString& theName, const Graphic3d_Vec3i& theValue) { return PushVariable (theName, theValue); }
148
149   //! Pushes vec4i uniform.
150   Standard_Boolean PushVariableVec4i (const TCollection_AsciiString& theName, const Graphic3d_Vec4i& theValue) { return PushVariable (theName, theValue); }
151
152 public:
153
154   //! The path to GLSL programs determined from CSF_ShadersDirectory or CASROOT environment variables.
155   //! @return the root folder with default GLSL programs.
156   Standard_EXPORT static const TCollection_AsciiString& ShadersFolder();
157
158 private:
159
160   TCollection_AsciiString       myID;            //!< the unique identifier of program object
161   Graphic3d_ShaderObjectList    myShaderObjects; //!< the list of attached shader objects
162   Graphic3d_ShaderVariableList  myVariables;     //!< the list of custom uniform variables
163   Graphic3d_ShaderAttributeList myAttributes;    //!< the list of custom vertex attributes
164   TCollection_AsciiString       myHeader;        //!< GLSL header with version code and used extensions
165   Standard_Integer              myNbLightsMax;   //!< length of array of light sources (THE_MAX_LIGHTS)
166   Standard_Integer              myNbClipPlanesMax; //!< length of array of clipping planes (THE_MAX_CLIP_PLANES)
167
168 };
169
170 DEFINE_STANDARD_HANDLE (Graphic3d_ShaderProgram, Standard_Transient)
171
172 // =======================================================================
173 // function : PushVariable
174 // purpose  : Pushes custom uniform variable to the program
175 // =======================================================================
176 template<class T> inline
177 Standard_Boolean Graphic3d_ShaderProgram::PushVariable (const TCollection_AsciiString& theName,
178                                                         const T& theValue)
179 {
180   Handle(Graphic3d_ShaderVariable) aVariable = Graphic3d_ShaderVariable::Create (theName, theValue);
181   if (aVariable.IsNull() || !aVariable->IsDone())
182   {
183     return Standard_False;
184   }
185
186   myVariables.Append (aVariable);
187   return Standard_True;
188 }
189
190 #endif