Navigation
| Name | HairStrandsCore |
| Type | Runtime |
| Part of Plugins | Groom |
| Location | /Engine/Plugins/Runtime/HairStrands/Source/HairStrandsCore/ |
| Module Build Rules | HairStrandsCore.Build.cs |
Classes
| Name | Remarks |
|---|---|
| AGroomActor | An actor that renders a simulated hair |
| FGroomBindingAsyncBuildScope | Any thread implicated in the build must have a valid scope to be granted access to protected properties without causing any stalls. |
| FGroomBindingAsyncBuildWorker | Worker used to perform async compilation. |
| FGroomBindingCompilingManager | |
| FGroomCacheProcessor | Proxy that processes the HairGroupData into GroomCacheChunks that contain the groom animation data |
| FGroomComponentRecreateRenderStateContext | Used to recreate render context for all GroomComponents that use a given GroomAsset |
| FHairCardIndexBuffer | |
| FHairCardsVertexBuffer | |
| FHairCardsVertexFactory | A vertex factory which simply transforms explicit vertex attributes from local to world space. |
| FHairCardsVertexFactoryUniformShaderParameters | |
| FHairDescription | |
| FHairStrandsCore | Implements the HairStrands module |
| FHairStrandsVertexFactory | A vertex factory which simply transforms explicit vertex attributes from local to world space. |
| FHairStrandsVertexFactoryUniformShaderParameters | |
| FOnGroomBindingAssetBuildComplete | |
| FRDGWrapperVertexBuffer | Wrapper to reinterepet FRDGPooledBuffer as a FVertexBuffer. |
| UDataflowGroomContent | Dataflow content owning dataflow and binding assets that will be used to evaluate the graph |
| UGroomAsset | Implements an asset that can be used to store hair strands |
| UGroomAssetImportData | |
| UGroomBindingAsset | Implements an asset that can be used to store binding information between a groom and a skeletal mesh |
| UGroomBindingAssetList | |
| UGroomBlueprintLibrary | |
| UGroomCache | Implements an asset that is used to store an animated groom |
| UGroomCacheImportData | The asset import data to store the import settings within the GroomCache asset |
| UGroomCacheImportOptions | |
| UGroomComponent | |
| UGroomCreateBindingOptions | |
| UGroomCreateFollicleMaskOptions | |
| UGroomCreateStrandsTexturesOptions | |
| UGroomHairGroupsMapping | |
| UGroomHairGroupsPreview | |
| UGroomImportOptions | |
| UGroomPluginSettings | Settings for the groom plug-in |
| UHairCardGenerationSettings | Since hair-card generation can be controlled external to this plugin, this |
| UMovieSceneGroomCacheSection | Movie scene section that control GroomCache playback |
| UMovieSceneGroomCacheTrack | Handles animation of GroomCache |
| UNiagaraDataInterfaceHairStrands | Data Interface for the strand base |
| UNiagaraDataInterfacePressureGrid | Data Interface for the strand base |
| UNiagaraDataInterfaceVelocityGrid | Data Interface for the strand base |
Structs
Interfaces
| Name | Remarks |
|---|---|
| IGroomCacheBuffers | Interface to access GroomCache buffers for playback |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FHairCardsUniformBuffer | TUniformBufferRef< FHairCardsVertexFactoryUniformShaderParameters > | GroomInstance.h | |
| FHairGroupInstanceModifer | FHairGroupDesc | GroomDesc.h | |
| FHairStrandsUniformBuffer | TUniformBufferRef< FHairStrandsVertexFactoryUniformShaderParameters > | GroomInstance.h | |
| FOnGroomBindingAssetBuildCompleteNative | TBaseDelegate_TwoParams< void, UGroomBindingAsset *, EGroomBindingAssetBuildResult > | GroomBindingAsset.h | |
| TGroomAttributesConstRef | TMeshAttributesConstRef< FGroomID, AttributeType > | HairDescription.h | |
| TGroomAttributesRef | TMeshAttributesRef< FGroomID, AttributeType > | HairDescription.h | |
| TStrandAttributesConstRef | TMeshAttributesConstRef< FStrandID, AttributeType > | HairDescription.h | |
| TStrandAttributesRef | TMeshAttributesRef< FStrandID, AttributeType > | HairDescription.h | |
| TTextureAllocation | void(* | Typedef UTexture2D* (TCreateTextureHelper*)(FName Package, const FIntPoint& Resolution); | HairStrandsCore.h |
Enums
Public
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| BendOffset | const int32 | Niagara/NiagaraDataInterfaceHairStrands.h | |
| MaxDelay | const int32 | Niagara/NiagaraDataInterfaceHairStrands.h | |
| NumScales | const int32 | Niagara/NiagaraDataInterfaceHairStrands.h | |
| RadiusOffset | const int32 | Niagara/NiagaraDataInterfaceHairStrands.h | |
| StretchOffset | const int32 | Niagara/NiagaraDataInterfaceHairStrands.h | |
| ThicknessOffset | const int32 | Niagara/NiagaraDataInterfaceHairStrands.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| AO | const FName | HairAttributes.h | ||
| BasisType | const FName | HairAttributes.h | ||
| ClosestGuides | const FName | HairAttributes.h | ||
| ClumpID | const FName | HairAttributes.h | ||
| Color | const FName | HairAttributes.h | ||
| Color | const FName | HairAttributes.h | ||
| Color | const FName | HairAttributes.h | ||
| CurveType | const FName | HairAttributes.h | ||
| GroupCardsName | const FName | HairAttributes.h | ||
| GroupID | const FName | HairAttributes.h | ||
| GroupName | const FName | HairAttributes.h | ||
| Guide | const FName | HairAttributes.h | ||
| GuideWeights | const FName | HairAttributes.h | ||
| ID | const FName | HairAttributes.h | ||
| Knots | const FName | HairAttributes.h | ||
| MajorVersion | const FName | HairAttributes.h | ||
| MinorVersion | const FName | HairAttributes.h | ||
| Position | const FName | HairAttributes.h | ||
| Properties | const FName | HairAttributes.h | ||
| RootUV | const FName | HairAttributes.h | ||
| Roughness | const FName | HairAttributes.h | ||
| Roughness | const FName | HairAttributes.h | ||
| Roughness | const FName | HairAttributes.h | ||
| Tool | const FName | HairAttributes.h | ||
| VertexCount | const FName | HairAttributes.h | ||
| Width | const FName | HairAttributes.h | ||
| Width | const FName | HairAttributes.h | ||
| Width | const FName | HairAttributes.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void AddClearAABBPass
(
FRDGBuilder& GraphBuilder, |
HairStrandsInterpolation.h | ||
void AddComputeMipsPass
(
FRDGBuilder& GraphBuilder, |
HairStrandsMeshProjection.h | ||
void AddDeformSimHairStrandsPass
(
FRDGBuilder& GraphBuilder, |
Reset the interpolation data. | HairStrandsInterpolation.h | |
void AddGroomCacheUpdatePass
(
FRDGBuilder& GraphBuilder, |
HairStrandsInterpolation.h | ||
void AddHairCardsDeformationPass
(
FRDGBuilder& GraphBuilder, |
HairStrandsInterpolation.h | ||
void AddHairCardsRBFInterpolationPass
(
FRDGBuilder& GraphBuilder, |
HairStrandsMeshProjection.h | ||
void AddHairMeshesRBFInterpolationPass
(
FRDGBuilder& GraphBuilder, |
HairStrandsMeshProjection.h | ||
void AddHairStrandInitMeshSamplesPass
(
FRDGBuilder& GraphBuilder, |
Init the samples information to be used for interpolation | HairStrandsMeshProjection.h | |
void AddHairStrandsInterpolationPass
(
FRDGBuilder& GraphBuilder, |
HairStrandsInterpolation.h | ||
void AddHairStrandUpdateMeshSamplesPass
(
FRDGBuilder& GraphBuilder, |
Update the samples information to be used for interpolation | HairStrandsMeshProjection.h | |
void AddHairStrandUpdateMeshTrianglesPass
(
FRDGBuilder& GraphBuilder, |
Update the triangles information on which hair stands have been projected | HairStrandsMeshProjection.h | |
void AddHairStrandUpdatePositionOffsetPass
(
FRDGBuilder& GraphBuilder, |
HairStrandsMeshProjection.h | ||
void AddHairTangentPass
(
FRDGBuilder& GraphBuilder, |
HairStrandsInterpolation.h | ||
void AddPatchAttributePass
(
FRDGBuilder& GraphBuilder, |
HairStrandsInterpolation.h | ||
void AddSkinUpdatePass
(
FRDGBuilder& GraphBuilder, |
HairStrandsMeshProjection.h | ||
void AddTransferPositionPass
(
FRDGBuilder& GraphBuilder, |
HairStrandsInterpolation.h | ||
void ComputeHairStrandsInterpolation
(
FRDGBuilder& GraphBuilder, |
HairStrandsInterpolation.h | ||
FHairGroupPublicData::FVertexFactoryInput ComputeHairStrandsVertexInputData
(
const FHairGroupInstance* Instance, |
HairStrandsInterpolation.h | ||
void ComputeInterpolationWeights
(
UGroomBindingAsset* BindingAsset, |
HairStrandsInterpolation.h | ||
void ConvertFromGroomAsset
(
UGroomAsset* In, |
Convert a groom asset into an editable groom asset. | GroomEdit.h | |
void ConvertToGroomAsset
(
UGroomAsset* Out, |
Convert an editable groom asset into a groom asset The 'operations' flag indicates what type of modifications have been done onto the editable groom. | GroomEdit.h | |
FGroomCacheResources CreateGroomCacheBuffer
(
FRDGBuilder& GraphBuilder, |
HairStrandsInterpolation.h | ||
UGroomImportOptions * CreateGroomImportOptions
(
const FHairDescriptionGroups& GroupsDescription, |
GroomImportOptions.h | ||
void CreateHairStrandsDebugDatas
(
const FHairStrandsDatas& InData, |
Debug data (used for debug visalization but also for texture generation) | GroomResources.h | |
void CreateHairStrandsDebugResources
(
FRDGBuilder& GraphBuilder, |
GroomResources.h | ||
void GenerateFolliculeMask
(
FRDGBuilder& GraphBuilder, |
HairStrandsMeshProjection.h | ||
void GenerateFolliculeMask
(
FRDGBuilder& GraphBuilder, |
HairStrandsMeshProjection.h | ||
uint32 GetBufferTotalNumBytes
(
const FRDGExternalBuffer& In |
GroomResources.h | ||
uint32 GetDataSize
(
const FHairStrandsBulkData& BulkData |
GroomAsset.h | ||
uint32 GetDataSize
(
const FHairStrandsInterpolationBulkData& InterpolationBulkData |
GroomAsset.h | ||
const FShaderParametersMetadata * GetForwardDeclaredShaderParametersStructMetadata
(
const FHairCardsVertexFactoryUniformShaderParameters* DummyPtr |
GroomInstance.h | ||
| GroomInstance.h | |||
const FLinearColor GetHairGroupDebugColor
(
int32 GroupIt |
Return the debug color of an hair group | GroomComponent.h | |
FHairGroupInstance * GetHairGroupInstance
(
UGroomComponent* In, |
Niagara/NiagaraDataInterfaceHairStrands.h | ||
EHairResourceLoadingType GetHairResourceLoadingType
(
EHairGeometryType InGeometryType, |
GroomResources.h | ||
float GetHairStrandsMaxLength
(
const FHairStrandsDatas& In |
HairStrandsDatas.h | ||
float GetHairStrandsMaxRadius
(
const FHairStrandsDatas& In |
HairStrandsDatas.h | ||
uint32 GetHairStrandsMaxSectionCount() |
Return the max number of section/triangle a skeletal mesh can have. After this count, binding will be disabled. | HairStrandsMeshProjection.h | |
uint32 GetHairStrandsMaxTriangleCount() |
HairStrandsMeshProjection.h | ||
uint32 GetHairTextureLayoutTextureCount
(
EHairTextureLayout In |
Returns the number of textures used for a particular layout. | GroomAssetCards.h | |
const TCHAR * GetHairTextureLayoutTextureName
(
EHairTextureLayout InLayout, |
GroomAssetCards.h | ||
bool HasHairAttribute
(
uint32 In, |
HairAttributes.h | ||
bool HasHairAttributeFlags
(
uint32 In, |
HairAttributes.h | ||
FRDGHairStrandsCullingData ImportCullingData
(
FRDGBuilder& GraphBuilder, |
HairStrandsInterpolation.h | ||
bool operator!
(
EGroomBindingAsyncProperties E |
GroomBindingAsset.h | ||
bool operator!
(
EGroomBindingAsyncPropertyLockType E |
GroomBindingAsset.h | ||
bool operator!
(
EGroomCacheAttributes E |
GroomCacheData.h | ||
bool operator!
(
EGroomCacheImportType E |
GroomCacheImportOptions.h | ||
bool operator!
(
EHairViewRayTracingMask E |
GroomInstance.h | ||
bool operator!
(
EHairResourceStatus A |
GroomResources.h | ||
| GroomBindingAsset.h | |||
| GroomBindingAsset.h | |||
| GroomCacheData.h | |||
| GroomCacheImportOptions.h | |||
| GroomInstance.h | |||
EHairResourceStatus operator&
(
EHairResourceStatus In, |
GroomResources.h | ||
| GroomBindingAsset.h | |||
| GroomBindingAsset.h | |||
EGroomCacheAttributes & operator&=
(
EGroomCacheAttributes& Lhs, |
GroomCacheData.h | ||
EGroomCacheImportType & operator&=
(
EGroomCacheImportType& Lhs, |
GroomCacheImportOptions.h | ||
| GroomInstance.h | |||
| GroomBindingAsset.h | |||
| GroomBindingAsset.h | |||
| GroomCacheData.h | |||
| GroomCacheImportOptions.h | |||
| GroomInstance.h | |||
| GroomBindingAsset.h | |||
| GroomBindingAsset.h | |||
EGroomCacheAttributes & operator^=
(
EGroomCacheAttributes& Lhs, |
GroomCacheData.h | ||
EGroomCacheImportType & operator^=
(
EGroomCacheImportType& Lhs, |
GroomCacheImportOptions.h | ||
| GroomInstance.h | |||
| GroomBindingAsset.h | |||
| GroomBindingAsset.h | |||
| GroomCacheData.h | |||
| GroomCacheImportOptions.h | |||
| GroomInstance.h | |||
EHairResourceStatus operator|
(
EHairResourceStatus In, |
GroomResources.h | ||
| GroomBindingAsset.h | |||
| GroomBindingAsset.h | |||
EGroomCacheAttributes & operator|=
(
EGroomCacheAttributes& Lhs, |
GroomCacheData.h | ||
EGroomCacheImportType & operator|=
(
EGroomCacheImportType& Lhs, |
GroomCacheImportOptions.h | ||
| GroomInstance.h | |||
EHairResourceStatus & operator|=
(
EHairResourceStatus& Out, |
GroomResources.h | ||
| GroomBindingAsset.h | |||
| GroomBindingAsset.h | |||
| GroomCacheData.h | |||
| GroomCacheImportOptions.h | |||
| GroomInstance.h | |||
bool RequestStrandsPosition
(
const UGroomComponent* Component, |
GroomBuilder.h | ||
void SetGroomAttribute
(
FHairDescription& HairDescription, |
HairDescription.h | ||
void SetHairAttribute
(
uint32& Out, |
HairAttributes.h | ||
void SetHairAttributeFlags
(
uint32& Out, |
HairAttributes.h | ||
void SetHairStrandAttribute
(
FHairDescription& HairDescription, |
HairDescription.h | ||
void SetHairVertexAttribute
(
FHairDescription& HairDescription, |
HairDescription.h |