HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
extComputationContext.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 #ifndef PXR_IMAGING_HD_EXT_COMPUTATION_CONTEXT_H
25 #define PXR_IMAGING_HD_EXT_COMPUTATION_CONTEXT_H
26 
27 #include "pxr/pxr.h"
28 #include "pxr/imaging/hd/api.h"
29 #include "pxr/base/vt/value.h"
30 
32 
33 ///
34 /// Interface class that defines the execution environment for the client
35 /// to run a computation.
36 ///
38 public:
39  HdExtComputationContext() = default;
40  virtual ~HdExtComputationContext();
41 
42  ///
43  /// Obtains the value of an named input to the computation.
44  ///
45  /// The code will issue a coding error and return a empty array
46  /// if the input is missing or of a different type.
47  ///
48  virtual const VtValue &GetInputValue(const TfToken &name) const = 0;
49 
50  ///
51  /// Obtains the value of an named input to the computation.
52  ///
53  /// If the input isn't present or of a different type
54  /// nullptr will be returned.
55  ///
56  virtual const VtValue *GetOptionalInputValuePtr(
57  const TfToken &name) const = 0;
58 
59  ///
60  /// Set the value of the specified output.
61  ///
62  virtual void SetOutputValue(const TfToken &name, const VtValue &output) = 0;
63 
64  ///
65  /// Called to indicate an error occurred while executing a computation
66  /// so that its output are invalid.
67  ///
68  virtual void RaiseComputationError() = 0;
69 
70 private:
73  = delete;
74 };
75 
77 
78 #endif // PXR_IMAGING_HD_EXT_COMPUTATION_CONTEXT_H
GLuint const GLchar * name
Definition: glew.h:1814
virtual ~HdExtComputationContext()
Definition: token.h:87
virtual const VtValue * GetOptionalInputValuePtr(const TfToken &name) const =0
virtual void SetOutputValue(const TfToken &name, const VtValue &output)=0
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1346
virtual void RaiseComputationError()=0
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
HdExtComputationContext()=default
virtual const VtValue & GetInputValue(const TfToken &name) const =0
Definition: value.h:174