MaterialExternalCodeRegistry.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
/*=============================================================================
    MaterialExternalCodeRegistry.h: External HLSL code declarations.
=============================================================================*/
 
#pragma once
 
#include "CoreMinimal.h"
#include "Materials/HLSLMaterialDerivativeAutogen.h"
#include "Materials/MaterialExpressionViewProperty.h"
#include "RHIDefinitions.h"
#include "RHIFeatureLevel.h"
 
#include "MaterialExternalCodeRegistry.generated.h"
 
UENUM(Flags)
enum class EMaterialShaderFrequency : uint8
{
    Vertex  = 1 << SF_Vertex,
    Pixel   = 1 << SF_Pixel,
    Compute = 1 << SF_Compute,
    Any     = Vertex | Pixel | Compute,
};
ENUM_CLASS_FLAGS(EMaterialShaderFrequency);
 
UENUM()
enum class EMaterialFeatureLevel : uint8
{
    ES2_REMOVED = ERHIFeatureLevel::ES2_REMOVED,
    ES3_1 = ERHIFeatureLevel::ES3_1,
    SM4_REMOVED = ERHIFeatureLevel::SM4_REMOVED,
    SM5 = ERHIFeatureLevel::SM5,
    SM6 = ERHIFeatureLevel::SM6,
    Num
};
static_assert((uint8)ERHIFeatureLevel::Num == (uint8)EMaterialFeatureLevel::Num);
 
UENUM(Flags)
enum class EMaterialValueTypeBridge : uint64
{
    Float1              = MCT_Float1,
    Float2              = MCT_Float2,
    Float3              = MCT_Float3,
    Float4              = MCT_Float4,
    Texture2D           = MCT_Texture2D UMETA(Hidden),
    TextureCube         = MCT_TextureCube UMETA(Hidden),
    Texture2DArray      = MCT_Texture2DArray UMETA(Hidden),
    TextureCubeArray    = MCT_TextureCubeArray UMETA(Hidden),
    VolumeTexture       = MCT_VolumeTexture UMETA(Hidden),
    StaticBool          = MCT_StaticBool UMETA(Hidden),
    Unknown             = MCT_Unknown UMETA(Hidden),
    MaterialAttributes  = MCT_MaterialAttributes UMETA(Hidden),
    TextureExternal     = MCT_TextureExternal UMETA(Hidden),
    TextureVirtual      = MCT_TextureVirtual UMETA(Hidden),
    SparseVolumeTexture = MCT_SparseVolumeTexture UMETA(Hidden),
    VTPageTableResult   = MCT_VTPageTableResult UMETA(Hidden),
    ShadingModel        = MCT_ShadingModel UMETA(Hidden),
    Substrate           = MCT_Substrate UMETA(Hidden),
    LWCScalar           = MCT_LWCScalar UMETA(Hidden),
    LWCVector2          = MCT_LWCVector2 UMETA(Hidden),
    LWCVector3          = MCT_LWCVector3 UMETA(Hidden),
    LWCVector4          = MCT_LWCVector4 UMETA(Hidden),
    Execution           = MCT_Execution UMETA(Hidden),
    VoidStatement       = MCT_VoidStatement UMETA(Hidden),
    Bool                = MCT_Bool UMETA(Hidden),
    UInt1               = MCT_UInt1 UMETA(Hidden),
    UInt2               = MCT_UInt2 UMETA(Hidden),
    UInt3               = MCT_UInt3 UMETA(Hidden),
    UInt4               = MCT_UInt4 UMETA(Hidden),
    TextureCollection   = MCT_TextureCollection UMETA(Hidden),
    TextureMeshPaint    = MCT_TextureMeshPaint,
    TextureMaterialCache= MCT_TextureMaterialCache,
    Texture             = MCT_Texture UMETA(Hidden),
    Float               = MCT_Float,
    UInt                = MCT_UInt UMETA(Hidden),
    LWCType             = MCT_LWCType UMETA(Hidden),
    Numeric             = MCT_Numeric UMETA(Hidden),
    Float3x3            = MCT_Float3x3,
    Float4x4            = MCT_Float4x4,
    LWCMatrix           = MCT_LWCMatrix,
};
 
USTRUCT()
struct FMaterialExternalCodeEnvironmentDefine
{
    GENERATED_BODY();
 
    UPROPERTY(Config)
    FName Name;
 
    UPROPERTY(Config)
    EMaterialShaderFrequency ShaderFrequency = EMaterialShaderFrequency::Any;
 
    void UpdateHash(FSHA1& Hasher) const;
};
 
USTRUCT()
struct FMaterialExternalCodeDeclaration
{
    GENERATED_BODY()
 
public:
    UPROPERTY(Config)
    uint32 bIsInlined:1 = false;
 
    UPROPERTY(Config)
    EMaterialValueTypeBridge ReturnType = EMaterialValueTypeBridge::Unknown;
 
    UPROPERTY(Config)
    FName Name;
 
    UPROPERTY(Config)
    FString Definition;
 
    UPROPERTY(Config)
    FString DefinitionDDX;
 
    UPROPERTY(Config)
    FString DefinitionDDY;
 
    UPROPERTY(Config)
    EDerivativeStatus Derivative = EDerivativeStatus::NotAware;
 
    UPROPERTY(Config)
    EMaterialShaderFrequency ShaderFrequency = EMaterialShaderFrequency::Any;
 
    UPROPERTY(Config)
    TArray<TEnumAsByte<EMaterialDomain>> Domains;
 
    UPROPERTY(Config)
    TArray<FMaterialExternalCodeEnvironmentDefine> EnvironmentDefines;
 
    UPROPERTY(Config)
    EMaterialFeatureLevel MinimumFeatureLevel = (EMaterialFeatureLevel)0;       // Default is lowest feature level (zero), whatever that is in the enum
 
public:
    inline EMaterialValueType GetReturnTypeValue() const
    {
        return (EMaterialValueType)ReturnType;
    }
 
    void UpdateHash(FSHA1& Hasher) const;
};
 
UCLASS(Config=MaterialExpressions)
class UMaterialExternalCodeCollection : public UObject
{
    GENERATED_BODY()
 
public:
    UPROPERTY(Config)
    TArray<FMaterialExternalCodeDeclaration> ExternalCodeDeclarations;
 
public:
    virtual void PostInitProperties() override;
 
};
 
struct FMaterialExposedViewPropertyMeta
{
    EMaterialExposedViewProperty EnumValue;
    EMaterialValueType Type;
    FStringView PropertyCode;
    FStringView InvPropertyCode;
};
 
class MaterialExternalCodeRegistry
{
public:
    MaterialExternalCodeRegistry(const MaterialExternalCodeRegistry&) = delete;
    MaterialExternalCodeRegistry& operator = (const MaterialExternalCodeRegistry&) = delete;
 
    static MaterialExternalCodeRegistry& Get();
 
    const FMaterialExternalCodeDeclaration* FindExternalCode(const FName& InExternalCodeIdentifier) const;
 
    const FMaterialExposedViewPropertyMeta& GetExternalViewPropertyCode(const EMaterialExposedViewProperty InViewProperty) const;
 
private:
    MaterialExternalCodeRegistry();
 
    void BuildMapToExternalDeclarations();
 
    TMap<FName, const FMaterialExternalCodeDeclaration*> ExternalCodeDeclarationMap;
 
};