HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
rendererPluginRegistry.h
Go to the documentation of this file.
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 PXR_IMAGING_HD_RENDERER_PLUGIN_REGISTRY_H
25 #define PXR_IMAGING_HD_RENDERER_PLUGIN_REGISTRY_H
26 
27 #include "pxr/pxr.h"
28 #include "pxr/imaging/hd/api.h"
30 #include "pxr/base/tf/singleton.h"
32 
34 
35 
36 class HdRendererPlugin;
39 
41 {
42 public:
43  ///
44  /// Returns the singleton registry for \c HdRendererPlugin
45  ///
46  HD_API
48 
49  ///
50  /// Entry point for defining an HdRendererPlugin plugin.
51  ///
52  template<typename T, typename... Bases>
53  static void Define();
54 
55  ///
56  /// Returns the id of plugin to use as the default
57  ///
58  HD_API
60 
61  ///
62  /// \deprecated Use GetOrCreateRendererPlugin instead.
63  ///
64  /// Returns the renderer plugin for the given id or null
65  /// if not found. The reference count on the returned
66  /// delegate is incremented.
67  ///
68  HD_API
69  HdRendererPlugin *GetRendererPlugin(const TfToken &pluginId);
70 
71  ///
72  /// Returns the renderer plugin for the given id or a null handle
73  /// if not found. The plugin is wrapped in a handle that automatically
74  /// increments and decrements the reference count and also stores the
75  /// plugin id.
76  ///
77  HD_API
79 
80  ///
81  /// Returns a render delegate created by the plugin with the given name
82  /// if the plugin is supported using given initial settings.
83  /// The render delegate is wrapped in a movable handle that
84  /// keeps the plugin alive until the render delegate is destroyed by
85  /// dropping the handle.
86  ///
87  HD_API
89  const TfToken &pluginId,
90  const HdRenderSettingsMap &settingsMap = {});
91 
92 private:
93  // Friend required by TfSingleton to access constructor (as it is private).
95 
96  // Singleton gets private constructed
98  ~HdRendererPluginRegistry() override;
99 
100  //
101  /// This class is not intended to be copied.
102  ///
104  HdRendererPluginRegistry &operator=(const HdRendererPluginRegistry &) = delete;
105 };
106 
107 
108 template<typename T, typename... Bases>
110 {
112 }
113 
114 
116 
117 #endif // PXR_IMAGING_HD_RENDERER_PLUGIN_REGISTRY_H
HD_API HdRendererPlugin * GetRendererPlugin(const TfToken &pluginId)
#define HD_API
Definition: api.h:40
HD_API HdRendererPluginHandle GetOrCreateRendererPlugin(const TfToken &pluginId)
HD_API HdPluginRenderDelegateUniqueHandle CreateRenderDelegate(const TfToken &pluginId, const HdRenderSettingsMap &settingsMap={})
Definition: token.h:87
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1375
HD_API TfToken GetDefaultPluginId()
static void Define()
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
static HD_API HdRendererPluginRegistry & GetInstance()