This document is for a version of USD that is under development. See this page for the current release.
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
sprim.h
1//
2// Copyright 2016 Pixar
3//
4// Licensed under the terms set forth in the LICENSE.txt file available at
5// https://openusd.org/license.
6//
7#ifndef PXR_IMAGING_HD_SPRIM_H
8#define PXR_IMAGING_HD_SPRIM_H
9
10#include "pxr/pxr.h"
11#include "pxr/imaging/hd/api.h"
12#include "pxr/imaging/hd/version.h"
13#include "pxr/imaging/hd/types.h"
14
15#include "pxr/usd/sdf/path.h"
16
17PXR_NAMESPACE_OPEN_SCOPE
18
19class HdSceneDelegate;
20class HdRenderParam;
21
35{
36public:
37 HD_API
38 HdSprim(SdfPath const & id);
39 HD_API
40 virtual ~HdSprim();
41
45 SdfPath const& GetId() const { return _id; }
46
54 virtual void Sync(HdSceneDelegate *sceneDelegate,
55 HdRenderParam *renderParam,
56 HdDirtyBits *dirtyBits) = 0;
57
61 HD_API
62 virtual void Finalize(HdRenderParam *renderParam);
63
67 virtual HdDirtyBits GetInitialDirtyBitsMask() const = 0;
68
69private:
70 SdfPath _id;
71};
72
73
74PXR_NAMESPACE_CLOSE_SCOPE
75
76#endif // PXR_IMAGING_HD_SPRIM_H
The HdRenderParam is an opaque (to core Hydra) handle, to an object that is obtained from the render ...
Adapter class providing data exchange with the client scene graph.
Sprim (state prim) is a base class of managing state for non-drawable scene entity (e....
Definition: sprim.h:35
virtual HD_API void Finalize(HdRenderParam *renderParam)
Finalizes object resources.
SdfPath const & GetId() const
Returns the identifier by which this state is known.
Definition: sprim.h:45
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...
virtual void Sync(HdSceneDelegate *sceneDelegate, HdRenderParam *renderParam, HdDirtyBits *dirtyBits)=0
Synchronizes state from the delegate to this object.
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:274