Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > Engine > FMaterialResource

Light Theme

Dark Theme

FMaterialResource

Implementation of the [FMaterial](API\Runtime\Engine\FMaterial) interface for a [UMaterial](API\Runtime\Engine\Materials\UMaterial) or [UMaterialInstance](API\Runtime\Engine\Materials\UMaterialInstance).

Windows

MacOS

Linux

Inheritance Hierarchy

FMaterial

FMaterialResource

FMaterialResourceStats

References

Module	Engine
Header	/Engine/Source/Runtime/Engine/Public/MaterialShared.h
Include	#include "MaterialShared.h"

Syntax

class FMaterialResource : public FMaterial

Remarks

Implementation of the FMaterial interface for a UMaterial or UMaterialInstance.

Variables

		Name	Description
	UMaterial *	Material
	UMaterialInstan...	MaterialInstance

Constructors

	Name	Description
	FMaterialResource()

Destructors

	Name	Description
	~FMaterialResource()

Functions

	Name	Description
void	GetEstimatedNumTextureSamples ( uint32& VSSamples, uint32& PSSamples )
uint32	GetEstimatedNumVirtualTextureLookups()
const UMater...	GetMaterial()
const UMater...	GetMaterialInstance()
uint32	GetNumVirtualTextureStacks()
void	GetResourceSizeEx ( FResourceSizeEx& CumulativeResourc... )
int32	GetSamplerUsage()	Returns the number of samplers used in this material, or -1 if the material does not have a valid shader map (compile error or still compiling).
void	GetUserInterpolatorUsage ( uint32& NumUsedUVScalars, uint32& NumUsedCustomInterpolatorS... )
void	SetMaterial ( UMaterial* InMaterial )
void	SetMaterial ( UMaterial* InMaterial, UMaterialInstance* InInstance, ERHIFeatureLevel::Type InFeatureLev..., EMaterialQualityLevel::Type InQuali... )
void	SetMaterialInstance ( UMaterialInstance* InMaterialI... )

Overridden from FMaterial

	Name	Description
void	AddReferencedObjects ( FReferenceCollector& Collector )
bool	AllowNegativeEmissiveColor()
void	BeginAllowCachingStaticParameterValues()
bool	CastsRayTracedShadows()
int32	CompilePropertyAndSetMaterialProperty ( EMaterialProperty Property, FMaterialCompiler* Compiler, EShaderFrequency OverrideShaderFreq..., bool bUsePreviousFrameTime )	Entry point for compiling a specific material property. This must call SetMaterialProperty.
bool	ComputeFogPerPixel()
void	EndAllowCachingStaticParameterValues()
void	GatherCustomOutputExpressions ( TArray< class UMaterialExpressionCu... )	Gives the material a chance to compile any custom output nodes it has added
void	GatherExpressionsForCustomInterpolators ( TArray< class UMaterialExpression&... )	Gather any UMaterialExpressionCustomOutput expressions in the material and referenced function calls
bool	GetAllowDevelopmentShaderCompile()	Returns true if this material is allowed to make development shaders via the global CVar CompileShadersForDevelopment.
FString	GetAssetName()	Similar to GetFriendlyName, but but avoids historical behavior of the former, returning the exact asset name for material instances instead of just the material.
FName	GetAssetPath()	Allows to associate the shader resources with the asset for load order.
FString	GetBaseMaterialPathName()	Useful for debugging.
int32	GetBlendableLocation()
bool	GetBlendableOutputAlpha()
enum EBlendM...	GetBlendMode()
bool	GetCastDynamicShadowAsMasked()
FString	GetDebugName()
uint32	GetDecalBlendMode()
bool	GetForwardBlendsSkyLightCubemaps()
FString	GetFriendlyName()
FString	GetFullPath()
uint32	GetMaterialDecalResponse()
EMaterialDom...	GetMaterialDomain()
FGuid	GetMaterialId()	Gets the Guid that represents this material.
UMaterialInt...	GetMaterialInterface()
FString	GetMaterialUsageDescription()	Returns a string that describes the material's usage for debugging purposes.
float	GetMaxDisplacement()
int32	GetNumCustomizedUVs()
float	GetOpacityMaskClipValue()
TArrayView< ...	GetReferencedTextures()
float	GetRefractionDepthBiasValue()
enum ERefrac...	GetRefractionMode()
void	GetShaderMapId ( EShaderPlatform Platform, const ITargetPlatform* TargetP..., FMaterialShaderMapId& OutId )	Material properties.
FMaterialSha...	GetShadingModels()
EMaterialSha...	GetShadingRate()
void	GetStaticParameterSet ( EShaderPlatform Platform, FStaticParameterSet& OutSet )
uint32	GetStencilCompare()
uint32	GetStencilRefValue()
enum EMateri...	GetTessellationMode()
float	GetTranslucencyDirectionalLightingIntensity()
enum ETransl...	GetTranslucencyLightingMode()
float	GetTranslucentBackscatteringExponent()
FLinearColor	GetTranslucentMultipleScatteringExtinction()
float	GetTranslucentSelfShadowDensityScale()
float	GetTranslucentSelfShadowSecondDensityScale()
float	GetTranslucentSelfShadowSecondOpacity()
float	GetTranslucentShadowDensityScale()
float	GetTranslucentShadowStartOffset()
bool	HasAmbientOcclusionConnected()
bool	HasAnisotropyConnected()
bool	HasBaseColorConnected()
bool	HasEmissiveColorConnected()
bool	HasMaterialAttributesConnected()
bool	HasMaterialLayers()
bool	HasNormalConnected()
bool	HasPixelDepthOffsetConnected()
bool	HasRoughnessConnected()
bool	HasRuntimeVirtualTextureOutput()
bool	HasSpecularConnected()
bool	HasVertexPositionOffsetConnected()
bool	IsAdaptiveTessellationEnabled()
bool	IsCrackFreeDisplacementEnabled()
bool	IsDefaultMaterial()
bool	IsDeferredDecal()
bool	IsDistorted()
bool	IsDitheredLODTransition()
bool	IsDitherMasked()
bool	IsDualBlendingEnabled ( EShaderPlatform Platform )
bool	IsFullyRough()
bool	IsLightFunction()
bool	IsMasked()
bool	IsMobileSeparateTranslucencyEnabled()
bool	IsNonmetal()
bool	IsPersistent()	Should shaders compiled for this material be saved to disk?
bool	IsShadingModelFromMaterialExpression()
bool	IsSky()
bool	IsSpecialEngineMaterial()
bool	IsStencilTestEnabled()
bool	IsTangentSpaceNormal()
bool	IsTranslucencyAfterDOFEnabled()
bool	IsTranslucencyWritingCustomDepth()
bool	IsTranslucencyWritingVelocity()
bool	IsTwoSided()
bool	IsUIMaterial()
bool	IsUsedWithAPEXCloth()
bool	IsUsedWithBeamTrails()
bool	IsUsedWithEditorCompositing()
bool	IsUsedWithGeometryCache()
bool	IsUsedWithGeometryCollections()
bool	IsUsedWithHairStrands()
bool	IsUsedWithInstancedStaticMeshes()
bool	IsUsedWithLandscape()
bool	IsUsedWithLidarPointCloud()
bool	IsUsedWithMeshParticles()
bool	IsUsedWithMorphTargets()
bool	IsUsedWithNiagaraMeshParticles()
bool	IsUsedWithNiagaraRibbons()
bool	IsUsedWithNiagaraSprites()
bool	IsUsedWithParticleSprites()
bool	IsUsedWithParticleSystem()
bool	IsUsedWithSkeletalMesh()
bool	IsUsedWithSplineMeshes()
bool	IsUsedWithStaticLighting()
bool	IsUsedWithVirtualHeightfieldMesh()
bool	IsUsedWithWater()
bool	IsUsingAlphaToCoverage()
bool	IsUsingFullPrecision()
bool	IsUsingHQForwardReflections()
bool	IsUsingPlanarForwardReflections()
bool	IsUsingPreintegratedGFForSimpleIBL()
bool	IsVolumetricPrimitive()
bool	IsWireframe()
void	LegacySerialize ( FArchive& Ar )	Serializes the material.
void	NotifyCompilationFinished()	Called when compilation of an FMaterial finishes, after the GameThreadShaderMap is set and the render command to set the RenderThreadShaderMap is queued
bool	RequiresSynchronousCompilation()
bool	ShouldApplyCloudFogging()
bool	ShouldApplyFogging()
bool	ShouldBlockGI()
bool	ShouldDisableDepthTest()
bool	ShouldDoContactShadows()
bool	ShouldDoSSR()
bool	ShouldEnableResponsiveAA()
bool	ShouldGenerateSphericalParticleNormals()
bool	ShouldInjectEmissiveIntoLPV()
bool	ShouldInlineShaderCode()	Some materials may be loaded early - before the shader library - and need their code inlined
bool	ShouldWriteDepthToTranslucentMaterial()
bool	ShouldWriteOnlyAlpha()
bool	UseLmDirectionality()
bool	UseNormalCurvatureToRoughness()

Deprecated Functions

		Name	Description
	void	SetMaterial ( UMaterial* InMaterial, EMaterialQualityLevel::Type InQuali..., bool bInHasQualityLevelUsage, ERHIFeatureLevel::Type InFeatureLev..., UMaterialInstance* InInstance )	Parameter bInHasQualityLevelUsage is depreceated

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss