All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
materialParam.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_MATERIAL_PARAM_H
25 #define PXR_IMAGING_HD_ST_MATERIAL_PARAM_H
26 
27 #include "pxr/pxr.h"
28 #include "pxr/imaging/hdSt/api.h"
29 
30 #include "pxr/imaging/hd/enums.h"
31 #include "pxr/imaging/hd/types.h"
32 #include "pxr/usd/sdf/path.h"
33 #include "pxr/base/vt/value.h"
34 
35 #include "pxr/base/tf/token.h"
36 
37 #include <string>
38 #include <vector>
39 
40 PXR_NAMESPACE_OPEN_SCOPE
41 
42 using HdSt_MaterialParamVector = std::vector<class HdSt_MaterialParam>;
43 
44 // XXX: Docs
45 class HdSt_MaterialParam final {
46 public:
47  typedef size_t ID;
48 
49  // Indicates the kind of material parameter.
50  enum ParamType {
51  // This is a shader specified fallback value that is
52  // not connected to either a primvar or texture.
53  ParamTypeFallback,
54  // This is a parameter that is connected to a primvar.
55  ParamTypePrimvar,
56  // This is a parameter that is connected to a texture.
57  ParamTypeTexture,
58  // This is a parameter that is connected to a field reader.
59  ParamTypeField,
60  // Accesses 3d texture with potential transform and fallback under
61  // different name
62  ParamTypeFieldRedirect,
63  // Additional primvar needed by material. One that is not connected to
64  // a input parameter (ParamTypePrimvar).
65  ParamTypeAdditionalPrimvar
66  };
67 
68  HDST_API
69  HdSt_MaterialParam();
70 
71  HDST_API
72  HdSt_MaterialParam(ParamType paramType,
73  TfToken const& name,
74  VtValue const& fallbackValue,
75  SdfPath const& connection=SdfPath(),
76  TfTokenVector const& samplerCoords=TfTokenVector(),
77  HdTextureType textureType=HdTextureType::Uv,
78  std::string const& swizzle=std::string());
79 
80  // No d'tor so that we pick up the implicitly declared default
81  // move c'tor.
82 
85  HDST_API
86  static ID ComputeHash(HdSt_MaterialParamVector const &shaders);
87 
88  HDST_API
89  HdTupleType GetTupleType() const;
90 
91  bool IsField() const {
92  return paramType == ParamTypeField;
93  }
94  bool IsTexture() const {
95  return paramType == ParamTypeTexture;
96  }
97  bool IsPrimvar() const {
98  return paramType == ParamTypePrimvar;
99  }
100  bool IsFallback() const {
101  return paramType == ParamTypeFallback;
102  }
103  bool IsFieldRedirect() const {
104  return paramType == ParamTypeFieldRedirect;
105  }
106  bool IsAdditionalPrimvar() const {
107  return paramType == ParamTypeAdditionalPrimvar;
108  }
109 
110  ParamType paramType;
111  TfToken name;
112  VtValue fallbackValue;
113  SdfPath connection;
114  TfTokenVector samplerCoords;
115  HdTextureType textureType;
116  std::string swizzle;
117 };
118 
119 
120 PXR_NAMESPACE_CLOSE_SCOPE
121 
122 #endif //PXR_IMAGING_HD_ST_MATERIAL_PARAM_H
HdTupleType represents zero, one, or more values of the same HdType.
Definition: types.h:239
Token for efficient comparison, assignment, and hashing of known strings.
Definition: token.h:87
std::vector< TfToken > TfTokenVector
Convenience types.
Definition: token.h:431
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:288
Provides a container which may hold any type, and provides introspection and iteration over array typ...
Definition: value.h:174