All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
extCompGpuPrimvarBufferSource.h
1 //
2 // Copyright 2018 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 HDST_EXT_COMP_GPU_PRIMVAR_BUFFER_SOURCE_H
25 #define HDST_EXT_COMP_GPU_PRIMVAR_BUFFER_SOURCE_H
26 
27 #include "pxr/pxr.h"
28 #include "pxr/imaging/hdSt/api.h"
29 #include "pxr/imaging/hd/bufferSource.h"
30 #include "pxr/imaging/hd/types.h"
31 
32 #include "pxr/base/tf/token.h"
33 
34 #include "pxr/usd/sdf/path.h"
35 
36 PXR_NAMESPACE_OPEN_SCOPE
37 
38 typedef boost::shared_ptr<class HdStExtCompGpuPrimvarBufferSource>
39  HdStExtCompGpuPrimvarBufferSourceSharedPtr;
40 
45 public:
47  HdTupleType const & valueType,
48  int numElements,
49  SdfPath const& compId);
50 
51  HDST_API
52  virtual ~HdStExtCompGpuPrimvarBufferSource() = default;
53 
54  HDST_API
55  virtual size_t ComputeHash() const override;
56 
57  HDST_API
58  virtual bool Resolve() override;
59 
60  HD_API
61  virtual TfToken const &GetName() const override;
62 
63  HDST_API
64  virtual size_t GetNumElements() const override;
65 
66  HD_API
67  virtual HdTupleType GetTupleType() const override;
68 
69  HDST_API
70  virtual void GetBufferSpecs(HdBufferSpecVector *specs) const override;
71 
72 protected:
73  virtual bool _CheckValid() const override;
74 
75 private:
76  TfToken _name;
77  HdTupleType _tupleType;
78  size_t _numElements;
79  SdfPath _compId;
80 
83  const HdStExtCompGpuPrimvarBufferSource &) = delete;
85  const HdStExtCompGpuPrimvarBufferSource &) = delete;
86 };
87 
88 PXR_NAMESPACE_CLOSE_SCOPE
89 
90 #endif // HDST_EXT_COMP_GPU_PRIMVAR_BUFFER_SOURCE_H
virtual HD_API TfToken const & GetName() const override
Return the name of this buffer source.
virtual HD_API HdTupleType GetTupleType() const override
Returns the data type and count (array size) for this buffer source.
HdTupleType represents zero, one, or more values of the same HdType.
Definition: types.h:239
virtual HDST_API bool Resolve() override
Prepare the access of GetData().
Token for efficient comparison, assignment, and hashing of known strings.
Definition: token.h:89
A abstract base class for pure cpu computation.
Definition: bufferSource.h:235
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:287
A buffer source mapped to an output of an ExtComp CPU computation.
virtual HDST_API size_t ComputeHash() const override
Computes and returns a hash value for the underlying data.
virtual HDST_API void GetBufferSpecs(HdBufferSpecVector *specs) const override
Add the buffer spec for this buffer source into given bufferspec vector.
virtual bool _CheckValid() const override
Checks the validity of the source buffer.
virtual HDST_API size_t GetNumElements() const override
Returns the number of elements (e.g.