HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
bprim.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_BPRIM_H
25 #define PXR_IMAGING_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 
35 
36 class HdSceneDelegate;
37 class HdRenderParam;
38 
39 /// \class HdBprim
40 ///
41 /// Bprim (buffer prim) is a base class of managing a blob of data that is
42 /// used to communicate between the scene delegate and render.
43 ///
44 /// Like other prim types (Rprim and Sprim), the Bprim communicates with the
45 /// scene delegate got get buffer properties (e.g. the size of the buffer) as
46 /// well as the contents of the buffer.
47 ///
48 /// Changes to the properties and contents are change tracked and updates
49 /// are cached in the renderer. The Render Delegate may choose to transform
50 /// the data into a renderer specific form on download.
51 ///
52 /// BPrims are sync'ed first and thus, Bprims should not be
53 /// Dependent on the state of any other prim.
54 ///
55 /// The most typical use of a Bprim would be a Texture.
56 class HdBprim {
57 public:
58  HD_API
59  HdBprim(SdfPath const & id);
60  HD_API
61  virtual ~HdBprim();
62 
63  /// Returns the identifier by which this buffer is known. This
64  /// identifier is a common associative key used by the SceneDelegate,
65  /// RenderIndex, and for binding to the buffer
66  SdfPath const& GetId() const { return _id; }
67 
68  /// Synchronizes state from the delegate to this object.
69  /// @param[in, out] dirtyBits: On input specifies which state is
70  /// is dirty and can be pulled from the scene
71  /// delegate.
72  /// On output specifies which bits are still
73  /// dirty and were not cleaned by the sync.
74  ///
75  virtual void Sync(HdSceneDelegate *sceneDelegate,
76  HdRenderParam *renderParam,
77  HdDirtyBits *dirtyBits) = 0;
78 
79  /// Finalizes object resources. This function might not delete resources,
80  /// but it should deal with resource ownership so that the sprim is
81  /// deletable.
82  HD_API
83  virtual void Finalize(HdRenderParam *renderParam);
84 
85  /// Returns the minimal set of dirty bits to place in the
86  /// change tracker for use in the first sync of this prim.
87  /// Typically this would be all dirty bits.
88  virtual HdDirtyBits GetInitialDirtyBitsMask() const = 0;
89 
90 private:
91  SdfPath _id;
92 };
93 
94 
96 
97 #endif // PXR_IMAGING_HD_BPRIM_H
virtual HdDirtyBits GetInitialDirtyBitsMask() const =0
uint32_t HdDirtyBits
Definition: types.h:127
#define HD_API
Definition: api.h:40
virtual HD_API ~HdBprim()
SdfPath const & GetId() const
Definition: bprim.h:66
HD_API HdBprim(SdfPath const &id)
Definition: path.h:288
virtual void Sync(HdSceneDelegate *sceneDelegate, HdRenderParam *renderParam, HdDirtyBits *dirtyBits)=0
virtual HD_API void Finalize(HdRenderParam *renderParam)
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1346
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
Definition: bprim.h:56