All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
shaderDefUtils.h
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 
31 #include "pxr/usd/ndr/nodeDiscoveryResult.h"
32 
33 #include <string>
34 
35 PXR_NAMESPACE_OPEN_SCOPE
36 
37 class UsdShadeShader;
38 
45 public:
63  USDSHADE_API
64  static bool SplitShaderIdentifier(const TfToken &identifier,
65  TfToken *familyName,
66  TfToken *implementationName,
67  NdrVersion *version);
68 
76  USDSHADE_API
77  static NdrNodeDiscoveryResultVec GetNodeDiscoveryResults(
78  const UsdShadeShader &shaderDef,
79  const std::string &sourceUri);
80 
84  USDSHADE_API
85  static NdrPropertyUniquePtrVec GetShaderProperties(
86  const UsdShadeConnectableAPI &shaderDef);
87 
91  USDSHADE_API
92  static std::string GetPrimvarNamesMetadataString(
93  const NdrTokenMap metadata,
94  const UsdShadeConnectableAPI &shaderDef);
95 };
96 
97 PXR_NAMESPACE_CLOSE_SCOPE
98 
99 #endif
static USDSHADE_API std::string GetPrimvarNamesMetadataString(const NdrTokenMap metadata, const UsdShadeConnectableAPI &shaderDef)
Collects all the names of valid primvar inputs of the given metadata and the given shaderDef and retu...
static USDSHADE_API bool SplitShaderIdentifier(const TfToken &identifier, TfToken *familyName, TfToken *implementationName, NdrVersion *version)
Given a shader&#39;s identifier token, computes the corresponding SdrShaderNode&#39;s family name...
Token for efficient comparison, assignment, and hashing of known strings.
Definition: token.h:87
This class contains a set of utility functions used for populating the shader registry with shaders d...
UsdShadeConnectableAPI is an API schema that provides a common interface for creating outputs and mak...
static USDSHADE_API NdrNodeDiscoveryResultVec GetNodeDiscoveryResults(const UsdShadeShader &shaderDef, const std::string &sourceUri)
Returns the list of NdrNodeDiscoveryResult objects that must be added to the shader registry for the ...
Base class for all USD shaders.
Definition: shader.h:85
static USDSHADE_API NdrPropertyUniquePtrVec GetShaderProperties(const UsdShadeConnectableAPI &shaderDef)
Gets all input and output properties of the given shaderDef and translates them into NdrProperties th...