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 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"
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 
41 
42 
43 class HdBufferResource;
44 
45 using HdBufferResourceSharedPtr = std::shared_ptr<HdBufferResource>;
46 using HdBufferResourceNamedList = std::vector<
47  std::pair<TfToken, HdBufferResourceSharedPtr> >;
48 
49 /// \class HdBufferResource
50 ///
51 /// A specific type of HdResource (GPU resource) representing a buffer object.
52 ///
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 
63  /// Data type and count
64  HdTupleType GetTupleType() const { return _tupleType; }
65 
66  /// Returns the interleaved offset (in bytes) of this data.
67  int GetOffset() const {return _offset;}
68 
69  /// Returns the stride (in bytes) of underlying buffer.
70  int GetStride() const {return _stride;}
71 
72 protected:
74  int _offset;
75  int _stride;
76 };
77 
78 
80 
81 #endif //PXR_IMAGING_HD_BUFFER_RESOURCE_H
HdTupleType GetTupleType() const
Data type and count.
#define HD_API
Definition: api.h:40
Definition: token.h:87
std::vector< std::pair< TfToken, HdBufferResourceSharedPtr > > HdBufferResourceNamedList
HdTupleType _tupleType
std::shared_ptr< HdBufferResource > HdBufferResourceSharedPtr
HD_API ~HdBufferResource()
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1375
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
GLintptr offset
Definition: glcorearb.h:664
GLint GLenum GLboolean GLsizei stride
Definition: glcorearb.h:871
int GetOffset() const
Returns the interleaved offset (in bytes) of this data.
HD_API HdBufferResource(TfToken const &role, HdTupleType tupleType, int offset, int stride)
int GetStride() const
Returns the stride (in bytes) of underlying buffer.