All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
resourceRegistry.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_RESOURCE_REGISTRY_H
25 #define PXR_IMAGING_HD_RESOURCE_REGISTRY_H
26 
27 #include "pxr/pxr.h"
28 #include "pxr/imaging/hd/api.h"
29 #include "pxr/imaging/hd/version.h"
30 
31 #include "pxr/imaging/hd/perfLog.h"
32 
33 #include "pxr/imaging/hf/perfLog.h"
34 
35 #include "pxr/base/tf/singleton.h"
36 #include "pxr/base/tf/token.h"
37 #include "pxr/base/vt/dictionary.h"
38 
39 #include <memory>
40 
41 PXR_NAMESPACE_OPEN_SCOPE
42 
43 
44 using HdResourceRegistrySharedPtr = std::shared_ptr<class HdResourceRegistry>;
45 
51 public:
52  HF_MALLOC_TAG_NEW("new HdResourceRegistry");
53 
54  HD_API
56 
57  HD_API
58  virtual ~HdResourceRegistry();
59 
61  HD_API
62  void Commit();
63 
65  HD_API
66  void GarbageCollect();
67 
69  HD_API
70  void GarbageCollectBprims();
71 
74  typedef size_t TextureKey;
75 
77  HD_API
78  virtual void InvalidateShaderRegistry();
79 
86  HD_API
87  virtual void ReloadResource(
88  TfToken const& resourceType,
89  std::string const& path);
90 
93  HD_API
94  virtual VtDictionary GetResourceAllocation() const;
95 
96 protected:
98  HD_API
99  virtual void _Commit();
100 
103  HD_API
104  virtual void _GarbageCollect();
105 
106  HD_API
107  virtual void _GarbageCollectBprims();
108 
109 private:
110  // Not copyable
111  HdResourceRegistry(const HdResourceRegistry&) = delete;
112  HdResourceRegistry& operator=(const HdResourceRegistry&) = delete;
113 };
114 
115 PXR_NAMESPACE_CLOSE_SCOPE
116 
117 #endif //PXR_IMAGING_HD_RESOURCE_REGISTRY_H
virtual HD_API VtDictionary GetResourceAllocation() const
Returns a report of resource allocation by role in bytes and a summary total allocation of GPU memory...
A map with string keys and VtValue values.
Definition: dictionary.h:63
Token for efficient comparison, assignment, and hashing of known strings.
Definition: token.h:87
HD_API void GarbageCollect()
cleanup all buffers and remove if empty
virtual HD_API void ReloadResource(TfToken const &resourceType, std::string const &path)
Generic method to inform RenderDelegate a resource needs to be reloaded.
A central registry for resources.
virtual HD_API void _GarbageCollect()
Hooks for derived registries to perform additional GC when GarbageCollect() or GarbageCollectBprims()...
HD_API void Commit()
Commits all in-flight source data.
HD_API void GarbageCollectBprims()
cleanup all Bprim registries
size_t TextureKey
Globally unique id for texture, see HdRenderIndex::GetTextureKey() for details.
virtual HD_API void InvalidateShaderRegistry()
Invalidate any shaders registered with this registry.
virtual HD_API void _Commit()
A hook for derived registries to perform additional resource commits.