HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
computation.h
Go to the documentation of this file.
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"
31 #include "pxr/imaging/hd/perfLog.h"
32 
33 #include <memory>
34 #include <vector>
35 
37 
38 
39 using HdBufferArrayRangeSharedPtr = std::shared_ptr<class HdBufferArrayRange>;
40 
41 using HdComputationSharedPtr = std::shared_ptr<class HdComputation>;
42 using HdComputationSharedPtrVector = std::vector<HdComputationSharedPtr>;
43 
44 /// \class HdComputation
45 ///
46 /// An interface class for GPU computation.
47 ///
48 /// GPU computation fills the result into range, which has to be allocated
49 /// using buffer specs determined by GetBufferSpecs, and registered as a pair
50 /// of computation and range.
51 ///
53 {
54 public:
55  HD_API
56  virtual ~HdComputation();
57 
58  /// Execute computation.
59  virtual void Execute(
61  HdResourceRegistry *resourceRegistry) = 0;
62 
63  /// Returns the size of its destination buffer (located by range argument
64  /// of Execute()). This function will be called after all HdBufferSources
65  /// have been resolved and commited, so it can use the result of those
66  /// buffer source results.
67  /// Returning 0 means it doesn't need to resize.
68  virtual int GetNumOutputElements() const = 0;
69 
70  /// Add the buffer spec for this computation into given bufferspec vector.
71  /// Caller has to allocate the destination buffer with respect to the
72  /// BufferSpecs, and passes the range when registering the computation.
73  virtual void GetBufferSpecs(HdBufferSpecVector *specs) const = 0;
74 
75  /// This function is needed as HdComputation shares a templatized interface
76  /// with HdBufferSource.
77  ///
78  /// It is a check to see if the GetBufferSpecs would produce a valid result.
79  bool IsValid() { return true; }
80 };
81 
82 
84 
85 #endif // PXR_IMAGING_HD_COMPUTATION_H
GLenum GLint * range
Definition: glew.h:3500
#define HD_API
Definition: api.h:40
std::shared_ptr< class HdComputation > HdComputationSharedPtr
Definition: computation.h:41
std::vector< struct HdBufferSpec > HdBufferSpecVector
virtual HD_API ~HdComputation()
virtual void GetBufferSpecs(HdBufferSpecVector *specs) const =0
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1346
bool IsValid()
Definition: computation.h:79
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
std::shared_ptr< HdBufferArrayRange > HdBufferArrayRangeSharedPtr
Definition: bufferArray.h:45
virtual void Execute(HdBufferArrayRangeSharedPtr const &range, HdResourceRegistry *resourceRegistry)=0
Execute computation.
std::vector< HdComputationSharedPtr > HdComputationSharedPtrVector
Definition: computation.h:42
virtual int GetNumOutputElements() const =0