UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
FSkinnedMeshSceneProxyDesc Struct Reference

#include <SkinnedMeshSceneProxyDesc.h>

+ Inheritance diagram for FSkinnedMeshSceneProxyDesc:

Public Member Functions

 FSkinnedMeshSceneProxyDesc ()=default
 
ENGINE_API FSkinnedMeshSceneProxyDesc (const USkinnedMeshComponent *Component)
 
ENGINE_API void InitializeFromSkinnedMeshComponent (const USkinnedMeshComponent *)
 
ENGINE_API USkinnedAsset * GetSkinnedAsset () const
 
ENGINE_API UPhysicsAsset * GetPhysicsAsset () const
 
ENGINE_API bool ShouldDrawDebugSkeleton () const
 
ENGINE_API const TOptional< FLinearColor > & GetDebugDrawColor () const
 
ENGINE_API void GetPreSkinnedLocalBounds (FBoxSphereBounds &OutBounds) const
 
ENGINE_API UMaterialInterface * GetMaterial (int32 MaterialIndex) const
 
ENGINE_API int32 GetBoneIndex (FName BoneName) const
 
ENGINE_API FMaterialRelevance GetMaterialRelevance (ERHIFeatureLevel::Type InFeatureLevel) const
 
ENGINE_API FMaterialRelevance GetMaterialRelevance (EShaderPlatform InShaderPlatform) const
 
ENGINE_API float GetOverlayMaterialMaxDrawDistance () const
 
ENGINE_API UMaterialInterface * GetOverlayMaterial () const
 
void GetMaterialSlotsOverlayMaterial (TArray< TObjectPtr< UMaterialInterface > > &OutMaterialSlotsOverlayMaterial) const
 
virtual ENGINE_API void GetUsedMaterials (TArray< UMaterialInterface * > &OutMaterials, bool bGetDebugMaterials=false) const override
 
FVector GetComponentScale () const
 
int32 GetPredictedLODLevel () const
 
float GetMaxDistanceFactor () const
 
void SetLODInfo (TArrayView< const FSkelMeshComponentLODInfo > InLODInfo)
 
bool ShouldCPUSkin () const
 
ENGINE_API bool ShouldNaniteSkin () const
 
ENGINE_API bool HasValidNaniteData () const
 
ENGINE_API bool IsSkinCacheAllowed (int32 LodIdx) const
 
ENGINE_API UMeshDeformerInstance * GetMeshDeformerInstance () const
 
ENGINE_API UMeshDeformerInstance * GetMeshDeformerInstanceForLOD (int32 LODIndex) const
 
void InitializeFrom (const USkinnedMeshComponent *InComponent)
 
- Public Member Functions inherited from FPrimitiveSceneProxyDesc
ENGINE_API FPrimitiveSceneProxyDesc ()
 
ENGINE_API FPrimitiveSceneProxyDesc (const UPrimitiveComponent *)
 
virtual ENGINE_API ~FPrimitiveSceneProxyDesc ()
 
ENGINE_API void InitializeFromPrimitiveComponent (const UPrimitiveComponent *)
 
bool IsVisible () const
 
bool IsVisibleEditor () const
 
bool ShouldRenderSelected () const
 
bool IsComponentIndividuallySelected () const
 
ESceneDepthPriorityGroup GetStaticDepthPriorityGroup () const
 
bool HasStaticLighting () const
 
bool IsCollisionEnabled () const
 
bool IsPrecomputedLightingValid () const
 
bool HasValidSettingsForStaticLighting () const
 
bool GetShadowIndirectOnly () const
 
bool GetLevelInstanceEditingState () const
 
bool IsHidden () const
 
bool IsOwnerEditorOnly () const
 
bool ShouldRenderProxyFallbackToDefaultMaterial () const
 
bool SupportsWorldPositionOffsetVelocity () const
 
bool IsFirstPersonRelevant () const
 
int32 GetRayTracingGroupId () const
 
FSceneInterface * GetScene () const
 
const FCustomPrimitiveData & GetCustomPrimitiveData () const
 
TArrayView< URuntimeVirtualTexture * > GetRuntimeVirtualTextures () const
 
ERuntimeVirtualTextureMainPassType GetVirtualTextureRenderPassType () const
 
float GetVirtualTextureMainPassMaxDrawDistance () const
 
const UObject * AdditionalStatObject () const
 
TStatId GetStatID (bool bForDeferredUse=false) const
 
IPrimitiveComponent * GetPrimitiveComponentInterface () const
 
UWorld * GetWorld () const
 
FPrimitiveComponentId GetPrimitiveSceneId () const
 
UObject * GetOwner () const
 
template<class T >
T * GetOwner () const
 
ULevel * GetLevel () const
 
FString GetPathName () const
 
FName GetMeshDrawCommandStatsCategory () const
 
bool IsStaticMeshFirstPersonRelevant () const
 
ULevel * GetComponentLevel () const
 

Static Public Member Functions

static ENGINE_API FSkeletalMeshObject * CreateMeshObject (const FSkinnedMeshSceneProxyDesc &Desc)
 
static ENGINE_API FPrimitiveSceneProxy * CreateSceneProxy (const FSkinnedMeshSceneProxyDesc &Desc, bool bHideSkin, int32 MinLODIndex)
 

Public Attributes

TOptional< FLinearColor > DebugDrawColor
 
FMaterialRelevance MaterialRelevance {}
 
TArrayView< const FSkelMeshComponentLODInfo > LODInfo
 
FSkeletalMeshObject * MeshObject = nullptr
 
FSkeletalMeshObject * PreviousMeshObject = nullptr
 
USkinnedAsset * SkinnedAsset = nullptr
 
UPhysicsAsset * PhysicsAsset = nullptr
 
UMaterialInterface * OverlayMaterial = nullptr
 
TArray< TObjectPtr< UMaterialInterface > > MaterialSlotsOverlayMaterial
 
const FMeshDeformerInstanceSet * MeshDeformerInstances = nullptr
 
TArrayView< const TObjectPtr< UMaterialInterface > > OverrideMaterials
 
TArrayView< const ESkinCacheUsage > SkinCacheUsage {}
 
int32 PredictedLODLevel = 0
 
float MaxDistanceFactor = 1.0f
 
FVector ComponentScale = FVector::OneVector
 
float StreamingDistanceMultiplier = 1.0f
 
float NanitePixelProgrammableDistance = 0.0f
 
float CapsuleIndirectShadowMinVisibility = 0.0f
 
float OverlayMaterialMaxDrawDistance = 0.0f
 
uint8 bForceWireframe: 1 = false
 
uint8 bCanHighlightSelectedSections: 1 = false
 
uint8 bRenderStatic: 1 = false
 
uint8 bPerBoneMotionBlur: 1 = false
 
uint8 bCastCapsuleDirectShadow: 1 = false
 
uint8 bCastCapsuleIndirectShadow: 1 = false
 
uint8 bDrawDebugSkeleton: 1 = false
 
uint8 bCPUSkinning: 1 = false
 
uint32 bSortTriangles:1 = false
 
uint8 bAllowAlwaysVisible: 1 = false
 
- Public Attributes inherited from FPrimitiveSceneProxyDesc
UObject * Component = nullptr
 
UObject * Owner = nullptr
 
UWorld * World = nullptr
 
TArrayView< URuntimeVirtualTexture * > RuntimeVirtualTextures
 
TArray< uint32 > ActorOwners
 
const FCustomPrimitiveData * CustomPrimitiveData = nullptr
 
FSceneInterface * Scene = nullptr
 
IPrimitiveComponent * PrimitiveComponentInterface = nullptr
 
const UObject * AdditionalStatObjectPtr = nullptr
 
uint64 HiddenEditorViews = 0
 
TStatId StatId
 
uint32 CastShadow: 1
 
uint32 bReceivesDecals: 1
 
uint32 bOnlyOwnerSee: 1
 
uint32 bOwnerNoSee: 1
 
uint32 bLevelInstanceEditingState: 1
 
uint32 bUseViewOwnerDepthPriorityGroup: 1
 
uint32 bVisibleInReflectionCaptures: 1
 
uint32 bVisibleInRealTimeSkyCaptures: 1
 
uint32 bVisibleInRayTracing: 1
 
uint32 bRenderInDepthPass: 1
 
uint32 bRenderInMainPass: 1
 
uint32 bTreatAsBackgroundForOcclusion: 1
 
uint32 bCastDynamicShadow: 1
 
uint32 bCastStaticShadow: 1
 
uint32 bEmissiveLightSource: 1
 
uint32 bAffectDynamicIndirectLighting: 1
 
uint32 bAffectIndirectLightingWhileHidden: 1
 
uint32 bAffectDistanceFieldLighting: 1
 
uint32 bCastVolumetricTranslucentShadow: 1
 
uint32 bCastContactShadow: 1
 
uint32 bCastHiddenShadow: 1
 
uint32 bCastShadowAsTwoSided: 1
 
uint32 bSelfShadowOnly: 1
 
uint32 bCastInsetShadow: 1
 
uint32 bCastCinematicShadow: 1
 
uint32 bCastFarShadow: 1
 
uint32 bLightAttachmentsAsGroup: 1
 
uint32 bSingleSampleShadowFromStationaryLights: 1
 
uint32 bUseAsOccluder: 1
 
uint32 bSelectable: 1
 
uint32 bHasPerInstanceHitProxies: 1
 
uint32 bUseEditorCompositing: 1
 
uint32 bIsBeingMovedByEditor: 1
 
uint32 bReceiveMobileCSMShadows: 1
 
uint32 bRenderCustomDepth: 1
 
uint32 bVisibleInSceneCaptureOnly: 1
 
uint32 bHiddenInSceneCapture: 1
 
uint32 bForceMipStreaming: 1
 
uint32 bRayTracingFarField: 1
 
uint32 bHoldout: 1
 
uint32 bIsFirstPerson: 1
 
uint32 bIsFirstPersonWorldSpaceRepresentation: 1
 
uint32 bLumenHeightfield: 1
 
uint32 bIsVisible: 1
 
uint32 bIsVisibleEditor: 1
 
uint32 bSelected: 1
 
uint32 bIndividuallySelected: 1
 
uint32 bShouldRenderSelected: 1
 
uint32 bWantsEditorEffects: 1
 
uint32 bCollisionEnabled: 1
 
uint32 bIsHidden: 1
 
uint32 bIsHiddenEd: 1
 
uint32 bSupportsWorldPositionOffsetVelocity: 1
 
uint32 bIsOwnerEditorOnly: 1
 
uint32 bIsInstancedStaticMesh: 1
 
uint32 bHasStaticLighting: 1
 
uint32 bHasValidSettingsForStaticLighting: 1
 
uint32 bIsPrecomputedLightingValid: 1
 
uint32 bShadowIndirectOnly: 1
 
uint32 bShouldRenderProxyFallbackToDefaultMaterial:1
 
int32 TranslucencySortPriority = 0
 
float TranslucencySortDistanceOffset = 0.0f
 
int32 CustomDepthStencilValue = 0
 
FLightingChannels LightingChannels
 
ERayTracingGroupCullingPriority RayTracingGroupCullingPriority = ERayTracingGroupCullingPriority::CP_4_DEFAULT
 
EShadowCacheInvalidationBehavior ShadowCacheInvalidationBehavior = EShadowCacheInvalidationBehavior::Auto
 
TEnumAsByte< ESceneDepthPriorityGroup > ViewOwnerDepthPriorityGroup = ESceneDepthPriorityGroup::SDPG_World
 
TEnumAsByte< EComponentMobility::Type > Mobility = EComponentMobility::Movable
 
TEnumAsByte< EIndirectLightingCacheQuality > IndirectLightingCacheQuality = EIndirectLightingCacheQuality::ILCQ_Point
 
TEnumAsByte< ESceneDepthPriorityGroup > DepthPriorityGroup = ESceneDepthPriorityGroup::SDPG_World
 
ELightmapType LightmapType = ELightmapType::Default
 
ERendererStencilMask CustomDepthStencilWriteMask = ERendererStencilMask::ERSM_Default
 
ERuntimeVirtualTextureMainPassType VirtualTextureRenderPassType = ERuntimeVirtualTextureMainPassType::Exclusive
 
int8 VirtualTextureLodBias = 0
 
int8 VirtualTextureMinCoverage = 0
 
int32 VirtualTextureCullMips = 0
 
float VirtualTextureMainPassMaxDrawDistance = 0.0f
 
FPrimitiveComponentId ComponentId
 
int32 VisibilityId = 0
 
float CachedMaxDrawDistance = 0.0f
 
float MinDrawDistance = 0.0f
 
float BoundsScale = 1.0f
 
int32 RayTracingGroupId = FPrimitiveSceneProxy::InvalidRayTracingGroupId
 
ERHIFeatureLevel::Type FeatureLevel
 
FName MeshDrawCommandStatsCategory
 

Constructor & Destructor Documentation

◆ FSkinnedMeshSceneProxyDesc() [1/2]

FSkinnedMeshSceneProxyDesc::FSkinnedMeshSceneProxyDesc ( )
default

◆ FSkinnedMeshSceneProxyDesc() [2/2]

FSkinnedMeshSceneProxyDesc::FSkinnedMeshSceneProxyDesc ( const USkinnedMeshComponent *  Component)

Member Function Documentation

◆ CreateMeshObject()

FSkeletalMeshObject * FSkinnedMeshSceneProxyDesc::CreateMeshObject ( const FSkinnedMeshSceneProxyDesc &  Desc)
static

◆ CreateSceneProxy()

FPrimitiveSceneProxy * FSkinnedMeshSceneProxyDesc::CreateSceneProxy ( const FSkinnedMeshSceneProxyDesc &  Desc,
bool  bHideSkin,
int32  MinLODIndex 
)
static

◆ GetBoneIndex()

int32 FSkinnedMeshSceneProxyDesc::GetBoneIndex ( FName  BoneName) const

◆ GetComponentScale()

FVector FSkinnedMeshSceneProxyDesc::GetComponentScale ( ) const
inline

◆ GetDebugDrawColor()

const TOptional< FLinearColor > & FSkinnedMeshSceneProxyDesc::GetDebugDrawColor ( ) const

◆ GetMaterial()

UMaterialInterface * FSkinnedMeshSceneProxyDesc::GetMaterial ( int32  MaterialIndex) const

◆ GetMaterialRelevance() [1/2]

FMaterialRelevance FSkinnedMeshSceneProxyDesc::GetMaterialRelevance ( ERHIFeatureLevel::Type  InFeatureLevel) const

◆ GetMaterialRelevance() [2/2]

FMaterialRelevance FSkinnedMeshSceneProxyDesc::GetMaterialRelevance ( EShaderPlatform  InShaderPlatform) const

◆ GetMaterialSlotsOverlayMaterial()

void FSkinnedMeshSceneProxyDesc::GetMaterialSlotsOverlayMaterial ( TArray< TObjectPtr< UMaterialInterface > > &  OutMaterialSlotsOverlayMaterial) const
inline

◆ GetMaxDistanceFactor()

float FSkinnedMeshSceneProxyDesc::GetMaxDistanceFactor ( ) const
inline

◆ GetMeshDeformerInstance()

UMeshDeformerInstance * FSkinnedMeshSceneProxyDesc::GetMeshDeformerInstance ( ) const

◆ GetMeshDeformerInstanceForLOD()

UMeshDeformerInstance * FSkinnedMeshSceneProxyDesc::GetMeshDeformerInstanceForLOD ( int32  LODIndex) const

◆ GetOverlayMaterial()

UMaterialInterface * FSkinnedMeshSceneProxyDesc::GetOverlayMaterial ( ) const

◆ GetOverlayMaterialMaxDrawDistance()

float FSkinnedMeshSceneProxyDesc::GetOverlayMaterialMaxDrawDistance ( ) const

◆ GetPhysicsAsset()

UPhysicsAsset * FSkinnedMeshSceneProxyDesc::GetPhysicsAsset ( ) const

◆ GetPredictedLODLevel()

int32 FSkinnedMeshSceneProxyDesc::GetPredictedLODLevel ( ) const
inline

◆ GetPreSkinnedLocalBounds()

void FSkinnedMeshSceneProxyDesc::GetPreSkinnedLocalBounds ( FBoxSphereBounds &  OutBounds) const

◆ GetSkinnedAsset()

USkinnedAsset * FSkinnedMeshSceneProxyDesc::GetSkinnedAsset ( ) const

◆ GetUsedMaterials()

void FSkinnedMeshSceneProxyDesc::GetUsedMaterials ( TArray< UMaterialInterface * > &  OutMaterials,
bool  bGetDebugMaterials = false 
) const
overridevirtual

Reimplemented from FPrimitiveSceneProxyDesc.

◆ HasValidNaniteData()

bool FSkinnedMeshSceneProxyDesc::HasValidNaniteData ( ) const

◆ InitializeFrom()

void FSkinnedMeshSceneProxyDesc::InitializeFrom ( const USkinnedMeshComponent *  InComponent)
inline

◆ InitializeFromSkinnedMeshComponent()

void FSkinnedMeshSceneProxyDesc::InitializeFromSkinnedMeshComponent ( const USkinnedMeshComponent *  InComponent)

◆ IsSkinCacheAllowed()

bool FSkinnedMeshSceneProxyDesc::IsSkinCacheAllowed ( int32  LodIdx) const

◆ SetLODInfo()

void FSkinnedMeshSceneProxyDesc::SetLODInfo ( TArrayView< const FSkelMeshComponentLODInfo >  InLODInfo)
inline

◆ ShouldCPUSkin()

bool FSkinnedMeshSceneProxyDesc::ShouldCPUSkin ( ) const
inline

◆ ShouldDrawDebugSkeleton()

bool FSkinnedMeshSceneProxyDesc::ShouldDrawDebugSkeleton ( ) const

◆ ShouldNaniteSkin()

bool FSkinnedMeshSceneProxyDesc::ShouldNaniteSkin ( ) const

Member Data Documentation

◆ bAllowAlwaysVisible

uint8 FSkinnedMeshSceneProxyDesc::bAllowAlwaysVisible

◆ bCanHighlightSelectedSections

uint8 FSkinnedMeshSceneProxyDesc::bCanHighlightSelectedSections

◆ bCastCapsuleDirectShadow

uint8 FSkinnedMeshSceneProxyDesc::bCastCapsuleDirectShadow

◆ bCastCapsuleIndirectShadow

uint8 FSkinnedMeshSceneProxyDesc::bCastCapsuleIndirectShadow

◆ bCPUSkinning

uint8 FSkinnedMeshSceneProxyDesc::bCPUSkinning

◆ bDrawDebugSkeleton

uint8 FSkinnedMeshSceneProxyDesc::bDrawDebugSkeleton

◆ bForceWireframe

uint8 FSkinnedMeshSceneProxyDesc::bForceWireframe

◆ bPerBoneMotionBlur

uint8 FSkinnedMeshSceneProxyDesc::bPerBoneMotionBlur

◆ bRenderStatic

uint8 FSkinnedMeshSceneProxyDesc::bRenderStatic

◆ bSortTriangles

uint32 FSkinnedMeshSceneProxyDesc::bSortTriangles

◆ CapsuleIndirectShadowMinVisibility

float FSkinnedMeshSceneProxyDesc::CapsuleIndirectShadowMinVisibility = 0.0f

◆ ComponentScale

FVector FSkinnedMeshSceneProxyDesc::ComponentScale = FVector::OneVector

◆ DebugDrawColor

TOptional<FLinearColor> FSkinnedMeshSceneProxyDesc::DebugDrawColor

◆ LODInfo

TArrayView<const FSkelMeshComponentLODInfo> FSkinnedMeshSceneProxyDesc::LODInfo

◆ MaterialRelevance

FMaterialRelevance FSkinnedMeshSceneProxyDesc::MaterialRelevance {}

◆ MaterialSlotsOverlayMaterial

TArray<TObjectPtr<UMaterialInterface> > FSkinnedMeshSceneProxyDesc::MaterialSlotsOverlayMaterial

◆ MaxDistanceFactor

float FSkinnedMeshSceneProxyDesc::MaxDistanceFactor = 1.0f

◆ MeshDeformerInstances

const FMeshDeformerInstanceSet* FSkinnedMeshSceneProxyDesc::MeshDeformerInstances = nullptr

◆ MeshObject

FSkeletalMeshObject* FSkinnedMeshSceneProxyDesc::MeshObject = nullptr

◆ NanitePixelProgrammableDistance

float FSkinnedMeshSceneProxyDesc::NanitePixelProgrammableDistance = 0.0f

◆ OverlayMaterial

UMaterialInterface* FSkinnedMeshSceneProxyDesc::OverlayMaterial = nullptr

◆ OverlayMaterialMaxDrawDistance

float FSkinnedMeshSceneProxyDesc::OverlayMaterialMaxDrawDistance = 0.0f

◆ OverrideMaterials

TArrayView<const TObjectPtr<UMaterialInterface> > FSkinnedMeshSceneProxyDesc::OverrideMaterials

◆ PhysicsAsset

UPhysicsAsset* FSkinnedMeshSceneProxyDesc::PhysicsAsset = nullptr

◆ PredictedLODLevel

int32 FSkinnedMeshSceneProxyDesc::PredictedLODLevel = 0

◆ PreviousMeshObject

FSkeletalMeshObject* FSkinnedMeshSceneProxyDesc::PreviousMeshObject = nullptr

◆ SkinCacheUsage

TArrayView<const ESkinCacheUsage> FSkinnedMeshSceneProxyDesc::SkinCacheUsage {}

◆ SkinnedAsset

USkinnedAsset* FSkinnedMeshSceneProxyDesc::SkinnedAsset = nullptr

◆ StreamingDistanceMultiplier

float FSkinnedMeshSceneProxyDesc::StreamingDistanceMultiplier = 1.0f
The documentation for this struct was generated from the following files: