Files
UnrealEngine/Engine/Source/ThirdParty/MaterialX/Deploy/MaterialX-1.38.10/include/MaterialXGenMdl/MdlSyntax.h
2025-05-18 13:04:45 +08:00

84 lines
2.9 KiB
C++

//
// Copyright Contributors to the MaterialX Project
// SPDX-License-Identifier: Apache-2.0
//
#ifndef MATERIALX_MDLSYNTAX_H
#define MATERIALX_MDLSYNTAX_H
/// @file
/// MDL syntax class
#include <MaterialXGenMdl/Export.h>
#include <MaterialXGenShader/Syntax.h>
MATERIALX_NAMESPACE_BEGIN
class MdlSyntax;
/// Shared pointer to an MdlSyntax
using MdlSyntaxPtr = shared_ptr<MdlSyntax>;
/// @class MdlSyntax
/// Syntax class for MDL (Material Definition Language)
class MX_GENMDL_API MdlSyntax : public Syntax
{
public:
MdlSyntax();
static SyntaxPtr create() { return std::make_shared<MdlSyntax>(); }
const string& getConstantQualifier() const override { return CONST_QUALIFIER; };
const string& getUniformQualifier() const override { return UNIFORM_QUALIFIER; };
const string& getSourceFileExtension() const override { return SOURCE_FILE_EXTENSION; };
string getSwizzledVariable(const string& srcName, const TypeDesc* srcType, const string& channels, const TypeDesc* dstType) const override;
/// Override to return array type suffix.
string getArrayTypeSuffix(const TypeDesc* type, const Value& value) const override;
/// Override to indicate array variables have no array suffix.
string getArrayVariableSuffix(const TypeDesc*, const Value&) const override { return EMPTY_STRING; };
static const string CONST_QUALIFIER;
static const string UNIFORM_QUALIFIER;
static const string SOURCE_FILE_EXTENSION;
static const StringVec VECTOR2_MEMBERS;
static const StringVec VECTOR3_MEMBERS;
static const StringVec VECTOR4_MEMBERS;
static const StringVec COLOR3_MEMBERS;
static const StringVec COLOR4_MEMBERS;
static const StringVec ADDRESSMODE_MEMBERS;
static const StringVec COORDINATESPACE_MEMBERS;
static const StringVec FILTERLOOKUPMODE_MEMBERS;
static const StringVec FILTERTYPE_MEMBERS;
static const StringVec DISTRIBUTIONTYPE_MEMBERS;
static const StringVec SCATTER_MODE_MEMBERS;
/// Get an type description for an enumeration based on member value
const TypeDesc* getEnumeratedType(const string& value) const;
/// Given an input specification attempt to remap this to an enumeration which is accepted by
/// the shader generator. The enumeration may be converted to a different type than the input.
bool remapEnumeration(const string& value, const TypeDesc* type, const string& enumNames, std::pair<const TypeDesc*, ValuePtr>& result) const override;
/// Modify the given name string to remove any invalid characters or tokens.
void makeValidName(string& name) const override;
};
namespace Type
{
extern MX_GENMDL_API const TypeDesc* MDL_ADDRESSMODE;
extern MX_GENMDL_API const TypeDesc* MDL_COORDINATESPACE;
extern MX_GENMDL_API const TypeDesc* MDL_FILTERLOOKUPMODE;
extern MX_GENMDL_API const TypeDesc* MDL_FILTERTYPE;
extern MX_GENMDL_API const TypeDesc* MDL_DISTRIBUTIONTYPE;
} // namespace Type
MATERIALX_NAMESPACE_END
#endif