All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
rprimUtils.h
1 //
2 // Copyright 2019 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_ST_RPRIM_UTILS_H
25 #define PXR_IMAGING_HD_ST_RPRIM_UTILS_H
26 
27 #include "pxr/pxr.h"
28 #include "pxr/imaging/hdSt/api.h"
29 #include "pxr/imaging/hd/sceneDelegate.h"
30 
31 #include <boost/shared_ptr.hpp>
32 
33 #include <string>
34 
35 PXR_NAMESPACE_OPEN_SCOPE
36 
37 class HdDrawItem;
38 class HdRprim;
39 struct HdRprimSharedData;
40 class HdStDrawItem;
41 class HdStInstancer;
42 typedef boost::shared_ptr<class HdStShaderCode> HdStShaderCodeSharedPtr;
43 
44 // Get filtered primvar descriptors for drawItem
45 HdPrimvarDescriptorVector
46 HdStGetPrimvarDescriptors(
47  HdRprim const * prim,
48  HdStDrawItem const * drawItem,
49  HdSceneDelegate * delegate,
50  HdInterpolation interpolation);
51 
52 // Get filtered instancer primvar descriptors for drawItem
53 HdPrimvarDescriptorVector
54 HdStGetInstancerPrimvarDescriptors(
55  HdStInstancer const * instancer,
56  HdRprim const * prim,
57  HdStDrawItem const * drawItem,
58  HdSceneDelegate * delegate);
59 
60 // Resolves the material shader for the given prim (using a fallback
61 // material as necessary), including optional mixin shader source code.
62 HDST_API
63 HdStShaderCodeSharedPtr
64 HdStGetMaterialShader(
65  HdRprim const * prim,
66  HdSceneDelegate * delegate,
67  std::string const & mixinSource = std::string());
68 
69 // Given prim information it will create sources representing
70 // constant primvars and hand it to the resource registry.
71 HDST_API
72 void HdStPopulateConstantPrimvars(
73  HdRprim *prim,
74  HdRprimSharedData *sharedData,
75  HdSceneDelegate *delegate,
76  HdDrawItem *drawItem,
77  HdDirtyBits *dirtyBits,
78  HdPrimvarDescriptorVector const& constantPrimvars);
79 
80 PXR_NAMESPACE_CLOSE_SCOPE
81 
82 #endif // PXR_IMAGING_HD_ST_RPRIM_UTILS_H
The render engine state for a given rprim from the scene graph.
Definition: rprim.h:67
Adapter class providing data exchange with the client scene graph.
HdSt implements instancing by drawing each proto multiple times with a single draw call...
Definition: instancer.h:70
A draw item is a light-weight representation of an HdRprim&#39;s resources and material to be used for re...
Definition: drawItem.h:66