432df4dce54f32fe05c2d01496cd8a07eaf6cfdf
[occt.git] / src / OpenGl / OpenGl_ShaderObject.hxx
1 // Created on: 2013-09-19
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 _OpenGl_ShaderObject_Header
17 #define _OpenGl_ShaderObject_Header
18
19 #include <Graphic3d_ShaderObject.hxx>
20 #include <OpenGl_GlCore20.hxx>
21 #include <OpenGl_Resource.hxx>
22
23 //! Wrapper for OpenGL shader object.
24 class OpenGl_ShaderObject : public OpenGl_Resource
25 {
26
27 public:
28
29   //! Non-valid shader name.
30   static const GLuint NO_SHADER = 0;
31
32 public:
33
34   //! Creates uninitialized shader object.
35   Standard_EXPORT OpenGl_ShaderObject (GLenum theType);
36
37   //! Releases resources of shader object.
38   Standard_EXPORT virtual ~OpenGl_ShaderObject();
39
40   //! Loads shader source code.
41   Standard_EXPORT Standard_Boolean LoadSource (const Handle(OpenGl_Context)&  theCtx,
42                                                const TCollection_AsciiString& theSource);
43
44   //! Compiles the shader object.
45   Standard_EXPORT Standard_Boolean Compile (const Handle(OpenGl_Context)& theCtx);
46
47   //! Initializes (loads and compiles) shader object with the specified description.
48   Standard_EXPORT Standard_Boolean Initialize (const Handle(OpenGl_Context)&         theCtx,
49                                                const Handle(Graphic3d_ShaderObject)& theShader);
50
51   //! Fetches information log of the last compile operation.
52   Standard_EXPORT Standard_Boolean FetchInfoLog (const Handle(OpenGl_Context)& theCtx,
53                                                  TCollection_AsciiString&      theLog);
54
55   //! Creates new empty shader object of specified type.
56   Standard_EXPORT Standard_Boolean Create (const Handle(OpenGl_Context)& theCtx);
57
58   //! Destroys shader object.
59   Standard_EXPORT virtual void Release (OpenGl_Context* theCtx);
60
61   //! Returns type of shader object.
62   GLenum Type() const { return myType; }
63   
64 protected:
65
66   GLenum myType;     //!< Type of OpenGL shader object
67   GLuint myShaderID; //!< Handle of OpenGL shader object
68
69 public:
70
71   DEFINE_STANDARD_RTTI (OpenGl_ShaderObject, OpenGl_Resource)
72   friend class OpenGl_ShaderProgram;
73
74 };
75
76 #endif // _OpenGl_ShaderObject_Header