bufferResource.h
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 PXR_IMAGING_HD_BUFFER_RESOURCE_H
25 #define PXR_IMAGING_HD_BUFFER_RESOURCE_H
26 
27 #include "pxr/pxr.h"
28 #include "pxr/imaging/hd/api.h"
29 #include "pxr/imaging/hd/version.h"
30 #include "pxr/imaging/hd/resource.h"
31 #include "pxr/imaging/hd/types.h"
32 
33 #include "pxr/base/tf/token.h"
34 
35 #include <cstddef>
36 #include <memory>
37 #include <utility>
38 #include <vector>
39 
40 PXR_NAMESPACE_OPEN_SCOPE
41 
42 
43 class HdBufferResource;
44 
45 using HdBufferResourceSharedPtr = std::shared_ptr<HdBufferResource>;
46 using HdBufferResourceNamedList = std::vector<
47  std::pair<TfToken, HdBufferResourceSharedPtr> >;
48 
53 class HdBufferResource : public HdResource {
54 public:
55  HD_API
56  HdBufferResource(TfToken const &role,
57  HdTupleType tupleType,
58  int offset,
59  int stride);
60  HD_API
62 
64  HdTupleType GetTupleType() const { return _tupleType; }
65 
67  int GetOffset() const {return _offset;}
68 
70  int GetStride() const {return _stride;}
71 
72 protected:
73  HdTupleType _tupleType;
74  int _offset;
75  int _stride;
76 };
77 
78 
79 PXR_NAMESPACE_CLOSE_SCOPE
80 
81 #endif //PXR_IMAGING_HD_BUFFER_RESOURCE_H
HdTupleType represents zero, one, or more values of the same HdType.
Definition: types.h:358
A specific type of HdResource (GPU resource) representing a buffer object.
Token for efficient comparison, assignment, and hashing of known strings.
Definition: token.h:87
int GetStride() const
Returns the stride (in bytes) of underlying buffer.
int GetOffset() const
Returns the interleaved offset (in bytes) of this data.
HdTupleType GetTupleType() const
Data type and count.
Base class for all GPU resource objects.
Definition: resource.h:44
TfToken class for efficient string referencing and hashing, plus conversions to and from stl string c...