All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
rendererPlugin.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 PXR_IMAGING_HD_RENDERER_PLUGIN_H
25 #define PXR_IMAGING_HD_RENDERER_PLUGIN_H
26 
27 #include "pxr/pxr.h"
28 #include "pxr/imaging/hd/api.h"
29 #include "pxr/imaging/hf/pluginBase.h"
30 #include "pxr/imaging/hd/renderDelegate.h"
31 
32 PXR_NAMESPACE_OPEN_SCOPE
33 
34 class SdfPath;
35 class HdRenderIndex;
37 
50 public:
51 
57  HD_API
59  HdRenderSettingsMap const &settingsMap = {});
60 
64  HD_API
65  TfToken GetPluginId() const;
66 
75  virtual HdRenderDelegate *CreateRenderDelegate() = 0;
76 
85  HD_API
86  virtual HdRenderDelegate *CreateRenderDelegate(
87  HdRenderSettingsMap const& settingsMap);
88 
95  virtual void DeleteRenderDelegate(HdRenderDelegate *renderDelegate) = 0;
96 
104  virtual bool IsSupported() const = 0;
105 
106 protected:
107  HdRendererPlugin() = default;
108  HD_API
109  ~HdRendererPlugin() override;
110 
111 private:
112  // This class doesn't require copy support.
113  HdRendererPlugin(const HdRendererPlugin &) = delete;
114  HdRendererPlugin &operator =(const HdRendererPlugin &) = delete;
115 
116 };
117 
118 
119 PXR_NAMESPACE_CLOSE_SCOPE
120 
121 #endif // PXR_IMAGING_HD_RENDERER_PLUGIN_H
The Hydra render index is a flattened representation of the client scene graph, which may be composed...
Definition: renderIndex.h:117
virtual void DeleteRenderDelegate(HdRenderDelegate *renderDelegate)=0
Clients should use CreateDelegate since this method will eventually become protected.
This class defines a renderer plugin interface for Hydra.
A (movable) handle for a render delegate that was created using a a plugin.
Base class for all hydra plugin classes.
Definition: pluginBase.h:39
Token for efficient comparison, assignment, and hashing of known strings.
Definition: token.h:87
virtual bool IsSupported() const =0
Returns true if this renderer plugin is supported in the running process and false if not...
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:288
HD_API TfToken GetPluginId() const
Look-up plugin id in plugin registry.
HD_API HdPluginRenderDelegateUniqueHandle CreateDelegate(HdRenderSettingsMap const &settingsMap={})
Create a render delegate through the plugin and wrap it in a handle that keeps this plugin alive unti...
virtual HdRenderDelegate * CreateRenderDelegate()=0
Clients should use CreateDelegate since this method will eventually become protected, use CreateRenderDelegateHandle instead.