Module |
|
Header |
/Engine/Source/Runtime/Engine/Classes/Materials/MaterialInterface.h |
Include |
#include "Materials/MaterialInterface.h" |
class UMaterialInterface :
public UObject,
public IBlendableInterface,
public IInterface_AssetUserData
Name | Description | ||
---|---|---|---|
|
uint8 |
AllowCachingStaticParameterValuesCounter |
|
|
TObjectPtr< cla... |
AssetImportData |
Importing data and options used for this material |
|
AssetUserData |
Array of user data stored with the asset |
|
|
uint8: 1 |
bIncludedInBaseGame |
Whether this material interface is included in the base game (and not in a DLC) |
|
bool |
bLoadedCachedExpressionData |
Set if CachedExpressionData was loaded from disk, should typically be true when running with cooked data, and false in the editor |
|
bool |
bTextureStreamingDataSorted |
Because of redirector, the texture names need to be resorted at each load in case they changed. |
|
TUniquePtr< FMa... |
CachedExpressionData |
Cached data generated from the material's expressions, may be nullptr UMaterials should always have cached data UMaterialInstances will have cached data if they have overriden material layers (possibly for other reasons in the future) |
|
TUniquePtr< FMa... |
CachedHLSLTree |
|
|
CachedStaticParameterValues |
||
|
TObjectPtr< UMa... |
EditorOnlyData |
|
|
LayerParameterExpansion |
||
|
LightmassSettings |
The Lightmass settings for this object. |
|
|
ParameterOverviewExpansion |
||
|
ParentRefFence |
A fence to track when the primitive is no longer used as a parent |
|
|
PreviewMesh |
The mesh used by the material editor to preview the material. |
|
|
SpecularProfiles |
Specular Profile. For internal usage, not editable/visible |
|
|
TObjectPtr< cla... |
SubsurfaceProfile |
SubsurfaceProfile, for Screen Space Subsurface Scattering.. |
|
TextureStreamingData |
Data used by the texture streaming to know how each texture is sampled by the material. |
|
|
TextureStreamingDataMissingEntries |
List of all used but missing texture indices in TextureStreamingData. |
|
|
int32 |
TextureStreamingDataVersion |
|
|
TObjectPtr< cla... |
ThumbnailInfo |
Information for thumbnail rendering |
Name | Description | |
---|---|---|
|
UMaterialInterface() |
|
|
UMaterialInterface ( |
|
|
UMaterialInterface ( |
Name | Description | |
---|---|---|
|
~UMaterialInterface() |
Name | Description | ||
---|---|---|---|
|
void |
AddReferencedObjects ( |
|
|
void |
AnalyzeMaterialCompilationInCallback ( |
Return insight on what (e.g. texture coordinates, vertex data, etc) is used in the shader graph compiled by a callback |
|
void |
AnalyzeMaterialCustomOutput ( |
Return insight on what (e.g. texture coordinates, vertex data, etc) is used in the shader graph of a material custom output |
|
void |
AnalyzeMaterialProperty ( |
Return number of used texture coordinates and whether or not the Vertex data is used in the shader graph |
|
void |
AnalyzeMaterialPropertyEx ( |
Return insight on what (e.g. texture coordinates, vertex data, etc) is used in the shader graph of a material property |
|
void |
AssertDefaultMaterialsExist() |
Asserts if any default material does not exist. |
|
void |
AssertDefaultMaterialsPostLoaded() |
Asserts if any default material has not been post-loaded. |
|
void |
CacheGivenTypesForCooking ( |
|
|
void |
CacheShaders ( |
Submits remaining shaders for recompilation. |
|
bool |
CastsRayTracedShadows() |
|
|
bool |
CheckMaterialUsage ( |
Checks if the material can be used with the given usage flag. |
|
bool |
CheckMaterialUsage_Concurrent ( |
Same as above but is valid to call from any thread. |
|
int32 |
CompileProperty ( |
Compiles a material property. |
|
int32 |
CompilePropertyEx ( |
Allows material properties to be compiled with the option of being overridden by the material attributes input. |
|
uint32 |
ComputeAllStateCRC() |
|
|
UMaterialInt... |
CreateEditorOnlyData() |
|
|
void |
DeclareConstructClasses ( |
|
|
void |
DumpDebugInfo ( |
|
|
void |
EnsureIsComplete() |
Checks to see if this material has all its shaders cached and if not, will perform a synchronous compilation of those. |
|
void |
FilterOutPlatformShadingModels ( |
Filter out ShadingModels field to a shader platform settings |
|
bool |
FindTextureStreamingDataIndexRange ( |
Find entries within TextureStreamingData that match the given name. |
|
void |
ForceRecompileForRendering() |
Clears the shader cache and recompiles the shader for rendering. |
|
void |
GetAllDoubleVectorParameterInfo ( |
|
|
void |
GetAllFontParameterInfo ( |
|
|
void |
GetAllParameterInfoOfType ( |
|
|
void |
GetAllParametersOfType ( |
|
|
void |
GetAllRuntimeVirtualTextureParameterInfo ( |
|
|
void |
GetAllScalarParameterInfo ( |
|
|
void |
GetAllSparseVolumeTextureParameterInfo ( |
|
|
void |
GetAllStaticComponentMaskParameterInfo ( |
|
|
void |
GetAllStaticSwitchParameterInfo ( |
|
|
void |
GetAllTextureParameterInfo ( |
|
|
void |
GetAllVectorParameterInfo ( |
|
|
UMaterial &#... |
GetBaseMaterial() |
Walks up parent chain and finds the base Material that this is an instance of. |
|
EBlendMode |
GetBlendMode() |
|
|
const FMater... |
GetCachedExpressionData ( |
|
|
const FMater... |
GetCachedHLSLTree ( |
|
|
bool |
GetCastDynamicShadowAsMasked() |
|
|
bool |
GetCastShadowAsMasked() |
|
|
void |
GetDependencies ( |
Get this material dependencies. |
|
void |
GetDependentFunctions ( |
|
|
float |
GetDiffuseBoost() |
|
|
FDisplacemen... |
GetDisplacementScaling() |
|
|
bool |
GetDoubleVectorParameterChannelNames ( |
|
|
bool |
GetDoubleVectorParameterDefaultValue ( |
|
|
bool |
GetDoubleVectorParameterValue ( |
|
|
const UMater... |
GetEditorOnlyData() |
|
|
UMaterialInt... |
GetEditorOnlyData() |
|
|
const UClass... |
GetEditorOnlyDataClass() |
|
|
float |
GetEmissiveBoost() |
|
|
float |
GetExportResolutionScale() |
|
|
uint32 |
GetFeatureLevelsToCompileForAllMaterials() |
Get bitfield indicating which feature levels should be compiled by default |
|
uint32 |
GetFeatureLevelsToCompileForRendering() |
Returns a bitfield indicating which feature levels should be compiled for rendering. |
|
bool |
GetFontParameterDefaultValue ( |
|
|
bool |
GetFontParameterValue ( |
|
|
bool |
GetGroupName ( |
|
|
bool |
GetGroupSortPriority ( |
Get the sort priority index of the given parameter group |
|
int32 |
GetHeight() |
|
|
const FGuid ... |
GetLightingGuid() |
|
|
void |
GetLightingGuidChain |
Returns all the Guids related to this material. |
|
const UMater... |
GetMaterial() |
Get the material which we are instancing. |
|
UMaterial &#... |
GetMaterial() |
Get the material which we are instancing. |
|
const UMater... |
GetMaterial_Concurrent ( |
Same as above, but can be called concurrently |
|
void |
GetMaterialInheritanceChain ( |
|
|
bool |
GetMaterialLayers ( |
Get the material layers stack |
|
const FMater... |
GetMaterialResource ( |
Get the static permutation resource if the instance has one |
|
FMaterialRes... |
GetMaterialResource ( |
Get the static permutation resource if the instance has one |
|
float |
GetMaxWorldPositionOffsetDisplacement() |
|
|
UMaterialInt... |
GetNaniteOverideMaterial() |
Get the associated nanite override material. |
|
UMaterialInt... |
GetNaniteOverride ( |
Get the associated nanite override material |
|
float |
GetOpacityMaskClipValue() |
Access to overridable properties of the base material. |
|
bool |
GetOverrideCastShadowAsMasked() |
|
|
bool |
GetOverrideDiffuseBoost() |
|
|
bool |
GetOverrideEmissiveBoost() |
|
|
bool |
GetOverrideExportResolutionScale() |
|
|
bool |
GetParameterDefaultValue ( |
|
|
bool |
GetParameterDesc ( |
|
|
FMaterialPar... |
GetParameterInfo ( |
|
|
bool |
GetParameterSortPriority ( |
Get the sort priority index of the given parameter |
|
bool |
GetParameterValue ( |
|
|
UPhysicalMat... |
GetPhysicalMaterial() |
Return a pointer to the physical material used by this material instance. |
|
UPhysicalMat... |
GetPhysicalMaterialFromMap ( |
Return a pointer to the physical material from mask map at given index. |
|
UPhysicalMat... |
GetPhysicalMaterialMask() |
Return a pointer to the physical material mask used by this material instance. |
|
void |
GetQualityLevelUsage |
Determines whether each quality level has different nodes by inspecting the material's expressions. |
|
void |
GetQualityLevelUsageForCooking |
|
|
TArrayView< ... |
GetReferencedTextures() |
Get textures referenced by expressions, including nested functions. |
|
void |
GetReferencedTexturesAndOverrides |
Add to the set any texture referenced by expressions, including nested functions, as well as any overrides from parameters. |
|
bool |
GetRefractionSettings ( |
|
|
FMaterialRel... |
GetRelevance ( |
|
|
FMaterialRel... |
GetRelevance_Concurrent ( |
|
|
FMaterialRen... |
GetRenderProxy() |
Return a pointer to the FMaterialRenderProxy used for rendering. |
|
bool |
GetRuntimeVirtualTextureParameterDefaultValue ( |
|
|
bool |
GetRuntimeVirtualTextureParameterValue ( |
|
|
UEnum * |
GetSamplerTypeEnum() |
Access the cached uenum type information for material sampler type |
|
bool |
GetScalarParameterDefaultValue ( |
|
|
bool |
GetScalarParameterSliderMinMax ( |
|
|
bool |
GetScalarParameterValue ( |
|
|
void |
GetShaderTypes ( |
Gathers a list of shader types sorted by vertex factory types that should be cached for this material. |
|
FMaterialSha... |
GetShadingModels() |
|
|
bool |
GetSparseVolumeTextureParameterDefaultValue ( |
|
|
bool |
GetSparseVolumeTextureParameterValue ( |
|
|
USpecularPro... |
GetSpecularProfile_Internal ( |
|
|
bool |
GetStaticComponentMaskParameterDefaultValue ( |
|
|
bool |
GetStaticComponentMaskParameterValue ( |
Get the value of the given static component mask parameter |
|
void |
GetStaticParameterValues ( |
Builds a composited set of static parameters, including inherited and overridden values |
|
bool |
GetStaticSwitchParameterDefaultValue ( |
|
|
bool |
GetStaticSwitchParameterValue ( |
Get the value of the given static switch parameter |
|
const FStrat... |
GetStrataCompilationConfig() |
|
|
USubsurfaceP... |
GetSubsurfaceProfile_Internal() |
|
|
float |
GetTextureDensity ( |
Returns the density of a texture in (LocalSpace Unit / Texture). |
|
bool |
GetTextureParameterChannelNames ( |
|
|
bool |
GetTextureParameterDefaultValue ( |
|
|
bool |
GetTextureParameterValue ( |
|
|
bool |
GetTexturesInPropertyChain ( |
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). |
|
const TArray... |
GetTextureStreamingData() |
Accessor to the data. |
|
GetTextureStreamingData() |
||
|
void |
GetUsedTextures ( |
Return the textures used to render this material. |
|
void |
GetUsedTexturesAndIndices ( |
Return the textures used to render this material and the material indices bound to each. |
|
bool |
GetVectorParameterChannelNames ( |
|
|
bool |
GetVectorParameterDefaultValue ( |
|
|
bool |
GetVectorParameterValue ( |
|
|
int32 |
GetWidth() |
|
|
bool |
HasTextureStreamingData() |
Returns whether there is any streaming data in the component. |
|
void |
InitDefaultMaterials() |
Initializes all default materials. |
|
bool |
IsComplete() |
Checks to see if this material has all its shaders cached. |
|
bool |
IsDeferredDecal() |
|
|
bool |
IsDependent ( |
Test this material for dependency on a given material. |
|
bool |
IsDependent_Concurrent ( |
Same as above, but can be called concurrently |
|
bool |
IsDitheredLODTransition() |
|
|
bool |
IsDoubleVectorParameterUsedAsChannelMask ( |
|
|
bool |
IsEditorOnlyDataValid() |
|
|
bool |
IsMasked() |
|
|
bool |
IsPropertyActive ( |
Checks to see if an input property should be active, based on the state of the material |
|
bool |
IsScalarParameterUsedAsAtlasPosition ( |
|
|
bool |
IsShadingModelFromMaterialExpression() |
|
|
bool |
IsTextureReferencedByProperty ( |
Checks to see if the given property references the texture |
|
bool |
IsThinSurface() |
|
|
bool |
IsTranslucencyWritingCustomDepth() |
|
|
bool |
IsTranslucencyWritingFrontLayerTransparency() |
|
|
bool |
IsTranslucencyWritingVelocity() |
|
|
bool |
IsTwoSided() |
|
|
bool |
IsUsingControlFlow() |
|
|
bool |
IsUsingNewHLSLGenerator() |
|
|
bool |
IsVectorParameterUsedAsChannelMask ( |
|
|
bool |
IterateDependentFunctions ( |
|
|
void |
IterateOverActiveFeatureLevels ( |
Iterate over all feature levels currently marked as active |
|
void |
LogMaterialsAndTextures ( |
Output to the log which materials and textures are used by this material. |
|
uint32 |
NumSpecularProfile_Internal() |
|
|
void |
OverrideNumericParameterDefault ( |
Overrides the default value of the given parameter (transient). |
|
void |
OverrideTexture ( |
Override a specific texture (transient) |
|
FGraphEventA... |
PrecachePSOs ( |
|
|
FGraphEventA... |
PrecachePSOs ( |
Precache PSOs which can be used for this material for the given vertex factory type and material paramaters |
|
FGraphEventA... |
PrecachePSOs ( |
Precache PSOs which can be used for this material for the given vertex factory type and material paramaters |
|
FGraphEventA... |
PrecachePSOs ( |
|
|
FGraphEventA... |
PrecachePSOs ( |
|
|
void |
RecacheAllMaterialUniformExpressions ( |
Re-caches uniform expressions for all material interfaces Set bRecreateUniformBuffer to true if uniform buffer layout will change (e.g. FMaterial is being recompiled). |
|
void |
RecacheUniformExpressions ( |
Re-caches uniform expressions for this material interface Set bRecreateUniformBuffer to true if uniform buffer layout will change (e.g. FMaterial is being recompiled). |
|
void |
SaveShaderStableKeysInner ( |
|
|
void |
SetCastShadowAsMasked ( |
|
|
void |
SetDiffuseBoost ( |
|
|
void |
SetEmissiveBoost ( |
|
|
void |
SetExportResolutionScale ( |
|
|
void |
SetFeatureLevelToCompile ( |
Set which feature levels this material instance should compile. |
|
void |
SetForceMipLevelsToBeResident ( |
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. |
|
void |
SetGlobalRequiredFeatureLevel ( |
Set which feature levels all materials should compile to. GMaxRHIFeatureLevel is always compiled. |
|
void |
SetLightingGuid() |
|
|
void |
SetOverrideCastShadowAsMasked ( |
|
|
void |
SetOverrideDiffuseBoost ( |
|
|
void |
SetOverrideEmissiveBoost ( |
|
|
void |
SetOverrideExportResolutionScale ( |
|
|
void |
SetShouldForcePlanePreview ( |
Set whether or not this Material Interface should force a plane preview |
|
void |
SetStrataCompilationConfig ( |
|
|
void |
SetTextureStreamingData ( |
Set new texture streaming data. |
|
bool |
ShouldAlwaysEvaluateWorldPositionOffset() |
|
|
bool |
ShouldForcePlanePreview() |
True if this Material Interface should force a plane preview |
|
void |
SortTextureStreamingData ( |
Sort the texture streaming data by names to accelerate search. Only sorts if required. |
|
void |
SubmitRemainingJobsForWorld ( |
Submits shaders to be compiled for all the materials in the world. |
|
bool |
UpdateLightmassTextureTracking() |
Check if the textures have changed since the last time the material was serialized for Lightmass... |
|
void |
UpdateMaterialRenderProxy ( |
|
|
bool |
UseAnyStreamingTexture() |
Return whether this material refer to any streaming textures. |
|
bool |
WritesToRuntimeVirtualTexture() |
Name | Description | ||
---|---|---|---|
|
void |
BeginDestroy() |
Called before destroying the object. |
|
void |
FinishDestroy() |
Called to finish destroying the object. |
|
void |
GetAssetRegistryTags ( |
Gathers a list of asset registry searchable tags which are name/value pairs with some type information This only needs to be implemented for asset objects |
|
bool |
IsReadyForFinishDestroy() |
Called to check if the object is ready for FinishDestroy. |
|
void |
PostCDOContruct() |
Called after the C++ constructor has run on the Class Default Object (CDO) for a class. |
|
void |
PostDuplicate ( |
Called after duplication & serialization and before PostLoad. |
|
void |
PostEditChangeProperty ( |
Called when a property on this object has been modified externally |
|
void |
PostInitProperties() |
Called after the C++ constructor and after the properties have been initialized, including those loaded from config. |
|
void |
PostLoad() |
Do any object-specific cleanup required immediately after loading an object. |
|
void |
PreSave ( |
Presave function. |
|
bool |
Rename ( |
Rename this object to a unique name, or change its outer. |
|
void |
Serialize ( |
Handles reading, writing, and reference collecting using FArchive. |
Name | Description | ||
---|---|---|---|
|
void |
OverrideBlendableSettings ( |
Name | Description | ||
---|---|---|---|
|
void |
AddAssetUserData ( |
|
|
UAssetUserDa... |
GetAssetUserDataOfClass ( |
|
|
void |
RemoveUserDataOfClass ( |
Name |
Description |
---|---|
FeatureLevelsForAllMaterials |
Feature level bitfield to compile for all materials |
SamplerTypeEnum |
Cached type information for the sampler type enumeration. |
Name | Description | ||
---|---|---|---|
|
float |
GetScalarParameterDefault ( |
This function is deprecated. Use GetScalarParameterDefaultValue instead. |
|
PRAGMA_DISAB... |
PreSave ( |
Use version that takes FObjectPreSaveContext instead. |