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 HD_RENDERER_PLUGIN_H
25 #define 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;
36 
49 public:
50 
55  virtual HdRenderDelegate *CreateRenderDelegate() = 0;
56 
62  HD_API
63  virtual HdRenderDelegate *CreateRenderDelegate(
64  HdRenderSettingsMap const& settingsMap);
65 
69  virtual void DeleteRenderDelegate(HdRenderDelegate *renderDelegate) = 0;
70 
78  virtual bool IsSupported() const = 0;
79 
80 protected:
81  HdRendererPlugin() = default;
82  HD_API
83  virtual ~HdRendererPlugin();
84 
85 
86 private:
87  // This class doesn't require copy support.
88  HdRendererPlugin(const HdRendererPlugin &) = delete;
89  HdRendererPlugin &operator =(const HdRendererPlugin &) = delete;
90 
91 };
92 
93 
94 PXR_NAMESPACE_CLOSE_SCOPE
95 
96 #endif // HD_RENDERER_PLUGIN_H
The Hydra render index is a flattened representation of the client scene graph, which may be composed...
Definition: renderIndex.h:119
virtual void DeleteRenderDelegate(HdRenderDelegate *renderDelegate)=0
Release the object factoried by CreateRenderDelegate().
This class defines a renderer plugin interface for Hydra.
Base class for all hydra plugin classes.
Definition: pluginBase.h:39
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:287
virtual HdRenderDelegate * CreateRenderDelegate()=0
Factory a Render Delegate object, that Hydra can use to factory prims and communicate with a renderer...