All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
rendererPlugin.h
1 //
2 // Copyright 2019 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_PLUGIN_HD_PRMAN_LOADER_RENDERER_PLUGIN_H
25 #define PXR_IMAGING_PLUGIN_HD_PRMAN_LOADER_RENDERER_PLUGIN_H
26 
27 #include "pxr/pxr.h"
28 #include "pxr/imaging/hd/rendererPlugin.h"
29 
30 PXR_NAMESPACE_OPEN_SCOPE
31 
32 class HdPrmanLoaderRendererPlugin final : public HdRendererPlugin
33 {
34 public:
35  HdPrmanLoaderRendererPlugin();
36  virtual ~HdPrmanLoaderRendererPlugin();
37 
38  HdRenderDelegate *CreateRenderDelegate() override;
39  HdRenderDelegate *CreateRenderDelegate(
40  HdRenderSettingsMap const& settingsMap) override;
41  void DeleteRenderDelegate(HdRenderDelegate *) override;
42  bool IsSupported() const override;
43 
44 private:
45  // This class does not support copying.
46  HdPrmanLoaderRendererPlugin(
47  const HdPrmanLoaderRendererPlugin&) = delete;
48  HdPrmanLoaderRendererPlugin &operator =(
49  const HdPrmanLoaderRendererPlugin&) = delete;
50 };
51 
52 // These macros are used to shim the actual hdPrman delegate implementation
53 #define HDPRMAN_LOADER_CREATE_DELEGATE \
54  extern "C" ARCH_EXPORT HdRenderDelegate* HdPrmanLoaderCreateDelegate( \
55  HdRenderSettingsMap const& settingsMap)
56 #define HDPRMAN_LOADER_DELETE_DELEGATE \
57  extern "C" ARCH_EXPORT void HdPrmanLoaderDeleteDelegate( \
58  HdRenderDelegate *renderDelegate)
59 
60 PXR_NAMESPACE_CLOSE_SCOPE
61 
62 #endif // PXR_IMAGING_PLUGIN_HD_PRMAN_LOADER_RENDERER_PLUGIN_H
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.
virtual bool IsSupported() const =0
Returns true if this renderer plugin is supported in the running process and false if not...
virtual HdRenderDelegate * CreateRenderDelegate()=0
Clients should use CreateDelegate since this method will eventually become protected, use CreateRenderDelegateHandle instead.