1. Epic GamesDeveloper
  3. UMaterial

UMaterial

A Material is an asset which can be applied to a mesh to control the visual look of the scene.

API > API/Runtime > API/Runtime/Engine

A Material is an asset which can be applied to a mesh to control the visual look of the scene. When light from the scene hits the surface, the shading model of the material is used to calculate how that light interacts with the surface.

Warning: Creating new materials directly increases shader compile times! Consider creating a Material Instance off of an existing material instead.

   
Name UMaterial
Type class
Header File /Engine/Source/Runtime/Engine/Public/Materials/Material.h
Include Path #include "Materials/Material.h"

Syntax

UCLASS (HideCategories=Object, MinimalAPI, BlueprintType,  
       prioritizeCategories=("Material", "Nanite", "Translucency", "TranslucencySelfShadowing", "Refraction", "WorldPositionOffset", "PostProcessMaterial", "Mobile", "ForwardShading", "PhysicalMaterial", "PhysicalMaterialMask", "Usage", "Lightmass", "Previewing", "ImportSettings"))  
class UMaterial : public UMaterialInterface

Inheritance Hierarchy

Implements Interfaces

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

UMaterial ( const FObjectInitializer& ObjectInitializer
)

   Materials/Material.h  
  Materials/Material.h  

UMaterial ( FVTableHelper& Helper
)

   Materials/Material.h  

Classes

Name Remarks
FMaterialCompilationFinished  

Structs

Name Remarks
FLayersInterfaces  

Enums

Public

Name Remarks
EPostEditChangeEffectOnShaders  

Constants

Name Type Remarks Include Path
MaterialCompilationFinishedEvent FMaterialCompilationFinished   Materials/Material.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
AllowTranslucentCustomDepthWrites uint8 Allows a translucent material to be used with custom depth writing by compiling additional shaders. Materials/Material.h
  • EditAnywhere
  • Category=Translucency
  • AdvancedDisplay
  • Meta=(DisplayName="Allow Custom Depth Writes")
bAllowDevelopmentShaderCompile uint8 If true the compilation environment will be changed to remove the global COMPILE_SHADERS_FOR_DEVELOPMENT flag. Materials/Material.h
  • Transient
  • DuplicateTransient
bAllowFrontLayerTranslucency uint8 Allows a translucent material to be used with Front Layer Translucency by compiling additional shaders. Materials/Material.h
  • EditAnywhere
  • Category=Translucency
  • AdvancedDisplay
  • Meta=(DisplayName="Allow Front Layer Translucency")
bAllowNegativeEmissiveColor uint8 Whether the material should allow outputting negative emissive color values. Materials/Material.h
  • EditAnywhere
  • Category=Material
  • AdvancedDisplay
bAllowTranslucentLocalLightShadow uint8 Allows a translucent material to receive local light shadows. Materials/Material.h
  • EditAnywhere
  • Category=Translucency
  • AdvancedDisplay
  • Meta=(DisplayName="Allow Local Light Shadow")
bAllowVariableRateShading uint8 Allows the use of variable rate shading when evaluating this material. Materials/Material.h
  • EditAnywhere
  • Category=Material
  • AdvancedDisplay
bAlwaysEvaluateWorldPositionOffset bool Forces World Position Offset to always be evaluated for this material, even if the primitive it's applied to has disabled it via "Evaluate World Position Offset" or "World Position Offset Disable Distance". Materials/Material.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=WorldPositionOffset
bApplyCloudFogging uint8 When true, translucent materials receive cloud contribution as part of the fog evaluation, per vertex or per pixel according to the other selected options. Materials/Material.h
  • EditAnywhere
  • Category=Translucency
  • Meta=(DisplayName="Apply Cloud Fogging")
bAutomaticallySetUsageInEditor uint8 Whether to automatically set usage flags based on what the material is applied to in the editor. Materials/Material.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category=Usage
  • AdvancedDisplay
bCanMaskedBeAssumedOpaque uint8 True if this Material can be assumed Opaque when set to masked. Materials/Material.h  
bCastDynamicShadowAsMasked uint8 Whether the material should cast shadows as masked even though it has a translucent blend mode. Materials/Material.h
  • EditAnywhere
  • Category=Material
  • AdvancedDisplay
bCastRayTracedShadows uint8 When true, the material casts ray tracing shadows. Materials/Material.h
  • EditAnywhere
  • Category=Material
bCompatibleWithLumenCardSharing uint8 When true, allows to share Lumen Cards between different instances even when material uses world position or per instance data, which may change material look per instance. Materials/Material.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category=Material
  • AdvancedDisplay
bComputeFogPerPixel uint8 When true, translucent materials have fog computed for every pixel, which costs more but fixes artifacts due to low tessellation. Materials/Material.h
  • EditAnywhere
  • Category=Translucency
bContactShadows uint8 Contact shadows on translucency Materials/Material.h
  • EditAnywhere
  • Category=Translucency
  • Meta=(DisplayName="Contact Shadows")
bDisableDepthTest uint8 Whether to draw on top of opaque pixels even if behind them. Materials/Material.h
  • EditAnywhere
  • Category=Translucency
  • AdvancedDisplay
bDisablePreExposureScale uint8 Disable pre-exposure scale in post process materials (multiply by View.OneOverPreExposure on inputs, View.PreExposure on output). Materials/Material.h
  • EditAnywhere
  • Category=PostProcessMaterial
bEnableDisplacementFade uint8 Enables fading out and disabling of dynamic displacement in the distance, as displacement becomes unnoticeable Materials/Material.h
  • EditAnywhere
  • Category=Nanite
  • Meta=(EditCondition="bEnableTessellation", InlineEditConditionToggle)
bEnableExecWire uint8   Materials/Material.h
  • EditAnywhere
  • Category=Material
bEnableMobileSeparateTranslucency uint8 Indicates that the translucent material should not be affected by bloom or DOF. Materials/Material.h
  • EditAnywhere
  • Category=Translucency
  • Meta=(DisplayName="Mobile Separate Translucency")
  • AdvancedDisplay
bEnableNewHLSLGenerator uint8   Materials/Material.h
  • EditAnywhere
  • Category=Material
bEnableResponsiveAA uint8 Indicates that the material should be rendered using responsive anti-aliasing. Materials/Material.h
  • EditAnywhere
  • Category=Translucency
  • Meta=(DisplayName="Responsive AA")
  • AdvancedDisplay
bEnableStencilTest uint8 Selectively execute post process material only for pixels that pass the stencil test against the Custom Depth/Stencil buffer. Materials/Material.h
  • EditAnywhere
  • Category=PostProcessMaterial
  • AdvancedDisplay
bEnableTessellation uint8 Whether tessellation is enabled on the material. NOTE: Required for displacement to work. Materials/Material.h
  • EditAnywhere
  • Category=Nanite
  • Meta=(Keywords="Displacement")
bForceCompatibleWithLightFunctionAtlas uint8 Indicates that this material is safe to use with the light function atlas: Materials/Material.h
  • EditAnywhere
  • Category=LightFunctionMaterial
  • Meta=(DisplayName="Compatible With Light Function Atlas")
bForwardBlendsSkyLightCubemaps uint8 Enables blending of sky light cubemap textures. Materials/Material.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category=ForwardShading
  • Meta=(DisplayName="Blend Sky Light Cubemaps")
bForwardRenderUsePreintegratedGFForSimpleIBL uint32 Forward (including mobile) renderer: use preintegrated GF lut for simple IBL, but will use one more sampler. Materials/Material.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category=ForwardShading
  • Meta=(DisplayName="PreintegratedGF For Simple IBL")
bFullyRough uint8 Forces the material to be completely rough. Saves a number of instructions and one sampler. Materials/Material.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category=Material
  • AdvancedDisplay
bGenerateSphericalParticleNormals uint8 Whether to generate spherical normals for particles that use this material. Materials/Material.h
  • EditAnywhere
  • Category=Material
  • AdvancedDisplay
bHasPixelAnimation uint8 Whether the opaque material has any pixel animations happening, that isn't included in the geometric velocities. Materials/Material.h
  • EditAnywhere
  • Category=Material
  • Meta=(DisplayName="Has Pixel Animation")
  • AdvancedDisplay
bIsBlendable uint8 Allows blendability to be turned off, only used if domain is PostProcess Materials/Material.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=PostProcessMaterial
  • Meta=(DisplayName="Is Blendable")
bIsFunctionPreviewMaterial uint8 True if Material is the function preview material used in the material instance editor. Materials/Material.h
  • Transient
  • DuplicateTransient
bIsMaterialEditorStatsMaterial uint8 True if this is a special material used for stats by the material editor. Materials/Material.h
  • Transient
  • DuplicateTransient
bIsPreviewMaterial uint8 True if Material is the preview material used in the material editor. Materials/Material.h
  • Transient
  • DuplicateTransient
bIsSky uint8 Unlit and Opaque materials can be used as sky material on a sky dome mesh. Materials/Material.h
  • EditAnywhere
  • Category=Material
  • AdvancedDisplay
bIsThinSurface uint8 Indicates that the material should be rendered as a thin surface (i.e., without inner volume). Materials/Material.h
  • EditAnywhere
  • Category=Material
bIsTranslucencyVelocityFromDepth uint8 When true, translucent materials that write velocity will calculate it only based on the written depth and camera movement. Materials/Material.h
  • EditAnywhere
  • Category=Translucency
  • Meta=(DisplayName="Velocity From Depth Only", editcondition="bOutputTranslucentVelocity")
BlendableLocation TEnumAsByte< EBlendableLocation > Where the node is inserted in the (post processing) graph, only used if domain is PostProcess Materials/Material.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=PostProcessMaterial
  • Meta=(DisplayName="Blendable Location")
BlendableOutputAlpha uint8 If this is enabled, the blendable will output alpha Materials/Material.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=PostProcessMaterial
  • Meta=(DisplayName="Output Alpha")
BlendablePriority int32 If multiple nodes with the same type are inserted at the same point, this defined order and if they get combined, only used if domain is PostProcess Materials/Material.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=PostProcessMaterial
  • Meta=(DisplayName="Blendable Priority")
BlendMode TEnumAsByte< EBlendMode > Determines how the material's color is blended with background colors. Materials/Material.h
  • BlueprintReadOnly
  • EditAnywhere
  • Category=Material
  • AssetRegistrySearchable
bNormalCurvatureToRoughness uint8 Reduce roughness based on screen space normal changes. Materials/Material.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category=Material
  • AdvancedDisplay
bOutputTranslucentVelocity uint8 When true, translucent materials will output motion vectors and write to depth buffer in velocity pass. Materials/Material.h
  • EditAnywhere
  • Category=Translucency
  • Meta=(DisplayName="Output Depth and Velocity")
bRelaxRuntimeVirtualTextureRestrictions uint8 Relax restrictions on Runtime Virtual Texture output compilation. Materials/Material.h
  • EditAnywhere
  • Category=VirtualTexture
bRelaxRuntimeVirtualTextureRestrictionsForOldContent uint8   Materials/Material.h
  • EditAnywhere
  • Category=VirtualTexture
bScreenSpaceReflections uint8 SSR on translucency Materials/Material.h
  • EditAnywhere
  • Category=Translucency
  • Meta=(DisplayName="Screen Space Reflections")
bSubstrateRoughnessTracking uint8 This can be used to disable roughness tracking. Materials/Material.h
  • EditAnywhere
  • BlueprintReadOnly
  • Meta=(DisplayName="Roughness Tracking")
  • Category=Substrate
bTangentSpaceNormal uint8 Whether the material takes a tangent space normal or a world space normal as input. Materials/Material.h
  • EditAnywhere
  • Category=Material
  • AdvancedDisplay
bUseAlphaToCoverage uint8 Use alpha to coverage for masked material on mobile, make sure MSAA is enabled as well. Materials/Material.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category=Mobile
  • AdvancedDisplay
  • Meta=(EditCondition="BlendMode != EBlendMode::BLEND_Opaque")
bUsedAsSpecialEngineMaterial uint8 This is a special usage flag that allows a material to be assignable to any primitive type. Materials/Material.h
  • DuplicateTransient
bUsedWithBeamTrails uint8 Indicates that the material and its instances can be used with beam trails This will result in the shaders required to support beam trails being compiled which will increase shader compile time and memory usage. Materials/Material.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category=Usage
bUsedWithClothing uint8 Indicates that the material and its instances can be used with clothing This will result in the shaders required to support clothing being compiled which will increase shader compile time and memory usage. Materials/Material.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category=Usage
bUsedWithEditorCompositing uint8 Indicates that the material and its instances can be used with editor compositing Materials/Material.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category=Usage
bUsedWithGeometryCache uint8   Materials/Material.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category=Usage
bUsedWithGeometryCollections uint8 Indicates that the material and its instances can be use with geometry collections This will result in the shaders required to support geometry collections being compiled which will increase shader compile time and memory usage. Materials/Material.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category=Usage
bUsedWithHairStrands uint32 Indicates that the material and its instances can be use with hair strands This will result in the shaders required to support hair strands geometries being compiled which will increase shader compile time and memory usage. Materials/Material.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category=Usage
bUsedWithHeterogeneousVolumes uint32 Indicates that the material and its instances with heterogeneous volumes. Materials/Material.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category=Usage
bUsedWithInstancedStaticMeshes uint8 Indicates that the material and its instances can be used with instanced static meshes This will result in the shaders required to support instanced static meshes being compiled which will increase shader compile time and memory usage. Materials/Material.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category=Usage
bUsedWithLidarPointCloud uint32 Indicates that the material and its instances can be use with LiDAR Point Clouds This will result in the shaders required to support LiDAR Point Cloud geometries being compiled which will increase shader compile time and memory usage. Materials/Material.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category=Usage
bUsedWithMeshParticles uint8 Indicates that the material and its instances can be used with mesh particles This will result in the shaders required to support mesh particles being compiled which will increase shader compile time and memory usage. Materials/Material.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category=Usage
bUsedWithMorphTargets uint8 Indicates that the material and its instances can be used with morph targets This will result in the shaders required to support morph targets being compiled which will increase shader compile time and memory usage. Materials/Material.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category=Usage
bUsedWithNanite uint32 Indicates that the material and its instances can be used with Nanite meshes. Materials/Material.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category=Usage
bUsedWithNeuralNetworks uint8 Indicates that the material and its instances can be used with neural network engine. Materials/Material.h
  • EditAnywhere
  • Category=PostProcessMaterial
bUsedWithNiagaraMeshParticles uint8   Materials/Material.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category=Usage
bUsedWithNiagaraRibbons uint8   Materials/Material.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category=Usage
bUsedWithNiagaraSprites uint8 Indicates that the material and its instances can be used with Niagara sprites (meshes and ribbons, respectively) This will result in the shaders required to support Niagara sprites being compiled which will increase shader compile time and memory usage. Materials/Material.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category=Usage
bUsedWithParticleSprites uint8 Indicates that the material and its instances can be used with particle sprites This will result in the shaders required to support particle sprites being compiled which will increase shader compile time and memory usage. Materials/Material.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category=Usage
bUsedWithSkeletalMesh uint8 Indicates that the material and its instances can be used with skeletal meshes. Materials/Material.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category=Usage
bUsedWithSplineMeshes uint8 Indicates that the material and its instances can be used with spline meshes This will result in the shaders required to support spline meshes being compiled which will increase shader compile time and memory usage. Materials/Material.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category=Usage
bUsedWithStaticLighting uint8 Indicates that the material and its instances can be used with static lighting This will result in the shaders required to support static lighting being compiled which will increase shader compile time and memory usage. Materials/Material.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category=Usage
bUsedWithStaticMesh uint32 Indicates that the material and its instances can be used on StaticMeshes, which is true by default on all Materials This can be used to remove shaders which are not required, reducing shader compile time and memory usage Materials/Material.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category=Usage
  • AdvancedDisplay
bUsedWithVirtualHeightfieldMesh uint32 Indicates that the material and its instances can be used with Virtual Heightfield Mesh. Materials/Material.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category=Usage
bUsedWithVolumetricCloud uint32 Indicates that the material and its instances with volumetric cloud. Materials/Material.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category=Usage
bUsedWithVoxels uint8 Indicates that the material and its instances can be used with Nanite voxel meshes. Materials/Material.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category=Usage
bUsedWithWater uint32 Indicates that the material and its instances can be use with water This will result in the shaders required to support water meshes being compiled which will increase shader compile time and memory usage. Materials/Material.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category=Usage
bUseEmissiveForDynamicAreaLighting uint8 If enabled, the material's emissive colour is injected into the LightPropagationVolume Materials/Material.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Material
  • Meta=(DisplayName="Emissive (Dynamic Area Light)")
  • AdvancedDisplay
bUseHQForwardReflections uint8 Forward renderer: enables multiple parallax-corrected reflection captures that blend together. Materials/Material.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category=ForwardShading
  • Meta=(DisplayName="High Quality Reflections")
bUseLightmapDirectionality uint8 Use lightmap directionality and per pixel normals. Materials/Material.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category=Mobile
bUseMaterialAttributes uint8 When true, the material attributes pin is used instead of the regular pins. Materials/Material.h
  • EditAnywhere
  • Category=Material
bUsePlanarForwardReflections uint8 Enables planar reflection when using the forward renderer or mobile. Materials/Material.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category=ForwardShading
  • Meta=(DisplayName="Planar Reflections")
bUsesDistortion uint8 Indicates that the material and its instances can be used with distortion This will result in the shaders required to support distortion being compiled which will increase shader compile time and memory usage. Materials/Material.h  
bUseTranslucencyVertexFog uint8 When true, translucent materials are fogged. Defaults to true. Materials/Material.h
  • EditAnywhere
  • Category=Translucency
  • Meta=(DisplayName="Apply Fogging")
bWriteOnlyAlpha uint8 Whether the transluency pass should write its alpha, and only the alpha, into the framebuffer Materials/Material.h
  • EditAnywhere
  • Category=Translucency
  • AdvancedDisplay
DecalBlendMode TEnumAsByte< EDecalBlendMode >   Materials/Material.h
  • Meta=(DeprecatedProperty, DeprecationMessage="No longer used.")
DefaultMaterialInstance FDefaultMaterialInstance * FMaterialRenderProxy derivative that represent this material to the renderer, when the renderer needs to fetch parameter values. Materials/Material.h  
DisplacementFadeRange FDisplacementFadeRange   Materials/Material.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Nanite
  • Meta=(DisplayName="Displacement Fade", EditCondition="bEnableDisplacementFade", DisplayAfter="DisplacementScaling")
DisplacementScaling FDisplacementScaling   Materials/Material.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Nanite
  • Meta=(DisplayName="Displacement", EditCondition="bEnableTessellation", DisplayAfter="bEnableTessellation")
DitheredLODTransition uint8 Whether meshes rendered with the material should support dithered LOD transitions. Materials/Material.h
  • EditAnywhere
  • Category=Material
  • AdvancedDisplay
  • Meta=(DisplayName="Dithered LOD Transition")
DitherOpacityMask uint8 Dither opacity mask. Materials/Material.h
  • EditAnywhere
  • Category=Material
  • AdvancedDisplay
EditorParameters TMap< FName, TArray< UMaterialExpression * > > Used to detect duplicate parameters. Does not contain parameters in referenced functions! Materials/Material.h  
EditorPitch int32   Materials/Material.h  
EditorX int32   Materials/Material.h  
EditorY int32   Materials/Material.h  
EditorYaw int32   Materials/Material.h  
FloatPrecisionMode TEnumAsByte< EMaterialFloatPrecisionMode > How to use full (highp) precision in the pixel shader. Materials/Material.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category=Mobile
MaterialDecalResponse TEnumAsByte< EMaterialDecalResponse > Defines how the material reacts on DBuffer decals (Affects look, performance and texture/sample usage). Materials/Material.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category=Material
  • AdvancedDisplay
  • Meta=(DisplayName="Decal Response (DBuffer)")
  • AssetRegistrySearchable
MaterialDomain TEnumAsByte< EMaterialDomain > The domain that the material's attributes will be evaluated in. Materials/Material.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category=Material
  • AssetRegistrySearchable
MaterialGraph TObjectPtr< class UMaterialGraph > EdGraph based representation of the Material Materials/Material.h  
MaxWorldPositionOffsetDisplacement float Specifies the max world position offset of the material. Materials/Material.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=WorldPositionOffset
  • Meta=(ClampMin=0.0f)
NaniteOverrideMaterial FMaterialOverrideNanite An override material which will be used instead of this one when rendering with Nanite. Materials/Material.h
  • EditAnywhere
  • Category=Nanite
  • Meta=(EditInline, ShowOnlyInnerProperties)
NeuralProfileId int8 Set by reference object cannot be modified. Materials/Material.h
  • EditAnywhere
  • Category=PostProcessMaterial
  • AdvancedDisplay
  • Meta=(EditCondition="false")
NumCustomizedUVs int32 Number of customized UV inputs to display. Materials/Material.h
  • EditAnywhere
  • Category=Material
  • AdvancedDisplay
  • Meta=(ClampMin=0)
OpacityMaskClipValue float If BlendMode is BLEND_Masked, the surface is not rendered where OpacityMask < OpacityMaskClipValue. Materials/Material.h
  • EditAnywhere
  • Category=Material
  • AdvancedDisplay
PhysicalMaterialMap TObjectPtr< class UPhysicalMaterial > Physical material mask map to use for this graphics material. Used for sounds, effects etc. Materials/Material.h
  • EditAnywhere
  • Category=PhysicalMaterialMask
PhysMaterial TObjectPtr< class UPhysicalMaterial > Physical material to use for this graphics material. Used for sounds, effects etc. Materials/Material.h
  • EditAnywhere
  • Category=PhysicalMaterial
PhysMaterialMask TObjectPtr< class UPhysicalMaterialMask > Physical material mask to use for this graphics material. Used for sounds, effects etc. Materials/Material.h
  • EditAnywhere
  • Category=PhysicalMaterial
PixelDepthOffsetMode TEnumAsByte< EPixelDepthOffsetMode > Controls whether refraction takes into account the material surface coverage, or not. Materials/Material.h
  • EditAnywhere
  • Category=PixelDepthOffset
PreshaderGap uint16 If non-zero, overrides r.Material.PreshaderGapInterval for this material. Materials/Material.h
  • EditAnywhere
  • Category=Material
  • AdvancedDisplay
RefractionCoverageMode TEnumAsByte< ERefractionCoverageMode > Controls whether refraction takes into account the material surface coverage, or not. Materials/Material.h
  • EditAnywhere
  • Category=Refraction
RefractionDepthBias float This is the refraction depth bias, larger values offset distortion to prevent closer objects from rendering into the distorted surface at acute viewing angles but increases the disconnect between surface and where the refraction starts. Materials/Material.h
  • EditAnywhere
  • Category=Refraction
RefractionMethod TEnumAsByte< ERefractionMode > Controls how the Refraction input is interpreted and how the refraction offset into scene color is computed for this material. Materials/Material.h
  • EditAnywhere
  • Category=Refraction
RenderTracePhysicalMaterialOutputs TArray< TObjectPtr< class UPhysicalMaterial > >   Materials/Material.h  
ResolutionRelativeToInput FName Set output resolution relative to the given User Scene Texture input. Materials/Material.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=PostProcessMaterial
  • Meta=(DisplayName="Resolution Relative To Input")
ShadingRate TEnumAsByte< EMaterialShadingRate > Select what shading rate to apply, on platforms that support variable rate shading. Materials/Material.h
  • EditAnywhere
  • Category=Material
  • AdvancedDisplay
StateId FGuid Guid that uniquely identifies this material. Materials/Material.h  
StencilCompare TEnumAsByte< EMaterialStencilCompare >   Materials/Material.h
  • EditAnywhere
  • Category=PostProcessMaterial
  • AdvancedDisplay
  • Meta=(EditCondition="bEnableStencilTest")
StencilRefValue uint8   Materials/Material.h
  • EditAnywhere
  • Category=PostProcessMaterial
  • AdvancedDisplay
  • Meta=(EditCondition="bEnableStencilTest")
SubstrateCompilationConfig FSubstrateCompilationConfig Not a UPROPERTY, used to propagate editor only Substrate material simplification options for preview. Materials/Material.h  
TranslucencyDirectionalLightingIntensity float Useful for artificially increasing the influence of the normal on the lighting result for translucency. Materials/Material.h
  • EditAnywhere
  • Category=Translucency
  • Meta=(DisplayName="Directional Lighting Intensity")
TranslucencyLightingMode TEnumAsByte< ETranslucencyLightingMode > Sets the lighting mode that will be used on this material if it is translucent. Materials/Material.h
  • EditAnywhere
  • AssetRegistrySearchable
  • Category=Translucency
  • Meta=(DisplayName="Lighting Mode")
TranslucencyPass TEnumAsByte< EMaterialTranslucencyPass > Specifies the separate pass in which to render translucency. Materials/Material.h
  • EditAnywhere
  • AdvancedDisplay
  • Category=Translucency
TranslucentBackscatteringExponent float Controls how diffuse the material's backscattering is when using the MSM_Subsurface shading model. Materials/Material.h
  • EditAnywhere
  • Category=TranslucencySelfShadowing
  • Meta=(DisplayName="Backscattering Exponent")
TranslucentDirectionalLightShadowQuality float Set directional light shadow quality received by translucent material. Materials/Material.h
  • EditAnywhere
  • Category=Translucency
  • AdvancedDisplay
  • Meta=(DisplayName="Directional Light Shadow Quality", UIMin="0", UIMax="1", ClampMin="0", ClampMax="1", SliderExponent=1.0)
TranslucentLocalLightShadowQuality float Set local light shadow quality received by translucent material. Materials/Material.h
  • EditAnywhere
  • Category=Translucency
  • AdvancedDisplay
  • Meta=(DisplayName="Local Light Shadow Quality", UIMin="0", UIMax="1", ClampMin="0", ClampMax="1", SliderExponent=1.0)
TranslucentMultipleScatteringExtinction FLinearColor Colored extinction factor used to approximate multiple scattering in dense volumes. Materials/Material.h
  • EditAnywhere
  • Category=TranslucencySelfShadowing
  • Meta=(DisplayName="Multiple Scattering Extinction")
TranslucentSelfShadowDensityScale float Scale used to make translucent self-shadowing more or less opaque than the material's shadow on other objects. Materials/Material.h
  • EditAnywhere
  • Category=TranslucencySelfShadowing
  • Meta=(DisplayName="Self Shadow Density Scale")
TranslucentSelfShadowSecondDensityScale float Used to make a second self shadow gradient, to add interesting shading in the shadow of the first. Materials/Material.h
  • EditAnywhere
  • Category=TranslucencySelfShadowing
  • Meta=(DisplayName="Second Density Scale")
TranslucentSelfShadowSecondOpacity float Controls the strength of the second self shadow gradient. Materials/Material.h
  • EditAnywhere
  • Category=TranslucencySelfShadowing
  • Meta=(DisplayName="Second Opacity")
TranslucentShadowDensityScale float Scale used to make translucent shadows more or less opaque than the material's actual opacity. Materials/Material.h
  • EditAnywhere
  • Category=TranslucencySelfShadowing
  • Meta=(DisplayName="Shadow Density Scale")
TranslucentShadowStartOffset float Local space distance to bias the translucent shadow. Materials/Material.h
  • EditAnywhere
  • Category=TranslucencySelfShadowing
  • Meta=(DisplayName="Start Offset")
TwoSided uint8 Indicates that the material should be rendered without backface culling and the normal should be flipped for backfaces. Materials/Material.h
  • EditAnywhere
  • Category=Material
UsageFlagCacheMiss std::atomic< uint32 >   Materials/Material.h  
UsageFlagWarnings uint32 True if we have printed a warning about material usage for a given usage flag. Materials/Material.h
  • Transient
  • DuplicateTransient
UserSceneTexture FName Specify a user generated scene texture as output, overriding the default output implied by "Blendable Location", only used if domain is PostProcess Materials/Material.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=PostProcessMaterial
  • Meta=(DisplayName="User Scene Texture")
UserTextureDivisor FIntPoint A divisor for the resolution of the User Scene Texture above, allowing an intermediate with reduced resolution Materials/Material.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=PostProcessMaterial
  • Meta=(DisplayName="User Texture Divisor")
Wireframe uint8 Enables a wireframe view of the mesh the material is applied to. Materials/Material.h
  • EditAnywhere
  • Category=Material
  • AdvancedDisplay

Protected

Name Type Remarks Include Path Unreal Specifiers
bCachingUniformExpressions bool This instance is caching uniform expressions (the render thread hasn't canceled its creation). Materials/Material.h  
CachedMaterialResourcesForCooking TMap< const ITargetPlatform *, TArray< FMaterialResourceForCooking > > Material resources being cached for cooking. Materials/Material.h  
LoadedMaterialResources TArray< FMaterialResource > Inline material resources serialized from disk. To be processed on game thread in PostLoad. Materials/Material.h  
MaterialResources TArray< FMaterialResource * > Material resources used for rendering this material. Materials/Material.h  
ReferencedTextureGuids TArray< FGuid >   Materials/Material.h  
ReleasedByRT FThreadSafeBool Flag used to guarantee that the RT is finished using various resources in this UMaterial before cleanup. Materials/Material.h  
ShadingModel TEnumAsByte< EMaterialShadingModel > Determines how inputs are combined to create the material's final color. Materials/Material.h
  • EditAnywhere
  • Category=Material
  • AssetRegistrySearchable
ShadingModels FMaterialShadingModelField   Materials/Material.h
  • AssetRegistrySearchable
UsedShadingModels FString These are the shading models present in this material. Materials/Material.h
  • VisibleAnywhere
  • Transient
  • Category=Material

Functions

Public

Name Remarks Include Path Unreal Specifiers

virtual bool AddExpressionParameter ( UMaterialExpression* Expression,
TMap< FName, TArray< UMaterialExpression* > >& ParameterTypeMap
)

 Add an expression node that represents a parameter to the list of material parameters. Materials/Material.h  

virtual FMaterialResource * AllocateResource()

   Materials/Material.h  

void AssignExpressionCollection ( const FMaterialExpressionCollection& InCollection
)

   Materials/Material.h  

bool AttemptInsertNewGroupName ( const FString& InNewName
)

 Attempts to add a new group name to the Group Data struct. True if new name was added. Materials/Material.h  

virtual void BuildEditorParameterList()

 Iterate through all of the expression nodes in the material and finds any parameters to put in EditorParameters. Materials/Material.h  
Cancels any currently outstanding compilation jobs for this material. Materials/Material.h  

bool CheckInValidStateForCompilation ( FMaterialCompiler* Compiler
) const

 Checks that no pre-compilation errors have been detected and if so it reports them using specified compiler. Materials/Material.h  

ExpressionType * FindExpressionByGUID ( const FGuid& InGUID
)

 Attempt to find a expression by its GUID. Materials/Material.h  

void FinishCacheUniformExpressions()

   Materials/Material.h  

void GetAllCustomOutputExpressions ( TArray< class UMaterialExpressionCustomOutput* >& OutCustomOutputs
) const

 Returns any UMaterialExpressionCustomOutput expressions Materials/Material.h  

void GetAllExpressionsForCustomInterpolators ( TArray< class UMaterialExpression* >& OutExpressions
) const

   Materials/Material.h  

void GetAllExpressionsInMaterialAndFunctionsOfType ( TArray< ExpressionType* >& OutExpressions
) const

 Get all expressions of the requested type, recursing through any function expressions in the material Materials/Material.h  

void GetAllExpressionsOfType ( TArray< const ExpressionType* >& OutExpressions
) const

 Get all expressions of the requested type Materials/Material.h  

void GetAllFunctionOutputExpressions ( TArray< class UMaterialExpressionFunctionOutput* >& OutFunctionOutputs
) const

 Returns any UMaterialExpressionFunctionOutput expressions Materials/Material.h  

virtual bool GetAllReferencedExpressions ( TArray< UMaterialExpression* >& OutExpressions,
FStaticParameterSet* InStaticParameterSet,
ERHIFeatureLevel::Type InFeatureLevel,
EMaterialQualityLevel::Type InQuality,
ERHIShadingPath::Type InShadingPath,
const bool bInRecurseIntoMaterialFunctions,
TSet< UClass* >* InMobileCustomOutputExpressionTypesToQuery
)

 Get all referenced expressions (returns the chains for all properties). Materials/Material.h  

TConstArrayView< TObjectPtr< UMaterialExpressionComment > > GetEditorComments()

   Materials/Material.h  
  Materials/Material.h  
  Materials/Material.h  

bool GetExpressionInputDescription ( EMaterialProperty InProperty,
FMaterialInputDescription& OutDescription
)

   Materials/Material.h  

FExpressionInput * GetExpressionInputForProperty ( EMaterialProperty InProperty
)

 Get the expression input for the given property Materials/Material.h  

TConstArrayView< TObjectPtr< UMaterialExpression > > GetExpressions()

   Materials/Material.h  

virtual bool GetExpressionsInPropertyChain ( EMaterialProperty InProperty,
TArray< UMaterialExpression* >& OutExpressions,
FStaticParameterSet* InStaticParameterSet,
ERHIFeatureLevel::Type InFeatureLevel,
EMaterialQualityLevel::Type InQuality,
ERHIShadingPath::Type InShadingPath,
const bool bInRecurseIntoMaterialFunctions
)

 Get the expression chain for the given property (ie fill in the given array with all expressions in the chain). Materials/Material.h  

uint32 GetMaterialDecalResponse()

 Returns the material's decal response mode Materials/Material.h  

EMaterialTranslateValidationFlags GetMaterialTranslateValidationFlags()

 Get user flags on the material that influence translation validation errors. Materials/Material.h  

TArrayView< const TObjectPtr< UPhysicalMaterial > > GetRenderTracePhysicalMaterialOutputs()

 Return the array of physical materials associated with the RenderTrace material outputs. Materials/Material.h  

void GetShaderTags ( TArray< FName >& OutShaderTags
) const

 Get collection of shader tags from this material's expressions. Materials/Material.h  

bool GetUsageByFlag ( const EMaterialUsage Usage
) const

   Materials/Material.h  

FString GetUsageName ( const EMaterialUsage Usage
) const

   Materials/Material.h  

bool HasAmbientOcclusionConnected()

   Materials/Material.h  

bool HasAnisotropyConnected()

   Materials/Material.h  

bool HasAnyExpressionsInMaterialAndFunctionsOfType()

 Checks if the material contains an expression of the requested type, recursing through any function expressions in the material Materials/Material.h  

bool HasBaseColorConnected()

   Materials/Material.h  

bool HasDisplacementConnected()

   Materials/Material.h  

virtual bool HasDuplicateDynamicParameters ( const UMaterialExpression* Expression
)

 Return whether the provided expression dynamic parameter has duplicates. Materials/Material.h  

virtual bool HasDuplicateParameters ( const UMaterialExpression* Expression
)

 Return whether the provided expression parameter has duplicates. Materials/Material.h  

bool HasEmissiveColorConnected()

   Materials/Material.h  

bool HasFlippedCoordinates()

 Checks whether a Material is arranged in the old style, with inputs flowing from right to left Materials/Material.h  

bool HasMetallicConnected()

   Materials/Material.h  

bool HasNormalConnected()

   Materials/Material.h  

bool HasPixelDepthOffsetConnected()

   Materials/Material.h  

bool HasRoughnessConnected()

   Materials/Material.h  

bool HasSpecularConnected()

   Materials/Material.h  

bool HasSubstrateFrontMaterialConnected()

   Materials/Material.h  

bool HasSurfaceThicknessConnected()

   Materials/Material.h  

bool HasVertexPositionOffsetConnected()

   Materials/Material.h  
  Materials/Material.h  

bool IsCompilingOrHadCompileError ( EShaderPlatform InShaderPlatform
)

 Useful to customize rendering if that case (e.g. hide the object) Materials/Material.h  

bool IsDefaultMaterial()

 Returns true if the material is one of the default materials. Materials/Material.h  

bool IsMobileSeparateTranslucencyEnabled()

   Materials/Material.h  

bool IsPostProcessMaterialOutputingAlpha()

   Materials/Material.h  

bool IsPropertyActiveInDerived ( EMaterialProperty InProperty,
const UMaterialInterface* DerivedMaterial
) const

 Like IsPropertyActive(), but considers any state overriden by DerivedMaterial Materials/Material.h  

bool IsPropertyActiveInEditor ( EMaterialProperty InProperty
) const

 Like IsPropertyActive(), but should be used in context of editor. Materials/Material.h  

bool IsPropertyConnected ( EMaterialProperty Property
) const

   Materials/Material.h  

bool IsPropertySupported ( EMaterialProperty InProperty
) const

 Return true if the property is supported. Materials/Material.h  

bool IsTextureForceRecompileCacheRessource ( UTexture* Texture
)

   Materials/Material.h  

bool IsUsageFlagDirty ( EMaterialUsage Usage
)

 Checks to see if the Usage flag has an annotation marking it as needing to be saved Materials/Material.h  

bool NeedsSetMaterialUsage_Concurrent ( bool& bOutHasUsage,
const EMaterialUsage Usage
) const

 Tests to see if this material needs a usage flag update Materials/Material.h  

void PostEditChangePropertyInternal ( FPropertyChangedEvent& PropertyChangedEvent,
const EPostEditChangeEffectOnShaders EffectOnShaders
)

   Materials/Material.h  

virtual FGraphEventArray PrecachePSOs ( const FPSOPrecacheVertexFactoryDataList& VertexFactoryDataList,
const FPSOPrecacheParams& PreCacheParams,
EPSOPrecachePriority Priority,
TArray< FMaterialPSOPrecacheRequestID >& OutMaterialPSORequestIDs
)

   Materials/Material.h  

virtual void PropagateExpressionParameterChanges ( const FName& ParameterName,
const FMaterialParameterMetadata& Meta
)

 A parameter with duplicates has to update its peers so that they all have the same value. Materials/Material.h  

virtual void PropagateExpressionParameterChanges ( const UMaterialExpression* Parameter
)

 A parameter with duplicates has to update its peers so that they all have the same value. Materials/Material.h  

void RebuildShadingModelField()

 Collect all material expressions fomr this material and all its functions and figure out which possible shading models exist in this material Materials/Material.h  
Releases rendering resources used by this material. Materials/Material.h  

virtual bool RemoveExpressionParameter ( UMaterialExpression* Expression
)

 Removes an expression node that represents a parameter from the list of material parameters. Materials/Material.h  

void SaveShaderStableKeys ( const ITargetPlatform* TP
)

   Materials/Material.h  

bool SetFontParameterValueEditorOnly ( FName ParameterName,
UFont* InFontValue,
int32 InFontPage
)

   Materials/Material.h  

bool SetMaterialUsage ( bool& bNeedsRecompile,
const EMaterialUsage Usage,
UMaterialInterface* MaterialInstance
)

 Set the given usage flag. Materials/Material.h  

bool SetParameterValueEditorOnly ( const FName& ParameterName,
const FMaterialParameterMetadata& Meta
)

   Materials/Material.h  

void SetRenderTracePhysicalMaterialOutputs ( TArrayView< TObjectPtr< UPhysicalMaterial > > PhysicalMaterials
)

 Set the array of physical materials associated with the RenderTrace material outputs. Materials/Material.h  

bool SetRuntimeVirtualTextureParameterValueEditorOnly ( FName ParameterName,
URuntimeVirtualTexture* InValue
)

   Materials/Material.h  

bool SetScalarParameterValueEditorOnly ( FName ParameterName,
float InValue
)

   Materials/Material.h  

void SetShadingModel ( EMaterialShadingModel NewModel
)

   Materials/Material.h  

bool SetSparseVolumeTextureParameterValueEditorOnly ( FName ParameterName,
USparseVolumeTexture* InValue
)

   Materials/Material.h  

bool SetStaticComponentMaskParameterValueEditorOnly ( FName ParameterName,
bool R,
bool G,
bool B,
bool A,
FGuid OutExpressionGuid
)

   Materials/Material.h  

bool SetStaticSwitchParameterValueEditorOnly ( FName ParameterName,
bool OutValue,
FGuid OutExpressionGuid
)

   Materials/Material.h  

bool SetTextureCollectionParameterValueEditorOnly ( FName ParameterName,
UTextureCollection* InValue
)

   Materials/Material.h  

bool SetTextureParameterValueEditorOnly ( FName ParameterName,
UTexture* InValue
)

   Materials/Material.h  

bool SetVectorParameterValueEditorOnly ( FName ParameterName,
FLinearColor InValue
)

   Materials/Material.h  

void StartCacheUniformExpressions()

 Tracking of in-flight uniform expression cache update operations for the DefaultMaterialInstance, for thread safety destroying the resource. Materials/Material.h  

bool SupportsShadingModelOverride()

 Return true if the material support shading model override Materials/Material.h  

void UpdateCachedExpressionData()

   Materials/Material.h  

virtual void UpdateExpressionDynamicParameters ( const UMaterialExpression* Expression
)

 Iterate through all of the expression nodes and fix up changed properties on matching dynamic parameters when a change occurs. Materials/Material.h  

virtual void UpdateExpressionParameterName ( UMaterialExpression* Expression
)

 Remove the expression from the editor parameters list (if it exists) and then re-adds it. Materials/Material.h  
Recompute the ddc cache key and reload the material in case the key is not the same. Materials/Material.h  

void UpdateTransientExpressionData()

   Materials/Material.h  

bool UserRequestsConvertMaterialToSubstrateMaterial()

   Materials/Material.h  

Overridden from UMaterialInterface

Name Remarks Include Path Unreal Specifiers

virtual void AppendCompileStateDebugInfo ( FStringBuilderBase& OutDebugInfo
) const

   Materials/Material.h  

virtual void CacheGivenTypesForCooking ( EShaderPlatform ShaderPlatform,
ERHIFeatureLevel::Type FeatureLevel,
EMaterialQualityLevel::Type QualityLevel,
const TArray< const FVertexFactoryType* >& VFTypes,
const TArray< const FShaderPipelineType* > PipelineTypes,
const TArray< const FShaderType* >& ShaderTypes
)

   Materials/Material.h  

virtual void CacheShaders ( EMaterialShaderPrecompileMode CompileMode
)

 Submits remaining shaders for recompilation. Materials/Material.h  

virtual bool CastsRayTracedShadows()

   Materials/Material.h  

virtual bool CheckMaterialUsage ( const EMaterialUsage Usage
)

 Checks if the material can be used with the given usage flag. Materials/Material.h  

virtual bool CheckMaterialUsage_Concurrent ( const EMaterialUsage Usage
) const

 Same as above but is valid to call from any thread. Materials/Material.h  

virtual void ClearNumericParameterDefault ( EMaterialParameterType Type,
const FHashedMaterialParameterInfo& ParameterInfo,
EShaderPlatform InShaderPlatform
)

   Materials/Material.h  

virtual int32 CompilePropertyEx ( FMaterialCompiler* Compiler,
const FGuid& AttributeID
)

 Allows material properties to be compiled with the option of being overridden by the material attributes input. Materials/Material.h  

virtual uint32 ComputeAllStateCRC ()

 Returns a CRC of all the Guids related to this material's shader. Materials/Material.h  

virtual void DumpDebugInfo ( FOutputDevice& OutputDevice
) const

   Materials/Material.h  

virtual void ForceRecompileForRendering ( EMaterialShaderPrecompileMode CompileMode
)

 Clears the shader cache and recompiles the shader for rendering. Materials/Material.h  

virtual EBlendableLocation GetBlendableLocation ( const UMaterial* Base
) const

   Materials/Material.h  

virtual int32 GetBlendablePriority ( const UMaterial* Base
) const

   Materials/Material.h  

virtual EBlendMode GetBlendMode()

   Materials/Material.h  

virtual bool GetCastDynamicShadowAsMasked()

   Materials/Material.h  

virtual void GetDependencies ( TSet< UMaterialInterface* >& Dependencies
)

 Get this material dependencies. Materials/Material.h  

virtual void GetDependentFunctions ( TArray< class UMaterialFunctionInterface* >& DependentFunctions
) const

   Materials/Material.h  

virtual FDisplacementFadeRange GetDisplacementFadeRange()

   Materials/Material.h  

virtual FDisplacementScaling GetDisplacementScaling()

   Materials/Material.h  
  Materials/Material.h  
  Materials/Material.h  

virtual const UClass * GetEditorOnlyDataClass()

   Materials/Material.h  

virtual bool GetGroupSortPriority ( const FString& InGroupName,
int32& OutSortPriority
) const

 Get the sort priority index of the given parameter group Materials/Material.h  

virtual void GetLightingGuidChain ( bool bIncludeTextures,
TArray< FGuid >& OutGuids
) const

 Returns all the Guids related to this material. Materials/Material.h  

virtual const UMaterial * GetMaterial ()

 Get the material which we are instancing. Materials/Material.h  

virtual UMaterial * GetMaterial ()

 Get the material which we are instancing. Materials/Material.h  

virtual const UMaterial * GetMaterial_Concurrent ( TMicRecursionGuard RecursionGuard
) const

 Same as above, but can be called concurrently Materials/Material.h  

virtual void GetMaterialInheritanceChain ( FMaterialInheritanceChain& OutChain
) const

   Materials/Material.h  

virtual bool GetMaterialLayers ( FMaterialLayersFunctions& OutLayers,
TMicRecursionGuard RecursionGuard
) const

 Get the material layers stack Materials/Material.h  

virtual const FMaterialResource * GetMaterialResource ( EShaderPlatform InShaderPlatform,
EMaterialQualityLevel::Type QualityLevel
) const

   Materials/Material.h  
  Materials/Material.h  

virtual float GetMaxWorldPositionOffsetDisplacement()

   Materials/Material.h  

virtual UMaterialInterface * GetNaniteOverride ( TMicRecursionGuard RecursionGuard
) const

 Get the associated nanite override material Materials/Material.h  

virtual UNeuralProfile * GetNeuralProfile_Internal()

   Materials/Material.h  

virtual float GetOpacityMaskClipValue()

 Access to overridable properties of the base material. Materials/Material.h  

virtual bool GetParameterValue ( EMaterialParameterType Type,
const FMemoryImageMaterialParameterInfo& ParameterInfo,
FMaterialParameterMetadata& OutValue,
EMaterialGetParameterValueFlags Flags
) const

   Materials/Material.h  

virtual UPhysicalMaterial * GetPhysicalMaterial()

 Return a pointer to the physical material used by this material instance. Materials/Material.h  

virtual UPhysicalMaterial * GetPhysicalMaterialFromMap ( int32 Index
) const

 Return a pointer to the physical material from mask map at given index. Materials/Material.h  

virtual UPhysicalMaterialMask * GetPhysicalMaterialMask()

 Return a pointer to the physical material mask used by this material instance. Materials/Material.h  

virtual bool GetRefractionSettings ( float& OutBiasValue
) const

   Materials/Material.h  
Return a pointer to the FMaterialRenderProxy used for rendering. Materials/Material.h  

virtual void GetShaderTypes ( EShaderPlatform Platform,
const ITargetPlatform* TargetPlatform,
TArray< FDebugShaderTypeInfo >& OutShaderInfo
)

 Gathers a list of shader types sorted by vertex factory types that should be cached for this material. Materials/Material.h  

virtual FMaterialShadingModelField GetShadingModels()

   Materials/Material.h  

virtual USpecularProfile * GetSpecularProfile_Internal ( uint32 Index
) const

   Materials/Material.h  

virtual USubsurfaceProfile * GetSubsurfaceProfile_Internal()

   Materials/Material.h  

virtual USubsurfaceProfile * GetSubsurfaceProfileOverride_Internal()

   Materials/Material.h  
  Materials/Material.h  

virtual USubsurfaceProfile * GetSubsurfaceProfileRoot_Internal ( uint32 Index
) const

   Materials/Material.h  

virtual bool GetTexturesInPropertyChain ( EMaterialProperty InProperty,
TArray< UTexture* >& OutTextures,
TArray< FName >* OutTextureParamNames,
FStaticParameterSet* InStaticParameterSet,
ERHIFeatureLevel::Type InFeatureLevel,
EMaterialQualityLevel::Type InQuality
)

 Get all of the textures in the expression chain for the given property (ie fill in the given array with all textures in the chain). Materials/Material.h  

virtual void GetUsedTextures ( TArray< UTexture* >& OutTextures,
TOptional< EMaterialQualityLevel::Type > InSpecificQualityLevel,
TOptional< EShaderPlatform > InSpecificShaderPlatform
) const

 Return the textures used to render this material. Materials/Material.h  

virtual void GetUsedTexturesAndIndices ( TArray< UTexture* >& OutTextures,
TArray< TArray< int32 > >& OutIndices,
EMaterialQualityLevel::Type QualityLevel,
EShaderPlatform InShaderPlatform
) const

   Materials/Material.h  

virtual bool HasCustomizedUVs()

   Materials/Material.h  

virtual bool HasCustomPrimitiveData()

   Materials/Material.h  

virtual bool HasMeshPaintTexture()

   Materials/Material.h  

virtual bool HasPixelAnimation()

   Materials/Material.h  

virtual bool HasSubstrateRoughnessTracking()

   Materials/Material.h  

virtual bool HasVertexInterpolator()

   Materials/Material.h  

virtual bool IsCompatibleWithLumenCardSharing()

   Materials/Material.h  

virtual bool IsCompiling()

   Materials/Material.h  

virtual bool IsComplete ()

 Checks to see if this material has all its shaders cached. Materials/Material.h  

virtual bool IsDeferredDecal()

   Materials/Material.h  

virtual bool IsDisplacementFadeEnabled()

   Materials/Material.h  

virtual bool IsDitheredLODTransition()

   Materials/Material.h  

virtual bool IsMasked()

   Materials/Material.h  

virtual bool IsPostProcessMaterial()

   Materials/Material.h  

virtual bool IsPropertyActive ( EMaterialProperty InProperty
) const

 Checks to see if an input property should be active, based on the state of the material Materials/Material.h  

virtual bool IsShadingModelFromMaterialExpression()

   Materials/Material.h  

virtual bool IsTessellationEnabled()

   Materials/Material.h  

virtual bool IsThinSurface()

   Materials/Material.h  

virtual bool IsTranslucencyVelocityFromDepth()

   Materials/Material.h  

virtual bool IsTranslucencyWritingCustomDepth()

   Materials/Material.h  

virtual bool IsTranslucencyWritingFrontLayerTransparency()

   Materials/Material.h  

virtual bool IsTranslucencyWritingVelocity()

   Materials/Material.h  

virtual bool IsTwoSided()

   Materials/Material.h  

virtual bool IsUIMaterial()

   Materials/Material.h  

virtual bool IterateDependentFunctions ( TFunctionRef< bool(UMaterialFunctionInterface*)> Predicate
) const

   Materials/Material.h  

virtual void LogMaterialsAndTextures ( FOutputDevice& Ar,
int32 Indent
) const

 Output to the log which materials and textures are used by this material. Materials/Material.h  

virtual uint32 NumSpecularProfile_Internal()

   Materials/Material.h  

virtual uint32 NumSubsurfaceProfileRoot_Internal()

   Materials/Material.h  

virtual void OverrideTexture ( const UTexture* InTextureToOverride,
UTexture* OverrideTexture,
ERHIFeatureLevel::Type InFeatureLevel
)

 Override a specific texture (transient) Materials/Material.h  

virtual void RecacheUniformExpressions ( bool bRecreateUniformBuffer
) const

 Re-caches uniform expressions for this material interface Materials/Material.h  

virtual void SaveShaderStableKeysInner ( const ITargetPlatform* TP,
const FStableShaderKeyAndValue& SaveKeyVal
)

   Materials/Material.h  

virtual void SetNumericParameterDefault ( EMaterialParameterType Type,
const FHashedMaterialParameterInfo& ParameterInfo,
const UE::Shader::FValue& Value,
EShaderPlatform InShaderPlatform
)

   Materials/Material.h  

virtual bool ShouldAlwaysEvaluateWorldPositionOffset()

   Materials/Material.h  

virtual bool ShouldForcePlanePreview()

 True if this Material Interface should force a plane preview Materials/Material.h  
Check if the textures have changed since the last time the material was serialized for Lightmass... Materials/Material.h  

virtual bool WritesToRuntimeVirtualTexture()

   Materials/Material.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void BeginCacheForCookedPlatformData ( const ITargetPlatform* TargetPlatform
)

   Materials/Material.h  

virtual void BeginDestroy()

   Materials/Material.h  

virtual bool CanEditChange ( const FProperty* InProperty
) const

   Materials/Material.h  

virtual void ClearAllCachedCookedPlatformData()

   Materials/Material.h  

virtual void ClearCachedCookedPlatformData ( const ITargetPlatform* TargetPlatform
)

   Materials/Material.h  

virtual void FinishDestroy()

   Materials/Material.h  

virtual void GetAssetRegistryTags ( FAssetRegistryTagsContext Context
) const

   Materials/Material.h  

virtual void GetResourceSizeEx ( FResourceSizeEx& CumulativeResourceSize
)

   Materials/Material.h  

virtual bool IsCachedCookedPlatformDataLoaded ( const ITargetPlatform* TargetPlatform
)

   Materials/Material.h  

virtual bool IsReadyForFinishDestroy()

   Materials/Material.h  

virtual bool Modify ( bool bAlwaysMarkDirty
)

   Materials/Material.h  

virtual void OnCookEvent ( UE::Cook::ECookEvent CookEvent,
UE::Cook::FCookEventContext& CookContext
)

   Materials/Material.h  

virtual void PostDuplicate ( bool bDuplicateForPIE
)

   Materials/Material.h  

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   Materials/Material.h  

virtual void PostInitProperties()

   Materials/Material.h  

virtual void PostLoad()

   Materials/Material.h  

virtual void PreEditChange ( FProperty* PropertyAboutToChange
)

   Materials/Material.h  

virtual void PreSave ( FObjectPreSaveContext ObjectSaveContext
)

   Materials/Material.h  

virtual void Serialize ( FArchive& Ar
)

   Materials/Material.h  

Overridden from UObjectBaseUtility

Name Remarks Include Path Unreal Specifiers

virtual bool CanBeClusterRoot()

   Materials/Material.h  

Protected

Name Remarks Include Path Unreal Specifiers

virtual bool RecursiveGetExpressionChain ( UMaterialExpression* InExpression,
TArray< FExpressionInput* >& InOutProcessedInputs,
TArray< UMaterialExpression* >& OutExpressions,
FStaticParameterSet* InStaticParameterSet,
ERHIFeatureLevel::Type InFeatureLevel,
EMaterialQualityLevel::Type InQuality,
ERHIShadingPath::Type InShadingPath,
EShaderFrequency InShaderFrequency,
EMaterialProperty InProperty,
const bool bInRecurseIntoMaterialFunctions
)

 Recursively retrieve the expressions contained in the chain of the given expression. Materials/Material.h  

void RecursiveUpdateRealtimePreview ( UMaterialExpression* InExpression,
TArray< UMaterialExpression* >& InOutExpressionsToProcess
)

 Recursively update the bRealtimePreview for each expression based on whether it is connected to something that is time-varying. Materials/Material.h  

Static

Name Remarks Include Path Unreal Specifiers

static void AddReferencedObjects ( UObject* InThis,
FReferenceCollector& Collector
)

   Materials/Material.h  

static void AllMaterialsCacheResourceShadersForRendering ( bool bUpdateProgressDialog,
bool bCacheAllRemainingShaders
)

 For all materials, UMaterial::CacheResourceShadersForRendering. Materials/Material.h  

static void CompileMaterialsForRemoteRecompile ( const TArray< UMaterialInterface* >& MaterialsToCompile,
EShaderPlatform ShaderPlatform,
ITargetPlatform* TargetPlatform,
TMap< FString, TArray< TRefCountPtr< class FMaterialShaderMap > > >& OutShaderMaps
)

 Builds a map from UMaterialInterface name to the shader maps that are needed for rendering on the given platform. Materials/Material.h  

static void CompileODSCMaterialsForRemoteRecompile ( TArray< FODSCRequestPayload > ShadersToRecompile,
TMap< FString, TArray< TRefCountPtr< class FMaterialShaderMap > > >& OutShaderMaps,
TFunction< UMaterialInterface*(const FString&)> ODSCCustomLoadMaterial
)

   Materials/Material.h  

static void DeclareConstructClasses ( TArray< FTopLevelAssetPath >& OutConstructClasses,
const UClass* SpecificSubclass
)

   Materials/Material.h  

static void FixCommentPositions ( TConstArrayView< TObjectPtr< UMaterialExpressionComment > > Comments
)

 Shifts the positions of comments so that they are aligned correctly with other expressions Materials/Material.h  

static bool FixFeatureLevelNodesForSM6 ( TArray< UMaterialExpression* > const& InExpressions
)

 Fixup feature level nodes that haven't set the SM6 pin. Returns true if a fixup was needed. Materials/Material.h  

static void FlipExpressionPositions ( TConstArrayView< TObjectPtr< UMaterialExpression > > Expressions,
TConstArrayView< TObjectPtr< UMaterialExpressionComment > > Comments,
bool bScaleCoords,
UMaterial* Material
)

 Flip the X coordinates of a material's expressions and space them out more Materials/Material.h  

static void ForceNoCompilationInPostLoad ( bool bForceNoCompilation
)

 DO NOT CALL outside of FMaterialEditor! Materials/Material.h  

static EBlendMode GetBlendModeFromString ( const TCHAR* InBlendModeStr
)

   Materials/Material.h  

static const TCHAR * GetBlendModeString ( EBlendMode InBlendMode
)

   Materials/Material.h  

static UMaterial * GetDefaultMaterial ( EMaterialDomain Domain
)

 Return the default material, loading it if necessary Materials/Material.h  

static UMaterialFunctionInterface * GetExpressionFunctionPointer ( const UMaterialExpression* Expression
)

   Materials/Material.h  

static TOptional< FLayersInterfaces > GetExpressionLayers ( const UMaterialExpression* Expression
)

   Materials/Material.h  

static bool GetExpressionParameterName ( const UMaterialExpression* Expression,
FName& OutName
)

 Get the name of a parameter. Materials/Material.h  

static EMaterialShadingModel GetMaterialShadingModelFromString ( const TCHAR* InMaterialShadingModelStr
)

   Materials/Material.h  

static const TCHAR * GetMaterialShadingModelString ( EMaterialShadingModel InMaterialShadingModel
)

 Helper functions for text output of properties. Materials/Material.h  

static bool IsDynamicParameter ( const UMaterialExpression* Expression
)

 Return whether the provided expression node is a dynamic parameter. Materials/Material.h  

static bool IsParameter ( const UMaterialExpression* Expression
)

 Return whether the provided expression node is a parameter. Materials/Material.h  

static bool IsPropertyRelevantForMobile ( EMaterialProperty InProperty
)

 Returns true if the material property is relevant for mobile platforms Materials/Material.h  

static void NotifyCompilationFinished ( UMaterialInterface* Material
)

   Materials/Material.h  

static FMaterialCompilationFinished & OnMaterialCompilationFinished()

   Materials/Material.h  

static void UpdateMaterialShaders ( TArray< const FShaderType* >& ShaderTypesToFlush,
TArray< const FShaderPipelineType* >& ShaderPipelineTypesToFlush,
TArray< const FVertexFactoryType* >& VFTypesToFlush,
EShaderPlatform ShaderPlatform
)

 Go through every material, flush the specified types and re-initialize the material's shader maps. Materials/Material.h  

Deprecated Variables

Name Type Remarks Include Path Unreal Specifiers
bIsMasked_DEPRECATED uint8 True if Material is masked and uses custom opacity Materials/Material.h  
bRootNodeOverridesDefaultDistortion_DEPRECATED uint8 Indicates that the material do not use the material physically based refraction (e.g. IOR from reflectivity F0), but overrides it for artistic purposes. Materials/Material.h  
bUsedWithUI_DEPRECATED uint8 Indicates that the material and its instances can be used with SlateUI and UMG This will result in the shaders required to support UI materials being compiled which will increase shader compile time and memory usage. Materials/Material.h  
bUseFullPrecision_DEPRECATED uint8 Deprecated. Materials/Material.h  
RefractionMode_DEPRECATED TEnumAsByte< ERefractionMode >   Materials/Material.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page