Module |
|
Header |
/Engine/Source/Runtime/Engine/Classes/Materials/MaterialInstance.h |
Include |
#include "Materials/MaterialInstance.h" |
class UMaterialInstance : public UMaterialInterface
Name | Description | ||
---|---|---|---|
|
BasePropertyOverrides |
||
|
uint8: 1 |
bCastDynamicShadowAsMasked |
|
|
uint8: 1 |
bHasStaticPermutationResource |
Indicates whether the instance has static permutation resources (which are required when static parameters are present) Read directly from the rendering thread, can only be modified with the use of a FMaterialUpdateContext. |
|
uint8: 1 |
bIsShadingModelFromMaterialExpression |
|
|
TEnumAsByte< EB... |
BlendMode |
|
|
uint8: 1 |
bOverrideSubsurfaceProfile |
Defines if SubsurfaceProfile from this instance is used or it uses the parent one. |
|
uint8: 1 |
DitheredLODTransition |
|
|
TArray< struct ... |
FontParameterValues |
Font parameters. |
|
float |
OpacityMaskClipValue |
Cached copies of the base property overrides or the value from the parent to avoid traversing the parent chain for each access. |
|
Parent |
Parent material. |
|
|
PhysicalMaterialMap |
Physical material map used with physical material mask, when it exists. |
|
|
PhysMaterial |
Physical material to use for this graphics material. Used for sounds, effects etc. |
|
|
bool[2] |
ReentrantFlag |
Flag to detect cycles in the material instance graph, this is only used at content creation time where the hierarchy can be changed. |
|
FMaterialInstan... |
Resource |
FMaterialRenderProxy derivative that represent this material instance to the renderer, when the renderer needs to fetch parameter values. |
|
TArray< struct ... |
RuntimeVirtualTextureParameterValues |
RuntimeVirtualTexture parameters. |
|
TArray< struct ... |
ScalarParameterValues |
Scalar parameters. |
|
ShadingModels |
||
|
TArray< struct ... |
TextureParameterValues |
Texture parameters. |
|
uint8: 1 |
TwoSided |
|
|
TArray< struct ... |
VectorParameterValues |
Vector parameters. |
Name | Description | |
---|---|---|
|
UMaterialInstance ( |
Name | Description | ||
---|---|---|---|
|
AddReferencedObjects ( |
||
|
AllMaterialsCacheResourceShadersForRendering ( |
For all materials instances, UMaterialInstance::CacheResourceShadersForRendering. |
|
|
FMaterialRes... |
AllocatePermutationResource() |
|
|
AppendReferencedParameterCollectionIdsTo |
||
|
BeginAllowCachingStaticParameterValues() |
||
|
CacheResourceShadersForCooking ( |
Cache resource shaders for rendering on the given shader platform. |
|
|
CacheResourceShadersForRendering ( |
Cache resource shaders for rendering on the given shader platform. |
|
|
CacheResourceShadersForRendering ( |
Cache resource shaders for rendering on the given shader platform. |
|
|
CacheShadersForResources ( |
Caches shader maps for an array of material resources. |
|
|
ClearParameterValuesInternal ( |
||
|
CopyMaterialInstanceParameters ( |
Copies over material instance parameters from the base material given a material interface. |
|
|
CopyMaterialUniformParametersInternal ( |
Copies the uniform parameters (scalar, vector and texture) from a material or instance hierarchy. |
|
|
DumpDebugInfo() |
||
|
EndAllowCachingStaticParameterValues() |
||
|
Equivalent ( |
||
|
GetAllParameterInfo ( |
Builds a composited set of parameter names, including inherited and overridden values |
|
|
GetAllParametersOfType ( |
||
|
GetAllShaderMaps ( |
Gathers actively used shader maps from all material resources used by this material instance |
|
|
GetBasePropertyOverridesHash ( |
Properties of the base material. Can now be overridden by instances. |
|
|
GetReentrantFlag() |
||
|
const FStati... |
GetStaticParameters() |
Gets static parameter set for this material. |
|
GetStaticParameterValues ( |
Builds a composited set of static parameters, including inherited and overridden values |
|
|
GetTextureExpressionValues |
||
|
HasOverridenBaseProperties() |
||
|
InitResources() |
Initialize the material instance's resources. |
|
|
InitStaticPermutation ( |
Recompiles static permutations if necessary. |
|
|
IsChildOf ( |
Determine whether this Material Instance is a child of another Material |
|
|
PropagateDataToMaterialProxy() |
To share code between PostLoad() and PostEditChangeProperty() |
|
|
RemoveLayerParameterIndex ( |
||
|
SaveShaderStableKeys ( |
||
|
SetFontParameterValueInternal ( |
||
|
SetParentInternal ( |
||
|
SetReentrantFlag ( |
||
|
SetRuntimeVirtualTextureParameterValueInternal ( |
||
|
SetScalarParameterAtlasInternal ( |
||
|
SetScalarParameterByIndexInternal ( |
||
|
SetScalarParameterValueInternal ( |
||
|
SetTextureParameterValueInternal ( |
||
|
SetVectorParameterByIndexInternal ( |
||
|
SetVectorParameterValueInternal ( |
Internal interface for setting / updating values for material instances. |
|
|
SwapLayerParameterIndices |
||
|
UpdateCachedLayerParameters() |
||
|
UpdateMaterialLayersParameterValue ( |
||
|
UpdateOverridableBaseProperties() |
||
|
UpdateParameterNames() |
Refresh parameter names using the stored reference to the expression object for the parameter. |
|
|
UpdateParameters() |
Updates parameter names on the material instance, returns true if parameters have changed. |
|
|
UpdateStaticPermutation ( |
Sets new static parameter overrides on the instance and recompiles the static permutation resources if needed. |
|
|
UpdateStaticPermutation ( |
Ensure's static permutations for current parameters and overrides are upto date. |
|
|
UpdateStaticPermutation ( |
Sets new static parameter overrides on the instance and recompiles the static permutation resources if needed (can be forced with bForceRecompile). |
|
|
ValidateTextureOverrides ( |
Name | Description | ||
---|---|---|---|
|
CastsRayTracedShadows() |
||
|
CheckMaterialUsage ( |
Checks if the material can be used with the given usage flag. |
|
|
CheckMaterialUsage_Concurrent ( |
Same as above but is valid to call from any thread. |
|
|
CompilePropertyEx ( |
Allows material properties to be compiled with the option of being overridden by the material attributes input. |
|
|
ForceRecompileForRendering() |
Clears the shader cache and recompiles the shader for rendering. |
|
|
GetAllFontParameterInfo ( |
||
|
GetAllMaterialLayersParameterInfo ( |
||
|
GetAllRuntimeVirtualTextureParameterInfo ( |
||
|
GetAllScalarParameterInfo ( |
||
|
GetAllStaticComponentMaskParameterInfo ( |
||
|
GetAllStaticSwitchParameterInfo ( |
||
|
GetAllTextureParameterInfo ( |
||
|
GetAllVectorParameterInfo ( |
||
|
GetBlendMode() |
||
|
GetCastShadowAsMasked() |
||
|
GetDependentFunctions ( |
||
|
float |
GetDiffuseBoost() |
|
|
float |
GetEmissiveBoost() |
|
|
float |
GetExportResolutionScale() |
|
|
GetFontParameterDefaultValue ( |
||
|
GetFontParameterValue ( |
||
|
GetGroupName ( |
||
|
GetGroupSortPriority |
Get the sort priority index of the given parameter group |
|
|
GetLayerParameterIndex ( |
||
|
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 |
|
GetMaterialLayersParameterValue ( |
Get the value of the given static material layers parameter |
|
|
FMaterialRes... |
GetMaterialResource ( |
Get the static permutation resource if the instance has one |
|
const FMater... |
GetMaterialResource ( |
Get the static permutation resource if the instance has one |
|
float |
GetOpacityMaskClipValue() |
Access to overridable properties of the base material. |
|
GetParameterDesc ( |
||
|
GetParameterSortPriority ( |
Get the sort priority index of the given parameter |
|
|
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. |
|
TArrayView< ... |
GetReferencedTextures() |
Appends textures referenced by expressions, including nested functions. |
|
GetReferencedTexturesAndOverrides |
Add to the set any texture referenced by expressions, including nested functions, as well as any overrides from parameters. |
|
|
GetRefractionSettings ( |
||
|
FMaterialRen... |
GetRenderProxy() |
Return a pointer to the FMaterialRenderProxy used for rendering. |
|
GetRuntimeVirtualTextureParameterDefaultValue ( |
||
|
GetRuntimeVirtualTextureParameterValue ( |
||
|
GetScalarParameterDefaultValue ( |
||
|
GetScalarParameterSliderMinMax ( |
||
|
GetScalarParameterValue ( |
||
|
FMaterialSha... |
GetShadingModels() |
|
|
GetStaticComponentMaskParameterDefaultValue |
||
|
GetStaticComponentMaskParameterValue |
Get the value of the given static component mask parameter |
|
|
GetStaticSwitchParameterDefaultValue ( |
||
|
GetStaticSwitchParameterValue ( |
Get the value of the given static switch parameter |
|
|
USubsurfaceP... |
GetSubsurfaceProfile_Internal() |
|
|
GetTerrainLayerWeightParameterValue ( |
Get the weightmap index of the given terrain layer weight parameter |
|
|
float |
GetTextureDensity ( |
Returns the density of a texture in (LocalSpace Unit / Texture). |
|
GetTextureParameterChannelNames ( |
||
|
GetTextureParameterDefaultValue ( |
||
|
GetTextureParameterValue ( |
||
|
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). |
|
|
GetUsedTextures ( |
Return the textures used to render this material. |
|
|
GetUsedTexturesAndIndices ( |
Return the textures used to render this material and the material indices bound to each. |
|
|
GetVectorParameterChannelNames ( |
||
|
GetVectorParameterDefaultValue ( |
||
|
GetVectorParameterValue ( |
||
|
IsDependent ( |
Test this material for dependency on a given material. |
|
|
IsDependent_Concurrent ( |
Same as above, but can be called concurrently |
|
|
IsDitheredLODTransition() |
||
|
IsMasked() |
||
|
IsPropertyActive ( |
Checks to see if an input property should be active, based on the state of the material |
|
|
IsScalarParameterUsedAsAtlasPosition ( |
||
|
IsShadingModelFromMaterialExpression() |
||
|
IsTwoSided() |
||
|
IsVectorParameterUsedAsChannelMask ( |
||
|
IterateDependentFunctions ( |
||
|
LogMaterialsAndTextures ( |
Output to the log which materials and textures are used by this material. |
|
|
OverrideScalarParameterDefault ( |
||
|
OverrideTexture ( |
Override a specific texture (transient) |
|
|
OverrideVectorParameterDefault ( |
Overrides the default value of the given parameter (transient). |
|
|
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). |
|
|
SaveShaderStableKeysInner ( |
||
|
UpdateLightmassTextureTracking() |
Check if the textures have changed since the last time the material was serialized for Lightmass... |
Name | Description | ||
---|---|---|---|
|
BeginCacheForCookedPlatformData ( |
Starts caching of platform specific data for the target platform Called when cooking before serialization so that object can prepare platform specific data Not called during normal loading of objects |
|
|
BeginDestroy() |
Called before destroying the object. |
|
|
ClearAllCachedCookedPlatformData() |
Clear all cached cooked platform data |
|
|
ClearCachedCookedPlatformData ( |
Clears cached cooked platform data for specific platform |
|
|
FinishDestroy() |
Called to finish destroying the object. |
|
|
GetResourceSizeEx ( |
Get the size of the object/resource for use in memory tools or to display to artists/LDs in the Editor This is the extended version which separates up the used memory into different memory regions (the actual definition of which may be platform specific). |
|
|
IsCachedCookedPlatformDataLoaded ( |
Have we finished loading all the cooked platform data for the target platforms requested in BeginCacheForCookedPlatformData |
|
|
IsReadyForFinishDestroy() |
Called to check if the object is ready for FinishDestroy. |
|
|
PostEditChangeProperty ( |
Called when a property on this object has been modified externally |
|
|
PostInitProperties() |
Called after the C++ constructor and after the properties have been initialized, including those loaded from config. |
|
|
PostLoad() |
Do any object-specific cleanup required immediately after loading an object. |
|
|
PreSave ( |
Presave function. |
|
|
Serialize ( |
Handles reading, writing, and reference collecting using FArchive. |
Name |
Description |
---|---|
FCustomParameterSetUpdaterDelegate |
Delegate for custom static parameters updater. |
FCustomStaticParametersGetterDelegate |
Delegate for custom static parameters getter. |
Name |
Description |
---|---|
CustomParameterSetUpdaters |
An array of custom parameter set updaters. |
CustomStaticParametersGetters |
Custom static parameters getter delegate. |
Name | Description | ||
---|---|---|---|
|
bOverrideBaseProperties_DEPRECATED |
Name | Description | ||
---|---|---|---|
|
UpdatePermutationAllocations |
Calling UpdatePermutationAllocations is no longer necessary |