HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
pluginRenderDelegateUniqueHandle.h
Go to the documentation of this file.
1 //
2 // Copyright 2020 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_PLUGIN_RENDER_DELEGATE_UNIQUE_HANDLE_H
25 #define PXR_IMAGING_HD_PLUGIN_RENDER_DELEGATE_UNIQUE_HANDLE_H
26 
27 #include "pxr/pxr.h"
28 #include "pxr/imaging/hd/api.h"
30 
31 #include <cstddef>
32 
34 
35 class HdRenderDelegate;
36 
37 ///
38 /// A (movable) handle for a render delegate that was created using a
39 /// a plugin.
40 ///
41 /// The handle owns the render delegate (render delegate is destroyed
42 /// when handle is dropped). The handle also can be queried what
43 /// plugin was used to create the render delegate and ensures the
44 /// plugin is kept alive until the render delegate is destroyed.
45 /// In other words, the handle can be used just like a std::unique_ptr.
46 ///
48 {
49 public:
50  HdPluginRenderDelegateUniqueHandle() : _delegate(nullptr) { }
51  HdPluginRenderDelegateUniqueHandle(const std::nullptr_t &)
52  : _delegate(nullptr) { }
53 
54  /// Transfer ownership
55  HD_API
57 
58  HD_API
60 
61  /// Transfer ownership
62  HD_API
65 
66  HD_API
68  const std::nullptr_t &);
69 
70  /// Get render delegate
71  HdRenderDelegate *Get() const { return _delegate; }
72 
73  HdRenderDelegate *operator->() const { return _delegate; }
74  HdRenderDelegate &operator*() const { return *_delegate; }
75 
76  /// Is the wrapped HdRenderDelegate valid?
77  explicit operator bool() const { return _delegate; }
78 
79  /// Get the id of the plugin used to create render delegate
80  HD_API
81  TfToken GetPluginId() const;
82 
83 private:
84  friend class HdRendererPlugin;
85 
87  const HdRendererPluginHandle &plugin, HdRenderDelegate * delegate)
88  : _plugin(plugin), _delegate(delegate) { }
89 
90  HdRendererPluginHandle _plugin;
91  HdRenderDelegate *_delegate;
92 };
93 
95 
96 #endif
HD_API TfToken GetPluginId() const
Get the id of the plugin used to create render delegate.
#define HD_API
Definition: api.h:40
Definition: token.h:87
HD_API HdPluginRenderDelegateUniqueHandle & operator=(HdPluginRenderDelegateUniqueHandle &&)
Transfer ownership.
HdRenderDelegate * Get() const
Get render delegate.
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1375
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91