HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
materialNetwork.h
Go to the documentation of this file.
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_NETWORK_H
25 #define PXR_IMAGING_HD_ST_MATERIAL_NETWORK_H
26 
27 #include "pxr/pxr.h"
28 #include "pxr/imaging/hdSt/api.h"
31 
33 
35 using HioGlslfxSharedPtr = std::shared_ptr<class HioGlslfx>;
36 using HdSt_MaterialParamVector = std::vector<class HdSt_MaterialParam>;
37 
38 /// \class HdStMaterialNetwork
39 ///
40 /// Helps HdStMaterial process a Hydra material network into shader source code
41 /// and parameters values.
43 {
44 public:
45  HDST_API
47 
48  HDST_API
50 
51  /// Process a material network topology and extract all the information we
52  /// need from it.
53  HDST_API
55  SdfPath const& materialId,
56  HdMaterialNetworkMap const& hdNetworkMap,
57  HdStResourceRegistry *resourceRegistry);
58 
59  HDST_API
60  TfToken const& GetMaterialTag() const;
61 
62  HDST_API
63  std::string const& GetFragmentCode() const;
64 
65  HDST_API
66  std::string const& GetGeometryCode() const;
67 
68  HDST_API
69  VtDictionary const& GetMetadata() const;
70 
71  HDST_API
73 
74  // Information necessary to allocate a texture.
76  {
77  // Name by which the texture will be accessed, i.e., the name
78  // of the accesor for thexture will be HdGet_name(...).
79  // It is generated from the input name the corresponding texture
80  // node is connected to.
85  // Memory request in bytes.
86  size_t memoryRequest;
87 
88  // The texture is not just identified by a file path attribute
89  // on the texture prim but there is special API to texture prim
90  // to obtain the texture.
91  //
92  // This is used for draw targets.
94  // This is used for draw targets and hashing.
96  };
97 
98  using TextureDescriptorVector = std::vector<TextureDescriptor>;
99 
100  HDST_API
102 
103 private:
104  TfToken _materialTag;
105  std::string _fragmentSource;
106  std::string _geometrySource;
107  VtDictionary _materialMetadata;
108  HdSt_MaterialParamVector _materialParams;
109  TextureDescriptorVector _textureDescriptors;
110  HioGlslfxSharedPtr _surfaceGfx;
111  size_t _surfaceGfxHash;
112 };
113 
114 
115 
117 
118 #endif
HDST_API void ProcessMaterialNetwork(SdfPath const &materialId, HdMaterialNetworkMap const &hdNetworkMap, HdStResourceRegistry *resourceRegistry)
HDST_API VtDictionary const & GetMetadata() const
HDST_API std::string const & GetGeometryCode() const
HDST_API TextureDescriptorVector const & GetTextureDescriptors() const
HDST_API ~HdStMaterialNetwork()
HDST_API std::string const & GetFragmentCode() const
Definition: token.h:87
GLsizei const GLchar *const * string
Definition: glcorearb.h:813
HdTextureType
Definition: enums.h:221
HDST_API HdSt_MaterialParamVector const & GetMaterialParams() const
Definition: path.h:288
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1375
#define HDST_API
Definition: api.h:40
HDST_API HdStMaterialNetwork()
std::shared_ptr< class HioGlslfx > HioGlslfxSharedPtr
Definition: glslfxShader.h:34
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
HDST_API TfToken const & GetMaterialTag() const
std::vector< TextureDescriptor > TextureDescriptorVector
std::vector< class HdSt_MaterialParam > HdSt_MaterialParamVector