HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
resource.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_RESOURCE_H
25 #define PXR_IMAGING_HD_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/base/tf/token.h"
31 
32 #include <cstddef>
33 #include <memory>
34 
36 
37 
38 using HdResourceSharedPtr = std::shared_ptr<class HdResource>;
39 
40 /// \class HdResource
41 ///
42 /// Base class for all GPU resource objects.
43 ///
45 {
46 public:
47  HD_API
48  HdResource(TfToken const & role);
49  HD_API
50  virtual ~HdResource();
51 
52  /// Returns the role of the GPU data in this resource.
53  TfToken const & GetRole() const {return _role;}
54 
55  /// Returns the size of the resource allocated in the GPU
56  HD_API
57  size_t GetSize() const {return _size;}
58 
59 protected:
60  /// Stores the size of the resource allocated in the GPU
61  HD_API
62  void SetSize(size_t size);
63 
64 private:
65 
66  // Don't allow copies.
67  HdResource(const HdResource &) = delete;
68  HdResource &operator=(const HdResource &) = delete;
69 
70 
71  const TfToken _role;
72  size_t _size;
73 };
74 
75 
77 
78 #endif //PXR_IMAGING_HD_RESOURCE_H
TfToken const & GetRole() const
Returns the role of the GPU data in this resource.
Definition: resource.h:53
virtual HD_API ~HdResource()
#define HD_API
Definition: api.h:40
std::shared_ptr< class HdResource > HdResourceSharedPtr
Definition: resource.h:38
GLsizeiptr size
Definition: glcorearb.h:663
Definition: token.h:87
HD_API void SetSize(size_t size)
Stores the size of the resource allocated in the GPU.
HD_API HdResource(TfToken const &role)
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1375
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
HD_API size_t GetSize() const
Returns the size of the resource allocated in the GPU.
Definition: resource.h:57