Loading...
Searching...
No Matches
renderPassAdapter.h
Go to the documentation of this file.
1//
2// Copyright 2024 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_USD_IMAGING_USD_IMAGING_RENDER_PASS_ADAPTER_H
8#define PXR_USD_IMAGING_USD_IMAGING_RENDER_PASS_ADAPTER_H
9
11
12#include "pxr/pxr.h"
13#include "pxr/usdImaging/usdImaging/api.h"
15
16PXR_NAMESPACE_OPEN_SCOPE
17
23{
24public:
26
29 {}
30
31 USDIMAGING_API
33
34 // ---------------------------------------------------------------------- //
36 // ---------------------------------------------------------------------- //
37
38 USDIMAGING_API
39 TfTokenVector GetImagingSubprims(UsdPrim const& prim) override;
40
41 USDIMAGING_API
42 TfToken GetImagingSubprimType(
43 UsdPrim const& prim,
44 TfToken const& subprim) override;
45
46 USDIMAGING_API
47 HdContainerDataSourceHandle GetImagingSubprimData(
48 UsdPrim const& prim,
49 TfToken const& subprim,
50 const UsdImagingDataSourceStageGlobals &stageGlobals) override;
51
52 USDIMAGING_API
53 HdDataSourceLocatorSet InvalidateImagingSubprim(
54 UsdPrim const& prim,
55 TfToken const& subprim,
56 TfTokenVector const& properties,
57 UsdImagingPropertyInvalidationType invalidationType) override;
58
59 // ---------------------------------------------------------------------- //
61 // ---------------------------------------------------------------------- //
62
63 USDIMAGING_API
67 instancerContext = nullptr) override;
68
69 USDIMAGING_API
70 bool IsSupported(UsdImagingIndexProxy const* index) const override;
71
72 // ---------------------------------------------------------------------- //
74 // ---------------------------------------------------------------------- //
75
77 USDIMAGING_API
78 void TrackVariability(UsdPrim const& prim,
79 SdfPath const& cachePath,
80 HdDirtyBits* timeVaryingBits,
82 instancerContext = nullptr) const override;
83
84
86 USDIMAGING_API
87 void UpdateForTime(UsdPrim const& prim,
88 SdfPath const& cachePath,
89 UsdTimeCode time,
90 HdDirtyBits requestedBits,
92 instancerContext = nullptr) const override;
93
94 // ---------------------------------------------------------------------- //
96 // ---------------------------------------------------------------------- //
97
100 USDIMAGING_API
101 HdDirtyBits ProcessPropertyChange(UsdPrim const& prim,
102 SdfPath const& cachePath,
103 TfToken const& propertyName) override;
104
105 USDIMAGING_API
106 void MarkDirty(UsdPrim const& prim,
107 SdfPath const& cachePath,
108 HdDirtyBits dirty,
109 UsdImagingIndexProxy* index) override;
110
111 // ---------------------------------------------------------------------- //
113 // ---------------------------------------------------------------------- //
114
115 USDIMAGING_API
116 VtValue Get(UsdPrim const& prim,
117 SdfPath const& cachePath,
118 TfToken const& key,
119 UsdTimeCode time,
120 VtIntArray *outIndices) const override;
121
122protected:
123 USDIMAGING_API
124 void _RemovePrim(SdfPath const& cachePath,
125 UsdImagingIndexProxy* index) override;
126};
127
128PXR_NAMESPACE_CLOSE_SCOPE
129
130#endif // PXR_USD_IMAGING_USD_IMAGING_RENDER_PASS_ADAPTER_H
Represents a set of data source locators closed under descendancy.
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:274
Token for efficient comparison, assignment, and hashing of known strings.
Definition: token.h:71
This class is used as a context object with global stage information, that gets passed down to dataso...
This proxy class exposes a subset of the private Delegate API to PrimAdapters.
Definition: indexProxy.h:30
Base class for all PrimAdapters.
Definition: primAdapter.h:54
Delegate support for UsdRenderPass.
USDIMAGING_API void UpdateForTime(UsdPrim const &prim, SdfPath const &cachePath, UsdTimeCode time, HdDirtyBits requestedBits, UsdImagingInstancerContext const *instancerContext=nullptr) const override
Thread Safe.
USDIMAGING_API void TrackVariability(UsdPrim const &prim, SdfPath const &cachePath, HdDirtyBits *timeVaryingBits, UsdImagingInstancerContext const *instancerContext=nullptr) const override
Thread Safe.
USDIMAGING_API SdfPath Populate(UsdPrim const &prim, UsdImagingIndexProxy *index, UsdImagingInstancerContext const *instancerContext=nullptr) override
Called to populate the RenderIndex for this UsdPrim.
USDIMAGING_API bool IsSupported(UsdImagingIndexProxy const *index) const override
Returns true if the adapter can be populated into the target index.
USDIMAGING_API HdDirtyBits ProcessPropertyChange(UsdPrim const &prim, SdfPath const &cachePath, TfToken const &propertyName) override
Returns a bit mask of attributes to be udpated, or HdChangeTracker::AllDirty if the entire prim must ...
USDIMAGING_API VtValue Get(UsdPrim const &prim, SdfPath const &cachePath, TfToken const &key, UsdTimeCode time, VtIntArray *outIndices) const override
Gets the value of the parameter named key for the given prim (which has the given cache path) and giv...
UsdPrim is the sole persistent scenegraph object on a UsdStage, and is the embodiment of a "Prim" as ...
Definition: prim.h:117
Represent a time value, which may be either numeric, holding a double value, or a sentinel value UsdT...
Definition: timeCode.h:72
Provides a container which may hold any type, and provides introspection and iteration over array typ...
Definition: value.h:90
Object used by instancer prim adapters to pass along context about the instancer and instance prim to...
std::vector< TfToken > TfTokenVector
Convenience types.
Definition: token.h:440