shaderMetadataHelpers.h

Go to the documentation of this file.

//
// Copyright 2018 Pixar
//
// Licensed under the terms set forth in the LICENSE.txt file available at
// https://openusd.org/license.
//
 
#ifndef PXR_USD_SDR_SHADER_METADATA_HELPERS_H
#define PXR_USD_SDR_SHADER_METADATA_HELPERS_H
 
 
#include "pxr/pxr.h"
#include "pxr/usd/sdr/api.h"
#include "pxr/base/tf/functionRef.h"
#include "pxr/base/tf/token.h"
#include "pxr/base/vt/value.h"
#include "pxr/usd/sdr/declare.h"
#include "pxr/usd/sdr/shaderNode.h"
#include "pxr/usd/sdr/shaderProperty.h"
#include "pxr/usd/sdf/valueTypeName.h"
 
#include <limits>
 
PXR_NAMESPACE_OPEN_SCOPE
 
namespace ShaderMetadataHelpers
{
    SDR_API
    bool
    IsTruthy(const TfToken& key, const SdrTokenMap& metadata);
 
    SDR_API
    std::string
    StringVal(const TfToken& key, const SdrTokenMap& metadata,
              const std::string& defaultValue = std::string());
 
    SDR_API
    TfToken
    TokenVal(const TfToken& key, const SdrTokenMap& metadata,
             const TfToken& defaultValue = TfToken());
 
    SDR_API
    int
    IntVal(const TfToken& key, const SdrTokenMap& metadata,
           int defaultValue = std::numeric_limits<int>::max());
 
    SDR_API
    SdrStringVec
    StringVecVal(const TfToken& key, const SdrTokenMap& metadata);
 
    SDR_API
    SdrTokenVec
    TokenVecVal(const TfToken& key, const SdrTokenMap& metadata);
 
    SDR_API
    SdrOptionVec
    OptionVecVal(const std::string& optionStr);
 
    SDR_API
    std::string
    CreateStringFromStringVec(const SdrStringVec& stringVec);
 
    SDR_API
    bool
    IsPropertyAnAssetIdentifier(const SdrTokenMap& metadata);
 
    SDR_API
    bool
    IsPropertyATerminal(const SdrTokenMap& metadata);
 
    SDR_API
    TfToken
    GetRoleFromMetadata(const SdrTokenMap& metadata);
 
    SDR_API
    VtValue
    ParseSdfValue(const std::string& valueStr,
                  const SdrShaderPropertyConstPtr& property,
                  std::string* err);
 
    SDR_API
    std::string
    ComputeShownIfFromMetadata(SdrShaderPropertyConstPtr property,
        const SdrShaderPropertyUniquePtrVec& allProperties,
        SdrShaderNodeConstPtr shader);
}
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#endif // PXR_USD_SDR_SHADER_METADATA_HELPERS_H