1. Epic GamesDeveloper
  3. UMaterialInterface

UMaterialInterface

API > API/Runtime > API/Runtime/Engine

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

Syntax

UCLASS (Abstract, BlueprintType, MinimalAPI, HideCategories=(Thumbnail))  
class UMaterialInterface :  
    public UObject ,  
    public IBlendableInterface ,  
    public IInterface_AssetUserData

Inheritance Hierarchy

Implements Interfaces

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

UMaterialInterface ( const FObjectInitializer& ObjectInitializer
)

   Materials/MaterialInterface.h  
  Materials/MaterialInterface.h  
  Materials/MaterialInterface.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~UMaterialInterface()

   Materials/MaterialInterface.h  

Constants

Name Type Remarks Include Path
FeatureLevelsForAllMaterials uint32 Feature level bitfield to compile for all materials Materials/MaterialInterface.h
SamplerTypeEnum UEnum * Cached type information for the sampler type enumeration. Materials/MaterialInterface.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
AssetImportData TObjectPtr< class UAssetImportData > Importing data and options used for this material Materials/MaterialInterface.h
  • EditAnywhere
  • Instanced
  • Category=ImportSettings
bIncludedInBaseGame uint8 Whether this material interface is included in the base game (and not in a DLC) Materials/MaterialInterface.h
  • Meta=(DisplayAfter="NeuralProfile")
LayerParameterExpansion TMap< FString, bool >   Materials/MaterialInterface.h  
MaterialInsight TUniquePtr< FMaterialInsights >   Materials/MaterialInterface.h  
NeuralProfile TObjectPtr< class UNeuralProfile > Neural network profile. For internal usage, not editable/visible Materials/MaterialInterface.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category=PostProcessMaterial
  • Meta=(DisplayName="Neural Profile")
OnBaseMaterialSetEvent FOnBaseMaterialIsSet Event triggered when the base material is set Materials/MaterialInterface.h  
ParameterOverviewExpansion TMap< FString, bool >   Materials/MaterialInterface.h  
ParentRefFence FRenderCommandFence A fence to track when the primitive is no longer used as a parent Materials/MaterialInterface.h  
PreviewMesh FSoftObjectPath The mesh used by the material editor to preview the material. Materials/MaterialInterface.h
  • EditAnywhere
  • Category=Previewing
  • Meta=(AllowedClasses="/Script/Engine.StaticMesh,/Script/Engine.SkeletalMesh", ExactClass="true")
SpecularProfiles TArray< TObjectPtr< class USpecularProfile > > Specular Profile. For internal usage, not editable/visible Materials/MaterialInterface.h  
SubsurfaceProfile TObjectPtr< class USubsurfaceProfile > SubsurfaceProfile, for Screen Space Subsurface Scattering.. Materials/MaterialInterface.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category=Material
  • Meta=(DisplayName="Subsurface Profile")
SubsurfaceProfiles TArray< TObjectPtr< class USubsurfaceProfile > > Subsurface Profiles. Materials/MaterialInterface.h  
TextureStreamingDataMissingEntries TArray< FMaterialTextureInfo > List of all used but missing texture indices in TextureStreamingData. Materials/MaterialInterface.h
  • Transient
ThumbnailInfo TObjectPtr< class UThumbnailInfo > Information for thumbnail rendering Materials/MaterialInterface.h
  • VisibleAnywhere
  • Instanced
  • Category=Thumbnail

Protected

Name Type Remarks Include Path Unreal Specifiers
bShouldForcePlanePreview bool Whether or not this material interface should force the preview to be a plane mesh. Materials/MaterialInterface.h  
FeatureLevelsToForceCompile uint32 Feature levels to force to compile. Materials/MaterialInterface.h  
LightingGuid FGuid Unique ID for this material, used for caching during distributed lighting Materials/MaterialInterface.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AnalyzeMaterialCompilationInCallback ( TFunctionRef< void(FMaterialCompiler*)> InCompilationCallback,
FMaterialAnalysisResult& OutResult
)

 Return insight on what (e.g. texture coordinates, vertex data, etc) is used in the shader graph compiled by a callback Materials/MaterialInterface.h  

void AnalyzeMaterialCustomOutput ( UMaterialExpressionCustomOutput* InCustomOutput,
int32 InOutputIndex,
FMaterialAnalysisResult& OutResult
)

 Return insight on what (e.g. texture coordinates, vertex data, etc) is used in the shader graph of a material custom output Materials/MaterialInterface.h  

void AnalyzeMaterialProperty ( EMaterialProperty InProperty,
int32& OutNumTextureCoordinates,
bool& bOutRequiresVertexData
)

 Return number of used texture coordinates and whether or not the Vertex data is used in the shader graph Materials/MaterialInterface.h  

void AnalyzeMaterialPropertyEx ( EMaterialProperty InProperty,
FMaterialAnalysisResult& OutResult
)

 Return insight on what (e.g. texture coordinates, vertex data, etc) is used in the shader graph of a material property Materials/MaterialInterface.h  

void AnalyzeMaterialTranslationOutput ( FMaterialResource* MaterialResource,
EShaderPlatform ShaderPlatform,
bool ValidationMode,
FMaterialAnalysisResult& OutResult
)

   Materials/MaterialInterface.h  

void AnalyzeMaterialTranslationOutput ( FMaterialResource* MaterialResource,
EShaderPlatform ShaderPlatform,
FMaterialAnalysisResult& OutResult
)

 Return insight on errors or warnings generated during translation Materials/MaterialInterface.h  

virtual void AppendCompileStateDebugInfo ( FStringBuilderBase& OutDebugInfo
) const

   Materials/MaterialInterface.h  

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

   Materials/MaterialInterface.h  

virtual void CacheShaders ( EMaterialShaderPrecompileMode CompileMode
)

 Submits remaining shaders for recompilation. Materials/MaterialInterface.h  

virtual bool CastsRayTracedShadows()

   Materials/MaterialInterface.h  

virtual bool CheckMaterialUsage ( const EMaterialUsage Usage
)

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

virtual bool CheckMaterialUsage_Concurrent ( const EMaterialUsage Usage
) const

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

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

   Materials/MaterialInterface.h  

int32 CompileProperty ( FMaterialCompiler* Compiler,
EMaterialProperty Property,
uint32 ForceCastFlags
)

 Compiles a material property. Materials/MaterialInterface.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/MaterialInterface.h  

virtual uint32 ComputeAllStateCRC()

   Materials/MaterialInterface.h  

virtual void DumpDebugInfo ( FOutputDevice& OutputDevice
) const

   Materials/MaterialInterface.h  
Checks to see if this material has all its shaders cached and if not, will perform a synchronous compilation of those. Materials/MaterialInterface.h  

bool FindTextureStreamingDataIndexRange ( FName TextureName,
int32& LowerIndex,
int32& HigherIndex
) const

 Find entries within TextureStreamingData that match the given name. Materials/MaterialInterface.h  

virtual void ForceRecompileForRendering ( EMaterialShaderPrecompileMode CompileMode
)

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

void GetAllDoubleVectorParameterInfo ( TArray< FMaterialParameterInfo >& OutParameterInfo,
TArray< FGuid >& OutParameterIds
) const

   Materials/MaterialInterface.h  

void GetAllFontParameterInfo ( TArray< FMaterialParameterInfo >& OutParameterInfo,
TArray< FGuid >& OutParameterIds
) const

   Materials/MaterialInterface.h  

void GetAllParameterCollectionParameterInfo ( TArray< FMaterialParameterInfo >& OutParameterInfo,
TArray< FGuid >& OutParameterIds
) const

   Materials/MaterialInterface.h  

virtual void GetAllParameterInfoOfType ( EMaterialParameterType Type,
TArray< FMaterialParameterInfo >& OutParameterInfo,
TArray< FGuid >& OutParameterIds
) const

   Materials/MaterialInterface.h  

virtual void GetAllParametersOfType ( EMaterialParameterType Type,
TMap< FMaterialParameterInfo, FMaterialParameterMetadata >& OutParameters
) const

   Materials/MaterialInterface.h  

void GetAllRuntimeVirtualTextureParameterInfo ( TArray< FMaterialParameterInfo >& OutParameterInfo,
TArray< FGuid >& OutParameterIds
) const

   Materials/MaterialInterface.h  

void GetAllScalarParameterInfo ( TArray< FMaterialParameterInfo >& OutParameterInfo,
TArray< FGuid >& OutParameterIds
) const

   Materials/MaterialInterface.h  

void GetAllSparseVolumeTextureParameterInfo ( TArray< FMaterialParameterInfo >& OutParameterInfo,
TArray< FGuid >& OutParameterIds
) const

   Materials/MaterialInterface.h  

void GetAllStaticComponentMaskParameterInfo ( TArray< FMaterialParameterInfo >& OutParameterInfo,
TArray< FGuid >& OutParameterIds
) const

   Materials/MaterialInterface.h  

void GetAllStaticSwitchParameterInfo ( TArray< FMaterialParameterInfo >& OutParameterInfo,
TArray< FGuid >& OutParameterIds
) const

   Materials/MaterialInterface.h  

void GetAllTextureCollectionParameterInfo ( TArray< FMaterialParameterInfo >& OutParameterInfo,
TArray< FGuid >& OutParameterIds
) const

   Materials/MaterialInterface.h  

void GetAllTextureParameterInfo ( TArray< FMaterialParameterInfo >& OutParameterInfo,
TArray< FGuid >& OutParameterIds
) const

   Materials/MaterialInterface.h  

void GetAllVectorParameterInfo ( TArray< FMaterialParameterInfo >& OutParameterInfo,
TArray< FGuid >& OutParameterIds
) const

   Materials/MaterialInterface.h  
Walks up parent chain and finds the base Material that this is an instance of. Materials/MaterialInterface.h
  • BlueprintCallable
  • Category="Rendering|Material"

virtual EBlendableLocation GetBlendableLocation ( const UMaterial* Base
) const

   Materials/MaterialInterface.h  

virtual int32 GetBlendablePriority ( const UMaterial* Base
) const

   Materials/MaterialInterface.h  

virtual EBlendMode GetBlendMode()

   Materials/MaterialInterface.h
  • BlueprintCallable
  • Category="Rendering|Material"

virtual const FMaterialCachedExpressionData & GetCachedExpressionData ( TMicRecursionGuard RecursionGuard
) const

   Materials/MaterialInterface.h  

virtual bool GetCastDynamicShadowAsMasked()

   Materials/MaterialInterface.h  

virtual bool GetCastShadowAsMasked()

   Materials/MaterialInterface.h  

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

 Get this material dependencies. Materials/MaterialInterface.h  

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

   Materials/MaterialInterface.h  

virtual float GetDiffuseBoost()

   Materials/MaterialInterface.h  

virtual FDisplacementFadeRange GetDisplacementFadeRange()

   Materials/MaterialInterface.h  

virtual FDisplacementScaling GetDisplacementScaling()

   Materials/MaterialInterface.h  

bool GetDoubleVectorParameterChannelNames ( const FHashedMaterialParameterInfo& ParameterInfo,
FParameterChannelNames& OutValue
) const

   Materials/MaterialInterface.h  

bool GetDoubleVectorParameterDefaultValue ( const FHashedMaterialParameterInfo& ParameterInfo,
FVector4d& OutValue
) const

   Materials/MaterialInterface.h  

bool GetDoubleVectorParameterValue ( const FHashedMaterialParameterInfo& ParameterInfo,
FVector4d& OutValue,
bool bOveriddenOnly
) const

   Materials/MaterialInterface.h  
  Materials/MaterialInterface.h  
  Materials/MaterialInterface.h  

virtual float GetEmissiveBoost()

   Materials/MaterialInterface.h  

virtual float GetExportResolutionScale()

   Materials/MaterialInterface.h  

bool GetFontParameterDefaultValue ( const FHashedMaterialParameterInfo& ParameterInfo,
UFont*& OutFontValue,
int32& OutFontPage
) const

   Materials/MaterialInterface.h  

bool GetFontParameterValue ( const FHashedMaterialParameterInfo& ParameterInfo,
UFont*& OutFontValue,
int32& OutFontPage,
bool bOveriddenOnly
) const

   Materials/MaterialInterface.h  

bool GetGroupName ( const FHashedMaterialParameterInfo& ParameterInfo,
FName& GroupName
) const

   Materials/MaterialInterface.h  

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

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

int32 GetHeight()

   Materials/MaterialInterface.h  

const FGuid & GetLightingGuid()

   Materials/MaterialInterface.h  

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

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

virtual UMaterial * GetMaterial ()

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

virtual const UMaterial * GetMaterial ()

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

virtual const UMaterial * GetMaterial_Concurrent ( TMicRecursionGuard RecursionGuard
) const

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

virtual void GetMaterialInheritanceChain ( FMaterialInheritanceChain& OutChain
) const

   Materials/MaterialInterface.h  

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

 Get the material layers stack Materials/MaterialInterface.h  

virtual const FMaterialResource * GetMaterialResource ( ERHIFeatureLevel::Type InFeatureLevel,
EMaterialQualityLevel::Type QualityLevel
) const

 Get the static permutation resource if the instance has one Materials/MaterialInterface.h  
Get the static permutation resource if the instance has one Materials/MaterialInterface.h  
  Materials/MaterialInterface.h  

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

   Materials/MaterialInterface.h  

virtual float GetMaxWorldPositionOffsetDisplacement()

   Materials/MaterialInterface.h  

UMaterialInterface * GetNaniteOverideMaterial()

 Get the associated nanite override material. Materials/MaterialInterface.h
  • BlueprintCallable
  • Category="Rendering|Material"

virtual UMaterialInterface * GetNaniteOverride ( TMicRecursionGuard RecursionGuard
) const

 Get the associated nanite override material Materials/MaterialInterface.h  

virtual UNeuralProfile * GetNeuralProfile_Internal()

   Materials/MaterialInterface.h  

virtual float GetOpacityMaskClipValue()

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

bool GetOverrideCastShadowAsMasked()

   Materials/MaterialInterface.h  

bool GetOverrideDiffuseBoost()

   Materials/MaterialInterface.h  

bool GetOverrideEmissiveBoost()

   Materials/MaterialInterface.h  

bool GetOverrideExportResolutionScale()

   Materials/MaterialInterface.h  

bool GetParameterCollectionParameterDefaultValue ( const FHashedMaterialParameterInfo& ParameterInfo,
UMaterialParameterCollection*& OutValue
) const

   Materials/MaterialInterface.h  

virtual bool GetParameterCollectionParameterValue ( const FHashedMaterialParameterInfo& ParameterInfo,
UMaterialParameterCollection*& OutValue,
bool bOveriddenOnly
) const

   Materials/MaterialInterface.h  

bool GetParameterDefaultValue ( EMaterialParameterType Type,
const FMemoryImageMaterialParameterInfo& ParameterInfo,
FMaterialParameterMetadata& OutValue
) const

   Materials/MaterialInterface.h  

bool GetParameterDesc ( const FHashedMaterialParameterInfo& ParameterInfo,
FString& OutDesc
) const

   Materials/MaterialInterface.h  

FMaterialParameterInfo GetParameterInfo ( EMaterialParameterAssociation Association,
FName ParameterName,
UMaterialFunctionInterface* LayerFunction
) const

   Materials/MaterialInterface.h
  • BlueprintCallable
  • Category="Rendering|Material"

bool GetParameterSortPriority ( const FHashedMaterialParameterInfo& ParameterInfo,
int32& OutSortPriority
) const

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

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

   Materials/MaterialInterface.h  

virtual UPhysicalMaterial * GetPhysicalMaterial()

 Return a pointer to the physical material used by this material instance. Materials/MaterialInterface.h
  • BlueprintCallable
  • Category="Physics|Material"

virtual UPhysicalMaterial * GetPhysicalMaterialFromMap ( int32 Index
) const

 Return a pointer to the physical material from mask map at given index. Materials/MaterialInterface.h
  • BlueprintCallable
  • Category="Physics|Material"

virtual UPhysicalMaterialMask * GetPhysicalMaterialMask()

 Return a pointer to the physical material mask used by this material instance. Materials/MaterialInterface.h
  • BlueprintCallable
  • Category="Physics|Material"

void GetQualityLevelUsage ( TArray< bool, TInlineAllocator< EMaterialQualityLevel::Num > >& QualityLevelsUsed,
EShaderPlatform ShaderPlatform,
bool bCooking
)

 Determines whether each quality level has different nodes by inspecting the material's expressions. Materials/MaterialInterface.h  

void GetQualityLevelUsageForCooking ( TArray< bool, TInlineAllocator< EMaterialQualityLevel::Num > >& QualityLevelsUsed,
EShaderPlatform ShaderPlatform
)

   Materials/MaterialInterface.h  

TConstArrayView< TObjectPtr< UTextureCollection > > GetReferencedTextureCollections()

   Materials/MaterialInterface.h  

TArrayView< const TObjectPtr< UObject > > GetReferencedTextures()

 Get textures referenced by expressions, including nested functions. Materials/MaterialInterface.h  

virtual void GetReferencedTexturesAndOverrides ( TSet< const UTexture* >& InOutTextures
) const

 Add to the set any texture referenced by expressions, including nested functions, as well as any overrides from parameters. Materials/MaterialInterface.h  

virtual bool GetRefractionSettings ( float& OutBiasValue
) const

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

bool GetRuntimeVirtualTextureParameterDefaultValue ( const FHashedMaterialParameterInfo& ParameterInfo,
URuntimeVirtualTexture*& OutValue
) const

   Materials/MaterialInterface.h  

bool GetRuntimeVirtualTextureParameterValue ( const FHashedMaterialParameterInfo& ParameterInfo,
URuntimeVirtualTexture*& OutValue,
bool bOveriddenOnly
) const

   Materials/MaterialInterface.h  

bool GetScalarParameterDefaultValue ( const FHashedMaterialParameterInfo& ParameterInfo,
float& OutValue
) const

   Materials/MaterialInterface.h  

bool GetScalarParameterSliderMinMax ( const FHashedMaterialParameterInfo& ParameterInfo,
float& OutSliderMin,
float& OutSliderMax
) const

   Materials/MaterialInterface.h  

bool GetScalarParameterValue ( const FHashedMaterialParameterInfo& ParameterInfo,
float& OutValue,
bool bOveriddenOnly
) const

   Materials/MaterialInterface.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/MaterialInterface.h  

virtual FMaterialShadingModelField GetShadingModels()

   Materials/MaterialInterface.h
  • BlueprintCallable
  • Category="Rendering|Material"

bool GetSparseVolumeTextureParameterDefaultValue ( const FHashedMaterialParameterInfo& ParameterInfo,
USparseVolumeTexture*& OutValue
) const

   Materials/MaterialInterface.h  

bool GetSparseVolumeTextureParameterValue ( const FHashedMaterialParameterInfo& ParameterInfo,
USparseVolumeTexture*& OutValue,
bool bOveriddenOnly
) const

   Materials/MaterialInterface.h  

virtual USpecularProfile * GetSpecularProfile_Internal ( uint32 Index
) const

   Materials/MaterialInterface.h  

virtual USpecularProfile * GetSpecularProfileOverride_Internal()

   Materials/MaterialInterface.h  

bool GetStaticComponentMaskParameterDefaultValue ( const FHashedMaterialParameterInfo& ParameterInfo,
bool& OutR,
bool& OutG,
bool& OutB,
bool& OutA,
FGuid& OutExpressionGuid
) const

   Materials/MaterialInterface.h  

bool GetStaticComponentMaskParameterValue ( const FHashedMaterialParameterInfo& ParameterInfo,
bool& R,
bool& G,
bool& B,
bool& A,
FGuid& OutExpressionGuid,
bool bOveriddenOnly
) const

 Get the value of the given static component mask parameter Materials/MaterialInterface.h  

void GetStaticParameterValues ( FStaticParameterSet& OutStaticParameters
)

 Builds a composited set of static parameters, including inherited and overridden values Materials/MaterialInterface.h  

bool GetStaticSwitchParameterDefaultValue ( const FHashedMaterialParameterInfo& ParameterInfo,
bool& OutValue,
FGuid& OutExpressionGuid
) const

   Materials/MaterialInterface.h  

bool GetStaticSwitchParameterValue ( const FHashedMaterialParameterInfo& ParameterInfo,
bool& OutValue,
FGuid& OutExpressionGuid,
bool bOveriddenOnly
) const

 Get the value of the given static switch parameter Materials/MaterialInterface.h  

const FSubstrateCompilationConfig & GetSubstrateCompilationConfig()

   Materials/MaterialInterface.h  

virtual USubsurfaceProfile * GetSubsurfaceProfile_Internal()

   Materials/MaterialInterface.h  

virtual USubsurfaceProfile * GetSubsurfaceProfileOverride_Internal()

   Materials/MaterialInterface.h  

virtual USubsurfaceProfile * GetSubsurfaceProfileRoot_Internal ( uint32 Index
) const

   Materials/MaterialInterface.h  
  Materials/MaterialInterface.h  

bool GetTextureCollectionParameterDefaultValue ( const FHashedMaterialParameterInfo& ParameterInfo,
UTextureCollection*& OutValue
) const

   Materials/MaterialInterface.h  

virtual bool GetTextureCollectionParameterValue ( const FHashedMaterialParameterInfo& ParameterInfo,
UTextureCollection*& OutValue,
bool bOveriddenOnly
) const

   Materials/MaterialInterface.h  

virtual float GetTextureDensity ( FName TextureName,
const FMeshUVChannelInfo& UVChannelData
) const

 Returns the density of a texture in (LocalSpace Unit / Texture). Materials/MaterialInterface.h  

bool GetTextureParameterChannelNames ( const FHashedMaterialParameterInfo& ParameterInfo,
FParameterChannelNames& OutValue
) const

   Materials/MaterialInterface.h  

bool GetTextureParameterDefaultValue ( const FHashedMaterialParameterInfo& ParameterInfo,
UTexture*& OutValue
) const

   Materials/MaterialInterface.h  

virtual bool GetTextureParameterValue ( const FHashedMaterialParameterInfo& ParameterInfo,
UTexture*& OutValue,
bool bOveriddenOnly
) const

   Materials/MaterialInterface.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/MaterialInterface.h  
Accessor to the data. Materials/MaterialInterface.h  
  Materials/MaterialInterface.h  

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

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

virtual void GetUsedTextures ( TArray< UTexture* >& OutTextures,
EMaterialQualityLevel::Type QualityLevel,
bool bAllQualityLevels,
ERHIFeatureLevel::Type FeatureLevel,
bool bAllFeatureLevels
) const

   Materials/MaterialInterface.h  

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

 Return the textures used to render this material and the material indices bound to each. Materials/MaterialInterface.h  

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

   Materials/MaterialInterface.h  

FName GetUserSceneTextureOutput ( const UMaterial* Base
) const

   Materials/MaterialInterface.h  

virtual bool GetUserSceneTextureOverride ( FName& InOutValue
) const

   Materials/MaterialInterface.h  

bool GetVectorParameterChannelNames ( const FHashedMaterialParameterInfo& ParameterInfo,
FParameterChannelNames& OutValue
) const

   Materials/MaterialInterface.h  

bool GetVectorParameterDefaultValue ( const FHashedMaterialParameterInfo& ParameterInfo,
FLinearColor& OutValue
) const

   Materials/MaterialInterface.h  

bool GetVectorParameterValue ( const FHashedMaterialParameterInfo& ParameterInfo,
FLinearColor& OutValue,
bool bOveriddenOnly
) const

   Materials/MaterialInterface.h  

int32 GetWidth()

   Materials/MaterialInterface.h  

virtual bool HasCustomizedUVs()

   Materials/MaterialInterface.h  

virtual bool HasCustomPrimitiveData()

   Materials/MaterialInterface.h  

virtual bool HasMeshPaintTexture()

   Materials/MaterialInterface.h  

virtual bool HasPixelAnimation()

   Materials/MaterialInterface.h  

virtual bool HasSubstrateRoughnessTracking()

   Materials/MaterialInterface.h  

bool HasTextureStreamingData()

 Returns whether there is any streaming data in the component. Materials/MaterialInterface.h  

virtual bool HasVertexInterpolator()

   Materials/MaterialInterface.h  

virtual bool IsCompatibleWithLumenCardSharing()

   Materials/MaterialInterface.h  

virtual bool IsCompiling()

   Materials/MaterialInterface.h  

virtual bool IsComplete ()

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

virtual bool IsDeferredDecal()

   Materials/MaterialInterface.h  

virtual bool IsDependent ( UMaterialInterface* TestDependency
)

 Test this material for dependency on a given material. Materials/MaterialInterface.h  

virtual bool IsDependent_Concurrent ( UMaterialInterface* TestDependency,
TMicRecursionGuard RecursionGuard
)

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

virtual bool IsDisplacementFadeEnabled()

   Materials/MaterialInterface.h  

virtual bool IsDitheredLODTransition()

   Materials/MaterialInterface.h  

bool IsDoubleVectorParameterUsedAsChannelMask ( const FHashedMaterialParameterInfo& ParameterInfo,
bool& OutValue
) const

   Materials/MaterialInterface.h  

bool IsEditorOnlyDataValid()

   Materials/MaterialInterface.h  

virtual bool IsMasked()

   Materials/MaterialInterface.h  

virtual bool IsPostProcessMaterial()

   Materials/MaterialInterface.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/MaterialInterface.h  

bool IsScalarParameterUsedAsAtlasPosition ( const FHashedMaterialParameterInfo& ParameterInfo,
bool& OutValue,
TSoftObjectPtr< class UCurveLinearColor >& Curve,
TSoftObjectPtr< class UCurveLinearColorAtlas >& Atlas
) const

   Materials/MaterialInterface.h  

virtual bool IsShadingModelFromMaterialExpression()

   Materials/MaterialInterface.h  

virtual bool IsTessellationEnabled()

   Materials/MaterialInterface.h  

bool IsTextureReferencedByProperty ( EMaterialProperty InProperty,
const UTexture* InTexture
)

 Checks to see if the given property references the texture Materials/MaterialInterface.h  

virtual bool IsThinSurface()

   Materials/MaterialInterface.h  

virtual bool IsTranslucencyVelocityFromDepth()

   Materials/MaterialInterface.h  

virtual bool IsTranslucencyWritingCustomDepth()

   Materials/MaterialInterface.h  

virtual bool IsTranslucencyWritingFrontLayerTransparency()

   Materials/MaterialInterface.h  

virtual bool IsTranslucencyWritingVelocity()

   Materials/MaterialInterface.h  

virtual bool IsTwoSided()

   Materials/MaterialInterface.h  

virtual bool IsUIMaterial()

   Materials/MaterialInterface.h  

bool IsUsingMotionVectorWorldOffset_Concurrent ( EShaderPlatform InShaderPlatform
) const

   Materials/MaterialInterface.h  

bool IsUsingNewHLSLGenerator()

   Materials/MaterialInterface.h  

bool IsUsingNewTranslatorPrototype()

   Materials/MaterialInterface.h  

bool IsUsingTemporalResponsiveness_Concurrent ( EShaderPlatform InShaderPlatform
) const

   Materials/MaterialInterface.h  
  Materials/MaterialInterface.h  

bool IsUsingWorldPositionOffset_Concurrent ( EShaderPlatform InShaderPlatform
) const

   Materials/MaterialInterface.h  

bool IsVectorParameterUsedAsChannelMask ( const FHashedMaterialParameterInfo& ParameterInfo,
bool& OutValue
) const

   Materials/MaterialInterface.h  

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

   Materials/MaterialInterface.h  

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

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

virtual uint32 NumSpecularProfile_Internal()

   Materials/MaterialInterface.h  

virtual uint32 NumSubsurfaceProfileRoot_Internal()

   Materials/MaterialInterface.h  

virtual void OnAssignedAsOverride ( const UObject* Owner
)

 Callback triggered when the material has been assigned as an override material Materials/MaterialInterface.h  

virtual void OnRemovedAsOverride ( const UObject* Owner
)

 Callback triggered when the material has been removed as an override material Materials/MaterialInterface.h  

virtual void OverrideNumericParameterDefault ( EMaterialParameterType Type,
const FHashedMaterialParameterInfo& ParameterInfo,
const UE::Shader::FValue& Value,
bool bOverride,
ERHIFeatureLevel::Type FeatureLevel
)

 Overrides the default value of the given parameter (transient). Materials/MaterialInterface.h  

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

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

FGraphEventArray PrecachePSOs ( const TConstArrayView< const FVertexFactoryType* >& VertexFactoryTypes,
const FPSOPrecacheParams& PreCacheParams,
EPSOPrecachePriority PSOPrecachePriority,
TArray< FMaterialPSOPrecacheRequestID >& OutMaterialPSORequestIDs
)

   Materials/MaterialInterface.h  

FGraphEventArray PrecachePSOs ( const TConstArrayView< const FVertexFactoryType* >& VertexFactoryTypes,
const FPSOPrecacheParams& PreCacheParams
)

   Materials/MaterialInterface.h  

FGraphEventArray PrecachePSOs ( const TConstArrayView< const FVertexFactoryType* >& VertexFactoryTypes,
const FPSOPrecacheParams& PreCacheParams,
TArray< FMaterialPSOPrecacheRequestID >& OutMaterialPSORequestIDs
)

   Materials/MaterialInterface.h  

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

   Materials/MaterialInterface.h  

FGraphEventArray PrecachePSOs ( const FVertexFactoryType* VertexFactoryType,
const FPSOPrecacheParams& PreCacheParams
)

 Precache PSOs which can be used for this material for the given vertex factory type and material paramaters Materials/MaterialInterface.h  

virtual void RecacheUniformExpressions ( bool bRecreateUniformBuffer
) const

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

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

   Materials/MaterialInterface.h  

void SetCastShadowAsMasked ( bool InCastShadowAsMasked
)

   Materials/MaterialInterface.h  

void SetDiffuseBoost ( float InDiffuseBoost
)

   Materials/MaterialInterface.h  

void SetEmissiveBoost ( float InEmissiveBoost
)

   Materials/MaterialInterface.h  

void SetExportResolutionScale ( float InExportResolutionScale
)

   Materials/MaterialInterface.h  

void SetFeatureLevelToCompile ( ERHIFeatureLevel::Type FeatureLevel,
bool bShouldCompile
)

 Set which feature levels this material instance should compile. Materials/MaterialInterface.h  

virtual void SetForceMipLevelsToBeResident ( bool OverrideForceMiplevelsToBeResident,
bool bForceMiplevelsToBeResidentValue,
float ForceDuration,
int32 CinematicTextureGroups,
bool bFastResponse
)

 Force the streaming system to disregard the normal logic for the specified duration and instead always load all mip-levels for all textures used by this material. Materials/MaterialInterface.h
  • BlueprintCallable
  • Category="Rendering|Material"

void SetLightingGuid()

   Materials/MaterialInterface.h  

void SetMarkTextureAsEditorStreamingPool ( bool bInMarkAsEditorStreamingPool
)

 Set the bMarkAsEditorStreamingPool on all textures used by this MaterialInterface. Materials/MaterialInterface.h  

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

   Materials/MaterialInterface.h  

void SetOverrideCastShadowAsMasked ( bool bInOverrideCastShadowAsMasked
)

   Materials/MaterialInterface.h  

void SetOverrideDiffuseBoost ( bool bInOverrideDiffuseBoost
)

   Materials/MaterialInterface.h  

void SetOverrideEmissiveBoost ( bool bInOverrideEmissiveBoost
)

   Materials/MaterialInterface.h  

void SetOverrideExportResolutionScale ( bool bInOverrideExportResolutionScale
)

   Materials/MaterialInterface.h  

void SetShouldForcePlanePreview ( const bool bInShouldForcePlanePreview
)

 Set whether or not this Material Interface should force a plane preview Materials/MaterialInterface.h  

void SetSubstrateCompilationConfig ( FSubstrateCompilationConfig& SubstrateCompilationConfig
)

   Materials/MaterialInterface.h  

void SetTextureStreamingData ( const TArray< FMaterialTextureInfo >& InTextureStreamingData
)

 Set new texture streaming data. Materials/MaterialInterface.h  

virtual bool ShouldAlwaysEvaluateWorldPositionOffset()

   Materials/MaterialInterface.h  

virtual bool ShouldForcePlanePreview()

 True if this Material Interface should force a plane preview Materials/MaterialInterface.h  

void SortTextureStreamingData ( bool bForceSort,
bool bFinalSort
)

 Sort the texture streaming data by names to accelerate search. Only sorts if required. Materials/MaterialInterface.h  
Check if the textures have changed since the last time the material was serialized for Lightmass... Materials/MaterialInterface.h  

bool UseAnyStreamingTexture()

 Return whether this material refer to any streaming textures. Materials/MaterialInterface.h  

virtual bool WritesToRuntimeVirtualTexture()

   Materials/MaterialInterface.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void BeginDestroy()

   Materials/MaterialInterface.h  

virtual void FinishDestroy()

   Materials/MaterialInterface.h  

virtual void GetAssetRegistryTagMetadata ( TMap< FName, FAssetRegistryTagMetadata >& OutMetadata
) const

   Materials/MaterialInterface.h  

virtual void GetAssetRegistryTags ( FAssetRegistryTagsContext Context
) const

   Materials/MaterialInterface.h  

virtual bool IsReadyForFinishDestroy()

   Materials/MaterialInterface.h  

virtual void PostCDOContruct()

   Materials/MaterialInterface.h  

virtual void PostDuplicate ( bool bDuplicateForPIE
)

   Materials/MaterialInterface.h  

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   Materials/MaterialInterface.h  

virtual void PostInitProperties()

   Materials/MaterialInterface.h  

virtual void PostLoad()

   Materials/MaterialInterface.h  

virtual void PreSave ( FObjectPreSaveContext ObjectSaveContext
)

   Materials/MaterialInterface.h  

virtual bool Rename ( const TCHAR* NewName,
UObject* NewOuter,
ERenameFlags Flags
)

   Materials/MaterialInterface.h  

virtual void Serialize ( FArchive& Ar
)

   Materials/MaterialInterface.h  

Overridden from IBlendableInterface

Name Remarks Include Path Unreal Specifiers

virtual void OverrideBlendableSettings ( FSceneView& View,
float Weight
) const

   Materials/MaterialInterface.h  

Overridden from IInterface_AssetUserData

Name Remarks Include Path Unreal Specifiers

virtual void AddAssetUserData ( UAssetUserData* InUserData
)

   Materials/MaterialInterface.h  

virtual UAssetUserData * GetAssetUserDataOfClass ( TSubclassOf< UAssetUserData > InUserDataClass
)

 Returns an instance of the provided AssetUserData class if it's contained in the target asset. Materials/MaterialInterface.h  

virtual void RemoveUserDataOfClass ( TSubclassOf< UAssetUserData > InUserDataClass
)

   Materials/MaterialInterface.h  

Protected

Name Remarks Include Path Unreal Specifiers

virtual const UClass * GetEditorOnlyDataClass()

   Materials/MaterialInterface.h  
Returns a bitfield indicating which feature levels should be compiled for rendering. Materials/MaterialInterface.h  

void UpdateMaterialRenderProxy ( FMaterialRenderProxy& Proxy
)

   Materials/MaterialInterface.h  

Static

Name Remarks Include Path Unreal Specifiers

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

   Materials/MaterialInterface.h  

static void AppendToClassSchema ( FAppendToClassSchemaContext& Context
)

   Materials/MaterialInterface.h  

static void AssertDefaultMaterialsExist()

 Asserts if any default material does not exist. Materials/MaterialInterface.h  

static void AssertDefaultMaterialsPostLoaded()

 Asserts if any default material has not been post-loaded. Materials/MaterialInterface.h  

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

   Materials/MaterialInterface.h  

static void FilterOutPlatformShadingModels ( EShaderPlatform Platform,
FMaterialShadingModelField& ShadingModels
)

 Filter out ShadingModels field to a shader platform settings Materials/MaterialInterface.h  

static uint32 GetFeatureLevelsToCompileForAllMaterials()

 Get bitfield indicating which feature levels should be compiled by default Materials/MaterialInterface.h  

static UEnum * GetSamplerTypeEnum()

 Access the cached uenum type information for material sampler type Materials/MaterialInterface.h  

static void InitDefaultMaterials()

 Initializes all default materials. Materials/MaterialInterface.h  

static bool IsDefaultMaterialInitialized()

 Check if default materials as been initialized. Materials/MaterialInterface.h  

static void IterateOverActiveFeatureLevels ( FunctionType InHandler
)

 Iterate over all feature levels currently marked as active Materials/MaterialInterface.h  

static void PostLoadDefaultMaterials()

 Post loads all default materials. Materials/MaterialInterface.h  

static void PrecacheDefaultMaterialPSOs()

 Precache PSOs for all default materials. Materials/MaterialInterface.h  

static void RecacheAllMaterialUniformExpressions ( bool bRecreateUniformBuffer
)

 Re-caches uniform expressions for all material interfaces Set bRecreateUniformBuffer to true if uniform buffer layout will change (e.g. FMaterial is being recompiled). Materials/MaterialInterface.h  

static void SetGlobalRequiredFeatureLevel ( ERHIFeatureLevel::Type FeatureLevel,
bool bShouldCompile
)

 Set which feature levels all materials should compile to. GMaxRHIFeatureLevel is always compiled. Materials/MaterialInterface.h  
Submits shaders to be compiled for all the materials in the world. Materials/MaterialInterface.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page