0025973: Visualization, TKOpenGl - support EAGLContext as alternative to NSOpenGLContext
[occt.git] / src / OpenGl / OpenGl_ShaderManager.hxx
CommitLineData
30f0ad28 1// Created on: 2013-09-26
2// Created by: Denis BOGOLEPOV
d5f74e42 3// Copyright (c) 2013-2014 OPEN CASCADE SAS
30f0ad28 4//
973c2be1 5// This file is part of Open CASCADE Technology software library.
30f0ad28 6//
d5f74e42 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
973c2be1 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.
30f0ad28 12//
973c2be1 13// Alternatively, this file may be used under the terms of Open CASCADE
14// commercial license or contractual agreement.
30f0ad28 15
16#ifndef _OpenGl_ShaderManager_HeaderFile
17#define _OpenGl_ShaderManager_HeaderFile
18
19#include <Graphic3d_ShaderProgram_Handle.hxx>
20
21#include <NCollection_DataMap.hxx>
22#include <NCollection_Sequence.hxx>
23
24#include <Handle_OpenGl_ShaderManager.hxx>
256f9ac0 25#include <OpenGl_SetOfShaderPrograms.hxx>
30f0ad28 26#include <OpenGl_ShaderStates.hxx>
8625ef7e 27#include <OpenGl_AspectFace.hxx>
28#include <OpenGl_AspectLine.hxx>
29#include <OpenGl_AspectText.hxx>
30#include <OpenGl_AspectMarker.hxx>
31#include <OpenGl_Texture.hxx>
32#include <Visual3d_TypeOfModel.hxx>
30f0ad28 33
e6804ff7 34class OpenGl_View;
35
30f0ad28 36//! List of shader programs.
37typedef NCollection_Sequence<Handle(OpenGl_ShaderProgram)> OpenGl_ShaderProgramList;
38
39//! Map to declare per-program states of OCCT materials.
40typedef NCollection_DataMap<Handle(OpenGl_ShaderProgram), OpenGl_MaterialState> OpenGl_MaterialStates;
41
42//! This class is responsible for managing shader programs.
43class OpenGl_ShaderManager : public Standard_Transient
44{
45 friend class OpenGl_ShaderProgram;
46
47public:
48
49 //! Creates new empty shader manager.
50 Standard_EXPORT OpenGl_ShaderManager (OpenGl_Context* theContext);
51
52 //! Releases resources of shader manager.
53 Standard_EXPORT virtual ~OpenGl_ShaderManager();
54
05e2200b 55 //! Release all resources.
56 Standard_EXPORT void clear();
57
392ac980 58 //! Creates new shader program or re-use shared instance.
59 //! @param theProxy [IN] program definition
60 //! @param theShareKey [OUT] sharing key
61 //! @param theProgram [OUT] OpenGL program
8625ef7e 62 //! @return true on success
63 Standard_EXPORT Standard_Boolean Create (const Handle(Graphic3d_ShaderProgram)& theProxy,
64 TCollection_AsciiString& theShareKey,
65 Handle(OpenGl_ShaderProgram)& theProgram);
30f0ad28 66
67 //! Unregisters specified shader program.
392ac980 68 Standard_EXPORT void Unregister (TCollection_AsciiString& theShareKey,
69 Handle(OpenGl_ShaderProgram)& theProgram);
30f0ad28 70
71 //! Returns list of registered shader programs.
72 Standard_EXPORT const OpenGl_ShaderProgramList& ShaderPrograms() const;
73
74 //! Returns true if no program objects are registered in the manager.
75 Standard_EXPORT Standard_Boolean IsEmpty() const;
76
8625ef7e 77 //! Bind program for filled primitives rendering
78 Standard_Boolean BindProgram (const OpenGl_AspectFace* theAspect,
79 const Handle(OpenGl_Texture)& theTexture,
80 const Standard_Boolean theToLightOn,
81 const Standard_Boolean theHasVertColor,
82 const Handle(OpenGl_ShaderProgram)& theCustomProgram)
83 {
84 if (!theCustomProgram.IsNull()
85 || myContext->caps->ffpEnable)
86 {
87 return bindProgramWithState (theCustomProgram, theAspect);
88 }
89
90 const Standard_Integer aBits = getProgramBits (theTexture, theHasVertColor);
91 Handle(OpenGl_ShaderProgram)& aProgram = getStdProgram (theToLightOn, aBits);
92 return bindProgramWithState (aProgram, theAspect);
93 }
30f0ad28 94
8625ef7e 95 //! Bind program for line rendering
96 Standard_Boolean BindProgram (const OpenGl_AspectLine* theAspect,
97 const Handle(OpenGl_Texture)& theTexture,
98 const Standard_Boolean theToLightOn,
99 const Standard_Boolean theHasVertColor,
100 const Handle(OpenGl_ShaderProgram)& theCustomProgram)
101 {
102 if (!theCustomProgram.IsNull()
103 || myContext->caps->ffpEnable)
104 {
105 return bindProgramWithState (theCustomProgram, theAspect);
106 }
107
108 const Standard_Integer aBits = getProgramBits (theTexture, theHasVertColor);
109 Handle(OpenGl_ShaderProgram)& aProgram = getStdProgram (theToLightOn, aBits);
110 return bindProgramWithState (aProgram, theAspect);
111 }
30f0ad28 112
8625ef7e 113 //! Bind program for point rendering
114 Standard_Boolean BindProgram (const OpenGl_AspectMarker* theAspect,
115 const Handle(OpenGl_Texture)& theTexture,
116 const Standard_Boolean theToLightOn,
117 const Standard_Boolean theHasVertColor,
118 const Handle(OpenGl_ShaderProgram)& theCustomProgram)
119 {
120 if (!theCustomProgram.IsNull()
121 || myContext->caps->ffpEnable)
122 {
123 return bindProgramWithState (theCustomProgram, theAspect);
124 }
125
126 const Standard_Integer aBits = getProgramBits (theTexture, theHasVertColor) | OpenGl_PO_Point;
127 Handle(OpenGl_ShaderProgram)& aProgram = getStdProgram (theToLightOn, aBits);
128 return bindProgramWithState (aProgram, theAspect);
129 }
130
131 //! Bind program for rendering alpha-textured font.
132 Standard_Boolean BindProgram (const OpenGl_AspectText* theAspect,
133 const Handle(OpenGl_ShaderProgram)& theCustomProgram)
134 {
135 if (!theCustomProgram.IsNull()
136 || myContext->caps->ffpEnable)
137 {
138 return bindProgramWithState (theCustomProgram, theAspect);
139 }
140
141 if (myFontProgram.IsNull())
142 {
143 prepareStdProgramFont();
144 }
145 return bindProgramWithState (myFontProgram, theAspect);
146 }
30f0ad28 147
b86bb3df 148 //! Bind program for FBO blit operation.
149 Standard_Boolean BindFboBlitProgram()
150 {
151 if (myBlitProgram.IsNull())
152 {
153 prepareStdProgramFboBlit();
154 }
155 return !myBlitProgram.IsNull()
156 && myContext->BindProgram (myBlitProgram);
157 }
158
30f0ad28 159public:
160
161 //! Returns current state of OCCT light sources.
162 Standard_EXPORT const OpenGl_LightSourceState& LightSourceState() const;
163
164 //! Updates state of OCCT light sources.
165 Standard_EXPORT void UpdateLightSourceStateTo (const OpenGl_ListOfLight* theLights);
166
167 //! Pushes current state of OCCT light sources to specified program.
168 Standard_EXPORT void PushLightSourceState (const Handle(OpenGl_ShaderProgram)& theProgram) const;
169
170public:
171
172 //! Returns current state of OCCT projection transform.
173 Standard_EXPORT const OpenGl_ProjectionState& ProjectionState() const;
174
175 //! Updates state of OCCT projection transform.
c827ea3a 176 Standard_EXPORT void UpdateProjectionStateTo (const OpenGl_Mat4& theProjectionMatrix);
30f0ad28 177
30f0ad28 178 //! Pushes current state of OCCT projection transform to specified program.
179 Standard_EXPORT void PushProjectionState (const Handle(OpenGl_ShaderProgram)& theProgram) const;
180
181public:
182
183 //! Returns current state of OCCT model-world transform.
184 Standard_EXPORT const OpenGl_ModelWorldState& ModelWorldState() const;
185
186 //! Updates state of OCCT model-world transform.
c827ea3a 187 Standard_EXPORT void UpdateModelWorldStateTo (const OpenGl_Mat4& theModelWorldMatrix);
30f0ad28 188
30f0ad28 189 //! Pushes current state of OCCT model-world transform to specified program.
190 Standard_EXPORT void PushModelWorldState (const Handle(OpenGl_ShaderProgram)& theProgram) const;
191
192public:
193
194 //! Returns current state of OCCT world-view transform.
195 Standard_EXPORT const OpenGl_WorldViewState& WorldViewState() const;
196
197 //! Updates state of OCCT world-view transform.
c827ea3a 198 Standard_EXPORT void UpdateWorldViewStateTo (const OpenGl_Mat4& theWorldViewMatrix);
30f0ad28 199
30f0ad28 200 //! Pushes current state of OCCT world-view transform to specified program.
201 Standard_EXPORT void PushWorldViewState (const Handle(OpenGl_ShaderProgram)& theProgram) const;
202
203public:
204
205 //! Updates state of OCCT clipping planes.
206 Standard_EXPORT void UpdateClippingState();
207
208 //! Reverts state of OCCT clipping planes.
209 Standard_EXPORT void RevertClippingState();
210
211 //! Pushes current state of OCCT clipping planes to specified program.
212 Standard_EXPORT void PushClippingState (const Handle(OpenGl_ShaderProgram)& theProgram) const;
213
214public:
215
216 //! Resets state of OCCT material for all programs.
217 Standard_EXPORT void ResetMaterialStates();
218
219 //! Updates state of OCCT material for specified program.
220 Standard_EXPORT void UpdateMaterialStateTo (const Handle(OpenGl_ShaderProgram)& theProgram,
221 const OpenGl_Element* theAspect);
222
223 //! Pushes current state of OCCT material to specified program.
224 Standard_EXPORT void PushMaterialState (const Handle(OpenGl_ShaderProgram)& theProgram) const;
225
226 //! Returns current state of OCCT material for specified program.
227 Standard_EXPORT const OpenGl_MaterialState* MaterialState (const Handle(OpenGl_ShaderProgram)& theProgram) const;
228
229public:
05e2200b 230
30f0ad28 231 //! Pushes current state of OCCT graphics parameters to specified program.
232 Standard_EXPORT void PushState (const Handle(OpenGl_ShaderProgram)& theProgram) const;
233
392ac980 234public:
235
236 //! Overwrites context
237 void SetContext (OpenGl_Context* theCtx)
238 {
239 myContext = theCtx;
240 }
241
8625ef7e 242 //! Sets shading model.
256f9ac0 243 Standard_EXPORT void SetShadingModel(const Visual3d_TypeOfModel theModel);
8625ef7e 244
e6804ff7 245 //! Sets last view manger used with.
246 //! Helps to handle matrix states in multi-view configurations.
247 void SetLastView (const OpenGl_View* theLastView)
248 {
249 myLastView = theLastView;
250 }
251
252 //! Returns true when provided view is the same as cached one.
253 bool IsSameView (const OpenGl_View* theView) const
254 {
255 return myLastView == theView;
256 }
257
30f0ad28 258protected:
259
8625ef7e 260 //! Define program bits.
261 Standard_Integer getProgramBits (const Handle(OpenGl_Texture)& theTexture,
262 const Standard_Boolean theHasVertColor)
263 {
264 Standard_Integer aBits = 0;
265 if (myContext->Clipping().IsClippingOrCappingOn())
266 {
267 aBits |= OpenGl_PO_ClipPlanes;
268 }
269 if (!theTexture.IsNull())
270 {
4e1523ef 271 aBits |= theTexture->IsAlpha() ? OpenGl_PO_TextureA : OpenGl_PO_TextureRGB;
8625ef7e 272 }
273 if (theHasVertColor)
274 {
275 aBits |= OpenGl_PO_VertColor;
276 }
277 return aBits;
278 }
279
280 //! Prepare standard GLSL program.
281 Handle(OpenGl_ShaderProgram)& getStdProgram (const Standard_Boolean theToLightOn,
282 const Standard_Integer theBits)
283 {
284 if (theToLightOn)
285 {
256f9ac0 286 Handle(OpenGl_ShaderProgram)& aProgram = myLightPrograms->ChangeValue (theBits);
8625ef7e 287 if (aProgram.IsNull())
288 {
289 prepareStdProgramLight (aProgram, theBits);
290 }
291 return aProgram;
292 }
293
256f9ac0 294 Handle(OpenGl_ShaderProgram)& aProgram = myFlatPrograms.ChangeValue (theBits);
8625ef7e 295 if (aProgram.IsNull())
296 {
297 prepareStdProgramFlat (aProgram, theBits);
298 }
299 return aProgram;
300 }
301
302 //! Prepare standard GLSL program for textured font.
303 Standard_EXPORT Standard_Boolean prepareStdProgramFont();
304
b86bb3df 305 //! Prepare standard GLSL program for FBO blit operation.
306 Standard_EXPORT Standard_Boolean prepareStdProgramFboBlit();
307
8625ef7e 308 //! Prepare standard GLSL program without lighting.
309 Standard_EXPORT Standard_Boolean prepareStdProgramFlat (Handle(OpenGl_ShaderProgram)& theProgram,
310 const Standard_Integer theBits);
311
312 //! Prepare standard GLSL program with lighting.
313 Standard_Boolean prepareStdProgramLight (Handle(OpenGl_ShaderProgram)& theProgram,
314 const Standard_Integer theBits)
315 {
316 return myShadingModel == Visual3d_TOM_FRAGMENT
317 ? prepareStdProgramPhong (theProgram, theBits)
318 : prepareStdProgramGouraud (theProgram, theBits);
319 }
320
321 //! Prepare standard GLSL program with per-vertex lighting.
322 Standard_EXPORT Standard_Boolean prepareStdProgramGouraud (Handle(OpenGl_ShaderProgram)& theProgram,
323 const Standard_Integer theBits);
324
325 //! Prepare standard GLSL program with per-pixel lighting.
326 Standard_EXPORT Standard_Boolean prepareStdProgramPhong (Handle(OpenGl_ShaderProgram)& theProgram,
327 const Standard_Integer theBits);
328
256f9ac0 329 //! Define computeLighting GLSL function depending on current lights configuration
abdf0b10 330 //! @param theHasVertColor flag to use getVertColor() instead of Ambient and Diffuse components of active material
331 Standard_EXPORT TCollection_AsciiString stdComputeLighting (const Standard_Boolean theHasVertColor);
256f9ac0 332
8625ef7e 333 //! Bind specified program to current context and apply state.
334 Standard_EXPORT Standard_Boolean bindProgramWithState (const Handle(OpenGl_ShaderProgram)& theProgram,
335 const OpenGl_Element* theAspect);
336
256f9ac0 337 //! Set pointer myLightPrograms to active lighting programs set from myMapOfLightPrograms
338 Standard_EXPORT void switchLightPrograms();
339
8625ef7e 340protected:
341
256f9ac0 342 Visual3d_TypeOfModel myShadingModel; //!< lighting shading model
343 OpenGl_ShaderProgramList myProgramList; //!< The list of shader programs
344 Handle(OpenGl_SetOfShaderPrograms) myLightPrograms; //!< pointer to active lighting programs matrix
345 OpenGl_SetOfShaderPrograms myFlatPrograms; //!< programs matrix without lighting
346 Handle(OpenGl_ShaderProgram) myFontProgram; //!< standard program for textured text
b86bb3df 347 Handle(OpenGl_ShaderProgram) myBlitProgram; //!< standard program for FBO blit emulation
256f9ac0 348 OpenGl_MapOfShaderPrograms myMapOfLightPrograms; //!< map of lighting programs depending on shading model and lights configuration
8625ef7e 349
256f9ac0 350 OpenGl_Context* myContext; //!< OpenGL context
8625ef7e 351
352protected:
353
256f9ac0 354 OpenGl_MaterialStates myMaterialStates; //!< Per-program state of OCCT material
355 OpenGl_ProjectionState myProjectionState; //!< State of OCCT projection transformation
356 OpenGl_ModelWorldState myModelWorldState; //!< State of OCCT model-world transformation
357 OpenGl_WorldViewState myWorldViewState; //!< State of OCCT world-view transformation
8cf06aa2 358 OpenGl_ClippingState myClippingState; //!< State of OCCT clipping planes
256f9ac0 359 OpenGl_LightSourceState myLightSourceState; //!< State of OCCT light sources
30f0ad28 360
361private:
362
256f9ac0 363 const OpenGl_View* myLastView; //!< Pointer to the last view shader manager used with
8625ef7e 364
365public:
366
367 DEFINE_STANDARD_RTTI (OpenGl_ShaderManager)
368
30f0ad28 369};
370
371#endif // _OpenGl_ShaderManager_HeaderFile