HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
bufferResource.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_H
25 #define PXR_IMAGING_HD_ST_BUFFER_RESOURCE_H
26 
27 #include "pxr/pxr.h"
28 #include "pxr/imaging/hdSt/api.h"
30 
31 #include "pxr/imaging/hgi/buffer.h"
32 
33 #include "pxr/base/tf/token.h"
34 
35 #include <memory>
36 #include <utility>
37 #include <vector>
38 
40 
42  std::shared_ptr<class HdStBufferResource>;
43 
45  std::pair<TfToken, HdStBufferResourceSharedPtr>;
47  std::vector<HdStBufferResourceNamedPair>;
48 
49 /// \class HdStBufferResource
50 ///
51 /// A specific type of HdBufferResource (GPU resource) representing
52 /// an HgiBufferHandle.
53 ///
55 {
56 public:
57  HDST_API
58  HdStBufferResource(TfToken const &role,
59  HdTupleType tupleType,
60  int offset,
61  int stride);
62  HDST_API
64 
65  /// Sets the HgiBufferHandle for this resource and its size.
66  /// also caches the gpu address of the buffer.
67  HDST_API
68  void SetAllocation(HgiBufferHandle const& handle, size_t size);
69 
70  /// Returns the HgiBufferHandle for this GPU resource
71  HgiBufferHandle& GetHandle() { return _handle; }
72 
73 private:
74  HgiBufferHandle _handle;
75 };
76 
77 
79 
80 #endif // PXR_IMAGING_HD_ST_BUFFER_RESOURCE_H
std::vector< std::pair< TfToken, HdStBufferResourceSharedPtr > > HdStBufferResourceNamedList
HgiBufferHandle & GetHandle()
Returns the HgiBufferHandle for this GPU resource.
GLsizeiptr size
Definition: glcorearb.h:664
Definition: token.h:87
HDST_API HdStBufferResource(TfToken const &role, HdTupleType tupleType, int offset, int stride)
std::pair< TfToken, HdStBufferResourceSharedPtr > HdStBufferResourceNamedPair
std::shared_ptr< class HdStBufferResource > HdStBufferResourceSharedPtr
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1394
#define HDST_API
Definition: api.h:40
HDST_API ~HdStBufferResource()
HDST_API void SetAllocation(HgiBufferHandle const &handle, size_t size)
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
GLintptr offset
Definition: glcorearb.h:665
GLint GLenum GLboolean GLsizei stride
Definition: glcorearb.h:872