HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
extCompInputSource.h
Go to the documentation of this file.
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 
25 #ifndef PXR_IMAGING_HD_EXT_COMP_INPUT_SOURCE_H
26 #define PXR_IMAGING_HD_EXT_COMP_INPUT_SOURCE_H
27 
28 #include "pxr/pxr.h"
29 #include "pxr/imaging/hd/api.h"
30 #include "pxr/imaging/hd/version.h"
32 
33 #include <memory>
34 
36 
37 class VtValue;
38 
39 ///
40 /// Abstract base class for a Buffer Source that represents a binding to an
41 /// input to an ExtComputation.
42 ///
43 ///
45 public:
46  /// Constructs the input binding with the name inputName
47  HD_API
48  Hd_ExtCompInputSource(const TfToken &inputName);
49 
50  HD_API
51  virtual ~Hd_ExtCompInputSource() = default;
52 
53  /// Returns the name of the input.
54  HD_API
55  virtual TfToken const &GetName() const final;
56 
57  /// Returns the value associated with the input.
58  HD_API
59  virtual const VtValue &GetValue() const = 0;
60 
61 private:
62  TfToken _inputName;
63 
64  Hd_ExtCompInputSource() = delete;
65  Hd_ExtCompInputSource(const Hd_ExtCompInputSource &) = delete;
66  Hd_ExtCompInputSource &operator = (const Hd_ExtCompInputSource &) = delete;
67 };
68 
70  std::shared_ptr<Hd_ExtCompInputSource>;
72  std::vector<Hd_ExtCompInputSourceSharedPtr>;
73 
74 
76 
77 #endif // PXR_IMAGING_HD_EXT_COMP_INPUT_SOURCE_H
std::vector< Hd_ExtCompInputSourceSharedPtr > Hd_ExtCompInputSourceSharedPtrVector
#define HD_API
Definition: api.h:40
virtual HD_API const VtValue & GetValue() const =0
Returns the value associated with the input.
virtual HD_API ~Hd_ExtCompInputSource()=default
Definition: token.h:87
std::shared_ptr< Hd_ExtCompInputSource > Hd_ExtCompInputSourceSharedPtr
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1375
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
Definition: value.h:168
virtual HD_API TfToken const & GetName() const final
Returns the name of the input.