All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
computation.h
1 //
2 // Copyright 2016 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_COMPUTATION_H
25 #define PXR_IMAGING_HD_COMPUTATION_H
26 
27 #include "pxr/pxr.h"
28 #include "pxr/imaging/hd/api.h"
29 #include "pxr/imaging/hd/version.h"
30 #include "pxr/imaging/hd/bufferSpec.h"
31 #include "pxr/imaging/hd/perfLog.h"
32 #include <boost/shared_ptr.hpp>
33 
34 #include <memory>
35 #include <vector>
36 
37 PXR_NAMESPACE_OPEN_SCOPE
38 
39 
40 using HdBufferArrayRangeSharedPtr = std::shared_ptr<class HdBufferArrayRange>;
41 
42 using HdComputationSharedPtr = std::shared_ptr<class HdComputation>;
43 using HdComputationSharedPtrVector = std::vector<HdComputationSharedPtr>;
44 
54 {
55 public:
56  HD_API
57  virtual ~HdComputation();
58 
60  virtual void Execute(
61  HdBufferArrayRangeSharedPtr const &range,
62  HdResourceRegistry *resourceRegistry) = 0;
63 
69  virtual int GetNumOutputElements() const = 0;
70 
74  virtual void GetBufferSpecs(HdBufferSpecVector *specs) const = 0;
75 
80  bool IsValid() { return true; }
81 };
82 
83 
84 PXR_NAMESPACE_CLOSE_SCOPE
85 
86 #endif // PXR_IMAGING_HD_COMPUTATION_H
virtual int GetNumOutputElements() const =0
Returns the size of its destination buffer (located by range argument of Execute()).
bool IsValid()
This function is needed as HdComputation shares a templatized interface with HdBufferSource.
Definition: computation.h:80
A central registry for resources.
virtual void Execute(HdBufferArrayRangeSharedPtr const &range, HdResourceRegistry *resourceRegistry)=0
Execute computation.
An interface class for GPU computation.
Definition: computation.h:53
virtual void GetBufferSpecs(HdBufferSpecVector *specs) const =0
Add the buffer spec for this computation into given bufferspec vector.