Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > Engine > FSkeletalMeshObject

Light Theme

Dark Theme

FSkeletalMeshObject

Interface for mesh rendering data

Windows

MacOS

Linux

Inheritance Hierarchy

FDeferredCleanupInterface

FSkeletalMeshObject

References

Module	Engine
Header	/Engine/Source/Runtime/Engine/Public/SkeletalRenderPublic.h
Include	#include "SkeletalRenderPublic.h"

Syntax

class FSkeletalMeshObject : public FDeferredCleanupInterface

Remarks

Interface for mesh rendering data

Variables

	Name	Description
bool	bHasBeenUpdatedAtLeastOnce	This is set to true when we have sent our Mesh data to the rendering thread at least once as it needs to have have a datastructure created there for each MeshObject
bool	bUsePerBoneMotionBlur	If true, per-bone motion blur is enabled for this object.
uint32	ComponentId	Component ID to which belong this mesh object
ERHIFeatureLeve...	FeatureLevel	Feature level to render for.
uint32	LastFrameNumber	Used to keep track of the first call to UpdateMinDesiredLODLevel each frame.
TArray< FSkelMe...	LODInfo
int32	MaterialIndexPreview
float	MaxDistanceFactor	High (best) DistanceFactor that was desired for rendering this SkeletalMesh last frame.
int32	MinDesiredLODLevel	Lowest (best) LOD that was desired for rendering this SkeletalMesh last frame.
int32	SectionIndexPreview	Index of the section to preview... If set to -1, all section will be rendered
int32	SelectedEditorMaterial	The Material currently selected. need to remember this index for reimporting cloth
int32	SelectedEditorSection	The section currently selected in the Editor. Used for highlighting
TArray< FCapsul...	ShadowCapsuleShapes
TArray< FSkelet...	SkeletalMeshLODInfo	Per-LOD info.
FSkeletalMeshRe...	SkeletalMeshRenderData	The skeletal mesh resource with which to render.
FGPUSkinCacheEn...	SkinCacheEntry
TStatId	StatId	Used for dynamic stats
float	WorkingMaxDistanceFactor	This frames max distance factor.
int32	WorkingMinDesiredLODLevel	This frames min desired LOD level.

Constructors

	Name	Description
	FSkeletalMeshObject ( USkinnedMeshComponent* InMeshC..., FSkeletalMeshRenderData* InSke..., ERHIFeatureLevel::Type FeatureLevel )

Destructors

	Name	Description
	~FSkeletalMeshObject()

Functions

	Name	Description
void	CacheVertices ( int32 LODIndex, bool bForce )	Re-skin cached vertices for an LOD and update the vertex buffer.
void	DrawVertexElements ( FPrimitiveDrawInterface* PDI, const FMatrix& ToWorldSpace, bool bDrawNormals, bool bDrawTangents, bool bDrawBinormals )	Draw Normals/Tangents based on skinned vertex data
void	EnableOverlayRendering ( bool bEnabled, const TArray< int32 >* InBones..., const TArray< UMorphTarget* > ... )	Enable blend weight rendering in the editor
uint32	GetComponentId()	Return the ID of the component to which the skeletal mesh object belongs to.
TArray< FTra...	GetComponentSpaceTransforms()	Get the array of component-space bone transforms.
ERHIFeatureL...	GetFeatureLevel()	Returns the feature level this FSkeletalMeshObject was created with
int32	GetLOD()	Get the LOD to render this mesh at.
const TArray...	GetReferenceToLocalMatrices()	Get the array of refpose->local matrices Not safe to hold this reference between frames, because it exists in dynamic data passed from main thread.
const TArray...	GetRenderSections ( int32 InLODIndex )	List of sections to be rendered based on instance weight usage.
void	GetResourceSizeEx ( FResourceSizeEx& CumulativeResourc... )	Returns the size of memory allocated by render data
float	GetScreenSize ( int32 LODIndex )	Returns the display factor for the given LOD level
FSkeletalMes...	GetSkeletalMeshRenderData()	Get the skeletal mesh resource for which this mesh object was created.
const FVerte...	GetSkinVertexFactory ( const FSceneView* View, int32 LODIndex, int32 ChunkIdx )
TStatId	GetStatId()
bool	HaveValidDynamicData()	Return true if this does have valid dynamic data to render
void	InitLODInfos ( const USkinnedMeshComponent* I... )	Initialize the array of LODInfo based on the settings of the current skel mesh component
void	InitResources ( USkinnedMeshComponent* InMeshC... )	Initialize rendering resources for each LOD
bool	IsCPUSkinned()	Returns true if this mesh performs skinning on the CPU.
bool	IsMaterialHidden ( int32 InLODIndex, int32 MaterialIdx )	Determine if the material section entry for an LOD is hidden or not
void	PreGDMECallback ( FGPUSkinCache* GPUSkinCache, uint32 FrameNumber )	Called by FSkeletalMeshObject prior to GDME.
void	RefreshClothingTransforms ( const FMatrix& InNewLocalToWorld, uint32 FrameNumber )	Called to notify clothing data that component transform has changed
void	ReleaseResources()	Release rendering resources for each LOD
void	SetHiddenMaterials ( int32 InLODIndex, const TArray< bool >& HiddenMateri... )	Update the hidden material section flags for an LOD entry
bool	ShouldUsePerBoneMotionBlur()
void	Update ( int32 LODIndex, USkinnedMeshComponent* InMeshC..., const TArray< FActiveMorphTarget > ..., const TArray< float >& MorphTarget..., EPreviousBoneTransformUpdateMode Pr... )	Called by the game thread for any dynamic data updates for this skel mesh object
void	UpdateMinDesiredLODLevel ( const FSceneView* View, const FBoxSphereBounds& Bounds, int32 FrameNumber, uint8 CurFirstLODIdx )	Given a set of views, update the MinDesiredLODLevel member to indicate the minimum (ie best) LOD we would like to use to render this mesh.
void	UpdateSkinWeightBuffer ( USkinnedMeshComponent* InMeshC... )	Will force re-evaluating which Skin Weight buffer should be used for skinning, determined by checking for any override weights or a skin weight profile being set.

Classes

	Name	Description
	FSkelMeshObjectLODInfo	Setup for rendering a specific LOD entry of the component

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss