0024023: Revamp the OCCT Handle -- automatic
[occt.git] / src / OpenGl / OpenGl_Sampler.hxx
1 // Created on: 2014-10-08
2 // Created by: Denis BOGOLEPOV
3 // Copyright (c) 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_SAMPLER_H
17 #define OPENGL_SAMPLER_H
18
19 #include <OpenGl_Context.hxx>
20
21 //! Class implements OpenGL sampler object resource that
22 //! stores the sampling parameters for a texture access.
23 class OpenGl_Sampler : public OpenGl_Resource
24 {
25 public:
26
27   //! Helpful constant defining invalid sampler identifier
28   static const GLuint NO_SAMPLER = 0;
29
30 public:
31
32   //! Creates new sampler object.
33   Standard_EXPORT OpenGl_Sampler();
34
35   //! Releases resources of sampler object.
36   Standard_EXPORT virtual ~OpenGl_Sampler();
37
38   //! Destroys object - will release GPU memory if any.
39   Standard_EXPORT virtual void Release (OpenGl_Context* theContext);
40
41   //! Initializes sampler object.
42   Standard_EXPORT Standard_Boolean Init (OpenGl_Context& theContext);
43
44   //! Returns true if current object was initialized.
45   Standard_Boolean IsValid() const
46   {
47     return isValidSampler();
48   }
49
50   //! Binds sampler object to the given texture unit.
51   Standard_EXPORT void Bind (OpenGl_Context& theContext, const GLuint theUnit = 0);
52
53   //! Unbinds sampler object from the given texture unit.
54   Standard_EXPORT void Unbind (OpenGl_Context& theContext, const GLuint theUnit = 0);
55
56   //! Sets specific sampler parameter.
57   Standard_EXPORT void SetParameter (OpenGl_Context& theContext, const GLenum theParam, const GLint theValue);
58
59   //! Returns OpenGL sampler ID.
60   GLuint SamplerID() const
61   {
62     return mySamplerID;
63   }
64
65 protected:
66
67   //! Checks if sampler object is valid.
68   Standard_Boolean isValidSampler() const
69   {
70     return mySamplerID != NO_SAMPLER;
71   }
72
73 protected:
74
75   GLuint mySamplerID; //!< OpenGL sampler object ID
76
77 public:
78
79   DEFINE_STANDARD_RTTI(OpenGl_Sampler, OpenGl_Resource)
80
81 };
82
83 #endif // OPENGL_SAMPLER_H