![]() |
UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
|
#include "Field/FieldSystemTypes.h"#include "Misc/MessageDialog.h"#include "UObject/AssetRegistryTagsContext.h"#include "UObject/LinkerLoad.h"#include "UObject/FortniteMainBranchObjectVersion.h"#include "UObject/UE5MainStreamObjectVersion.h"#include "Internationalization/LocKeyFuncs.h"#include "UObject/NaniteResearchStreamObjectVersion.h"#include "Materials/MaterialExpressionChannelMaskParameterColor.h"#include "UObject/UObjectAnnotation.h"#include "RenderUtils.h"#include "UObject/UObjectIterator.h"#include "UObject/Package.h"#include "SubstrateDefinitions.h"#include "UObject/ConstructorHelpers.h"#include "Engine/Engine.h"#include "Engine/Font.h"#include "DataDrivenShaderPlatformInfo.h"#include "MaterialDomain.h"#include "MaterialShared.h"#include "MaterialSharedPrivate.h"#include "Materials/HLSLMaterialTranslator.h"#include "Materials/MaterialAttributeDefinitionMap.h"#include "Materials/MaterialExpressionMaterialAttributeLayers.h"#include "Materials/MaterialExpressionLayerStack.h"#include "Materials/MaterialExpressionMaterialFunctionCall.h"#include "Materials/MaterialFunction.h"#include "Materials/MaterialFunctionMaterialLayer.h"#include "Materials/MaterialFunctionMaterialLayerBlend.h"#include "Materials/MaterialFunctionInstance.h"#include "Materials/MaterialInstanceSupport.h"#include "Materials/MaterialParameterCollection.h"#include "Engine/TextureCube.h"#include "Engine/Texture2DArray.h"#include "Engine/TextureCubeArray.h"#include "Engine/VolumeTexture.h"#include "Engine/SubsurfaceProfile.h"#include "Serialization/ObjectWriter.h"#include "Serialization/ObjectReader.h"#include "VT/RuntimeVirtualTexture.h"#include "SparseVolumeTexture/SparseVolumeTexture.h"#include "ProfilingDebugging/LoadTimeTracker.h"#include "ColorManagement/ColorSpace.h"#include "Containers/Array.h"#include "Logging/StructuredLog.h"#include "Materials/MaterialExpressionAbs.h"#include "Materials/MaterialExpressionAbsorptionMediumMaterialOutput.h"#include "Materials/MaterialExpressionActorPositionWS.h"#include "Materials/MaterialExpressionAdd.h"#include "Materials/MaterialExpressionAppendVector.h"#include "Materials/MaterialExpressionArccosine.h"#include "Materials/MaterialExpressionArccosineFast.h"#include "Materials/MaterialExpressionArcsine.h"#include "Materials/MaterialExpressionArcsineFast.h"#include "Materials/MaterialExpressionArctangent.h"#include "Materials/MaterialExpressionArctangentFast.h"#include "Materials/MaterialExpressionArctangent2.h"#include "Materials/MaterialExpressionArctangent2Fast.h"#include "Materials/MaterialExpressionAtmosphericFogColor.h"#include "Materials/MaterialExpressionBentNormalCustomOutput.h"#include "Materials/MaterialExpressionBindlessSwitch.h"#include "Materials/MaterialExpressionBlackBody.h"#include "Materials/MaterialExpressionBlend.h"#include "Materials/MaterialExpressionBlendMaterialAttributes.h"#include "Materials/MaterialExpressionBreakMaterialAttributes.h"#include "Materials/MaterialExpressionBumpOffset.h"#include "Materials/MaterialExpressionCameraPositionWS.h"#include "Materials/MaterialExpressionCameraVectorWS.h"#include "Materials/MaterialExpressionCeil.h"#include "Materials/MaterialExpressionChannelMaskParameter.h"#include "Materials/MaterialExpressionClamp.h"#include "Materials/MaterialExpressionCollectionParameter.h"#include "Materials/MaterialExpressionCollectionTransform.h"#include "Materials/MaterialExpressionColorRamp.h"#include "Materials/MaterialExpressionComment.h"#include "Materials/MaterialExpressionComposite.h"#include "Materials/MaterialExpressionComponentMask.h"#include "Materials/MaterialExpressionConstant.h"#include "Materials/MaterialExpressionConstant2Vector.h"#include "Materials/MaterialExpressionConstant3Vector.h"#include "Materials/MaterialExpressionConstant4Vector.h"#include "Materials/MaterialExpressionConstantBiasScale.h"#include "Materials/MaterialExpressionConvert.h"#include "Materials/MaterialExpressionCosine.h"#include "Materials/MaterialExpressionCrossProduct.h"#include "Materials/MaterialExpressionCustom.h"#include "Materials/MaterialExpressionDBufferTexture.h"#include "Materials/MaterialExpressionDDX.h"#include "Materials/MaterialExpressionDDY.h"#include "Materials/MaterialExpressionDecalColor.h"#include "Materials/MaterialExpressionDecalDerivative.h"#include "Materials/MaterialExpressionDecalLifetimeOpacity.h"#include "Materials/MaterialExpressionDecalMipmapLevel.h"#include "Materials/MaterialExpressionDepthFade.h"#include "Materials/MaterialExpressionDepthOfFieldFunction.h"#include "Materials/MaterialExpressionDeriveNormalZ.h"#include "Materials/MaterialExpressionDesaturation.h"#include "Materials/MaterialExpressionDistance.h"#include "Materials/MaterialExpressionDistanceCullFade.h"#include "Materials/MaterialExpressionDistanceFieldsRenderingSwitch.h"#include "Materials/MaterialExpressionDivide.h"#include "Materials/MaterialExpressionDotProduct.h"#include "Materials/MaterialExpressionDynamicParameter.h"#include "Materials/MaterialExpressionExternalCodeBase.h"#include "Materials/MaterialExpressionCloudLayer.h"#include "Materials/MaterialExpressionCustomOutput.h"#include "Materials/MaterialExpressionEyeAdaptation.h"#include "Materials/MaterialExpressionEyeAdaptationInverse.h"#include "Materials/MaterialExpressionFeatureLevelSwitch.h"#include "Materials/MaterialExpressionDataDrivenShaderPlatformInfoSwitch.h"#include "Materials/MaterialExpressionRequiredSamplersSwitch.h"#include "Materials/MaterialExpressionFloor.h"#include "Materials/MaterialExpressionFloatToUInt.h"#include "Materials/MaterialExpressionFmod.h"#include "Materials/MaterialExpressionFontSignedDistance.h"#include "Materials/MaterialExpressionFontSample.h"#include "Materials/MaterialExpressionFontSampleParameter.h"#include "Materials/MaterialExpressionFrac.h"#include "Materials/MaterialExpressionFresnel.h"#include "Materials/MaterialExpressionFunctionInput.h"#include "Materials/MaterialExpressionFunctionOutput.h"#include "Materials/MaterialExpressionGIReplace.h"#include "Materials/MaterialExpressionRayTracingQualitySwitch.h"#include "Materials/MaterialExpressionPathTracingQualitySwitch.h"#include "Materials/MaterialExpressionPathTracingRayTypeSwitch.h"#include "Materials/MaterialExpressionPathTracingBufferTexture.h"#include "Materials/MaterialExpressionGetMaterialAttributes.h"#include "Materials/MaterialExpressionHairAttributes.h"#include "Materials/MaterialExpressionHairColor.h"#include "Materials/MaterialExpressionIf.h"#include "Materials/MaterialExpressionInverseLinearInterpolate.h"#include "Materials/MaterialExpressionLightmapUVs.h"#include "Materials/MaterialExpressionMeshPaintTextureCoordinateIndex.h"#include "Materials/MaterialExpressionMeshPaintTextureObject.h"#include "Materials/MaterialExpressionMeshPaintTextureReplace.h"#include "Materials/MaterialExpressionPrecomputedAOMask.h"#include "Materials/MaterialExpressionLightmassReplace.h"#include "Materials/MaterialExpressionLightVector.h"#include "Materials/MaterialExpressionLinearInterpolate.h"#include "Materials/MaterialExpressionRgbToHsv.h"#include "Materials/MaterialExpressionHsvToRgb.h"#include "Materials/MaterialExpressionExponential.h"#include "Materials/MaterialExpressionExponential2.h"#include "Materials/MaterialExpressionLength.h"#include "Materials/MaterialExpressionLocalPosition.h"#include "Materials/MaterialExpressionLogarithm.h"#include "Materials/MaterialExpressionLogarithm2.h"#include "Materials/MaterialExpressionLogarithm10.h"#include "Materials/MaterialExpressionMakeMaterialAttributes.h"#include "Materials/MaterialExpressionMax.h"#include "Materials/MaterialExpressionMaterialProxyReplace.h"#include "Materials/MaterialExpressionMin.h"#include "Materials/MaterialExpressionModulo.h"#include "Materials/MaterialExpressionMultiply.h"#include "Materials/MaterialExpressionNaniteReplace.h"#include "Materials/MaterialExpressionMaterialCache.h"#include "Materials/MaterialExpressionNormalize.h"#include "Materials/MaterialExpressionNeuralPostProcessNode.h"#include "Materials/MaterialExpressionObjectBounds.h"#include "Materials/MaterialExpressionObjectLocalBounds.h"#include "Materials/MaterialExpressionObjectOrientation.h"#include "Materials/MaterialExpressionObjectPositionWS.h"#include "Materials/MaterialExpressionObjectRadius.h"#include "Materials/MaterialExpressionBounds.h"#include "Materials/MaterialExpressionOneMinus.h"#include "Materials/MaterialExpressionPanner.h"#include "Materials/MaterialExpressionParameter.h"#include "Materials/MaterialExpressionPinBase.h"#include "Materials/MaterialExpressionPreSkinnedLocalBounds.h"#include "Materials/MaterialExpressionPreviousFrameSwitch.h"#include "Materials/MaterialExpressionRerouteBase.h"#include "Materials/MaterialExpressionReroute.h"#include "Materials/MaterialExpressionNamedReroute.h"#include "Materials/MaterialExpressionScalarParameter.h"#include "Materials/MaterialExpressionSetMaterialAttributes.h"#include "Materials/MaterialExpressionShadowReplace.h"#include "Materials/MaterialExpressionSign.h"#include "Materials/MaterialExpressionStaticBoolParameter.h"#include "Materials/MaterialExpressionStaticSwitchParameter.h"#include "Materials/MaterialExpressionStaticComponentMaskParameter.h"#include "Materials/MaterialExpressionSubsurfaceMediumMaterialOutput.h"#include "Materials/MaterialExpressionVectorParameter.h"#include "Materials/MaterialExpressionDoubleVectorParameter.h"#include "Materials/MaterialExpressionParticleColor.h"#include "Materials/MaterialExpressionParticleDirection.h"#include "Materials/MaterialExpressionParticleMacroUV.h"#include "Materials/MaterialExpressionParticleMotionBlurFade.h"#include "Materials/MaterialExpressionParticleRandom.h"#include "Materials/MaterialExpressionParticlePositionWS.h"#include "Materials/MaterialExpressionParticleRadius.h"#include "Materials/MaterialExpressionParticleRelativeTime.h"#include "Materials/MaterialExpressionParticleSize.h"#include "Materials/MaterialExpressionParticleSpriteRotation.h"#include "Materials/MaterialExpressionParticleSpeed.h"#include "Materials/MaterialExpressionPerInstanceFadeAmount.h"#include "Materials/MaterialExpressionPerInstanceRandom.h"#include "Materials/MaterialExpressionPerInstanceCustomData.h"#include "Materials/MaterialExpressionPixelDepth.h"#include "Materials/MaterialExpressionPixelNormalWS.h"#include "Materials/MaterialExpressionPostVolumeUserFlagTest.h"#include "Materials/MaterialExpressionPower.h"#include "Materials/MaterialExpressionPreSkinnedNormal.h"#include "Materials/MaterialExpressionPreSkinnedPosition.h"#include "Materials/MaterialExpressionQualitySwitch.h"#include "Materials/MaterialExpressionShadingPathSwitch.h"#include "Materials/MaterialExpressionReflectionVectorWS.h"#include "Materials/MaterialExpressionRotateAboutAxis.h"#include "Materials/MaterialExpressionRotator.h"#include "Materials/MaterialExpressionRound.h"#include "Materials/MaterialExpressionRuntimeVirtualTextureCustomData.h"#include "Materials/MaterialExpressionRuntimeVirtualTextureOutput.h"#include "Materials/MaterialExpressionRuntimeVirtualTextureReplace.h"#include "Materials/MaterialExpressionRuntimeVirtualTextureSample.h"#include "Materials/MaterialExpressionRuntimeVirtualTextureSampleParameter.h"#include "Materials/MaterialExpressionVirtualTextureFeatureSwitch.h"#include "Materials/MaterialExpressionSaturate.h"#include "Materials/MaterialExpressionSceneColor.h"#include "Materials/MaterialExpressionSceneDepth.h"#include "Materials/MaterialExpressionSceneDepthWithoutWater.h"#include "Materials/MaterialExpressionSceneTexelSize.h"#include "Materials/MaterialExpressionSceneTexture.h"#include "Materials/MaterialExpressionScreenPosition.h"#include "Materials/MaterialExpressionShadingModel.h"#include "Materials/MaterialExpressionSine.h"#include "Materials/MaterialExpressionSmoothStep.h"#include "Materials/MaterialExpressionSingleLayerWaterMaterialOutput.h"#include "Materials/MaterialExpressionThinTranslucentMaterialOutput.h"#include "Materials/MaterialExpressionFirstPersonOutput.h"#include "Materials/MaterialExpressionSobol.h"#include "Materials/MaterialExpressionSpeedTree.h"#include "Materials/MaterialExpressionSphereMask.h"#include "Materials/MaterialExpressionSphericalParticleOpacity.h"#include "Materials/MaterialExpressionSquareRoot.h"#include "Materials/MaterialExpressionSRGBColorToWorkingColorSpace.h"#include "Materials/MaterialExpressionStaticBool.h"#include "Materials/MaterialExpressionStaticSwitch.h"#include "Materials/MaterialExpressionStep.h"#include "Materials/MaterialExpressionSubtract.h"#include "Materials/MaterialExpressionTangent.h"#include "Materials/MaterialExpressionTangentOutput.h"#include "Materials/MaterialExpressionTemporalSobol.h"#include "Materials/MaterialExpressionTextureBase.h"#include "Materials/MaterialExpressionTextureObject.h"#include "Materials/MaterialExpressionSwitch.h"#include "Materials/MaterialExpressionTextureSample.h"#include "Materials/MaterialExpressionParticleSubUV.h"#include "Materials/MaterialExpressionParticleSubUVProperties.h"#include "Materials/MaterialExpressionTextureCollection.h"#include "Materials/MaterialExpressionTextureCollectionParameter.h"#include "Materials/MaterialExpressionTextureSampleParameter.h"#include "Materials/MaterialExpressionTextureObjectFromCollection.h"#include "Materials/MaterialExpressionTextureObjectParameter.h"#include "Materials/MaterialExpressionTextureSampleParameter2D.h"#include "Materials/MaterialExpressionAntialiasedTextureMask.h"#include "Materials/MaterialExpressionTextureSampleParameterSubUV.h"#include "Materials/MaterialExpressionTextureSampleParameterCube.h"#include "Materials/MaterialExpressionTextureSampleParameter2DArray.h"#include "Materials/MaterialExpressionTextureSampleParameterCubeArray.h"#include "Materials/MaterialExpressionTextureSampleParameterVolume.h"#include "Materials/MaterialExpressionTextureCoordinate.h"#include "Materials/MaterialExpressionTime.h"#include "Materials/MaterialExpressionDeltaTime.h"#include "Materials/MaterialExpressionTransform.h"#include "Materials/MaterialExpressionTransformPosition.h"#include "Materials/MaterialExpressionTruncate.h"#include "Materials/MaterialExpressionTruncateLWC.h"#include "Materials/MaterialExpressionTwoSidedSign.h"#include "Materials/MaterialExpressionUserSceneTexture.h"#include "Materials/MaterialExpressionVertexColor.h"#include "Materials/MaterialExpressionVertexNormalWS.h"#include "Materials/MaterialExpressionVertexTangentWS.h"#include "Materials/MaterialExpressionViewProperty.h"#include "Materials/MaterialExpressionIsOrthographic.h"#include "Materials/MaterialExpressionViewSize.h"#include "Materials/MaterialExpressionVolumetricAdvancedMaterialInput.h"#include "Materials/MaterialExpressionVolumetricAdvancedMaterialOutput.h"#include "Materials/MaterialExpressionWorldPosition.h"#include "Materials/MaterialExpressionDistanceToNearestSurface.h"#include "Materials/MaterialExpressionDistanceFieldGradient.h"#include "Materials/MaterialExpressionDistanceFieldApproxAO.h"#include "Materials/MaterialExpressionClearCoatNormalCustomOutput.h"#include "Materials/MaterialExpressionAtmosphericLightVector.h"#include "Materials/MaterialExpressionAtmosphericLightColor.h"#include "Materials/MaterialExpressionSkyAtmosphereLightIlluminance.h"#include "Materials/MaterialExpressionSkyAtmosphereLightDirection.h"#include "Materials/MaterialExpressionSkyAtmosphereViewLuminance.h"#include "Materials/MaterialExpressionSkyLightEnvMapSample.h"#include "Materials/MaterialExpressionMaterialLayerOutput.h"#include "Materials/MaterialExpressionCurveAtlasRowParameter.h"#include "Materials/MaterialExpressionMapARPassthroughCameraUV.h"#include "Materials/MaterialExpressionShaderStageSwitch.h"#include "Materials/MaterialExpressionReflectionCapturePassSwitch.h"#include "Materials/MaterialExpressionSubstrate.h"#include "Materials/MaterialExpressionSamplePhysicsField.h"#include "Materials/MaterialExpressionIfThenElse.h"#include "Materials/MaterialExpressionGenericConstant.h"#include "Materials/MaterialExpressionSparseVolumeTextureBase.h"#include "Materials/MaterialExpressionSparseVolumeTextureObject.h"#include "Materials/MaterialExpressionSparseVolumeTextureSample.h"#include "Materials/MaterialExpressionIsFirstPerson.h"#include "Materials/MaterialExternalCodeRegistry.h"#include "Materials/MaterialExpressionRecordTextureStreamingInfo.h"#include "Materials/MaterialExpressionOperator.h"#include "Materials/MaterialExpressionAggregate.h"#include "Materials/MaterialExpressionTemporalResponsivenessOutput.h"#include "Materials/MaterialExpressionMotionVectorWorldOffsetOutput.h"#include "EditorSupportDelegates.h"#include "Materials/MaterialExpressionVertexInterpolator.h"#include "Materials/MaterialInstanceConstant.h"#include "Curves/CurveLinearColorAtlas.h"#include "Curves/CurveLinearColor.h"#include "MaterialExpressionSettings.h"#include "UObject/ObjectEditorOptionalSupport.h"Namespaces | |
| namespace | CookDeterminism |
| namespace | MaterialFunctionInterface |
Macros | |
| #define | LOCTEXT_NAMESPACE "MaterialExpression" |
| #define | SWAP_REFERENCE_TO(ExpressionInput, ToBeRemovedExpression, ToReplaceWithExpression) |
| #define | GET_SET_MA_MATERIALATTRIBUTESINDEX 0 |
| #define GET_SET_MA_MATERIALATTRIBUTESINDEX 0 |
| #define LOCTEXT_NAMESPACE "MaterialExpression" |
| #define SWAP_REFERENCE_TO | ( | ExpressionInput, | |
| ToBeRemovedExpression, | |||
| ToReplaceWithExpression | |||
| ) |
| bool CanConnectMaterialValueTypes | ( | const EMaterialValueType | InputType, |
| const EMaterialValueType | OutputType | ||
| ) |
Check whether a combination of EMaterialValueType flags can be connected
| int32 CompileShadingModelBlendFunction | ( | FMaterialCompiler * | Compiler, |
| const int32 | A, | ||
| const int32 | B, | ||
| const int32 | Alpha | ||
| ) |
Compile a select "blend" between ShadingModels
| Compiler | The compiler to add code to |
| A | Select A if Alpha is less than 0.5f |
| B | Select B if Alpha is greater or equal to 0.5f |
| Alpha | Bland factor [0..1] |
| int32 CompileSubstrateBlendFunction | ( | FMaterialCompiler * | Compiler, |
| const int32 | A, | ||
| const int32 | B, | ||
| const int32 | Alpha | ||
| ) |
Compile a special blend function for Substrate when blending material attribute
| Compiler | The compiler to add code to |
| Foreground | Entry A, has a bigger impact when Alpha is close to 0 |
| Background | Entry B, has a bigger impact when Alpha is close to 1 |
| Alpha | Blend factor [0..1], when 0 |
| void ConvertToMultilineToolTip | ( | const FString & | InToolTip, |
| const int32 | TargetLineLength, | ||
| TArray< FString > & | OutToolTip | ||
| ) |
Parses a string into multiple lines, for use with tooltips.
| uint32 GetMaterialExpressionOperatorArity | ( | EMaterialExpressionOperatorKind | Operator | ) |
|
extern |
|
extern |
Given a combination of EMaterialValueType flags, get text descriptions of all types