Loading...
Searching...
No Matches
materialNetwork.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_NETWORK_H
25#define PXR_IMAGING_HD_ST_MATERIAL_NETWORK_H
26
27#include "pxr/pxr.h"
28#include "pxr/imaging/hdSt/api.h"
29#include "pxr/imaging/hd/enums.h"
30#include "pxr/imaging/hd/material.h"
31#include "pxr/imaging/hdSt/textureIdentifier.h"
33
34PXR_NAMESPACE_OPEN_SCOPE
35
37using HioGlslfxSharedPtr = std::shared_ptr<class HioGlslfx>;
38using HdSt_MaterialParamVector = std::vector<class HdSt_MaterialParam>;
39
45{
46public:
47 HDST_API
49
50 HDST_API
52
55 HDST_API
57 SdfPath const& materialId,
58 HdMaterialNetworkMap const& hdNetworkMap,
59 HdStResourceRegistry *resourceRegistry);
60
61 HDST_API
62 TfToken const& GetMaterialTag() const;
63
64 HDST_API
65 std::string const& GetFragmentCode() const;
66
67 HDST_API
68 std::string const& GetVolumeCode() const;
69
70 HDST_API
71 std::string const& GetGeometryCode() const;
72
73 HDST_API
74 std::string const& GetDisplacementCode() const;
75
76 HDST_API
77 VtDictionary const& GetMetadata() const;
78
79 HDST_API
80 HdSt_MaterialParamVector const& GetMaterialParams() const;
81
82 // Information necessary to allocate a texture.
83 struct TextureDescriptor
84 {
85 // Name by which the texture will be accessed, i.e., the name
86 // of the accesor for thexture will be HdGet_name(...).
87 // It is generated from the input name the corresponding texture
88 // node is connected to.
89 TfToken name;
90 HdStTextureIdentifier textureId;
91 HdTextureType type;
92 HdSamplerParameters samplerParameters;
93 // Memory request in bytes.
94 size_t memoryRequest;
95
96 // The texture is not just identified by a file path attribute
97 // on the texture prim but there is special API to texture prim
98 // to obtain the texture.
99 //
100 // This is used for draw targets.
101 bool useTexturePrimToFindTexture;
102 // This is used for draw targets and hashing.
103 SdfPath texturePrim;
104 };
105
106 using TextureDescriptorVector = std::vector<TextureDescriptor>;
107
108 HDST_API
109 TextureDescriptorVector const& GetTextureDescriptors() const;
110
111private:
112 TfToken _materialTag;
113 std::string _fragmentSource;
114 std::string _volumeSource;
115 std::string _geometrySource;
116 std::string _displacementSource;
117 VtDictionary _materialMetadata;
118 HdSt_MaterialParamVector _materialParams;
119 TextureDescriptorVector _textureDescriptors;
120 HioGlslfxSharedPtr _surfaceGfx;
121 size_t _surfaceGfxHash;
122};
123
124
125
126PXR_NAMESPACE_CLOSE_SCOPE
127
128#endif
Collection of standard parameters such as wrap modes to sample a texture.
Definition: types.h:127
Helps HdStMaterial process a Hydra material network into shader source code and parameters values.
HDST_API void ProcessMaterialNetwork(SdfPath const &materialId, HdMaterialNetworkMap const &hdNetworkMap, HdStResourceRegistry *resourceRegistry)
Process a material network topology and extract all the information we need from it.
A central registry of all GPU resources.
Class to identify a texture file or a texture within the texture file (e.g., a frame in a movie).
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:290
Token for efficient comparison, assignment, and hashing of known strings.
Definition: token.h:88
A map with string keys and VtValue values.
Definition: dictionary.h:60
Describes a map from network type to network.
Definition: material.h:129