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 > Renderer > FPrimitiveSceneInfo

Light Theme

Dark Theme

FPrimitiveSceneInfo

The renderer's internal state for a single [UPrimitiveComponent](API\Runtime\Engine\Components\UPrimitiveComponent).

Windows

MacOS

Linux

Inheritance Hierarchy

FDeferredCleanupInterface

FPrimitiveSceneInfo

References

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

Syntax

class FPrimitiveSceneInfo : public FDeferredCleanupInterface

Remarks

The renderer's internal state for a single UPrimitiveComponent. This has a one to one mapping with FPrimitiveSceneProxy, which is in the engine module.

Variables

	Name	Description
uint32: 1	bNeedsCachedReflectionCaptureUpdate	Whether the primitive is newly registered or moved and CachedReflectionCaptureProxy needs to be updated on the next render.
bool: 1	bShouldRenderInMainPass	Set to true for the primitive to be rendered in the main pass to be visible in a view.
bool: 1	bVisibleInRealTimeSkyCapture	Set to true for the primitive to be rendered into the real-time sky light reflection capture.
const FPlanarRe...	CachedPlanarReflectionProxy	Planar reflection that was closest to this primitive, used for forward reflections.
const FReflecti...	CachedReflectionCaptureProxies
const FReflecti...	CachedReflectionCaptureProxy	Reflection capture proxy that was closest to this primitive, used for the forward shading rendering path.
HHitProxy *	DefaultDynamicHitProxy	The hit proxy which is used to represent the primitive's dynamic elements.
FHitProxyId	DefaultDynamicHitProxyId	The ID of the hit proxy which is used to represent the primitive's dynamic elements.
TArray< int32, ...	DistanceFieldInstanceIndices	Mapping from instance index in this primitive to index in the global distance field object buffers.
TArray< TRefCou...	HitProxies	The hit proxies used by the primitive.
const FIndirect...	IndirectLightingCacheAllocation	Caches the primitive's indirect lighting cache allocation.
TUniformBufferR...	IndirectLightingCacheUniformBuffer	The uniform buffer holding precomputed lighting parameters for the indirect lighting cache allocation.
float	LastRenderTime	Last render time in seconds since level started play.
FPrimitiveCompo...	LightingAttachmentRoot	The root attachment component id for use with lighting, if valid.
FLightPrimitive...	LightList	The list of lights affecting this primitive.
FPrimitiveCompo...	LODParentComponentId	The component id of the LOD parent if valid.
int32	NumMobileMovablePointLights	The number of movable point lights for mobile
FOctreeElementI...	OctreeId	The identifier for the primitive in Scene->PrimitiveOctree.
float *	OwnerLastRenderTime	Pointer to the last render time variable on the primitive's owning actor (if owned), which is written to by the RT and read by the GT.
FPrimitiveCompo...	PrimitiveComponentId	Id for the component this primitive belongs to.
FPrimitiveScene...	Proxy	The render proxy for the primitive.
FScene *	Scene	The scene the primitive is in.
TArray< class F...	StaticMeshCommandInfos	The primitive's cached mesh draw commands infos for all static meshes.
TArray< class F...	StaticMeshes	The primitive's static meshes.
TArray< class F...	StaticMeshRelevances	The primitive's static mesh relevances.

Constructors

	Name	Description
	FPrimitiveSceneInfo ( UPrimitiveComponent* InPrimiti..., FScene* InScene )	Initialization constructor.

Destructors

	Name	Description
	~FPrimitiveSceneInfo()	Destructor.

Functions

	Name	Description
void	AddStaticMeshes ( FRHICommandListImmediate& RHICmdLi..., FScene* Scene, const TArrayView< FPrimitiveSceneIn..., bool bUpdateStaticDrawLists )	Adds the primitive's static meshes to the scene.
void	AddToScene ( FRHICommandListImmediate& RHICmdLi..., FScene* Scene, const TArrayView< FPrimitiveSceneIn..., bool bUpdateStaticDrawLists, bool bAddToStaticDrawLists, bool bAsyncCreateLPIs )	Adds the primitive to the scene.
void	ApplyWorldOffset ( FVector InOffset )	Shifts primitive position and all relevant data by an arbitrary delta.
void	BeginDeferredUpdateStaticMeshes()	Sets a flag to update the primitive's static meshes before it is next rendered.
void	BeginDeferredUpdateStaticMeshesWithoutVisibilityCheck()	Will update static meshes during next InitViews, even if it's not visible.
void	CacheReflectionCaptures()	Cache per-primitive reflection captures used for mobile/forward rendering.
void	ConditionalUpdateUniformBuffer ( FRHICommandListImmediate& RHICmdLi... )	Updates the primitive's uniform buffer.
void	FlushRuntimeVirtualTexture()	Mark the runtime virtual textures covered by this primitive as dirty.
void	GatherLightingAttachmentGroupPrimitives ( TArray< FPrimitiveSceneInfo*, ... )	Builds an array of all primitive scene info's in this primitive's attachment group.
void	GatherLightingAttachmentGroupPrimitives ( TArray< const FPrimitiveSceneInfo&... )	Builds an array of all primitive scene info's in this primitive's attachment group.
FBoxSphereBo...	GetAttachmentGroupBounds()	Builds a cumulative bounding box of this primitive and all the primitives in the same attachment group.
int32	GetIndex()	Retrieves the index of the primitive in the scene's primitives array.
const int32 ...	GetIndexAddress()	Retrieves the address of the primitives index into in the scene's primitives array.
int32	GetLightmapDataOffset()
uint32	GetMemoryFootprint()	Size this class uses in bytes
const FMeshB...	GetMeshBatch ( int8 InLODIndex )	Will output the FMeshBatch associated with the specified LODIndex.
int32	GetNumLightmapDataEntries()
FPrimitiveVi...	GetRuntimeVirtualTextureFlags()	Get the cached runtime virtual texture flags for this primitive.
void	GetStaticMeshesLODRange ( int8& OutMinLOD, int8& OutMaxLOD )	Will output the LOD ranges of the static meshes used with this primitive.
bool	IsIndexValid()	Simple comparison against the invalid values used before/after scene add/remove.
void	LinkAttachmentGroup()	Adds the primitive to the scene's attachment groups.
void	LinkLODParentComponent()	Set LOD Parent primitive information to the scene.
void	MarkIndirectLightingCacheBufferDirty()
bool	NeedsIndirectLightingCacheBufferUpdate()	Return true if we need to call LazyUpdateForRendering
bool	NeedsReflectionCaptureUpdate()	Returns whether the primitive needs to call CacheReflectionCaptures.
bool	NeedsUniformBufferUpdate()	Return true if we need to call LazyUpdateForRendering
bool	NeedsUpdateStaticMeshes()	Return true if we need to call ConditionalUpdateStaticMeshes
void	RemoveCachedReflectionCaptures()	Nulls out the cached per-primitive reflection captures.
void	RemoveFromScene ( bool bUpdateStaticDrawLists )	Removes the primitive from the scene.
void	RemoveStaticMeshes()	Removes the primitive's static meshes from the scene.
void	SetNeedsUniformBufferUpdate ( bool bInNeedsUniformBufferUpdate )
void	UnlinkAttachmentGroup()	Removes the primitive from the scene's attachment groups.
void	UnlinkLODParentComponent()	Clear LOD parent primitive information from the scene.
void	UpdateComponentLastRenderTime ( float CurrentWorldTime, bool bUpdateLastRenderTimeOnScreen )	Helper function for writing out to the last render times to the game thread
void	UpdateIndirectLightingCacheBuffer()
void	UpdateRuntimeVirtualTextureFlags()	Update the cached runtime virtual texture flags for this primitive.
int32	UpdateStaticLightingBuffer()	Updates static lighting uniform buffer, returns the number of entries needed for GPUScene
void	UpdateStaticMeshes ( FRHICommandListImmediate& RHICmdLi..., FScene* Scene, const TArrayView< FPrimitiveSceneIn..., bool bReAddToDrawLists )	Updates the primitive's static meshes in the scene.
void	UpdateUniformBuffer ( FRHICommandListImmediate& RHICmdLi... )	Updates the primitive's uniform buffer.

Constants

Name	Description
MaxCachedReflectionCaptureProxies

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

Take our survey

Dismiss