1. Epic GamesDeveloper
  3. FPrimitiveSceneInfo

FPrimitiveSceneInfo

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

API > API/Runtime > API/Runtime/Renderer

Inheritance Hierarchy

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

  Type Name Description
Public variable bool: 1 bNeedsCachedReflectionCaptureUpdate Whether the primitive is newly registered or moved and CachedReflectionCaptureProxy needs to be updated on the next render.
Public variable bool: 1 bShouldRenderInMainPass Set to true for the primitive to be rendered in the main pass to be visible in a view.
Public variable bool: 1 bVisibleInRealTimeSkyCapture Set to true for the primitive to be rendered into the real-time sky light reflection capture.
Public variable const FPlanarReflectionSceneProxy * CachedPlanarReflectionProxy Planar reflection that was closest to this primitive, used for forward reflections.
Public variable const FReflectionCaptureProxy *[MaxCachedReflectionCaptureProxies] CachedReflectionCaptureProxies  
Public variable const FReflectionCaptureProxy * CachedReflectionCaptureProxy Reflection capture proxy that was closest to this primitive, used for the forward shading rendering path.
Public variable HHitProxy * DefaultDynamicHitProxy The hit proxy which is used to represent the primitive's dynamic elements.
Public variable FHitProxyId DefaultDynamicHitProxyId The ID of the hit proxy which is used to represent the primitive's dynamic elements.
Public variable TArray< int32, TInlineAllocator< 1 > > DistanceFieldInstanceIndices Mapping from instance index in this primitive to index in the global distance field object buffers.
Public variable TArray< TRefCountPtr< HHitProxy > > HitProxies The hit proxies used by the primitive.
Public variable const FIndirectLightingCacheAllocation * IndirectLightingCacheAllocation Caches the primitive's indirect lighting cache allocation.
Public variable TUniformBufferRef< FIndirectLightingCacheUniformParameters > IndirectLightingCacheUniformBuffer The uniform buffer holding precomputed lighting parameters for the indirect lighting cache allocation.
Public variable float LastRenderTime Last render time in seconds since level started play.
Public variable FPrimitiveComponentId LightingAttachmentRoot The root attachment component id for use with lighting, if valid.
Public variable FLightPrimitiveInteraction * LightList The list of lights affecting this primitive.
Public variable FPrimitiveComponentId LODParentComponentId The component id of the LOD parent if valid.
Public variable TArray< int32, TInlineAllocator< 1 > > LumenPrimitiveGroupIndices Mapping from instance index in this primitive to index in the LumenPrimitiveGroup array.
Public variable TArray< FNaniteCommandInfo >[ENaniteMeshPass::Num] NaniteCommandInfos  
Public variable TArray< uint32 > NaniteHitProxyIds  
Public variable TArray< FNaniteMaterialSlot >[ENaniteMeshPass::Num] NaniteMaterialSlots  
Public variable TArray< FNaniteRasterBin >[ENaniteMeshPass::Num] NaniteRasterBins  
Public variable TArray< FNaniteShadingBin >[ENaniteMeshPass::Num] NaniteShadingBins  
Public variable int32 NumMobileDynamicLocalLights The number of local lights with dynamic lighting for mobile
Public variable FOctreeElementId2 OctreeId The identifier for the primitive in Scene->PrimitiveOctree.
Public variable 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.
Public variable FPrimitiveComponentId PrimitiveComponentId Id for the component this primitive belongs to.
Public variable FPrimitiveSceneProxy * Proxy The render proxy for the primitive.
Public variable int32 RegistrationSerialNumber Number assigned to this component when it was registered with the world.
Public variable FScene * Scene The scene the primitive is in.
Public variable TArray< class FCachedMeshDrawCommandInfo > StaticMeshCommandInfos The primitive's cached mesh draw commands infos for all static meshes.
Public variable TArray< class FStaticMeshBatch > StaticMeshes The primitive's static meshes.
Public variable TArray< class FStaticMeshBatchRelevance > StaticMeshRelevances The primitive's static mesh relevances.

Constructors

  Type Name Description
Public function  

FPrimitiveSceneInfo ( UPrimitiveComponent* InPrimitive,
FScene* InScene
)

 Initialization constructor.

Destructors

  Type Name Description
Public function   Destructor.

Functions

  Type Name Description
Public function Static void

AddStaticMeshes ( FScene* Scene,
TArrayView< FPrimitiveSceneInfo* > SceneInfos,
bool bCacheMeshDrawCommands
)

 Adds the primitive's static meshes to the scene.
Public function Static void

AddToScene ( FScene* Scene,
TArrayView< FPrimitiveSceneInfo* > SceneInfos
)

 Adds the primitive to the scene.
Public function Static void

AllocateGPUSceneInstances ( FScene* Scene,
const TArrayView< FPrimitiveSceneInfo* >& SceneInfos
)

 Allocate/Free slots for instance data in GPU-Scene
Public function void

ApplyWorldOffset ( FVector InOffset
)

 Shifts primitive position and all relevant data by an arbitrary delta.
Public function void Cache per-primitive reflection captures used for mobile/forward rendering.
Public function void Mark the runtime virtual textures covered by this primitive as dirty.
Public function void  
Public function Const void

GatherLightingAttachmentGroupPrimitives ( TArray< const FPrimitiveSceneInfo*, SceneRenderingAllocator >& OutChildSceneInfos
)

 Builds an array of all primitive scene info's in this primitive's attachment group.
Public function void

GatherLightingAttachmentGroupPrimitives ( TArray< FPrimitiveSceneInfo*, SceneRenderingAllocator >& OutChildSceneInfos
)

 Builds an array of all primitive scene info's in this primitive's attachment group.
Public function Const FBoxSphereBounds Builds a cumulative bounding box of this primitive and all the primitives in the same attachment group.
Public function Const FString Return primitive fullname (for debugging only).
Public function Const int32 Retrieves the index of the primitive in the scene's primitives array.
Public function Const const int32 * Retrieves the address of the primitives index into in the scene's primitives array.
Public function Const int32  
Public function Const int32  
Public function Const int32  
Public function Const int32  
Public function uint32 Size this class uses in bytes
Public function Const const FMeshBatch *

GetMeshBatch ( int8 InLODIndex
)

 Will output the FMeshBatch associated with the specified LODIndex.
Public function Const int32  
Public function Const int32  
Public function Const FString Return primitive Owner actor name (for debugging only).
Public function Const FPersistentPrimitiveIndex Persistent index of the primitive in the range [0, FScene::GetMaxPersistentPrimitiveIndex() ).
Public function Const FPrimitiveVirtualTextureFlags Get the cached runtime virtual texture flags for this primitive.
Public function Const void

GetStaticMeshesLODRange ( int8& OutMinLOD,
int8& OutMaxLOD
)

 Will output the LOD ranges of the static meshes used with this primitive.
Public function Const bool Simple comparison against the invalid values used before/after scene add/remove.
Public function void Adds the primitive to the scene's attachment groups.
Public function void Set LOD Parent primitive information to the scene.
Public function void

MarkGPUStateDirty ( EPrimitiveDirtyState PrimitiveDirtyState
)

 Marks the primitive UB as needing updated and requests a GPU scene update
Public function void  
Public function bool Return true if we need to call LazyUpdateForRendering
Public function Const bool Returns whether the primitive needs to call CacheReflectionCaptures.
Public function void Refreshes a primitive's references to raster bins.
Public function void Nulls out the cached per-primitive reflection captures.
Public function void

RemoveFromScene ( bool bUpdateStaticDrawLists
)

 Removes the primitive from the scene.
Public function void Removes the primitive's static meshes from the scene.
Public function bool

RequestGPUSceneUpdate ( EPrimitiveDirtyState PrimitiveDirtyState
)

 Adds a request to update GPU scene representation.
Public function void Sets a flag to update the primitive's static meshes before it is next rendered.
Public function bool Sets a flag to update the primitive's uniform buffer before it is next rendered.
Public function void

SetCacheShadowAsStatic ( bool bStatic
)

  
Public function Const bool  
Public function void Removes the primitive from the scene's attachment groups.
Public function void Clear LOD parent primitive information from the scene.
Public function Const void

UpdateComponentLastRenderTime ( float CurrentWorldTime,
bool bUpdateLastRenderTimeOnScreen
)

 Helper function for writing out to the last render times to the game thread
Public function void  
Public function void Update the cached runtime virtual texture flags for this primitive.
Public function int32 Updates static lighting uniform buffer, returns the number of entries needed for GPUScene
Public function Static void

UpdateStaticMeshes ( FScene* Scene,
TArrayView< FPrimitiveSceneInfo* > SceneInfos,
EUpdateStaticMeshFlags UpdateFlags,
bool bReAddToDrawLists
)

 Updates the primitive's static meshes in the scene.

Typedefs

Name Description
FPrimitiveSceneInfoEvent  

Constants

Name Description
MaxCachedReflectionCaptureProxies  
OnGPUSceneInstancesAllocated  
OnGPUSceneInstancesFreed  

Deprecated Functions

  Type Name Description
Public function void BeginDeferredUpdateStaticMeshes has been deprecated. Use RequestStaticMeshUpdate instead.
Public function void BeginDeferredUpdateStaticMeshesWithoutVisibilityCheck has been deprecated. Use RequestStaticMeshUpdate instead.
Public function void ConditionalUpdateUniformBuffer has been deprecated.
Public function Const bool NeedsUniformBufferUpdate has been deprecated.
Public function bool NeedsUpdateStaticMeshes has been deprecated.
Public function Static void

ReallocateGPUSceneInstances ( FScene* Scene,
const TArrayView< FPrimitiveSceneInfo* >& SceneInfos
)

 ReallocateGPUSceneInstances has been deprecated.
Public function void

SetNeedsUniformBufferUpdate ( bool bInNeedsUniformBufferUpdate
)

 SetNeedsUniformBufferUpdate is deprecated. Use RequestUniformBufferUpdate instead.
Public function void UpdateUniformBuffer has been deprecated.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page