Navigation
API > API/Runtime > API/Runtime/Engine
Contains all the information needed to uniquely identify a FMaterialShaderMap.
| Name | FMaterialShaderMapId |
| Type | class |
| Header File | /Engine/Source/Runtime/Engine/Public/MaterialShared.h |
| Include Path | #include "MaterialShared.h" |
Syntax
class FMaterialShaderMapId
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FMaterialShaderMapId() |
MaterialShared.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
~FMaterialShaderMapId() |
MaterialShared.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| BaseMaterialId | FGuid | The base material's StateId. | MaterialShared.h | |
| BasePropertyOverridesHash | FSHAHash | A hash of the base property overrides for this material instance. | MaterialShared.h | |
| bUsingNewHLSLGenerator | bool | Is the material using the new HLSL generator? | MaterialShared.h | |
| CookedShaderMapIdHash | FSHAHash | MaterialShared.h | ||
| ExpressionIncludesHash | FSHAHash | A hash of the content of files (dynamically) included by material expressions. | MaterialShared.h | |
| ExternalCodeReferencesHash | FSHAHash | A hash of all external code delcarations referenced in the shader map. | MaterialShared.h | |
| FeatureLevel | ERHIFeatureLevel::Type | Feature level that the shader map is going to be compiled for. | MaterialShared.h | |
| LayoutParams | FPlatformTypeLayoutParameters | Type layout parameters of the memory image | MaterialShared.h | |
| QualityLevel | EMaterialQualityLevel::Type | Quality level that this shader map is going to be compiled at. | MaterialShared.h | |
| ReferencedFunctions | TArray< FGuid > | Guids of any functions the material was dependent on. | MaterialShared.h | |
| ReferencedParameterCollections | TArray< FGuid > | Guids of any Parameter Collections the material was dependent on. | MaterialShared.h | |
| ShaderPipelineTypeDependencies | TArray< FShaderPipelineTypeDependency > | Shader pipeline types of shader pipelines that are inlined in this shader map in the DDC. | MaterialShared.h | |
| ShaderTypeDependencies | TArray< FShaderTypeDependency > | Shader types of shaders that are inlined in this shader map in the DDC. | MaterialShared.h | |
| SubstrateCompilationConfig | FSubstrateCompilationConfig | The Substrate configuration used when compiling this material, can be tweaked in the material editor for live visualization of simplification. | MaterialShared.h | |
| TextureReferencesHash | FSHAHash | Hash of the textures referenced by the uniform expressions in the shader map. | MaterialShared.h | |
| Usage | EMaterialShaderMapUsage::Type | Indicates what use case this shader map will be for. | MaterialShared.h | |
| UsageCustomOutput | FString | Name of which specific custom output this shader map will be a use case for. | MaterialShared.h | |
| VertexFactoryTypeDependencies | TArray< FVertexFactoryTypeDependency > | Vertex factory types of shaders that are inlined in this shader map in the DDC. | MaterialShared.h |
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bIsCookedId | bool | Was the shadermap Id loaded in from a cooked resource. | MaterialShared.h | |
| MaterialLayersId | TOptional< FMaterialLayersFunctions::ID > | MaterialShared.h | ||
| StaticComponentMaskParameters | TArray< FStaticComponentMaskParameter > | MaterialShared.h | ||
| StaticSwitchParameters | TArray< FStaticSwitchParameter > | Relevant portions of StaticParameterSet from material. | MaterialShared.h | |
| TerrainLayerWeightParameters | TArray< FStaticTerrainLayerWeightParameter > | MaterialShared.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void AppendKeyString
(
FString& KeyString, |
Appends string representations of this Id to a key string. | MaterialShared.h | |
bool ContainsShaderPipelineType
(
const FShaderPipelineType* ShaderPipelineType |
Returns true if the requested shader type is a dependency of this shader map Id. | MaterialShared.h | |
bool ContainsShaderType
(
const FShaderType* ShaderType, |
Returns true if the requested shader type is a dependency of this shader map Id. | MaterialShared.h | |
bool ContainsVertexFactoryType
(
const FVertexFactoryType* VFType |
Returns true if the requested vertex factory type is a dependency of this shader map Id. | MaterialShared.h | |
bool Equals
(
const FMaterialShaderMapId& ReferenceSet, |
Tests this set against another for equality. | MaterialShared.h | |
void GetMaterialHash
(
FSHAHash& OutHash |
MaterialShared.h | ||
void GetMaterialHash
(
FSHAHash& OutHash, |
Hashes the material-specific part of this shader map Id. | MaterialShared.h | |
const TOptional< FMaterialLayersFunctions::ID > & GetMaterialLayersId() |
MaterialShared.h | ||
EShaderPermutationFlags GetPermutationFlags() |
MaterialShared.h | ||
SIZE_T GetSizeBytes() |
MaterialShared.h | ||
const TArray< FStaticComponentMaskParameter > & GetStaticComponentMaskParameters() |
MaterialShared.h | ||
const TArray< FStaticSwitchParameter > & GetStaticSwitchParameters() |
MaterialShared.h | ||
const TArray< FStaticTerrainLayerWeightParameter > & GetTerrainLayerWeightParameters() |
MaterialShared.h | ||
bool IsContentValid() |
Ensure content is valid - for example overrides are set deterministically for serialization and sorting | MaterialShared.h | |
bool IsCookedId() |
MaterialShared.h | ||
bool IsValid() |
MaterialShared.h | ||
void RecordAndEmit
(
FMaterialKeyGeneratorContext& Context |
MaterialShared.h | ||
void Serialize
(
FArchive& Ar, |
MaterialShared.h | ||
void SetShaderDependencies
(
const TArray< FShaderType* >& ShaderTypes, |
MaterialShared.h | ||
void UpdateFromParameterSet
(
const FStaticParameterSet& StaticParameters |
Updates the Id's static parameter set data. | MaterialShared.h |
Operators
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool operator!=
(
const FMaterialShaderMapId& ReferenceSet |
MaterialShared.h | ||
bool operator==
(
const FMaterialShaderMapId& ReferenceSet |
Tests this set against another for equality | MaterialShared.h |