All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
uniformBlock.h
Go to the documentation of this file.
1 //
2 // Copyright 2016 Pixar
3 //
4 // Licensed under the Apache License, Version 2.0 (the "Apache License")
5 // with the following modification; you may not use this file except in
6 // compliance with the Apache License and the following modification to it:
7 // Section 6. Trademarks. is deleted and replaced with:
8 //
9 // 6. Trademarks. This License does not grant permission to use the trade
10 // names, trademarks, service marks, or product names of the Licensor
11 // and its affiliates, except as required to comply with Section 4(c) of
12 // the License and to reproduce the content of the NOTICE file.
13 //
14 // You may obtain a copy of the Apache License at
15 //
16 // http://www.apache.org/licenses/LICENSE-2.0
17 //
18 // Unless required by applicable law or agreed to in writing, software
19 // distributed under the Apache License with the above modification is
20 // distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
21 // KIND, either express or implied. See the Apache License for the specific
22 // language governing permissions and limitations under the Apache License.
23 //
24 #ifndef GLF_UNIFORM_BLOCK_H
25 #define GLF_UNIFORM_BLOCK_H
26 
28 
29 #include "pxr/pxr.h"
30 #include "pxr/imaging/glf/api.h"
31 #include "pxr/imaging/garch/gl.h"
32 #include "pxr/base/tf/declarePtrs.h"
33 #include "pxr/base/tf/refBase.h"
34 #include "pxr/base/tf/weakBase.h"
35 #include <string>
36 
37 PXR_NAMESPACE_OPEN_SCOPE
38 
39 
41 TF_DECLARE_WEAK_PTRS(GlfBindingMap);
42 
47 class GlfUniformBlock : public TfRefBase, public TfWeakBase {
48 public:
49 
51  GLF_API
52  static GlfUniformBlockRefPtr New(char const *label = nullptr);
53 
54  GLF_API
55  virtual ~GlfUniformBlock();
56 
58  GLF_API
59  void Bind(GlfBindingMapPtr const & bindingMap,
60  std::string const & identifier);
61 
64  GLF_API
65  void Update(const void *data, int size);
66 
67 protected:
68  GLF_API
69  GlfUniformBlock(char const *label);
70 
71 private:
72  GLuint _buffer;
73  int _size;
74  std::string _debugLabel;
75 };
76 
77 
78 PXR_NAMESPACE_CLOSE_SCOPE
79 
80 #endif
#define TF_DECLARE_WEAK_PTRS(type)
Define standard weak pointer types.
Definition: declarePtrs.h:62
#define TF_DECLARE_WEAK_AND_REF_PTRS(type)
Define standard weak, ref, and vector pointer types.
Definition: declarePtrs.h:89
GLF_API void Bind(GlfBindingMapPtr const &bindingMap, std::string const &identifier)
Binds the uniform buffer using a bindingMap and identifier.
Enable a concrete base class for use with TfRefPtr.
Definition: refBase.h:72
GLF_API void Update(const void *data, int size)
Updates the content of the uniform buffer.
Manages a GL uniform buffer object.
Definition: uniformBlock.h:47
static GLF_API GlfUniformBlockRefPtr New(char const *label=nullptr)
Returns a new instance.
Enable a concrete base class for use with TfWeakPtr.
Definition: weakBase.h:142