1. Epic GamesDeveloper
  3. FMaterialCompilationOutput

FMaterialCompilationOutput

Stores outputs from the material compile that need to be saved.

API > API/Runtime > API/Runtime/Engine

Stores outputs from the material compile that need to be saved. Updates to layout fields in this class must be accompanied with a GUID bump to MaterialTranslationDDCVersion entry in FDevSystemGuids.

   
Name FMaterialCompilationOutput
Type class
Header File /Engine/Source/Runtime/Engine/Public/MaterialShared.h
Include Path #include "MaterialShared.h"

Syntax

class FMaterialCompilationOutput

Constructors

Name Remarks Include Path Unreal Specifiers

FMaterialCompilationOutput()

   MaterialShared.h  

Structs

Name Remarks
InternalLinkType  

Typedefs

Name Type Remarks Include Path
DerivedType FMaterialCompilationOutput   MaterialShared.h
InternalBaseType typename TGetBaseTypeHelper< FMaterialCompilationOutput >::Type   MaterialShared.h

Constants

Name Type Remarks Include Path
CounterBase int   MaterialShared.h
InterfaceType ETypeLayoutInterface::Type   MaterialShared.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
pad0 uint8bNeedsSceneTextures True if the material needs the scene texture lookups. MaterialShared.h  
pad1 uint8bUsesDBufferTextureLookup True if the material uses DBuffer texture lookups. MaterialShared.h  
pad10 uint8bUsesPerInstanceCustomData True if the material uses per-instance custom data MaterialShared.h  
pad11 uint8bUsesVertexInterpolator True if the material uses vertex interpolator MaterialShared.h  
pad12 uint8bHasRuntimeVirtualTextureOutputNode True if the material writes to a runtime virtual texture custom output node. MaterialShared.h  
pad13 uint8bUsesAnisotropy True if the material uses non 0 anisotropy value MaterialShared.h  
pad14 uint8bIsLightFunctionAtlasCompatible True if the material is compatible with the light function atlas MaterialShared.h  
pad15 uint8bUsesDisplacement Whether the material uses scalar displacement. MaterialShared.h  
pad16 uint8bUsedWithNeuralNetworks Whether the material uses NNE. MaterialShared.h  
pad17 uint8bUsesCustomizedUVs Whether the material uses customized UVs. MaterialShared.h  
pad2 uint8bUsesEyeAdaptation True if the material uses the EyeAdaptationLookup MaterialShared.h  
pad3 uint8bModifiesMeshPosition True if the material modifies the the mesh position. MaterialShared.h  
pad4 uint8bUsesWorldPositionOffset Whether the material uses world position offset. MaterialShared.h  
pad5 uint8bUsesTemporalResponsiveness True if the material uses temporal responsiveness. MaterialShared.h  
pad6 uint8bUsesMotionVectorWorldOffset True if the material uses motion vector offset. MaterialShared.h  
pad7 uint8bUsesGlobalDistanceField True if material uses the global distance field MaterialShared.h  
pad8 uint8bUsesPixelDepthOffset True if the material writes a pixel depth offset MaterialShared.h  
pad9 uint8bUsesDistanceCullFade True if the material uses distance cull fade MaterialShared.h  
FSubstrateMaterialCompilationOutputSubstrateMaterialCompilationOutput   The Substrate material layout MaterialShared.h  
FUniformExpressionSetUniformExpressionSet     MaterialShared.h  
uint16EstimatedLWCFuncUsagesCS     MaterialShared.h  
uint16EstimatedLWCFuncUsagesPS     MaterialShared.h  
uint16EstimatedLWCFuncUsagesVS   Estimate of the number of times each LWC operator occurs in the material shader code MaterialShared.h  
uint16EstimatedNumTextureSamplesPS     MaterialShared.h  
uint16EstimatedNumTextureSamplesVS   Number of times SampleTexture is called, excludes custom nodes. MaterialShared.h  
uint16EstimatedNumVirtualTextureLookups   Number of virtual texture lookups performed, excludes direct invocation in shaders (for example VT lightmaps) MaterialShared.h  
uint32UsedSceneTextures   Bitfield of the ESceneTextures used MaterialShared.h  
uint8NumUsedCustomInterpolatorScalars   Number of used custom vertex interpolation scalars. MaterialShared.h  
uint8NumUsedUVScalars   Number of used custom UV scalars. MaterialShared.h  
uint8NumVirtualTextureFeedbackRequests   Number of feedback requests used for virtual texturing. MaterialShared.h  
uint8RuntimeVirtualTextureOutputAttributeMask   Bitfield of runtime virtual texture output attributes. MaterialShared.h  
uint8UsedDBufferTextures   Bitfield of used DBuffer textures . MaterialShared.h  
uint8UsedPathTracingBufferTextures   Bitfield of the EPathTracingBufferTextureId used MaterialShared.h  
UserSceneTextureInputs TMemoryImageArray< FScriptName > User scene texture inputs to this material, these will use slots not taken up by the UsedSceneTextures bitfield below MaterialShared.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

int32 FindOrAddUserSceneTexture ( FName UserSceneTexture
)

 Returns Id for a user scene texture input, or INDEX_NONE if allocation fails. MaterialShared.h  

int32 FindUserSceneTexture ( FName UserSceneTexture
) const

 Returns Id for a user scene texture input, or INDEX_NONE if not found. MaterialShared.h  
Returns number of post process inputs used, between PostProcessInput SceneTexture nodes and UserSceneTexture nodes. MaterialShared.h  

const FTypeLayoutDesc & GetTypeLayout()

   MaterialShared.h  

bool IsSceneTextureUsed ( ESceneTextureId TexId
) const

   MaterialShared.h  

bool NeedsGBuffer()

 True if the material uses any GBuffer textures MaterialShared.h  

bool RequiresSceneColorCopy()

 Indicates whether the material uses scene color. MaterialShared.h  

void SetIsDBufferTextureLookupUsed ( bool bValue
)

   MaterialShared.h  

void SetIsDBufferTextureUsed ( int32 TextureIndex
)

   MaterialShared.h  

void SetIsPathTracingBufferTextureUsed ( int32 TexId
)

   MaterialShared.h  

void SetIsSceneTextureUsed ( ESceneTextureId TexId
)

   MaterialShared.h  

bool UsesSceneDepthLookup()

 True if the material uses the SceneDepth lookup MaterialShared.h  

bool UsesVelocitySceneTexture()

 True if the material uses the Velocity SceneTexture lookup MaterialShared.h  

Static

Name Remarks Include Path Unreal Specifiers

static uint32 GetGBufferMask()

 Returns mask for all scene textures that are from the GBuffer MaterialShared.h  

static void InternalDestroy ( void* Object,
const FTypeLayoutDesc&,
const FPointerTableBase* PtrTable,
bool bIsFrozen
)

   MaterialShared.h  

static void InternalInitializeBases ( FTypeLayoutDesc& TypeDesc
)

   MaterialShared.h  

static FTypeLayoutDesc & StaticGetTypeLayout()

   MaterialShared.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page