HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
bufferResourceGL.h
Go to the documentation of this file.
1 //
2 // Copyright 2017 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 PXR_IMAGING_HD_ST_BUFFER_RESOURCE_GL_H
25 #define PXR_IMAGING_HD_ST_BUFFER_RESOURCE_GL_H
26 
27 #include "pxr/imaging/garch/gl.h"
28 
29 #include "pxr/pxr.h"
30 #include "pxr/imaging/hdSt/api.h"
31 #include "pxr/imaging/hd/version.h"
33 
34 #include "pxr/imaging/hgi/buffer.h"
35 
36 #include "pxr/base/tf/token.h"
37 
38 #include <cstddef>
39 #include <memory>
40 #include <utility>
41 #include <vector>
42 
44 
46  std::shared_ptr<class HdStBufferResourceGL>;
47 
49  std::pair<TfToken, HdStBufferResourceGLSharedPtr>;
51  std::vector<HdStBufferResourceGLNamedPair>;
52 
53 /// \class HdStBufferResourceGL
54 ///
55 /// A specific type of HdBufferResource (GPU resource) representing an
56 /// OpenGL buffer object.
57 ///
59 {
60 public:
61  HDST_API
62  HdStBufferResourceGL(TfToken const &role,
63  HdTupleType tupleType,
64  int offset,
65  int stride);
66  HDST_API
68 
69  /// Sets the OpenGL name/identifier for this resource and its size.
70  /// also caches the gpu address of the buffer.
71  HDST_API
72  void SetAllocation(HgiBufferHandle const& id, size_t size);
73 
74  /// Returns the Hgi id for this GPU resource
75  HgiBufferHandle& GetId() { return _id; }
76 
77  /// Returns the gpu address (if available. otherwise returns 0).
78  uint64_t GetGPUAddress() const { return _gpuAddr; }
79 
80 private:
81  uint64_t _gpuAddr;
82  HgiBufferHandle _id;
83 };
84 
85 
87 
88 #endif // PXR_IMAGING_HD_ST_BUFFER_RESOURCE_GL_H
GLsizeiptr size
Definition: glew.h:1681
std::shared_ptr< class HdStBufferResourceGL > HdStBufferResourceGLSharedPtr
HDST_API ~HdStBufferResourceGL()
std::vector< std::pair< TfToken, HdStBufferResourceGLSharedPtr > > HdStBufferResourceGLNamedList
Definition: token.h:87
HDST_API void SetAllocation(HgiBufferHandle const &id, size_t size)
uint64_t GetGPUAddress() const
Returns the gpu address (if available. otherwise returns 0).
std::pair< TfToken, HdStBufferResourceGLSharedPtr > HdStBufferResourceGLNamedPair
GLsizei stride
Definition: glew.h:1523
HgiBufferHandle & GetId()
Returns the Hgi id for this GPU resource.
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1346
#define HDST_API
Definition: api.h:40
HDST_API HdStBufferResourceGL(TfToken const &role, HdTupleType tupleType, int offset, int stride)
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
GLintptr offset
Definition: glew.h:1682