All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
rendererPluginRegistry.h
1 //
2 // Copyright 2017 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_RENDER_PLUGIN_REGISTRY_H
25 #define HD_RENDER_PLUGIN_REGISTRY_H
26 
27 #include "pxr/pxr.h"
28 #include "pxr/imaging/hd/api.h"
29 #include "pxr/base/tf/singleton.h"
30 #include "pxr/imaging/hf/pluginRegistry.h"
31 
32 PXR_NAMESPACE_OPEN_SCOPE
33 
34 
35 class HdRendererPlugin;
36 
37 class HdRendererPluginRegistry final : public HfPluginRegistry
38 {
39 public:
43  HD_API
44  static HdRendererPluginRegistry &GetInstance();
45 
49  template<typename T, typename... Bases>
50  static void Define();
51 
55  HD_API
56  TfToken GetDefaultPluginId();
57 
63  HD_API
64  HdRendererPlugin *GetRendererPlugin(const TfToken &pluginId);
65 
66 private:
67  // Friend required by TfSingleton to access constructor (as it is private).
68  friend class TfSingleton<HdRendererPluginRegistry>;
69 
70  // Singleton gets private constructed
71  HdRendererPluginRegistry();
72  virtual ~HdRendererPluginRegistry();
73 
74  //
77  HdRendererPluginRegistry(const HdRendererPluginRegistry &) = delete;
78  HdRendererPluginRegistry &operator=(const HdRendererPluginRegistry &) = delete;
79 };
80 
81 
82 template<typename T, typename... Bases>
83 void HdRendererPluginRegistry::Define()
84 {
86 }
87 
88 
89 PXR_NAMESPACE_CLOSE_SCOPE
90 
91 #endif // HD_RENDER_PLUGIN_REGISTRY_H
Manage a single instance of an object (see.
Definition: singleton.h:122
Base class for registering Hydra plugins using the plug mechanism.
This class defines a renderer plugin interface for Hydra.
static void Define()
Entry point for registering a types implementation.
Token for efficient comparison, assignment, and hashing of known strings.
Definition: token.h:89