1. Epic GamesDeveloper
  3. FMaterialResource

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).

Unreal Engine C++ API Reference > Runtime > Engine

Inheritance Hierarchy

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

  Type Name Description
Protected variable TObjectPtr< UMaterial > Material  
Protected variable TObjectPtr< UMaterialInstance > MaterialInstance  

Constructors

  Type Name Description
Public function    

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function Const TStaticArray< uint16,(int) ELWCFunctionKind::Max >  
Public function Const void

GetEstimatedNumTextureSamples ( uint32& VSSamples,
uint32& PSSamples
)

  
Public function Const uint32  
Public function Const const UMaterial *  
Public function Const const UMaterialInstance *  
Public function Const uint32  
Public function void

GetResourceSizeEx ( FResourceSizeEx& CumulativeResourceSize
)

  
Public function Const int32 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).
Public function Const void

GetUserInterpolatorUsage ( uint32& NumUsedUVScalars,
uint32& NumUsedCustomInterpolatorScalars
)

  
Public function void

SetMaterial ( UMaterial* InMaterial
)

  
Public function void

SetMaterial ( UMaterial* InMaterial,
UMaterialInstance* InInstance,
ERHIFeatureLevel::Type InFeatureLevel,
EMaterialQualityLevel::Type InQualityLevel
)

  
Public function void

SetMaterialInstance ( UMaterialInstance* InMaterialInstance
)

  

Overridden from FMaterial

  Type Name Description
Public function Virtual void  
Public function Virtual Const bool  
Public function Virtual void  
Public function Virtual Const bool  
Public function Virtual Const bool Checks that no pre-compilation errors have been detected and if so it reports them using specified compiler.
Protected function Virtual Const int32

CompilePropertyAndSetMaterialProperty ( EMaterialProperty Property,
FMaterialCompiler* Compiler,
EShaderFrequency OverrideShaderFrequency,
bool bUsePreviousFrameTime
)

 Entry point for compiling a specific material property. This must call SetMaterialProperty.
Public function Virtual Const bool  
Public function Virtual void  
Protected function Virtual Const void Gives the material a chance to compile any custom output nodes it has added
Protected function Virtual Const void Gather any UMaterialExpressionCustomOutput expressions in the material and referenced function calls
Public function Virtual Const bool Returns true if this material is allowed to make development shaders via the global CVar CompileShadersForDevelopment.
Public function Virtual Const FString Similar to GetFriendlyName, but but avoids historical behavior of the former, returning the exact asset name for material instances instead of just the material.
Public function Virtual Const FName Allows to associate the shader resources with the asset for load order.
Protected function Virtual Const FString Useful for debugging.
Public function Virtual Const int32  
Public function Virtual Const bool  
Public function Virtual Const enum EBlendMode  
Public function Virtual Const bool  
Protected function Virtual Const FString  
Public function Virtual Const FDisplacementScaling  
Public function Virtual Const bool  
Public function Virtual Const FString  
Public function Virtual Const FString  
Public function Virtual Const uint32  
Public function Virtual Const EMaterialDomain  
Public function Virtual Const enum EMaterialFloatPrecisionMode  
Public function Virtual Const FGuid Gets the Guid that represents this material.
Public function Virtual Const UMaterialInterface *  
Public function Virtual Const FString Returns a string that describes the material's usage for debugging purposes.
Public function Virtual Const int32  
Public function Virtual Const float  
Public function Virtual Const TArrayView< const TObjectPtr< UObject > >  
Public function Virtual Const ERefractionCoverageMode  
Public function Virtual Const float  
Public function Virtual Const enum ERefractionMode  
Public function Virtual Const bool  
Public function Virtual Const void

GetShaderMapId ( EShaderPlatform Platform,
const ITargetPlatform* TargetPlatform,
FMaterialShaderMapId& OutId
)

 Material properties.
Public function Virtual Const FMaterialShadingModelField  
Public function Virtual Const EMaterialShadingRate  
Public function Virtual Const void

GetStaticParameterSet ( EShaderPlatform Platform,
FStaticParameterSet& OutSet
)

  
Public function Virtual Const uint32  
Public function Virtual Const uint32  
Public function Virtual Const float  
Public function Virtual Const enum ETranslucencyLightingMode  
Public function Virtual Const float  
Public function Virtual Const FLinearColor  
Public function Virtual Const float  
Public function Virtual Const float  
Public function Virtual Const float  
Public function Virtual Const float  
Public function Virtual Const float  
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual Const bool

HasMaterialPropertyConnected ( EMaterialProperty In
)

  
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual Const bool  
Protected function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual Const bool  
Protected function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual Const bool

IsDualBlendingEnabled ( EShaderPlatform Platform
)

  
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual Const bool Should shaders compiled for this material be saved to disk?
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual Const bool

IsSky ()

  
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual Const bool Should the material be compiled using exec pin?
Public function Virtual Const bool  
Public function Virtual Const bool Is the material using the new (WIP) HLSL generator?
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual void Serializes the material.
Public function Virtual void Called when compilation of an FMaterial finishes, after the GameThreadShaderMap is set and the render command to set the RenderThreadShaderMap is queued
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual Const bool Some materials may be loaded early - before the shader library - and need their code inlined
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual Const bool  

Deprecated Functions

  Type Name Description
Protected function Virtual Const bool Should instead check individual properties
Public function void

SetMaterial ( UMaterial* InMaterial,
EMaterialQualityLevel::Type InQualityLevel,
bool bInHasQualityLevelUsage,
ERHIFeatureLevel::Type InFeatureLevel,
UMaterialInstance* InInstance
)

 Parameter bInHasQualityLevelUsage is deprecated

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page