1 // Created on: 2013-09-19
2 // Created by: Denis BOGOLEPOV
3 // Copyright (c) 2013-2014 OPEN CASCADE SAS
5 // This file is part of Open CASCADE Technology software library.
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.
13 // Alternatively, this file may be used under the terms of Open CASCADE
14 // commercial license or contractual agreement.
16 #ifndef _OpenGl_ShaderProgram_Header
17 #define _OpenGl_ShaderProgram_Header
19 #include <NCollection_DataMap.hxx>
20 #include <NCollection_Sequence.hxx>
21 #include <TCollection_AsciiString.hxx>
23 #include <Graphic3d_ShaderObject.hxx>
24 #include <Graphic3d_ShaderProgram.hxx>
26 #include <OpenGl_Vec.hxx>
27 #include <OpenGl_Matrix.hxx>
28 #include <OpenGl_NamedResource.hxx>
29 #include <OpenGl_ShaderObject.hxx>
31 class OpenGl_ShaderProgram;
32 DEFINE_STANDARD_HANDLE(OpenGl_ShaderProgram, OpenGl_NamedResource)
34 //! The enumeration of OCCT-specific OpenGL/GLSL variables.
35 enum OpenGl_StateVariable
37 // OpenGL matrix state
38 OpenGl_OCC_MODEL_WORLD_MATRIX,
39 OpenGl_OCC_WORLD_VIEW_MATRIX,
40 OpenGl_OCC_PROJECTION_MATRIX,
41 OpenGl_OCC_MODEL_WORLD_MATRIX_INVERSE,
42 OpenGl_OCC_WORLD_VIEW_MATRIX_INVERSE,
43 OpenGl_OCC_PROJECTION_MATRIX_INVERSE,
44 OpenGl_OCC_MODEL_WORLD_MATRIX_TRANSPOSE,
45 OpenGl_OCC_WORLD_VIEW_MATRIX_TRANSPOSE,
46 OpenGl_OCC_PROJECTION_MATRIX_TRANSPOSE,
47 OpenGl_OCC_MODEL_WORLD_MATRIX_INVERSE_TRANSPOSE,
48 OpenGl_OCC_WORLD_VIEW_MATRIX_INVERSE_TRANSPOSE,
49 OpenGl_OCC_PROJECTION_MATRIX_INVERSE_TRANSPOSE,
51 // OpenGL clip planes state
52 OpenGl_OCC_CLIP_PLANE_EQUATIONS,
53 OpenGl_OCC_CLIP_PLANE_CHAINS,
54 OpenGl_OCC_CLIP_PLANE_COUNT,
57 OpenGl_OCC_LIGHT_SOURCE_COUNT,
58 OpenGl_OCC_LIGHT_SOURCE_TYPES,
59 OpenGl_OCC_LIGHT_SOURCE_PARAMS,
60 OpenGl_OCC_LIGHT_AMBIENT,
63 OpenGl_OCCT_TEXTURE_ENABLE,
64 OpenGl_OCCT_DISTINGUISH_MODE,
65 OpenGl_OCCT_FRONT_MATERIAL,
66 OpenGl_OCCT_BACK_MATERIAL,
67 OpenGl_OCCT_ALPHA_CUTOFF,
70 // Weighted, Blended Order-Independent Transparency rendering state
71 OpenGl_OCCT_OIT_OUTPUT,
72 OpenGl_OCCT_OIT_DEPTH_FACTOR,
74 // Context-dependent state
75 OpenGl_OCCT_TEXTURE_TRSF2D,
76 OpenGl_OCCT_POINT_SIZE,
80 OpenGl_OCCT_LINE_WIDTH,
81 OpenGl_OCCT_LINE_FEATHER,
82 OpenGl_OCCT_LINE_STIPPLE_PATTERN, // occStipplePattern
83 OpenGl_OCCT_LINE_STIPPLE_FACTOR, // occStippleFactor
84 OpenGl_OCCT_WIREFRAME_COLOR,
85 OpenGl_OCCT_QUAD_MODE_STATE,
87 // Parameters of outline (silhouette) shader
88 OpenGl_OCCT_ORTHO_SCALE,
89 OpenGl_OCCT_SILHOUETTE_THICKNESS,
91 // DON'T MODIFY THIS ITEM (insert new items before it)
92 OpenGl_OCCT_NUMBER_OF_STATE_VARIABLES
95 //! Interface for generic setter of user-defined uniform variables.
96 struct OpenGl_SetterInterface
98 //! Sets user-defined uniform variable to specified program.
99 virtual void Set (const Handle(OpenGl_Context)& theCtx,
100 const Handle(Graphic3d_ShaderVariable)& theVariable,
101 OpenGl_ShaderProgram* theProgram) = 0;
104 virtual ~OpenGl_SetterInterface() {}
107 //! List of OpenGL shader objects.
108 typedef NCollection_Sequence<Handle(OpenGl_ShaderObject)> OpenGl_ShaderList;
110 //! List of shader variable setters.
111 typedef NCollection_DataMap<size_t, OpenGl_SetterInterface*> OpenGl_SetterList;
113 //! Support tool for setting user-defined uniform variables.
114 class OpenGl_VariableSetterSelector
118 //! Creates new setter selector.
119 OpenGl_VariableSetterSelector();
121 //! Releases memory resources of setter selector.
122 ~OpenGl_VariableSetterSelector();
124 //! Sets user-defined uniform variable to specified program.
125 void Set (const Handle(OpenGl_Context)& theCtx,
126 const Handle(Graphic3d_ShaderVariable)& theVariable,
127 OpenGl_ShaderProgram* theProgram) const;
131 //! List of variable setters.
132 OpenGl_SetterList mySetterList;
135 //! Defines types of uniform state variables.
136 enum OpenGl_UniformStateType
138 OpenGl_LIGHT_SOURCES_STATE,
139 OpenGl_CLIP_PLANES_STATE,
140 OpenGl_MODEL_WORLD_STATE,
141 OpenGl_WORLD_VIEW_STATE,
142 OpenGl_PROJECTION_STATE,
143 OpenGl_MATERIAL_STATE,
144 OpenGl_SURF_DETAIL_STATE,
146 OpenGl_UniformStateType_NB
149 //! Simple class represents GLSL program variable location.
150 class OpenGl_ShaderUniformLocation
153 //! Invalid location of uniform/attribute variable.
154 static const GLint INVALID_LOCATION = -1;
157 //! Construct an invalid location.
158 OpenGl_ShaderUniformLocation() : myLocation (INVALID_LOCATION) {}
160 //! Constructor with initialization.
161 explicit OpenGl_ShaderUniformLocation (GLint theLocation) : myLocation (theLocation) {}
163 //! Note you may safely put invalid location in functions like glUniform* - the data passed in will be silently ignored.
164 //! @return true if location is not equal to -1.
165 bool IsValid() const { return myLocation != INVALID_LOCATION; }
167 //! Return TRUE for non-invalid location.
168 operator bool() const { return myLocation != INVALID_LOCATION; }
170 //! Convert operators help silently put object to GL functions like glUniform*.
171 operator GLint() const { return myLocation; }
177 //! Wrapper for OpenGL program object.
178 class OpenGl_ShaderProgram : public OpenGl_NamedResource
180 friend class OpenGl_View;
181 friend class OpenGl_ShaderManager;
182 DEFINE_STANDARD_RTTIEXT(OpenGl_ShaderProgram, OpenGl_NamedResource)
185 //! Non-valid shader name.
186 static const GLuint NO_PROGRAM = 0;
188 //! Invalid location of uniform/attribute variable.
189 static const GLint INVALID_LOCATION = -1;
191 //! List of pre-defined OCCT state uniform variables.
192 static Standard_CString PredefinedKeywords[OpenGl_OCCT_NUMBER_OF_STATE_VARIABLES];
194 //! Wrapper for compiling shader object with verbose printing on error.
195 Standard_EXPORT static bool compileShaderVerbose (const Handle(OpenGl_Context)& theCtx,
196 const Handle(OpenGl_ShaderObject)& theShader,
197 const TCollection_AsciiString& theSource,
198 bool theToPrintSource = true);
200 //! Creates uninitialized shader program.
202 //! WARNING! This constructor is not intended to be called anywhere but from OpenGl_ShaderManager::Create().
203 //! Manager has been designed to synchronize camera position, lights definition and other aspects of the program implicitly,
204 //! as well as sharing same program across rendering groups.
206 //! Program created outside the manager will be left detached from these routines,
207 //! and them should be performed manually by caller.
209 //! This constructor has been made public to provide more flexibility to re-use OCCT OpenGL classes without OCCT Viewer itself.
210 //! If this is not the case - create the program using shared OpenGl_ShaderManager instance instead.
211 Standard_EXPORT OpenGl_ShaderProgram (const Handle(Graphic3d_ShaderProgram)& theProxy = NULL,
212 const TCollection_AsciiString& theId = "");
216 static OpenGl_VariableSetterSelector mySetterSelector;
220 //! Releases resources of shader program.
221 Standard_EXPORT virtual ~OpenGl_ShaderProgram();
223 //! Creates new empty shader program of specified type.
224 Standard_EXPORT Standard_Boolean Create (const Handle(OpenGl_Context)& theCtx);
226 //! Destroys shader program.
227 Standard_EXPORT virtual void Release (OpenGl_Context* theCtx) Standard_OVERRIDE;
229 //! Returns estimated GPU memory usage - cannot be easily estimated.
230 virtual Standard_Size EstimatedDataSize() const Standard_OVERRIDE { return 0; }
232 //! Attaches shader object to the program object.
233 Standard_EXPORT Standard_Boolean AttachShader (const Handle(OpenGl_Context)& theCtx,
234 const Handle(OpenGl_ShaderObject)& theShader);
236 //! Detaches shader object to the program object.
237 Standard_EXPORT Standard_Boolean DetachShader (const Handle(OpenGl_Context)& theCtx,
238 const Handle(OpenGl_ShaderObject)& theShader);
240 //! Initializes program object with the list of shader objects.
241 Standard_EXPORT Standard_Boolean Initialize (const Handle(OpenGl_Context)& theCtx,
242 const Graphic3d_ShaderObjectList& theShaders);
244 //! Links the program object.
245 //! @param theCtx bound OpenGL context
246 //! @param theIsVerbose flag to print log on error
247 Standard_EXPORT Standard_Boolean Link (const Handle(OpenGl_Context)& theCtx,
248 bool theIsVerbose = true);
250 //! Fetches information log of the last link operation.
251 Standard_EXPORT Standard_Boolean FetchInfoLog (const Handle(OpenGl_Context)& theCtx,
252 TCollection_AsciiString& theLog);
254 //! Fetches uniform variables from proxy shader program.
255 Standard_EXPORT Standard_Boolean ApplyVariables (const Handle(OpenGl_Context)& theCtx);
257 //! @return true if current object was initialized
258 inline bool IsValid() const
260 return myProgramID != NO_PROGRAM;
263 //! @return program ID
264 inline GLuint ProgramId() const
271 //! Return TRUE if program defines tessellation stage.
272 Standard_Boolean HasTessellationStage() const { return myHasTessShader; }
274 //! Return the length of array of light sources (THE_MAX_LIGHTS),
275 //! to be used for initialization occLightSources (OpenGl_OCC_LIGHT_SOURCE_PARAMS).
276 Standard_Integer NbLightsMax() const { return myNbLightsMax; }
278 //! Return the length of array of clipping planes (THE_MAX_CLIP_PLANES),
279 //! to be used for initialization occClipPlaneEquations (OpenGl_OCC_CLIP_PLANE_EQUATIONS) and occClipPlaneChains (OpenGl_OCC_CLIP_PLANE_CHAINS).
280 Standard_Integer NbClipPlanesMax() const { return myNbClipPlanesMax; }
282 //! Return the length of array of Fragment Shader outputs (THE_NB_FRAG_OUTPUTS),
283 //! to be used for initialization occFragColorArray/occFragColorN.
284 Standard_Integer NbFragmentOutputs() const { return myNbFragOutputs; }
286 //! Return true if Fragment Shader should perform alpha test; FALSE by default.
287 Standard_Boolean HasAlphaTest() const { return myHasAlphaTest; }
289 //! Return true if Fragment Shader color should output the weighted OIT coverage; FALSE by default.
290 Standard_Boolean HasWeightOitOutput() const { return myHasWeightOitOutput; }
294 //! Returns index of last modification of variables of specified state type.
295 Standard_Size ActiveState (const OpenGl_UniformStateType theType) const
297 return theType < OpenGl_UniformStateType_NB
298 ? myCurrentState[theType]
302 //! Updates index of last modification of variables of specified state type.
303 void UpdateState (const OpenGl_UniformStateType theType,
304 const Standard_Size theIndex)
306 if (theType < OpenGl_UniformStateType_NB)
308 myCurrentState[theType] = theIndex;
314 //! Returns location of the specific uniform variable.
315 Standard_EXPORT OpenGl_ShaderUniformLocation GetUniformLocation (const Handle(OpenGl_Context)& theCtx,
316 const GLchar* theName) const;
318 //! Returns index of the generic vertex attribute by variable name.
319 Standard_EXPORT GLint GetAttributeLocation (const Handle(OpenGl_Context)& theCtx,
320 const GLchar* theName) const;
322 //! Returns location of the OCCT state uniform variable.
323 const OpenGl_ShaderUniformLocation& GetStateLocation (OpenGl_StateVariable theVariable) const { return myStateLocations[theVariable]; }
327 //! Returns the value of the integer uniform variable.
328 Standard_EXPORT Standard_Boolean GetUniform (const Handle(OpenGl_Context)& theCtx,
329 const GLchar* theName,
330 OpenGl_Vec4i& theValue) const;
332 Standard_EXPORT Standard_Boolean GetUniform (const Handle(OpenGl_Context)& theCtx,
334 OpenGl_Vec4i& theValue) const;
336 //! Returns the value of the float uniform variable.
337 Standard_EXPORT Standard_Boolean GetUniform (const Handle(OpenGl_Context)& theCtx,
338 const GLchar* theName,
339 OpenGl_Vec4& theValue) const;
341 //! Returns the value of the float uniform variable.
342 Standard_EXPORT Standard_Boolean GetUniform (const Handle(OpenGl_Context)& theCtx,
344 OpenGl_Vec4& theValue) const;
348 //! Returns the integer vertex attribute.
349 Standard_EXPORT Standard_Boolean GetAttribute (const Handle(OpenGl_Context)& theCtx,
350 const GLchar* theName,
351 OpenGl_Vec4i& theValue) const;
353 //! Returns the integer vertex attribute.
354 Standard_EXPORT Standard_Boolean GetAttribute (const Handle(OpenGl_Context)& theCtx,
356 OpenGl_Vec4i& theValue) const;
358 //! Returns the float vertex attribute.
359 Standard_EXPORT Standard_Boolean GetAttribute (const Handle(OpenGl_Context)& theCtx,
360 const GLchar* theName,
361 OpenGl_Vec4& theValue) const;
363 //! Returns the float vertex attribute.
364 Standard_EXPORT Standard_Boolean GetAttribute (const Handle(OpenGl_Context)& theCtx,
366 OpenGl_Vec4& theValue) const;
370 //! Wrapper for glBindAttribLocation()
371 Standard_EXPORT Standard_Boolean SetAttributeName (const Handle(OpenGl_Context)& theCtx,
373 const GLchar* theName);
375 //! Wrapper for glVertexAttrib1f()
376 Standard_EXPORT Standard_Boolean SetAttribute (const Handle(OpenGl_Context)& theCtx,
377 const GLchar* theName,
380 //! Wrapper for glVertexAttrib1f()
381 Standard_EXPORT Standard_Boolean SetAttribute (const Handle(OpenGl_Context)& theCtx,
385 //! Wrapper for glVertexAttrib2fv()
386 Standard_EXPORT Standard_Boolean SetAttribute (const Handle(OpenGl_Context)& theCtx,
387 const GLchar* theName,
388 const OpenGl_Vec2& theValue);
390 //! Wrapper for glVertexAttrib2fv()
391 Standard_EXPORT Standard_Boolean SetAttribute (const Handle(OpenGl_Context)& theCtx,
393 const OpenGl_Vec2& theValue);
395 //! Wrapper for glVertexAttrib3fv()
396 Standard_EXPORT Standard_Boolean SetAttribute (const Handle(OpenGl_Context)& theCtx,
397 const GLchar* theName,
398 const OpenGl_Vec3& theValue);
400 //! Wrapper for glVertexAttrib3fv()
401 Standard_EXPORT Standard_Boolean SetAttribute (const Handle(OpenGl_Context)& theCtx,
403 const OpenGl_Vec3& theValue);
405 //! Wrapper for glVertexAttrib4fv()
406 Standard_EXPORT Standard_Boolean SetAttribute (const Handle(OpenGl_Context)& theCtx,
407 const GLchar* theName,
408 const OpenGl_Vec4& theValue);
410 //! Wrapper for glVertexAttrib4fv()
411 Standard_EXPORT Standard_Boolean SetAttribute (const Handle(OpenGl_Context)& theCtx,
413 const OpenGl_Vec4& theValue);
417 //! Specifies the value of the integer uniform variable.
418 Standard_EXPORT Standard_Boolean SetUniform (const Handle(OpenGl_Context)& theCtx,
419 const GLchar* theName,
422 //! Specifies the value of the integer uniform variable.
423 Standard_EXPORT Standard_Boolean SetUniform (const Handle(OpenGl_Context)& theCtx,
427 //! Specifies the value of the integer uniform 2D vector.
428 Standard_EXPORT Standard_Boolean SetUniform (const Handle(OpenGl_Context)& theCtx,
429 const GLchar* theName,
430 const OpenGl_Vec2i& theValue);
432 //! Specifies the value of the integer uniform 2D vector.
433 Standard_EXPORT Standard_Boolean SetUniform (const Handle(OpenGl_Context)& theCtx,
435 const OpenGl_Vec2i& theValue);
437 //! Specifies the value of the integer uniform 3D vector.
438 Standard_EXPORT Standard_Boolean SetUniform (const Handle(OpenGl_Context)& theCtx,
439 const GLchar* theName,
440 const OpenGl_Vec3i& theValue);
442 //! Specifies the value of the integer uniform 3D vector.
443 Standard_EXPORT Standard_Boolean SetUniform (const Handle(OpenGl_Context)& theCtx,
445 const OpenGl_Vec3i& theValue);
447 //! Specifies the value of the integer uniform 4D vector.
448 Standard_EXPORT Standard_Boolean SetUniform (const Handle(OpenGl_Context)& theCtx,
449 const GLchar* theName,
450 const OpenGl_Vec4i& theValue);
452 //! Specifies the value of the integer uniform 4D vector.
453 Standard_EXPORT Standard_Boolean SetUniform (const Handle(OpenGl_Context)& theCtx,
455 const OpenGl_Vec4i& theValue);
459 //! Specifies the value of the unsigned integer uniform 2D vector (uvec2).
460 Standard_EXPORT Standard_Boolean SetUniform (const Handle(OpenGl_Context)& theCtx,
461 const GLchar* theName,
462 const OpenGl_Vec2u& theValue);
464 //! Specifies the value of the unsigned integer uniform 2D vector (uvec2).
465 Standard_EXPORT Standard_Boolean SetUniform (const Handle(OpenGl_Context)& theCtx,
467 const OpenGl_Vec2u& theValue);
469 //! Specifies the value of the uvec2 uniform array
470 Standard_EXPORT Standard_Boolean SetUniform (const Handle(OpenGl_Context)& theCtx,
471 const GLchar* theName,
472 const GLsizei theCount,
473 const OpenGl_Vec2u* theValue);
475 //! Specifies the value of the uvec2 uniform array
476 Standard_EXPORT Standard_Boolean SetUniform (const Handle(OpenGl_Context)& theCtx,
478 const GLsizei theCount,
479 const OpenGl_Vec2u* theValue);
483 //! Specifies the value of the float uniform variable.
484 Standard_EXPORT Standard_Boolean SetUniform (const Handle(OpenGl_Context)& theCtx,
485 const GLchar* theName,
488 //! Specifies the value of the float uniform variable.
489 Standard_EXPORT Standard_Boolean SetUniform (const Handle(OpenGl_Context)& theCtx,
493 //! Specifies the value of the float uniform 2D vector.
494 Standard_EXPORT Standard_Boolean SetUniform (const Handle(OpenGl_Context)& theCtx,
495 const GLchar* theName,
496 const OpenGl_Vec2& theValue);
498 //! Specifies the value of the float uniform 2D vector.
499 Standard_EXPORT Standard_Boolean SetUniform (const Handle(OpenGl_Context)& theCtx,
501 const OpenGl_Vec2& theValue);
503 //! Specifies the value of the float uniform 3D vector.
504 Standard_EXPORT Standard_Boolean SetUniform (const Handle(OpenGl_Context)& theCtx,
505 const GLchar* theName,
506 const OpenGl_Vec3& theValue);
508 //! Specifies the value of the float uniform 3D vector.
509 Standard_EXPORT Standard_Boolean SetUniform (const Handle(OpenGl_Context)& theCtx,
511 const OpenGl_Vec3& theValue);
513 //! Specifies the value of the float uniform 4D vector.
514 Standard_EXPORT Standard_Boolean SetUniform (const Handle(OpenGl_Context)& theCtx,
515 const GLchar* theName,
516 const OpenGl_Vec4& theValue);
518 //! Specifies the value of the float uniform 4D vector.
519 Standard_EXPORT Standard_Boolean SetUniform (const Handle(OpenGl_Context)& theCtx,
521 const OpenGl_Vec4& theValue);
525 //! Specifies the value of the float uniform 4x4 matrix.
526 Standard_EXPORT Standard_Boolean SetUniform (const Handle(OpenGl_Context)& theCtx,
527 const GLchar* theName,
528 const OpenGl_Mat4& theValue,
529 GLboolean theTranspose = GL_FALSE);
531 //! Specifies the value of the float uniform 4x4 matrix.
532 Standard_EXPORT Standard_Boolean SetUniform (const Handle(OpenGl_Context)& theCtx,
534 const OpenGl_Mat4& theValue,
535 GLboolean theTranspose = GL_FALSE);
537 //! Specifies the value of the float uniform 4x4 matrix.
538 Standard_EXPORT Standard_Boolean SetUniform (const Handle(OpenGl_Context)& theCtx,
539 const GLchar* theName,
540 const OpenGl_Matrix& theValue,
541 GLboolean theTranspose = GL_FALSE);
543 //! Specifies the value of the float uniform 4x4 matrix.
544 Standard_EXPORT Standard_Boolean SetUniform (const Handle(OpenGl_Context)& theCtx,
546 const OpenGl_Matrix& theValue,
547 GLboolean theTranspose = GL_FALSE);
549 //! Specifies the value of the float uniform array
550 Standard_EXPORT Standard_Boolean SetUniform (const Handle(OpenGl_Context)& theCtx,
553 const Standard_ShortReal* theData);
555 //! Specifies the value of the float2 uniform array
556 Standard_EXPORT Standard_Boolean SetUniform (const Handle(OpenGl_Context)& theCtx,
559 const OpenGl_Vec2* theData);
561 //! Specifies the value of the float3 uniform array
562 Standard_EXPORT Standard_Boolean SetUniform (const Handle(OpenGl_Context)& theCtx,
565 const OpenGl_Vec3* theData);
567 //! Specifies the value of the float4 uniform array
568 Standard_EXPORT Standard_Boolean SetUniform (const Handle(OpenGl_Context)& theCtx,
571 const OpenGl_Vec4* theData);
573 //! Specifies the value of the integer uniform array
574 Standard_EXPORT Standard_Boolean SetUniform (const Handle(OpenGl_Context)& theCtx,
577 const Standard_Integer* theData);
579 //! Specifies the value of the int2 uniform array
580 Standard_EXPORT Standard_Boolean SetUniform (const Handle(OpenGl_Context)& theCtx,
583 const OpenGl_Vec2i* theData);
585 //! Specifies the value of the int3 uniform array
586 Standard_EXPORT Standard_Boolean SetUniform (const Handle(OpenGl_Context)& theCtx,
589 const OpenGl_Vec3i* theData);
591 //! Specifies the value of the int4 uniform array
592 Standard_EXPORT Standard_Boolean SetUniform (const Handle(OpenGl_Context)& theCtx,
595 const OpenGl_Vec4i* theData);
599 //! Specifies the value of the sampler uniform variable.
600 Standard_EXPORT Standard_Boolean SetSampler (const Handle(OpenGl_Context)& theCtx,
601 const GLchar* theName,
602 const Graphic3d_TextureUnit theTextureUnit);
604 //! Specifies the value of the sampler uniform variable.
605 Standard_EXPORT Standard_Boolean SetSampler (const Handle(OpenGl_Context)& theCtx,
607 const Graphic3d_TextureUnit theTextureUnit);
611 //! Update the shader program from external files (per shader stage) in the following way:
612 //! 1) If external file does not exist, then it will be created (current source code will be dumped, no recompilation) and FALSE will be returned.
613 //! 2) If external file exists and it has the same timestamp as myDumpDate, nothing will be done and FALSE will be returned.
614 //! 3) If external file exists and it has newer timestamp than myDumpDate, shader will be recompiled and relinked and TRUE will be returned.
615 //! @param theCtx OpenGL context bound to this working thread
616 //! @param theFolder folder to store files; when unspecified, $CSF_ShadersDirectoryDump or current folder will be used instead
617 //! @param theToBeautify flag improving formatting (add extra newlines)
618 //! @param theToReset when TRUE, existing dumps will be overridden
619 Standard_EXPORT Standard_Boolean UpdateDebugDump (const Handle(OpenGl_Context)& theCtx,
620 const TCollection_AsciiString& theFolder = "",
621 Standard_Boolean theToBeautify = Standard_False,
622 Standard_Boolean theToReset = Standard_False);
626 //! Increments counter of users.
627 //! Used by OpenGl_ShaderManager.
628 //! @return true when resource has been restored from delayed release queue
631 return ++myShareCount == 1;
634 //! Decrements counter of users.
635 //! Used by OpenGl_ShaderManager.
636 //! @return true when there are no more users of this program has been left
639 return --myShareCount == 0;
642 //! Links the program object.
643 Standard_EXPORT Standard_Boolean link (const Handle(OpenGl_Context)& theCtx);
647 GLuint myProgramID; //!< Handle of OpenGL shader program
648 OpenGl_ShaderList myShaderObjects; //!< List of attached shader objects
649 Handle(Graphic3d_ShaderProgram) myProxy; //!< Proxy shader program (from application layer)
650 Standard_Integer myShareCount; //!< program users count, initialized with 1 (already shared by one user)
651 Standard_Integer myNbLightsMax; //!< length of array of light sources (THE_MAX_LIGHTS)
652 Standard_Integer myNbClipPlanesMax; //!< length of array of clipping planes (THE_MAX_CLIP_PLANES)
653 Standard_Integer myNbFragOutputs; //!< length of array of Fragment Shader outputs (THE_NB_FRAG_OUTPUTS)
654 Standard_Boolean myHasAlphaTest; //!< flag indicating that Fragment Shader should perform alpha-test
655 Standard_Boolean myHasWeightOitOutput; //!< flag indicating that Fragment Shader includes weighted OIT coverage
656 Standard_Boolean myHasTessShader; //!< flag indicating that program defines tessellation stage
660 Standard_Size myCurrentState[OpenGl_UniformStateType_NB]; //!< defines last modification for variables of each state type
662 //! Stores locations of OCCT state uniform variables.
663 OpenGl_ShaderUniformLocation myStateLocations[OpenGl_OCCT_NUMBER_OF_STATE_VARIABLES];
668 struct OpenGl_VariableSetter : public OpenGl_SetterInterface
670 virtual void Set (const Handle(OpenGl_Context)& theCtx,
671 const Handle(Graphic3d_ShaderVariable)& theVariable,
672 OpenGl_ShaderProgram* theProgram)
674 theProgram->SetUniform (theCtx,
675 theVariable->Name().ToCString(),
676 theVariable->Value()->As<T>());
680 namespace OpenGl_HashMapInitializer
682 template<class K, class V>
685 NCollection_DataMap<K, V> myDictionary;
687 MapListOfType (K theKey, V theValue)
689 myDictionary.Bind (theKey, theValue);
692 MapListOfType& operator() (K theKey, V theValue)
694 myDictionary.Bind (theKey, theValue);
698 operator const NCollection_DataMap<K, V>& () const
704 template<class K, class V>
705 MapListOfType<K, V> CreateListOf (K theKey, V theValue)
707 return MapListOfType<K, V> (theKey, theValue);
711 #endif // _OpenGl_ShaderProgram_Header