HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
rendererPluginHandle.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_RENDERER_PLUGIN_HANDLE_H
25 #define PXR_IMAGING_HD_RENDERER_PLUGIN_HANDLE_H
26 
27 #include "pxr/pxr.h"
28 #include "pxr/imaging/hd/api.h"
30 
31 #include "pxr/base/tf/token.h"
32 
33 #include <cstddef>
34 
36 
37 class HdRendererPlugin;
39 
40 ///
41 /// A handle for HdRendererPlugin also storing the plugin id.
42 ///
43 /// Alleviates the need to ever call, e.g., ReleasePlugin since it
44 /// automatically decreases and increases the plugin's reference
45 /// counts with the plugin registry.
46 ///
48 {
49 public:
50  HdRendererPluginHandle() : _plugin(nullptr) { }
51  HdRendererPluginHandle(const std::nullptr_t &) : _plugin(nullptr) { }
52 
53  HD_API
55 
56  HD_API
58 
59  HD_API
61 
62  HD_API
63  HdRendererPluginHandle &operator=(const std::nullptr_t &);
64 
65  /// Get the wrapped HdRendererPlugin
66  HdRendererPlugin *Get() const { return _plugin; }
67 
68  HdRendererPlugin *operator->() const { return _plugin; }
69  HdRendererPlugin &operator*() const { return *_plugin; }
70 
71  /// Is the wrapped HdRendererPlugin valid?
72  explicit operator bool() const { return _plugin; }
73 
74 private:
76  friend class HdRendererPlugin;
77 
79  : _plugin(plugin) { }
80 
81  HdRendererPlugin *_plugin;
82 };
83 
85 
86 #endif
#define HD_API
Definition: api.h:40
HdRendererPluginHandle(const std::nullptr_t &)
HdRendererPlugin * operator->() const
HD_API ~HdRendererPluginHandle()
HD_API HdRendererPluginHandle & operator=(const HdRendererPluginHandle &)
HdRendererPlugin * Get() const
Get the wrapped HdRendererPlugin.
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1375
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
HdRendererPlugin & operator*() const