All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
resource.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 HD_RESOURCE_H
25 #define 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 <boost/noncopyable.hpp>
33 #include <boost/shared_ptr.hpp>
34 
35 #include <cstddef>
36 
37 PXR_NAMESPACE_OPEN_SCOPE
38 
39 
40 typedef boost::shared_ptr<class HdResource> HdResourceSharedPtr;
41 
46 class HdResource : boost::noncopyable
47 {
48 public:
49  HD_API
50  HdResource(TfToken const & role);
51  HD_API
52  virtual ~HdResource();
53 
55  TfToken const & GetRole() const {return _role;}
56 
58  HD_API
59  size_t GetSize() const {return _size;}
60 
61 protected:
63  HD_API
64  void SetSize(size_t size);
65 
66 private:
67  const TfToken _role;
68  size_t _size;
69 };
70 
71 
72 PXR_NAMESPACE_CLOSE_SCOPE
73 
74 #endif //HD_RESOURCE_H
HD_API void SetSize(size_t size)
Stores the size of the resource allocated in the GPU.
Token for efficient comparison, assignment, and hashing of known strings.
Definition: token.h:89
HD_API size_t GetSize() const
Returns the size of the resource allocated in the GPU.
Definition: resource.h:59
TfToken const & GetRole() const
Returns the role of the GPU data in this resource.
Definition: resource.h:55
Base class for all GPU resource objects.
Definition: resource.h:46