1. Epic GamesDeveloper
  3. HairStrandsCore

HairStrandsCore

Unreal Engine C++ API Reference > Plugins

Filters

Classes

  Type Name Description
Public class UClass ShowCategories, HideCategories AGroomActor An actor that renders a simulated hair  
Public struct EHairResourceStatus    
Public struct FEditableGroom    
Public struct FEditableGroomGroup Group & Groom.  
Public struct FEditableHairGuide    
Public struct FEditableHairGuideControlPoint Guides.  
Public struct FEditableHairStrand    
Public struct FEditableHairStrandControlPoint Strands.  
Public struct FFollicleInfo    
Public struct UStruct BlueprintType FFollicleMaskOptions    
Public struct UStruct BlueprintType FGoomBindingGroupInfo    
Public struct UStruct FGroomAnimationInfo Relevant information about a groom animation  
Public struct FGroomAssetMemoryStats    
Public struct FGroomBindingAssetMemoryStats    
Public struct FGroomBindingBuilder    
Public struct FGroomBuilder Data flow overview  
Public struct UStruct BlueprintType FGroomBuildSettings    
Public struct FGroomCacheAnimationData Groom animation data for a frame  
Public struct FGroomCacheChunk The smallest unit of streamed GroomCache data The BulkData member is loaded on-demand so that loading the GroomCache itself is relatively lightweight  
Public struct FGroomCacheGroupData Animatable group data that maps to FHairStrandsDatas  
Public struct UStruct BlueprintType FGroomCacheImportSettings    
Public struct UStruct FGroomCacheInfo Information about the GroomCache itself  
Public class FGroomCacheProcessor Proxy that processes the HairGroupData into GroomCacheChunks that contain the groom animation data  
Public struct FGroomCacheStrandData Animatable strand data that maps to FHairStrandsCurves  
Public struct FGroomCacheVertexData Animatable vertex data that maps to FHairStrandsPoints  
Public struct FGroomComponentMemoryStats    
Public class FGroomComponentRecreateRenderStateContext Used to recreate render context for all GroomComponents that use a given GroomAsset  
Public struct UStruct BlueprintType FGroomConversionSettings    
Public struct FGroomDeformerBuilder    
Public struct UStruct BlueprintType FGroomHairGroupPreview    
Public struct FGroomID    
Public struct FGroomRBFDeformer    
Public struct FGroomTextureBuilder    
Public struct UStruct BlueprintType FHairAdvancedRenderingSettings    
Public struct FHairAssetHelper    
Public struct UStruct BlueprintType FHairBendConstraint    
Public struct FHairBulkContainer    
Public class FHairCardIndexBuffer    
Public struct FHairCardsAtlasRectFormat    
Public struct FHairCardsBoundsFormat    
Public struct FHairCardsBulkData    
Public struct UStruct BlueprintType FHairCardsClusterSettings Deprecated  
Public struct FHairCardsDatas    
Public struct FHairCardsDeformedResource    
Public struct FHairCardsDimensionFormat    
Public struct FHairCardsGeometry Data structure holding cards geometry information.  
Public struct UStruct BlueprintType FHairCardsGeometrySettings    
Public struct FHairCardsIndexFormat    
Public struct FHairCardsInterpolationBulkData    
Public struct FHairCardsInterpolationDatas Hair cards points interpolation attributes  
Public struct FHairCardsInterpolationFormat    
Public struct FHairCardsInterpolationResource    
Public struct FHairCardsInterpolationVertex    
Public struct FHairCardsMaterialFormat    
Public struct FHairCardsNormalFormat    
Public struct FHairCardsOffsetAndCount    
Public struct FHairCardsPositionFormat    
Public struct FHairCardsProceduralAtlas    
Public struct FHairCardsProceduralDatas Data structure holding cards geometry information and intermediate data used for generating cards data based on strands groom  
Public struct FHairCardsProceduralGeometry    
Public struct FHairCardsProceduralResource Render buffers that will be used for rendering  
Public struct FHairCardsRestResource Render buffers that will be used for rendering  
Public struct FHairCardsSourceData    
Public struct FHairCardsStrandsAttributeFormat    
Public struct FHairCardsStrandsPositionFormat    
Public struct UStruct BlueprintType FHairCardsTextureSettings    
Public struct FHairCardsUVFormat    
Public class FHairCardsVertexBuffer    
Public class FHairCardsVertexFactory A vertex factory which simply transforms explicit vertex attributes from local to world space.  
Public class FHairCardsVertexFactoryUniformShaderParameters    
Public struct FHairCardsVoxel Internal data structure for computing surface flow.  
Public struct FHairCardsVoxelDensityFormat    
Public struct FHairCardsVoxelTangentFormat    
Public struct FHairClusterIndexFormat    
Public struct FHairClusterInfo Structure describing the LOD settings (Screen size, vertex info, ...) for each clusters.  
Public struct FHairClusterInfoFormat    
Public struct UStruct BlueprintType FHairCollisionConstraint    
Public struct FHairCommonResource Hair resouces which whom allocation can be deferred  
Public struct UStruct BlueprintType FHairDecimationSettings    
Public struct UStruct BlueprintType FHairDeformationSettings    
Public class FHairDescription    
Public struct FHairDescriptionBulkData Bulk data storage for FHairDescription  
Public struct FHairDescriptionGroup    
Public struct FHairDescriptionGroups    
Public struct FHairDescriptionVersion    
Public struct UStruct BlueprintType FHairExternalForces    
Public struct UStruct BlueprintType FHairGeometrySettings    
Public struct UStruct BlueprintType FHairGroupCardsInfo    
Public struct UStruct BlueprintType FHairGroupCardsTextures    
Public struct UStruct BlueprintType FHairGroupDesc    
Public struct UStruct BlueprintType FHairGroupInfo    
Public struct UStruct BlueprintType FHairGroupInfoWithVisibility    
Public struct FHairGroupInstance Represent/Describe data & resources of a hair group belonging to a groom.  
Public struct UStruct BlueprintType FHairGroupLODInfo    
Public struct FHairGroupPlatformData Describe all data & resource for a groom asset's hair group  
Public struct UStruct BlueprintType FHairGroupsCardsSourceDescription    
Public struct UStruct BlueprintType FHairGroupsInterpolation    
Public struct UStruct BlueprintType FHairGroupsLOD    
Public struct UStruct BlueprintType FHairGroupsMaterial    
Public struct UStruct BlueprintType FHairGroupsMeshesSourceDescription    
Public struct UStruct BlueprintType FHairGroupsPhysics    
Public struct UStruct BlueprintType FHairGroupsProceduralCards    
Public struct UStruct BlueprintType FHairGroupsRendering    
Public struct UStruct BlueprintType FHairInterpolationSettings    
Public struct FHairLODInfo    
Public struct UStruct BlueprintType FHairLODSettings    
Public struct UStruct BlueprintType FHairMaterialConstraints    
Public struct FHairMeshes    
Public struct FHairMeshesBulkData    
Public struct FHairMeshesDatas    
Public struct FHairMeshesDeformedResource Render buffers that will be used for rendering  
Public struct FHairMeshesRestResource Render buffers that will be used for rendering  
Public struct FHairOrientedBound    
Public struct FHairResourceName    
Public struct UStruct BlueprintType FHairShadowSettings    
Public struct UStruct BlueprintType FHairSimulationConstraints    
Public struct UStruct BlueprintType FHairSimulationForces    
Public struct UStruct BlueprintType FHairSimulationSettings    
Public struct UStruct BlueprintType FHairSimulationSetup    
Public struct UStruct BlueprintType FHairSimulationSolver    
Public struct UStruct BlueprintType FHairSolverSettings    
Public struct FHairStrandsAttributeFormat    
Public struct FHairStrandsBulkCommon    
Public struct FHairStrandsBulkData    
Public struct FHairStrandsClusterBulkData    
Public struct FHairStrandsClusterData    
Public struct FHairStrandsClusterResource    
Public class FHairStrandsCore Implements the HairStrands module  
Public struct FHairStrandsCullingResource    
Public struct FHairStrandsCurveFormat    
Public struct FHairStrandsCurves Hair strands Curves attribute  
Public struct FHairStrandsDatas Hair strands datas that are stored on CPU  
Public struct FHairStrandsDebugDatas Hair strands debug data  
Public struct FHairStrandsDeformedResource    
Public struct FHairStrandsDeformedRootResource Render buffers for root deformation for dynamic meshes  
Public struct FHairStrandsIndexFormat Hair strands index format  
Public struct FHairStrandsInterpolationBulkData    
Public struct FHairStrandsInterpolationDatas Hair strands points interpolation attributes  
Public struct FHairStrandsInterpolationFormat    
Public struct FHairStrandsInterpolationResource    
Public struct FHairStrandsMeshTrianglePositionFormat Skinned mesh triangle vertex position format  
Public struct UStruct BlueprintType FHairStrandsParameters    
Public struct FHairStrandsPoints Hair strands points attribute  
Public struct FHairStrandsPointToCurveFormat16    
Public struct FHairStrandsPointToCurveFormat32    
Public struct FHairStrandsPositionFormat    
Public struct FHairStrandsPositionOffsetFormat    
Public struct FHairStrandsProjectionMeshData    
Public struct FHairStrandsRaytracingFormat    
Public struct FHairStrandsRestResource Render buffers that will be used for rendering  
Public struct FHairStrandsRestRootResource Render buffers for root deformation for dynamic meshes  
Public struct FHairStrandsRootBarycentricFormat    
Public struct FHairStrandsRootBulkData Bulk data for root resources (GPU resources are stored into FHairStrandsRootResources)  
Public struct FHairStrandsRootData Source data for building root bulk data  
Public struct FHairStrandsRootIndexFormat    
Public struct FHairStrandsRootToUniqueTriangleIndexFormat    
Public struct FHairStrandsRootUtils    
Public struct FHairStrandsTangentFormat    
Public struct FHairStrandsUniqueTriangleIndexFormat Encode Section ID and triangle Index from the source skel. mesh.  
Public class FHairStrandsVertexFactory A vertex factory which simply transforms explicit vertex attributes from local to world space.  
Public class FHairStrandsVertexFactoryUniformShaderParameters    
Public struct FHairStrandsVoxelData    
Public struct FHairStrandsWeightFormat Hair strands weights format  
Public struct FHairStreamingRequest Streaming request are used for reading hair strands data from DDC or IO The request are translated later to FHairStrandsBulkCommon::FQuery for appropriate reading.  
Public struct UStruct BlueprintType FHairStretchConstraint    
Public struct FHairVertexFactoryTypesPerMaterialData    
Public struct UStruct FMovieSceneGroomCacheParams    
Public struct FPackedHairAttribute0Vertex    
Public struct FPackedHairCurve    
Public struct FPackedHairVertex    
Public struct FPointsSampler    
Public struct FStrandID    
Public struct FStrandsPositionOutput    
Public struct FStrandsTexturesInfo    
Public struct FStrandsTexturesOutput    
Public struct FVector4_16    
Public class IGroomCacheBuffers Interface to access GroomCache buffers for playback  
Public struct IGroomCacheStreamingManager    
Public class UClass BlueprintType AutoExpandCategories, HideCategories UGroomAsset Implements an asset that can be used to store hair strands  
Public class UClass UGroomAssetImportData    
Public class UClass BlueprintType HideCategories UGroomBindingAsset Implements an asset that can be used to store binding information between a groom and a skeletal mesh  
Public class UClass BlueprintType HideCategories UGroomBindingAssetList    
Public class UClass Meta UGroomBlueprintLibrary    
Public class UClass BlueprintType UGroomCache Implements an asset that is used to store an animated groom  
Public class UClass UGroomCacheImportData The asset import data to store the import settings within the GroomCache asset  
Public class UClass BlueprintType UGroomCacheImportOptions    
Public class UClass ClassGroup, HideCategories, Meta editinlinenew UGroomComponent    
Public class UClass BlueprintType HideCategories Config autocollapsecategories UGroomCreateBindingOptions    
Public class UClass BlueprintType HideCategories Config UGroomCreateFollicleMaskOptions    
Public class UClass BlueprintType HideCategories Config UGroomCreateStrandsTexturesOptions    
Public class UClass BlueprintType HideCategories Config UGroomHairGroupsPreview    
Public class UClass BlueprintType HideCategories Config UGroomImportOptions    
Public class UClass Config UGroomPluginSettings Settings for the groom plug-in  
Public class UClass Abstract editinlinenew UHairCardGenerationSettings Since hair-card generation can be controlled external to this plugin, this provides a way for those external generators a way to store their own generation data along with the groom/cards-entry.  
Public class UClass MinimalAPI UMovieSceneGroomCacheSection Movie scene section that control GroomCache playback  
Public class UClass MinimalAPI UMovieSceneGroomCacheTrack Handles animation of GroomCache  

Typedefs

Name Description
FHairCardsUniformBuffer  
FHairGroupInstanceModifer  
FHairStrandsUniformBuffer  
TGroomAttributesConstRef  
TGroomAttributesRef  
TStrandAttributesConstRef  
TStrandAttributesRef  
TTextureAllocation Typedef UTexture2D* (TCreateTextureHelper*)(FName Package, const FIntPoint& Resolution);

Enums

  Type Name Description
Public enum EEditableGroomOperations    
Public enum UEnum BlueprintType EFollicleMaskChannel List of channel  
Public enum UEnum BlueprintType EGroomBasisType    
Public enum UEnum BlueprintType EGroomBindingMeshType Enum that describes the type of mesh to bind to  
Public enum UEnum BlueprintType EGroomBindingType    
Public enum UEnum EGroomCacheAttributes Attributes in groom that can be animated  
Public enum UEnum BlueprintType EGroomCacheImportType    
Public enum UEnum EGroomCacheType Types of GroomCache Strands: animated render strands (including animatable hair attributes) Guides: animated guides that require in-engine simulation (position only)  
Public enum UEnum BlueprintType EGroomCurveType    
Public enum UEnum BlueprintType EGroomGeometryType    
Public enum UEnum BlueprintType EGroomGuideType    
Public enum UEnum EGroomInterpolationQuality    
Public enum UEnum BlueprintType EGroomInterpolationType List of interpolation type  
Public enum UEnum EGroomInterpolationWeight    
Public enum UEnum BlueprintType EGroomLODType    
Public enum UEnum BlueprintType EGroomNiagaraSolvers List of niagara solvers  
Public enum UEnum BlueprintType EGroomOverrideType    
Public enum UEnum BlueprintType EGroomStrandsSize Size of each strands  
Public enum UEnum BlueprintType EHairAtlasTextureType    
Public enum EHairAttribute    
Public enum EHairAttributeFlags    
Public enum UEnum BlueprintType EHairCardsClusterType    
Public enum UEnum BlueprintType EHairCardsGenerationType    
Public enum UEnum BlueprintType EHairCardsSourceType    
Public enum EHairGroupInfoFlags    
Public enum UEnum EHairInterpolationQuality    
Public enum UEnum EHairInterpolationWeight    
Public enum EHairLODSelectionType    
Public enum EHairResourceLoadingType    
Public enum EHairStrandsAllocationType    
Public enum EHairStrandsResourcesType    
Public enum EHairViewRayTracingMask    
Public enum UEnum BlueprintType EStrandsTexturesMeshType Size of each strands  
Public enum UEnum BlueprintType EStrandsTexturesTraceType Size of each strands  
Public enum HairStrandsTriangleType    

Functions

  Type Name Description
Public function void

AddComputeMipsPass ( FRDGBuilder& GraphBuilder,
FGlobalShaderMap* ShaderMap,
FRDGTextureRef& OutTexture
)

  
Public function void

AddHairCardsRBFInterpolationPass ( FRDGBuilder& GraphBuilder,
FGlobalShaderMap* ShaderMap,
const int32 MeshLODIndex,
FHairCardsRestResource* RestResources,
FHairCardsDeformedResource* DeformedResources,
FHairStrandsRestRootResource* RestRootResources,
FHairStrandsDeformedRootResource* DeformedRootResources
)

  
Public function void

AddHairMeshesRBFInterpolationPass ( FRDGBuilder& GraphBuilder,
FGlobalShaderMap* ShaderMap,
const int32 MeshLODIndex,
FHairMeshesRestResource* RestResources,
FHairMeshesDeformedResource* DeformedResources,
FHairStrandsRestRootResource* RestRootResources,
FHairStrandsDeformedRootResource* DeformedRootResources
)

  
Public function void

AddHairStrandInitMeshSamplesPass ( FRDGBuilder& GraphBuilder,
FGlobalShaderMap* ShaderMap,
const int32 LODIndex,
const HairStrandsTriangleType Type,
const FHairStrandsProjectionMeshData::LOD& MeshData,
FHairStrandsRestRootResource* RestResources,
FHairStrandsDeformedRootResource* DeformedResources
)

 Init the samples information to be used for interpolation
Public function void

AddHairStrandUpdateMeshSamplesPass ( FRDGBuilder& GraphBuilder,
FGlobalShaderMap* ShaderMap,
const int32 LODIndex,
const FHairStrandsProjectionMeshData::LOD& ProjectionMeshData,
FHairStrandsRestRootResource* RestResources,
FHairStrandsDeformedRootResource* DeformedResources
)

 Update the samples information to be used for interpolation
Public function void

AddHairStrandUpdateMeshTrianglesPass ( FRDGBuilder& GraphBuilder,
FGlobalShaderMap* ShaderMap,
const int32 LODIndex,
const HairStrandsTriangleType Type,
const FHairStrandsProjectionMeshData::LOD& MeshData,
FHairStrandsRestRootResource* RestResources,
FHairStrandsDeformedRootResource* DeformedResources
)

 Update the triangles information on which hair stands have been projected
Public function void

AddHairStrandUpdatePositionOffsetPass ( FRDGBuilder& GraphBuilder,
FGlobalShaderMap* ShaderMap,
const int32 LODIndex,
FHairStrandsDeformedRootResource* DeformedRootResources,
FHairStrandsDeformedResource* DeformedResources
)

  
Public function void

AddSkinUpdatePass ( FRDGBuilder& GraphBuilder,
FGlobalShaderMap* ShaderMap,
uint32 SectionIndex,
uint32 BonesOffset,
FSkeletalMeshLODRenderData& RenderData,
FRHIShaderResourceView* BoneMatrices,
FRHIShaderResourceView* PrevBoneMatrices,
FRDGBufferRef OutDeformedosition,
FRDGBufferRef OutPreviousDeformedosition
)

  
Public function void

ComputeHairStrandsInterpolation ( FRDGBuilder& GraphBuilder,
FGlobalShaderMap* ShaderMap,
const uint32 ViewUniqueID,
const uint32 ViewRayTracingMask,
const EGroomViewMode ViewMode,
const FVector& TranslatedWorldOffset,
const FShaderPrintData* ShaderPrintData,
FHairGroupInstance* Instance,
int32 LODIndex,
FHairStrandClusterData* ClusterData
)

  
Public function void

ComputeInterpolationWeights ( UGroomBindingAsset* BindingAsset,
FSkeletalMeshRenderData* TargetRenderData,
TArray< FRWBuffer >& TransferedPositions
)

  
Public function void Convert a groom asset into an editable groom asset.
Public function void

ConvertToGroomAsset ( UGroomAsset* Out,
const FEditableGroom* In,
uint32 Operations
)

 Convert an editable groom asset into a groom asset The 'operations' flag indicates what type of modifications have been done onto the editable groom.
Public function void Debug data (used for debug visalization but also for texture generation)
Public function void  
Public function FHairStrandsProjectionMeshData  
Public function void

GenerateFolliculeMask ( FRDGBuilder& GraphBuilder,
FGlobalShaderMap* ShaderMap,
const EPixelFormat Format,
const FIntPoint Resolution,
const uint32 MipCount,
const uint32 KernelSizeInPixels,
const uint32 Channel,
const int32 LODIndex,
FHairStrandsRestRootResource* RestResources,
FRDGTextureRef& OutTexture
)

  
Public function void

GenerateFolliculeMask ( FRDGBuilder& GraphBuilder,
FGlobalShaderMap* ShaderMap,
const EPixelFormat Format,
const FIntPoint Resolution,
const uint32 MipCount,
const uint32 KernelSizeInPixels,
const uint32 Channel,
const TArray< FRDGBufferRef >& RootUVBuffers,
FRDGTextureRef& OutTexture
)

  
Public function uint32  
Public function HAIRSTRANDSCORE_API const FShaderParametersMetadata *  
Public function HAIRSTRANDSCORE_API const FShaderParametersMetadata *  
Public function const FLinearColor

GetHairGroupDebugColor ( int32 GroupIt
)

 Return the debug color of an hair group
Public function EHairResourceLoadingType

GetHairResourceLoadingType ( EHairGeometryType InGeometryType,
int32 InLODIndex
)

  
Public function float  
Public function float  
Public function uint32 Return the max number of section/triangle a skeletal mesh can have. After this count, binding will be disabled.
Public function uint32  
Public function bool

HasHairAttribute ( uint32 In,
EHairAttribute InAttribute
)

  
Public function bool  
Public function constexpr bool  
Public function constexpr bool  
Public function bool  
Public function EHairResourceStatus  
Public function constexpr EGroomCacheImportType  
Public function constexpr EGroomCacheAttributes  
Public function EGroomCacheImportType &  
Public function EGroomCacheAttributes &  
Public function constexpr EGroomCacheAttributes  
Public function constexpr EGroomCacheImportType  
Public function EGroomCacheAttributes &  
Public function EGroomCacheImportType &  
Public function constexpr EGroomCacheAttributes  
Public function constexpr EGroomCacheImportType  
Public function EHairResourceStatus  
Public function EHairResourceStatus &  
Public function EGroomCacheImportType &  
Public function EGroomCacheAttributes &  
Public function constexpr EGroomCacheImportType  
Public function constexpr EGroomCacheAttributes  
Public function bool  
Public function enum EGroomViewModeuint8void

ResetHairStrandsInterpolation ( FRDGBuilder& GraphBuilder,
FGlobalShaderMap* ShaderMap,
FHairGroupInstance* Instance,
int32 LODIndex
)

 Reset the interpolation data.
Public function void

SetGroomAttribute ( FHairDescription& HairDescription,
FGroomID GroomID,
FName AttributeName,
AttributeType AttributeValue
)

  
Public function void

SetHairAttribute ( uint32& Out,
EHairAttribute InAttribute
)

  
Public function void

SetHairAttributeFlags ( uint32& Out,
EHairAttributeFlags InFlag
)

  
Public function void

SetHairStrandAttribute ( FHairDescription& HairDescription,
FStrandID StrandID,
FName AttributeName,
AttributeType AttributeValue
)

  
Public function void

SetHairVertexAttribute ( FHairDescription& HairDescription,
FVertexID VertexID,
FName AttributeName,
AttributeType AttributeValue
)

  

Variables

  Type Name Description
Public variable const FName AO  
Public variable const FName BasisType  
Public variable const FName ClosestGuides  
Public variable const FName ClumpID  
Public variable const FName Color  
Public variable const FName Color  
Public variable const FName Color  
Public variable const FName CurveType  
Public variable const FName GroupCardsID  
Public variable const FName GroupID  
Public variable const FName GroupName  
Public variable const FName Guide  
Public variable const FName GuideWeights  
Public variable const FName ID  
Public variable const FName Knots  
Public variable const FName MajorVersion  
Public variable const FName MinorVersion  
Public variable const FName Position  
Public variable const FName Properties  
Public variable const FName RootUV  
Public variable const FName Roughness  
Public variable const FName Roughness  
Public variable const FName Roughness  
Public variable const FName Tool  
Public variable const FName VertexCount  
Public variable const FName Width  
Public variable const FName Width  
Public variable const FName Width  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page