All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
bprim.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 HD_BPRIM_H
25 #define HD_BPRIM_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/types.h"
31 
32 #include "pxr/usd/sdf/path.h"
33 
34 PXR_NAMESPACE_OPEN_SCOPE
35 
36 class HdSceneDelegate;
37 class HdRenderParam;
38 
56 class HdBprim {
57 public:
58  HD_API
59  HdBprim(SdfPath const & id);
60  HD_API
61  virtual ~HdBprim();
62 
66  SdfPath const& GetId() const { return _id; }
67 
75  virtual void Sync(HdSceneDelegate *sceneDelegate,
76  HdRenderParam *renderParam,
77  HdDirtyBits *dirtyBits) = 0;
78 
82  HD_API
83  virtual void Finalize(HdRenderParam *renderParam);
84 
88  virtual HdDirtyBits GetInitialDirtyBitsMask() const = 0;
89 
90 private:
91  SdfPath _id;
92 };
93 
94 
95 PXR_NAMESPACE_CLOSE_SCOPE
96 
97 #endif // HD_BPRIM_H
virtual HdDirtyBits GetInitialDirtyBitsMask() const =0
Returns the minimal set of dirty bits to place in the change tracker for use in the first sync of thi...
The HdRenderParam is an opaque (to core Hydra) handle, to an object that is obtained from the render ...
virtual void Sync(HdSceneDelegate *sceneDelegate, HdRenderParam *renderParam, HdDirtyBits *dirtyBits)=0
Synchronizes state from the delegate to this object.
Adapter class providing data exchange with the client scene graph.
SdfPath const & GetId() const
Returns the identifier by which this buffer is known.
Definition: bprim.h:66
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:287
Bprim (buffer prim) is a base class of managing a blob of data that is used to communicate between th...
Definition: bprim.h:56
virtual HD_API void Finalize(HdRenderParam *renderParam)
Finalizes object resources.