UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FSubstrateMaterialCompilationOutput Struct Reference

#include <SubstrateMaterialShared.h>

Public Member Functions

 DECLARE_TYPE_LAYOUT (FSubstrateMaterialCompilationOutput, NonVirtual)
 
 FSubstrateMaterialCompilationOutput ()
 
 LAYOUT_FIELD (uint8, SubstrateMaterialType)
 
 LAYOUT_FIELD (uint8, SubstrateClosureCount)
 
 LAYOUT_FIELD (uint8, SubstrateUintPerPixel)
 
 LAYOUT_FIELD (ESubstrateBsdfFeature, SubstrateMaterialBsdfFeatures)
 
 LAYOUT_FIELD_EDITORONLY (FMemoryImageString, SubstrateMaterialDescription)
 
 LAYOUT_FIELD_EDITORONLY (uint8, SharedLocalBasesCount)
 
 LAYOUT_FIELD_EDITORONLY (uint8, RequestedBytePerPixel)
 
 LAYOUT_FIELD_EDITORONLY (uint8, PlatformBytePerPixel)
 
 LAYOUT_FIELD_EDITORONLY (uint8, RequestedClosurePerPixel)
 
 LAYOUT_FIELD_EDITORONLY (uint8, PlatformClosurePixel)
 
 LAYOUT_FIELD_EDITORONLY (uint8, bIsThin)
 
 LAYOUT_FIELD_EDITORONLY (uint8, MaterialType)
 
 LAYOUT_FIELD_EDITORONLY (uint8, bMaterialOutOfBudgetHasBeenSimplified, 1)
 
 LAYOUT_FIELD_EDITORONLY (uint8, bMaterialUsesLegacyGBufferDataPassThrough, 1)
 
 LAYOUT_FIELD_EDITORONLY (int8, RootOperatorIndex)
 
 LAYOUT_ARRAY_EDITORONLY (FSubstrateOperator, Operators, SUBSTRATE_COMPILATION_OUTPUT_MAX_OPERATOR)
 

Constructor & Destructor Documentation

◆ FSubstrateMaterialCompilationOutput()

FSubstrateMaterialCompilationOutput::FSubstrateMaterialCompilationOutput ( )

Member Function Documentation

◆ DECLARE_TYPE_LAYOUT()

FSubstrateMaterialCompilationOutput::DECLARE_TYPE_LAYOUT ( FSubstrateMaterialCompilationOutput  ,
NonVirtual   
)

◆ LAYOUT_ARRAY_EDITORONLY()

FSubstrateMaterialCompilationOutput::LAYOUT_ARRAY_EDITORONLY ( FSubstrateOperator  ,
Operators  ,
SUBSTRATE_COMPILATION_OUTPUT_MAX_OPERATOR   
)

◆ LAYOUT_FIELD() [1/4]

FSubstrateMaterialCompilationOutput::LAYOUT_FIELD ( ESubstrateBsdfFeature  ,
SubstrateMaterialBsdfFeatures   
)

Substrate feature used across the material (Aniso, SSS, Fuzz, ...)

◆ LAYOUT_FIELD() [2/4]

FSubstrateMaterialCompilationOutput::LAYOUT_FIELD ( uint8  ,
SubstrateClosureCount   
)

Substrate closure count, at compile time (0-7)

◆ LAYOUT_FIELD() [3/4]

FSubstrateMaterialCompilationOutput::LAYOUT_FIELD ( uint8  ,
SubstrateMaterialType   
)

Substrate material type, at compile time (Possible values from SUBSTRATE_MATERIAL_TYPE_XXX: simple/single/complex/complex special)

◆ LAYOUT_FIELD() [4/4]

FSubstrateMaterialCompilationOutput::LAYOUT_FIELD ( uint8  ,
SubstrateUintPerPixel   
)

Substrate uint per pixel, at compile time (0-255)

◆ LAYOUT_FIELD_EDITORONLY() [1/11]

FSubstrateMaterialCompilationOutput::LAYOUT_FIELD_EDITORONLY ( FMemoryImageString  ,
SubstrateMaterialDescription   
)

The Substrate verbose description

◆ LAYOUT_FIELD_EDITORONLY() [2/11]

FSubstrateMaterialCompilationOutput::LAYOUT_FIELD_EDITORONLY ( int8  ,
RootOperatorIndex   
)

◆ LAYOUT_FIELD_EDITORONLY() [3/11]

FSubstrateMaterialCompilationOutput::LAYOUT_FIELD_EDITORONLY ( uint8  ,
bIsThin   
)

Indicate that the material is considered a thin surface instead of a volume filled up with matter

◆ LAYOUT_FIELD_EDITORONLY() [4/11]

FSubstrateMaterialCompilationOutput::LAYOUT_FIELD_EDITORONLY ( uint8  ,
bMaterialOutOfBudgetHasBeenSimplified  ,
 
)

The byte per pixel count supported by the platform the material has been compiled against

◆ LAYOUT_FIELD_EDITORONLY() [5/11]

FSubstrateMaterialCompilationOutput::LAYOUT_FIELD_EDITORONLY ( uint8  ,
bMaterialUsesLegacyGBufferDataPassThrough  ,
 
)

True if the blendable GBuffer is used by Substrate and the Front material pin is not plugged in: in this case we can passthough substrate and use legacy base pass material shader.

◆ LAYOUT_FIELD_EDITORONLY() [6/11]

FSubstrateMaterialCompilationOutput::LAYOUT_FIELD_EDITORONLY ( uint8  ,
MaterialType   
)

Indicate the final material type

◆ LAYOUT_FIELD_EDITORONLY() [7/11]

FSubstrateMaterialCompilationOutput::LAYOUT_FIELD_EDITORONLY ( uint8  ,
PlatformBytePerPixel   
)

The byte count per pixel supported by the platform the material has been compiled against

◆ LAYOUT_FIELD_EDITORONLY() [8/11]

FSubstrateMaterialCompilationOutput::LAYOUT_FIELD_EDITORONLY ( uint8  ,
PlatformClosurePixel   
)

The closure count per pixel supported by the platform the material has been compiled against

◆ LAYOUT_FIELD_EDITORONLY() [9/11]

FSubstrateMaterialCompilationOutput::LAYOUT_FIELD_EDITORONLY ( uint8  ,
RequestedBytePerPixel   
)

Material requested byte count per pixel

◆ LAYOUT_FIELD_EDITORONLY() [10/11]

FSubstrateMaterialCompilationOutput::LAYOUT_FIELD_EDITORONLY ( uint8  ,
RequestedClosurePerPixel   
)

Material requested closure count per pixel

◆ LAYOUT_FIELD_EDITORONLY() [11/11]

FSubstrateMaterialCompilationOutput::LAYOUT_FIELD_EDITORONLY ( uint8  ,
SharedLocalBasesCount   
)

The number of local normal/tangent bases


The documentation for this struct was generated from the following files: