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

#include <StaticMeshSceneProxyDesc.h>

+ Inheritance diagram for FStaticMeshSceneProxyDesc:

Public Member Functions

ENGINE_API FStaticMeshSceneProxyDesc ()
 
ENGINE_API FStaticMeshSceneProxyDesc (const UStaticMeshComponent *)
 
ENGINE_API ~FStaticMeshSceneProxyDesc ()
 
ENGINE_API void InitializeFromStaticMeshComponent (const UStaticMeshComponent *)
 
bool IsReverseCulling () const
 
bool IsDisallowNanite () const
 
bool IsForceDisableNanite () const
 
bool IsForceNaniteForMasked () const
 
int32 GetForcedLodModel () const
 
bool IsDisplayNaniteFallbackMesh () const
 
UStaticMesh * GetStaticMesh () const
 
UObject * GetLODParentPrimitive () const
 
const Nanite::FResources * GetNaniteResources () const
 
UMaterialInterface * GetOverlayMaterial () const
 
float GetOverlayMaterialMaxDrawDistance () const
 
int32 GetStaticLightMapResolution () const
 
UObject * GetObjectForPropertyColoration () const
 
FColor GetWireframeColor () const
 
virtual ENGINE_API void GetUsedMaterials (TArray< UMaterialInterface * > &OutMaterials, bool bGetDebugMaterials=false) const override
 
ENGINE_API UMaterialInterface * GetMaterial (int32 MaterialIndex, bool bDoingNaniteMaterialAudit=false, bool bIgnoreNaniteOverrideMaterials=false) const
 
ENGINE_API int32 GetNumMaterials () const
 
bool ShouldCreateMaterialCacheProxy () const
 
ENGINE_API const UStaticMeshComponent * GetUStaticMeshComponent () const
 
ENGINE_API void GetMaterialSlotsOverlayMaterial (TArray< TObjectPtr< UMaterialInterface > > &OutMaterialSlotsOverlayMaterial) const
 
ENGINE_API void SetMaterialRelevance (const FMaterialRelevance &InRelevance)
 
ENGINE_API FMaterialRelevance GetMaterialRelevance (EShaderPlatform ShaderPlatform) const
 
ENGINE_API FMaterialRelevance GetMaterialRelevance (ERHIFeatureLevel::Type InFeatureLevel) const
 
FTextureResource * GetMeshPaintTextureResource () const
 
ENGINE_API UBodySetup * GetBodySetup () const
 
ENGINE_API bool HasValidNaniteData () const
 
ENGINE_API bool ShouldCreateNaniteProxy (Nanite::FMaterialAudit *OutNaniteMaterials=nullptr) const
 
ENGINE_API bool UseNaniteOverrideMaterials (bool bDoingMaterialAudit) const
 
ENGINE_API UMaterialInterface * GetNaniteAuditMaterial (int32 MaterialIndex) const
 
ENGINE_API void SetCollisionResponseToChannels (const FCollisionResponseContainer &InContainer)
 
ENGINE_API const FCollisionResponseContainer & GetCollisionResponseToChannels () const
 
- 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
 

Public Attributes

TArrayView< TObjectPtr< UMaterialInterface > > OverrideMaterials
 
TArray< TObjectPtr< UMaterialInterface > > MaterialSlotsOverlayMaterial
 
TArray< UMaterialCacheVirtualTexture * > MaterialCacheTextures
 
TArrayView< FStaticMeshComponentLODInfo > LODData
 
UStaticMesh * StaticMesh = nullptr
 
UBodySetup * BodySetup = nullptr
 
UObject * LODParentPrimitive = nullptr
 
UTexture * MeshPaintTexture = nullptr
 
const Nanite::FResources * NaniteResources = nullptr
 
TObjectPtr< UMaterialInterface > OverlayMaterial
 
FMaterialRelevance MaterialRelevance
 
float OverlayMaterialMaxDrawDistance = 0.0f
 
float NanitePixelProgrammableDistance = 0.0f
 
float DistanceFieldSelfShadowBias = 0
 
float DistanceFieldIndirectShadowMinVisibility = 0.1f
 
int32 ForcedLodModel = 0
 
int32 MinLOD = 0
 
int32 WorldPositionOffsetDisableDistance = 0
 
int32 StaticLightMapResolution = 0
 
int32 MeshPaintTextureCoordinateIndex = 0
 
int32 MaterialCacheTextureCoordinateIndex = 0
 
FColor WireframeColor = FColor(0, 255, 255, 255)
 
uint32 bReverseCulling: 1 = false
 
uint32 bEvaluateWorldPositionOffset: 1
 
uint32 bOverrideMinLOD: 1
 
uint32 bCastDistanceFieldIndirectShadow: 1
 
uint32 bOverrideDistanceFieldSelfShadowBias: 1
 
uint32 bEvaluateWorldPositionOffsetInRayTracing: 1
 
uint32 bSortTriangles: 1
 
uint32 bDisplayNaniteFallbackMesh: 1
 
uint32 bDisallowNanite: 1
 
uint32 bForceDisableNanite: 1
 
uint32 bForceNaniteForMasked: 1
 
uint32 bUseProvidedMaterialRelevance: 1
 
uint32 bUseProvidedCollisionResponseContainer: 1
 
TOptional< FCollisionResponseContainer > CollisionResponseContainer
 
ELightmapType LightmapType = ELightmapType::Default
 
- 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

◆ FStaticMeshSceneProxyDesc() [1/2]

FStaticMeshSceneProxyDesc::FStaticMeshSceneProxyDesc ( )

◆ FStaticMeshSceneProxyDesc() [2/2]

FStaticMeshSceneProxyDesc::FStaticMeshSceneProxyDesc ( const UStaticMeshComponent *  InComponent)

◆ ~FStaticMeshSceneProxyDesc()

FStaticMeshSceneProxyDesc::~FStaticMeshSceneProxyDesc ( )
default

Member Function Documentation

◆ GetBodySetup()

UBodySetup * FStaticMeshSceneProxyDesc::GetBodySetup ( ) const

◆ GetCollisionResponseToChannels()

const FCollisionResponseContainer & FStaticMeshSceneProxyDesc::GetCollisionResponseToChannels ( ) const

◆ GetForcedLodModel()

int32 FStaticMeshSceneProxyDesc::GetForcedLodModel ( ) const
inline

◆ GetLODParentPrimitive()

UObject * FStaticMeshSceneProxyDesc::GetLODParentPrimitive ( ) const
inline

◆ GetMaterial()

UMaterialInterface * FStaticMeshSceneProxyDesc::GetMaterial ( int32  MaterialIndex,
bool  bDoingNaniteMaterialAudit = false,
bool  bIgnoreNaniteOverrideMaterials = false 
) const

◆ GetMaterialRelevance() [1/2]

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

◆ GetMaterialRelevance() [2/2]

FMaterialRelevance FStaticMeshSceneProxyDesc::GetMaterialRelevance ( EShaderPlatform  ShaderPlatform) const

◆ GetMaterialSlotsOverlayMaterial()

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

◆ GetMeshPaintTextureResource()

FTextureResource * FStaticMeshSceneProxyDesc::GetMeshPaintTextureResource ( ) const

◆ GetNaniteAuditMaterial()

UMaterialInterface * FStaticMeshSceneProxyDesc::GetNaniteAuditMaterial ( int32  MaterialIndex) const

◆ GetNaniteResources()

const Nanite::FResources * FStaticMeshSceneProxyDesc::GetNaniteResources ( ) const
inline

◆ GetNumMaterials()

int32 FStaticMeshSceneProxyDesc::GetNumMaterials ( ) const

◆ GetObjectForPropertyColoration()

UObject * FStaticMeshSceneProxyDesc::GetObjectForPropertyColoration ( ) const
inline

◆ GetOverlayMaterial()

UMaterialInterface * FStaticMeshSceneProxyDesc::GetOverlayMaterial ( ) const
inline

◆ GetOverlayMaterialMaxDrawDistance()

float FStaticMeshSceneProxyDesc::GetOverlayMaterialMaxDrawDistance ( ) const
inline

◆ GetStaticLightMapResolution()

int32 FStaticMeshSceneProxyDesc::GetStaticLightMapResolution ( ) const
inline

◆ GetStaticMesh()

UStaticMesh * FStaticMeshSceneProxyDesc::GetStaticMesh ( ) const
inline

◆ GetUsedMaterials()

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

Reimplemented from FPrimitiveSceneProxyDesc.

Reimplemented in ViewAdjustedStaticMeshGizmoComponentLocals::FViewAdjustedStaticMeshSceneProxyDesc.

◆ GetUStaticMeshComponent()

const UStaticMeshComponent * FStaticMeshSceneProxyDesc::GetUStaticMeshComponent ( ) const

◆ GetWireframeColor()

FColor FStaticMeshSceneProxyDesc::GetWireframeColor ( ) const
inline

◆ HasValidNaniteData()

bool FStaticMeshSceneProxyDesc::HasValidNaniteData ( ) const

◆ InitializeFromStaticMeshComponent()

void FStaticMeshSceneProxyDesc::InitializeFromStaticMeshComponent ( const UStaticMeshComponent *  InComponent)

◆ IsDisallowNanite()

bool FStaticMeshSceneProxyDesc::IsDisallowNanite ( ) const
inline

◆ IsDisplayNaniteFallbackMesh()

bool FStaticMeshSceneProxyDesc::IsDisplayNaniteFallbackMesh ( ) const
inline

◆ IsForceDisableNanite()

bool FStaticMeshSceneProxyDesc::IsForceDisableNanite ( ) const
inline

◆ IsForceNaniteForMasked()

bool FStaticMeshSceneProxyDesc::IsForceNaniteForMasked ( ) const
inline

◆ IsReverseCulling()

bool FStaticMeshSceneProxyDesc::IsReverseCulling ( ) const
inline

◆ SetCollisionResponseToChannels()

void FStaticMeshSceneProxyDesc::SetCollisionResponseToChannels ( const FCollisionResponseContainer &  InContainer)

◆ SetMaterialRelevance()

void FStaticMeshSceneProxyDesc::SetMaterialRelevance ( const FMaterialRelevance &  InRelevance)

◆ ShouldCreateMaterialCacheProxy()

bool FStaticMeshSceneProxyDesc::ShouldCreateMaterialCacheProxy ( ) const

◆ ShouldCreateNaniteProxy()

bool FStaticMeshSceneProxyDesc::ShouldCreateNaniteProxy ( Nanite::FMaterialAudit *  OutNaniteMaterials = nullptr) const

◆ UseNaniteOverrideMaterials()

bool FStaticMeshSceneProxyDesc::UseNaniteOverrideMaterials ( bool  bDoingMaterialAudit) const

Member Data Documentation

◆ bCastDistanceFieldIndirectShadow

uint32 FStaticMeshSceneProxyDesc::bCastDistanceFieldIndirectShadow

◆ bDisallowNanite

uint32 FStaticMeshSceneProxyDesc::bDisallowNanite

◆ bDisplayNaniteFallbackMesh

uint32 FStaticMeshSceneProxyDesc::bDisplayNaniteFallbackMesh

◆ bEvaluateWorldPositionOffset

uint32 FStaticMeshSceneProxyDesc::bEvaluateWorldPositionOffset

◆ bEvaluateWorldPositionOffsetInRayTracing

uint32 FStaticMeshSceneProxyDesc::bEvaluateWorldPositionOffsetInRayTracing

◆ bForceDisableNanite

uint32 FStaticMeshSceneProxyDesc::bForceDisableNanite

◆ bForceNaniteForMasked

uint32 FStaticMeshSceneProxyDesc::bForceNaniteForMasked

◆ BodySetup

UBodySetup* FStaticMeshSceneProxyDesc::BodySetup = nullptr

◆ bOverrideDistanceFieldSelfShadowBias

uint32 FStaticMeshSceneProxyDesc::bOverrideDistanceFieldSelfShadowBias

◆ bOverrideMinLOD

uint32 FStaticMeshSceneProxyDesc::bOverrideMinLOD

◆ bReverseCulling

uint32 FStaticMeshSceneProxyDesc::bReverseCulling

◆ bSortTriangles

uint32 FStaticMeshSceneProxyDesc::bSortTriangles

◆ bUseProvidedCollisionResponseContainer

uint32 FStaticMeshSceneProxyDesc::bUseProvidedCollisionResponseContainer

◆ bUseProvidedMaterialRelevance

uint32 FStaticMeshSceneProxyDesc::bUseProvidedMaterialRelevance

◆ CollisionResponseContainer

TOptional<FCollisionResponseContainer> FStaticMeshSceneProxyDesc::CollisionResponseContainer

◆ DistanceFieldIndirectShadowMinVisibility

float FStaticMeshSceneProxyDesc::DistanceFieldIndirectShadowMinVisibility = 0.1f

◆ DistanceFieldSelfShadowBias

float FStaticMeshSceneProxyDesc::DistanceFieldSelfShadowBias = 0

◆ ForcedLodModel

int32 FStaticMeshSceneProxyDesc::ForcedLodModel = 0

◆ LightmapType

ELightmapType FStaticMeshSceneProxyDesc::LightmapType = ELightmapType::Default

◆ LODData

TArrayView<FStaticMeshComponentLODInfo> FStaticMeshSceneProxyDesc::LODData

◆ LODParentPrimitive

UObject* FStaticMeshSceneProxyDesc::LODParentPrimitive = nullptr

◆ MaterialCacheTextureCoordinateIndex

int32 FStaticMeshSceneProxyDesc::MaterialCacheTextureCoordinateIndex = 0

◆ MaterialCacheTextures

TArray<UMaterialCacheVirtualTexture*> FStaticMeshSceneProxyDesc::MaterialCacheTextures

◆ MaterialRelevance

FMaterialRelevance FStaticMeshSceneProxyDesc::MaterialRelevance

◆ MaterialSlotsOverlayMaterial

TArray<TObjectPtr<UMaterialInterface> > FStaticMeshSceneProxyDesc::MaterialSlotsOverlayMaterial

◆ MeshPaintTexture

UTexture* FStaticMeshSceneProxyDesc::MeshPaintTexture = nullptr

◆ MeshPaintTextureCoordinateIndex

int32 FStaticMeshSceneProxyDesc::MeshPaintTextureCoordinateIndex = 0

◆ MinLOD

int32 FStaticMeshSceneProxyDesc::MinLOD = 0

◆ NanitePixelProgrammableDistance

float FStaticMeshSceneProxyDesc::NanitePixelProgrammableDistance = 0.0f

◆ NaniteResources

const Nanite::FResources* FStaticMeshSceneProxyDesc::NaniteResources = nullptr

◆ OverlayMaterial

TObjectPtr<UMaterialInterface> FStaticMeshSceneProxyDesc::OverlayMaterial

◆ OverlayMaterialMaxDrawDistance

float FStaticMeshSceneProxyDesc::OverlayMaterialMaxDrawDistance = 0.0f

◆ OverrideMaterials

TArrayView<TObjectPtr<UMaterialInterface> > FStaticMeshSceneProxyDesc::OverrideMaterials

◆ StaticLightMapResolution

int32 FStaticMeshSceneProxyDesc::StaticLightMapResolution = 0

◆ StaticMesh

UStaticMesh* FStaticMeshSceneProxyDesc::StaticMesh = nullptr

◆ WireframeColor

FColor FStaticMeshSceneProxyDesc::WireframeColor = FColor(0, 255, 255, 255)

◆ WorldPositionOffsetDisableDistance

int32 FStaticMeshSceneProxyDesc::WorldPositionOffsetDisableDistance = 0
The documentation for this struct was generated from the following files: