UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
HairStrandsInterface.cpp File Reference

Namespaces

namespace  HairStrands
 

Functions

 DEFINE_LOG_CATEGORY_STATIC (LogHairRendering, Log, All)
 
FRDGImportedBuffer Register (FRDGBuilder &GraphBuilder, const FRDGExternalBuffer &In, ERDGImportedBufferFlags Flags, ERDGUnorderedAccessViewFlags UAVFlags)
 
FRDGBufferSRVRef RegisterAsSRV (FRDGBuilder &GraphBuilder, const FRDGExternalBuffer &In)
 
FRDGBufferUAVRef RegisterAsUAV (FRDGBuilder &GraphBuilder, const FRDGExternalBuffer &In, ERDGUnorderedAccessViewFlags Flags)
 
bool IsHairRayTracingEnabled ()
 
bool IsHairStrandsSupported (EHairStrandsShaderType Type, EShaderPlatform Platform)
 
bool IsHairStrandsEnabled (EHairStrandsShaderType Type, EShaderPlatform Platform)
 
bool IsHairStrandsBindingEnable ()
 
bool IsHairStrandsSimulationEnable ()
 
bool IsHairStrandsNonVisibleShadowCastingEnable ()
 
bool IsHairStrandsVisibleInShadows (const FViewInfo &View, const FHairStrandsInstance &Instance)
 
bool IsHairStrandContinuousDecimationReorderingEnabled ()
 
bool IsHairVisibilityComputeRasterEnabled ()
 
bool IsHairVisibilityComputeRasterForwardEnabled (EShaderPlatform InPlatform)
 
bool IsHairVisibilityComputeRasterContinuousLODEnabled ()
 
void RegisterBookmarkFunction (THairStrandsBookmarkFunction Bookmark)
 
void RunHairStrandsBookmark (FRDGBuilder &GraphBuilder, EHairStrandsBookmark Bookmark, FHairStrandsBookmarkParameters &Parameters)
 
void RunHairStrandsBookmark (EHairStrandsBookmark Bookmark, FHairStrandsBookmarkParameters &Parameters)
 
void CullHairInstance (FScene *Scene, FViewInfo &View, FHairInstanceCullingResults &Out)
 
void CullHairInstanceShadow (FScene *Scene, TArray< FViewInfo > &Views, FHairInstanceCullingResults &Out)
 
void CreateHairStrandsBookmarkParameters (FScene *Scene, FViewInfo &View, FHairStrandsBookmarkParameters &Out, bool bComputeVisibleInstances)
 
void UpdateHairStrandsBookmarkParameters (FScene *Scene, TArray< FViewInfo > &Views, FHairStrandsBookmarkParameters &Out)
 
void CreateHairStrandsBookmarkParameters (FScene *Scene, TArray< FViewInfo > &Views, TConstArrayView< FViewInfo * > AllViews, FHairStrandsBookmarkParameters &Out, bool bComputeVisibleInstances)
 
bool HairStrands::IsHairStrandsVF (const FMeshBatch *Mesh)
 
bool HairStrands::IsHairCardsVF (const FMeshBatch *Mesh)
 
bool HairStrands::IsHairCompatible (const FMeshBatch *Mesh)
 
bool HairStrands::IsHairVisible (const FMeshBatchAndRelevance &MeshBatch, bool bCheckLengthScale)
 
FHairGroupPublicDataHairStrands::GetHairData (const FMeshBatch *In)
 
void HairStrands::AddVisibleShadowCastingLight (const FScene &Scene, TArray< FViewInfo > &Views, const FLightSceneInfo *LightSceneInfo)
 

Variables

THairStrandsBookmarkFunction GHairStrandsBookmarkFunction = nullptr
 

Function Documentation

◆ CreateHairStrandsBookmarkParameters() [1/2]

void CreateHairStrandsBookmarkParameters ( FScene Scene,
FViewInfo View,
FHairStrandsBookmarkParameters Out,
bool  bComputeVisibleInstances 
)

◆ CreateHairStrandsBookmarkParameters() [2/2]

void CreateHairStrandsBookmarkParameters ( FScene Scene,
TArray< FViewInfo > &  Views,
TConstArrayView< FViewInfo * >  AllViews,
FHairStrandsBookmarkParameters Out,
bool  bComputeVisibleInstances 
)

◆ CullHairInstance()

void CullHairInstance ( FScene Scene,
FViewInfo View,
FHairInstanceCullingResults Out 
)

◆ CullHairInstanceShadow()

void CullHairInstanceShadow ( FScene Scene,
TArray< FViewInfo > &  Views,
FHairInstanceCullingResults Out 
)

◆ DEFINE_LOG_CATEGORY_STATIC()

DEFINE_LOG_CATEGORY_STATIC ( LogHairRendering  ,
Log  ,
All   
)

◆ IsHairRayTracingEnabled()

bool IsHairRayTracingEnabled ( )

◆ IsHairStrandContinuousDecimationReorderingEnabled()

bool IsHairStrandContinuousDecimationReorderingEnabled ( )

◆ IsHairStrandsBindingEnable()

bool IsHairStrandsBindingEnable ( )

◆ IsHairStrandsEnabled()

bool IsHairStrandsEnabled ( EHairStrandsShaderType  Type,
EShaderPlatform  Platform 
)

◆ IsHairStrandsNonVisibleShadowCastingEnable()

bool IsHairStrandsNonVisibleShadowCastingEnable ( )

◆ IsHairStrandsSimulationEnable()

bool IsHairStrandsSimulationEnable ( )

◆ IsHairStrandsSupported()

bool IsHairStrandsSupported ( EHairStrandsShaderType  Type,
EShaderPlatform  Platform 
)

◆ IsHairStrandsVisibleInShadows()

bool IsHairStrandsVisibleInShadows ( const FViewInfo View,
const FHairStrandsInstance Instance 
)

◆ IsHairVisibilityComputeRasterContinuousLODEnabled()

bool IsHairVisibilityComputeRasterContinuousLODEnabled ( )

◆ IsHairVisibilityComputeRasterEnabled()

bool IsHairVisibilityComputeRasterEnabled ( )

◆ IsHairVisibilityComputeRasterForwardEnabled()

bool IsHairVisibilityComputeRasterForwardEnabled ( EShaderPlatform  InPlatform)

◆ Register()

FRDGImportedBuffer Register ( FRDGBuilder GraphBuilder,
const FRDGExternalBuffer In,
ERDGImportedBufferFlags  Flags,
ERDGUnorderedAccessViewFlags  UAVFlags 
)

◆ RegisterAsSRV()

FRDGBufferSRVRef RegisterAsSRV ( FRDGBuilder GraphBuilder,
const FRDGExternalBuffer In 
)

◆ RegisterAsUAV()

FRDGBufferUAVRef RegisterAsUAV ( FRDGBuilder GraphBuilder,
const FRDGExternalBuffer In,
ERDGUnorderedAccessViewFlags  Flags 
)

◆ RegisterBookmarkFunction()

void RegisterBookmarkFunction ( THairStrandsBookmarkFunction  Bookmark)

◆ RunHairStrandsBookmark() [1/2]

void RunHairStrandsBookmark ( EHairStrandsBookmark  Bookmark,
FHairStrandsBookmarkParameters Parameters 
)

◆ RunHairStrandsBookmark() [2/2]

void RunHairStrandsBookmark ( FRDGBuilder GraphBuilder,
EHairStrandsBookmark  Bookmark,
FHairStrandsBookmarkParameters Parameters 
)

◆ UpdateHairStrandsBookmarkParameters()

void UpdateHairStrandsBookmarkParameters ( FScene Scene,
TArray< FViewInfo > &  Views,
FHairStrandsBookmarkParameters Out 
)

Variable Documentation

◆ GHairStrandsBookmarkFunction

THairStrandsBookmarkFunction GHairStrandsBookmarkFunction = nullptr