HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
resourceRegistry.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_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 
42 
43 
44 using HdResourceRegistrySharedPtr = std::shared_ptr<class HdResourceRegistry>;
45 
46 /// \class HdResourceRegistry
47 ///
48 /// A central registry for resources.
49 ///
51 public:
52  HF_MALLOC_TAG_NEW("new HdResourceRegistry");
53 
54  HD_API
56 
57  HD_API
58  virtual ~HdResourceRegistry();
59 
60  /// Commits all in-flight source data.
61  HD_API
62  void Commit();
63 
64  /// cleanup all buffers and remove if empty
65  HD_API
66  void GarbageCollect();
67 
68  /// Globally unique id for texture, see HdRenderIndex::GetTextureKey() for
69  /// details.
70  typedef size_t TextureKey;
71 
72  /// Invalidate any shaders registered with this registry.
73  HD_API
74  virtual void InvalidateShaderRegistry();
75 
76  /// Generic method to inform RenderDelegate a resource needs to be reloaded.
77  /// This method can be used by the application to inform the renderDelegate
78  /// that a resource, which may not have any prim representation in Hydra,
79  /// needs to be reloaded. For example a texture found in a material network.
80  /// The `path` can be absolute or relative. It should usually match the
81  /// path found for textures during HdMaterial::Sync.
82  HD_API
83  virtual void ReloadResource(
84  TfToken const& resourceType,
85  std::string const& path);
86 
87  /// Returns a report of resource allocation by role in bytes and
88  /// a summary total allocation of GPU memory in bytes for this registry.
89  HD_API
90  virtual VtDictionary GetResourceAllocation() const;
91 
92 protected:
93  /// A hook for derived registries to perform additional resource commits.
94  HD_API
95  virtual void _Commit();
96 
97  /// Hooks for derived registries to perform additional GC when
98  /// GarbageCollect() is invoked.
99  HD_API
100  virtual void _GarbageCollect();
101 
102 private:
103  // Not copyable
104  HdResourceRegistry(const HdResourceRegistry&) = delete;
105  HdResourceRegistry& operator=(const HdResourceRegistry&) = delete;
106 };
107 
109 
110 #endif //PXR_IMAGING_HD_RESOURCE_REGISTRY_H
virtual HD_API void InvalidateShaderRegistry()
Invalidate any shaders registered with this registry.
std::shared_ptr< class HdResourceRegistry > HdResourceRegistrySharedPtr
HD_API void Commit()
Commits all in-flight source data.
GLsizei const GLchar *const * path
Definition: glcorearb.h:3340
#define HD_API
Definition: api.h:40
virtual HD_API void _Commit()
A hook for derived registries to perform additional resource commits.
virtual HD_API VtDictionary GetResourceAllocation() const
Definition: token.h:87
virtual HD_API void _GarbageCollect()
virtual HD_API void ReloadResource(TfToken const &resourceType, std::string const &path)
GLsizei const GLchar *const * string
Definition: glcorearb.h:813
HD_API void GarbageCollect()
cleanup all buffers and remove if empty
virtual HD_API ~HdResourceRegistry()
HF_MALLOC_TAG_NEW("new HdResourceRegistry")
HD_API HdResourceRegistry()
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1375
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91