HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
shaderDefUtils.h
Go to the documentation of this file.
1 //
2 // Copyright 2018 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_USD_USD_SHADE_SHADER_DEF_UTILS_H
25 #define PXR_USD_USD_SHADE_SHADER_DEF_UTILS_H
26 
27 #include "pxr/pxr.h"
28 #include "pxr/usd/usdShade/api.h"
30 
32 
33 #include <string>
34 
36 
37 class UsdShadeShader;
38 
39 /// \class UsdShadeShaderDefUtils
40 ///
41 /// This class contains a set of utility functions used for populating the
42 /// shader registry with shaders definitions specified using UsdShade schemas.
43 ///
45 public:
46  /// Returns the list of NdrNodeDiscoveryResult objects that must be added
47  /// to the shader registry for the given shader \p shaderDef, assuming it
48  /// is found in a shader definition file found by an Ndr discovery plugin.
49  ///
50  /// To enable the shaderDef parser to find and parse this shader,
51  /// \p sourceUri should have the resolved path to the usd file containing
52  /// this shader prim.
55  const UsdShadeShader &shaderDef,
56  const std::string &sourceUri);
57 
58  /// Gets all input and output properties of the given \p shaderDef and
59  /// translates them into NdrProperties that can be used as the properties
60  /// for an SdrShaderNode.
63  const UsdShadeConnectableAPI &shaderDef);
64 
65  /// Collects all the names of valid primvar inputs of the given \p metadata
66  /// and the given \p shaderDef and returns the string used to represent
67  /// them in SdrShaderNode metadata.
70  const NdrTokenMap metadata,
71  const UsdShadeConnectableAPI &shaderDef);
72 };
73 
75 
76 #endif
#define USDSHADE_API
Definition: api.h:40
static USDSHADE_API std::string GetPrimvarNamesMetadataString(const NdrTokenMap metadata, const UsdShadeConnectableAPI &shaderDef)
GLsizei const GLchar *const * string
Definition: glcorearb.h:814
std::vector< NdrNodeDiscoveryResult > NdrNodeDiscoveryResultVec
std::vector< NdrPropertyUniquePtr > NdrPropertyUniquePtrVec
Definition: declare.h:67
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1432
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
static USDSHADE_API NdrPropertyUniquePtrVec GetShaderProperties(const UsdShadeConnectableAPI &shaderDef)
static USDSHADE_API NdrNodeDiscoveryResultVec GetNodeDiscoveryResults(const UsdShadeShader &shaderDef, const std::string &sourceUri)
std::unordered_map< TfToken, std::string, TfToken::HashFunctor > NdrTokenMap
Definition: declare.h:61