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 > FStaticMeshSceneProxy

Light Theme

Dark Theme

FStaticMeshSceneProxy

A static mesh component scene proxy.

Windows

MacOS

Linux

Inheritance Hierarchy

FPrimitiveSceneProxy

FStaticMeshSceneProxy

	FInstancedStaticMeshSceneProxy
	FLandscapeMeshProxySceneProxy

References

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

Syntax

class FStaticMeshSceneProxy : public FPrimitiveSceneProxy

Remarks

A static mesh component scene proxy.

Variables

	Name	Description
uint32: 1	bCastShadow
bool	bPerSectionSelection	Whether selection should be per section or per entire proxy.
uint32: 1	bReverseCulling	This primitive has culling reversed
int32	ClampedMinLOD	Minimum LOD index to use. Clamped to valid range [0, NumLODs - 1].
const FDistance...	DistanceFieldData
int32	ForcedLodModel	The forcedLOD set in the static mesh editor, copied from the mesh component
uint8	HierarchicalLODIndex	Hierarchical LOD Index used for rendering
TArray< FLODInf...	LODs
int32	MaterialIndexPreview	Index of the material to preview. If set to INDEX_NONE, all section will be rendered
FMaterialReleva...	MaterialRelevance	The view relevance for all the static mesh's materials.
TArray< uint32 ...	MaterialStreamingRelativeBoxes	Material bounds used for texture streaming.
FStaticMeshOccl...	OccluderData
FStaticMeshRend...	RenderData
int32	SectionIndexPreview	Index of the section to preview. If set to INDEX_NONE, all section will be rendered
float	StreamingDistanceMultiplier	The component streaming distance multiplier
float	StreamingTransformScale	The cached GetTextureStreamingTransformScale

Constructors

	Name	Description
	FStaticMeshSceneProxy ( UStaticMeshComponent* Componen..., bool bForceLODsShareStaticLighting )	Initialization constructor.

Destructors

	Name	Description
	~FStaticMeshSceneProxy()

Functions

	Name	Description
uint32	GetAllocatedSize()
bool	GetCollisionMeshElement ( int32 LODIndex, int32 BatchIndex, int32 ElementIndex, uint8 InDepthPriorityGroup, const FMaterialRenderProxy* Re..., FMeshBatch& OutMeshBatch )	Sets up a collision FMeshBatch for a specific LOD and element.
uint8	GetCurrentFirstLODIdx_Internal()	Only call on render thread timeline
FLODMask	GetLODMask ( const FSceneView* View )	Returns the LOD mask for a view, this is like the ordinary LOD but can return two values for dither fading
bool	GetMaterialTextureScales ( int32 LODIndex, int32 SectionIndex, const FMaterialRenderProxy* Ma..., FVector4* OneOverScales, FIntVector4* UVChannelIndices )
bool	GetMeshElement ( int32 LODIndex, int32 BatchIndex, int32 ElementIndex, uint8 InDepthPriorityGroup, bool bUseSelectionOutline, bool bAllowPreCulledIndices, FMeshBatch& OutMeshBatch )	Sets up a FMeshBatch for a specific LOD and element.
int32	GetNumMeshBatches()	Gets the number of mesh batches required to represent the proxy, aside from section needs.
float	GetScreenSize ( int32 LODIndex )	Returns the display factor for the given LOD level
bool	GetShadowMeshElement ( int32 LODIndex, int32 BatchIndex, uint8 InDepthPriorityGroup, FMeshBatch& OutMeshBatch, bool bDitheredLODTransition )	Sets up a shadow FMeshBatch for a specific LOD.
bool	GetWireframeMeshElement ( int32 LODIndex, int32 BatchIndex, const FMaterialRenderProxy* Wi..., uint8 InDepthPriorityGroup, bool bAllowPreCulledIndices, FMeshBatch& OutMeshBatch )	Sets up a wireframe FMeshBatch for a specific LOD.
bool	IsCollisionView ( const FEngineShowFlags& EngineShow..., bool& bDrawSimpleCollision, bool& bDrawComplexCollision )
bool	IsReversedCullingNeeded ( bool bUseReversedIndices )	Returns whether this mesh needs reverse culling when using reversed indices.
void	SetEvaluateWorldPositionOffsetInRayTracing ( bool NewValue )
uint32	SetMeshElementGeometrySource ( int32 LODIndex, int32 ElementIndex, bool bWireframe, bool bRequiresAdjacencyInformation, bool bUseInversedIndices, bool bAllowPreCulledIndices, const FVertexFactory* VertexFa..., FMeshBatch& OutMeshElement )	Configures mesh batch vertex / index state. Returns the number of primitives used in the element.
void	SetMeshElementScreenSize ( int32 LODIndex, bool bDitheredLODTransition, FMeshBatch& OutMeshBatch )	Sets the screen size on a mesh element.

Overridden from FPrimitiveSceneProxy

	Name	Description
bool	CanBeOccluded()
int32	CollectOccluderElements ( FOccluderElementsCollector& Collec... )	Collects occluder geometry for software occlusion culling
HHitProxy &#...	CreateHitProxies ( UPrimitiveComponent* Component, TArray< TRefCountPtr< HHitProxy > >... )	Creates the hit proxies are used when DrawDynamicElements is called. Called in the game thread.
void	CreateRenderThreadResources()	Called when the rendering thread adds the proxy to the scene.
void	DestroyRenderThreadResources()	Called when the rendering thread removes the proxy from the scene.
void	DrawStaticElements ( FStaticPrimitiveDrawInterface*... )	Draws the primitive's static elements.
uint8	GetCurrentFirstLODIdx_RenderThread()
void	GetDistancefieldAtlasData ( FBox& LocalVolumeBounds, FVector2D& OutDistanceMinMax, FIntVector& OutBlockMin, FIntVector& OutBlockSize, bool& bOutBuiltAsIfTwoSided, bool& bMeshWasPlane, float& SelfShadowBias, TArray< FMatrix >& ObjectLocalToWo..., bool& bOutThrottled )
void	GetDistanceFieldInstanceInfo ( int32& NumInstances, float& BoundsSurfaceArea )
void	GetDynamicMeshElements ( const TArray< const FSceneView*..., const FSceneViewFamily& ViewFamily, uint32 VisibilityMap, FMeshElementCollector& Collector )	Gathers the primitive's dynamic mesh elements.
void	GetLCIs ( FLCIArray& LCIs )
int32	GetLightMapResolution()	Get the lightmap resolution for this primitive. Used in VMI_LightmapDensity.
void	GetLightRelevance ( const FLightSceneProxy* LightS..., bool& bDynamic, bool& bRelevant, bool& bLightMapped, bool& bShadowMapped )	Determines the relevance of this primitive's elements to the given light.
int32	GetLOD ( const FSceneView* View )	Returns the LOD that the primitive will render at for this view.
uint32	GetMemoryFootprint()	Every derived class should override these functions
void	GetMeshDescription ( int32 LODIndex, TArray< FMeshBatch >& OutMeshEleme... )	Gathers a description of the mesh elements to be rendered for the given LOD index, without consideration for views.
bool	GetMeshUVDensities ( int32 LODIndex, int32 SectionIndex, FVector4& WorldUVDensities )	Get mesh UV density for a LOD-section.
bool	GetPrimitiveDistance ( int32 LODIndex, int32 SectionIndex, const FVector& ViewOrigin, float& PrimitiveDistance )	Get primitive distance to view origin for a given LOD-section.
SIZE_T	GetTypeHash()	Return a type (or subtype) specific hash for sorting purposes
FPrimitiveVi...	GetViewRelevance ( const FSceneView* View )	Determines the relevance of this primitive's elements to the given view.
bool	HasDistanceFieldRepresentation()
bool	HasDynamicIndirectShadowCasterRepresentation()
bool	IsUsingDistanceCullFade()

Classes

	Name	Description
	FLODInfo	Information used by the proxy about a single LOD of the mesh.

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

Take our survey

Dismiss