1. Epic GamesDeveloper
  3. FPrimitiveSceneProxy

FPrimitiveSceneProxy

Encapsulates the data which is mirrored to render a [UPrimitiveComponent](API\Runtime\Engine\Components\UPrimitiveComponent) parallel to the game thread.

API > API/Runtime > API/Runtime/Engine

Inheritance Hierarchy

References

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

Syntax

class FPrimitiveSceneProxy

Remarks

Encapsulates the data which is mirrored to render a UPrimitiveComponent parallel to the game thread. This is intended to be subclassed to support different primitive types.

Variables

  Type Name Description
Protected variable uint8: 1 bAffectDistanceFieldLighting  
Protected variable uint8: 1 bAffectDynamicIndirectLighting True if the primitive influences dynamic indirect lighting.
Protected variable uint8: 1 bAffectIndirectLightingWhileHidden True if the primitive should affect indirect lighting even when hidden.
Protected variable uint8: 1 bAllowApproximateOcclusion If this is True, this primitive doesn't need exact occlusion info.
Protected variable uint8: 1 bAlwaysHasVelocity Whether the primitive should always be considered to have velocities, even if it hasn't moved.
Protected variable uint8: 1 bAnyMaterialAlwaysEvaluatesWorldPositionOffset Whether the primitive has any materials that must ALWAYS evaluate World Position Offset.
Protected variable uint8: 1 bAnyMaterialHasPixelAnimation Whether the primitive has any materials that must ALWAYS evaluate World Position Offset.
Protected variable uint8: 1 bAnyMaterialHasWorldPositionOffset Whether the primitive has any materials with World Position Offset.
Protected variable uint8: 1 bCanSkipRedundantTransformUpdates Whether this component can skip redundant transform updates where applicable.
Protected variable uint8: 1 bCastCapsuleDirectShadow Whether the primitive should use capsules for direct shadowing, if present. Forces inset shadows.
Protected variable uint8: 1 bCastCinematicShadow Whether this component should create a per-object shadow that gives higher effective shadow resolution.
Protected variable uint8: 1 bCastContactShadow Whether the object should cast a contact shadow
Protected variable uint8: 1 bCastDeepShadow Whether the object should cast a deep shadow
Protected variable uint8: 1 bCastDynamicShadow True if the primitive casts dynamic shadows.
Protected variable uint8: 1 bCastFarShadow When enabled, the component will be rendering into the distant shadow cascades (only for directional lights).
Protected variable uint8: 1 bCastHiddenShadow True if the primitive casts shadows even when hidden.
Protected variable uint8: 1 bCastInsetShadow Whether this component should create a per-object shadow that gives higher effective shadow resolution.
Protected variable uint8: 1 bCastsDynamicIndirectShadow Whether the primitive should use an inset indirect shadow from capsules or mesh distance fields.
Protected variable uint8: 1 bCastShadowAsTwoSided Whether this primitive should cast dynamic shadows as if it were a two sided material.
Protected variable uint8: 1 bCastStaticShadow True if the primitive casts static shadows.
Protected variable uint8: 1 bCastVolumetricTranslucentShadow Whether the object should cast a volumetric translucent shadow.
Protected variable uint8: 1 bDoesMeshBatchesUseSceneInstanceCount Set to true to inform scene update that the MDCs produced may use the (GPU)Scene instance count, and thus don't require recaching if the instance count changed.
Protected variable uint8: 1 bEmissiveLightSource Whether the primitive will be used as an emissive light source.
Protected variable uint8: 1 bEvaluateWorldPositionOffset Whether the primitive should evaluate any World Position Offset.
Protected variable uint8: 1 bGoodCandidateForCachedShadowmap Whether this proxy's mesh is unlikely to be constantly changing.
Protected variable uint8: 1 bHasDeformableMesh True if the mesh representation is deformable (see HasDeformableMesh() above for more details).
Protected variable uint8: 1 bHasValidSettingsForStaticLighting True if the primitive wants to use static lighting, but has invalid content settings to do so.
Protected variable uint8: 1 bHasWorldPositionOffsetVelocity Whether the primitive has any materials with World Position Offset, and some conditions around velocity are met.
Protected variable uint8: 1 bHoldout If this is True, this primitive should render black with an alpha of 0, but all secondary effects (shadows, refletions, indirect lighting) should behave as usual.
Protected variable uint8: 1 bIsAlwaysVisible Whether this proxy is always visible.
Protected variable uint8: 1 bIsFirstPerson If this is True, this primitive is to be rendered as a first person view object
Protected variable uint8: 1 bIsHeterogeneousVolume Whether this proxy is a heterogeneous volume.
Protected variable uint8: 1 bIsHierarchicalInstancedStaticMesh Whether the primitive is a HierarchicalInstancedStaticMesh.
Protected variable uint8: 1 bIsLandscapeGrass Whether the primitive is landscape grass.
Protected variable uint8: 1 bIsNaniteMesh Whether this proxy is a Nanite mesh.
Protected variable uint8: 1 bIsStaticMesh Whether this proxy is a static mesh.
Protected variable uint8: 1 bLightAttachmentsAsGroup Whether to light this component and any attachments as a group.
Protected variable uint8: 1 bNeedsUnbuiltPreviewLighting Whether the primitive should be statically lit but has unbuilt lighting, and a preview should be used.
Protected variable uint8: 1 bOpaqueOrMasked Whether this component contains opaque materials (cached once from assigned material).
Protected variable uint8: 1 bSelfShadowOnly When enabled, the component will only cast a shadow on itself and not other components in the world.
Protected variable uint8: 1 bShouldNotifyOnWorldAddRemove Whether this primitive requires notification when its level is added to the world and made visible for the first time.
Protected variable uint8: 1 bSinglePassGDME Whether to call GetDynamicMeshElements a single time, instead of once per unique FSceneViewFamily.
Protected variable uint8: 1 bSingleSampleShadowFromStationaryLights Whether the whole component should be shadowed as one from stationary lights, which makes shadow receiving much cheaper.
Protected variable uint8: 1 bSkinnedMesh If this is True, this primitive is a skinned mesh
Protected variable uint8: 1 bSplineMesh If this is True, this primitive is a spline mesh
Protected variable uint8: 1 bStaticElementsAlwaysUseProxyPrimitiveUniformBuffer Whether this proxy always uses UniformBuffer and no other uniform buffers.
Protected variable uint8: 1 bSupportsDistanceFieldRepresentation Whether the primitive type supports a distance field representation.
Protected variable uint8: 1 bSupportsGPUScene True if all meshes (AKA all vertex factories) drawn by this proxy support GPU scene (default is false).
Protected variable uint8: 1 bSupportsHeightfieldRepresentation Whether the primitive implements GetHeightfieldRepresentation()
Protected variable uint8: 1 bSupportsParallelGDME Whether the proxy supports asynchronously calling GetDynamicMeshElements.
Protected variable uint8: 1 bSupportsSortedTriangles Whether the object support triangles when rendered with translucent material
Protected variable uint8: 1 bVerifyUsedMaterials  
Protected variable uint8: 1 bVFRequiresPrimitiveUniformBuffer Whether this proxy ever draws with vertex factories that require a primitive uniform buffer.
Protected variable uint8: 1 bVisibleInLumenScene Whether this component should be tracked by Lumen Scene.
Protected variable uint8: 1 bWantsEditorEffects False by default, if true the proxy wants editor-only effects like outlines and overlays.
Protected variable uint8: 1 bWantsSelectionOutline True by default, if set to false will make given proxy never drawn with selection outline
Protected variable uint8: 1 bWillEverBeLit Can be set to false to skip some work only needed on lit primitives.
Protected variable FMaterialRelevance CombinedMaterialRelevance Cached material relevance available for GetMaterialRelevance call.
Public variable TArray< FDebugMassData > DebugMassData  
Protected variable float DistanceFieldSelfShadowBias  
Protected variable float DynamicIndirectShadowMinVisibility Min visibility for capsule shadows.
Protected variable TEnumAsByte< EIndirectLightingCacheQuality > IndirectLightingCacheQuality Quality of interpolated indirect lighting for Movable components.
Protected variable float MaxDrawDistance The primitive's cull distance.
Protected variable float MaxWPOExtent Maximum distance of World Position Offset used by materials.
Protected variable float MinDrawDistance The primitive's minimum cull distance.
Protected variable FVector2f MinMaxMaterialDisplacement  
Protected variable TArray< ERuntimeVirtualTextureMaterialType > RuntimeVirtualTextureMaterialTypes Set of unique runtime virtual texture material types referenced by RuntimeVirtualTextures.
Protected variable TArray< URuntimeVirtualTexture * > RuntimeVirtualTextures Array of runtime virtual textures that this proxy should render to.
Protected variable EShadowCacheInvalidationBehavior ShadowCacheInvalidationBehavior  
Protected variable int8 VirtualTextureCullMips Number of low mips to skip when rendering to runtime virtual texture.
Protected variable int8 VirtualTextureLodBias Geometry Lod bias when rendering to runtime virtual texture.
Protected variable int8 VirtualTextureMinCoverage Log2 of minimum estimated pixel coverage before culling from runtime virtual texture.

Constructors

  Type Name Description
Public function   Copy constructor.
Public function  

FPrimitiveSceneProxy ( const UPrimitiveComponent* InComponent,
FName ResourceName
)

 Initialization constructor.
Public function  

FPrimitiveSceneProxy ( const FPrimitiveSceneProxyDesc& InDesc,
FName ResourceName
)

  

Destructors

  Type Name Description
Public function Virtual   Virtual destructor.

Functions

  Type Name Description
Public function Virtual void

AcceptOcclusionResults ( const FSceneView* View,
TArray< bool >* Results,
int32 ResultsStart,
int32 NumResults
)

 Gives the primitive the results of sub-occlusion-queries
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Virtual Const bool  
Public function Const bool Returns true if this proxy should write velocity even when the transform isn't changing.
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Virtual void

ApplyLateUpdateTransform ( FRHICommandListBase& RHICmdList,
const FMatrix& LateUpdateTransform
)

 Applies a "late in the frame" adjustment to the proxy's existing transform
Public function void

ApplyLateUpdateTransform ( const FMatrix& LateUpdateTransform
)

  
Public function Virtual Const void

ApplyViewDependentMeshArguments ( const FSceneView& View,
FMeshBatch& ViewDependentMeshBatch
)

 Gives the primitive an opportunity to override MeshBatch arguments for a specific View Only called for a MeshBatch with a bViewDependentArguments property set
Public function Virtual void

ApplyWorldOffset ( FRHICommandListBase& RHICmdList,
FVector InOffset
)

 Shifts primitive position and all relevant data by an arbitrary delta.
Public function void

ApplyWorldOffset ( FVector InOffset
)

  
Public function Const void Apply the unform shader parameter settings for the proxy to the builder.
Public function Virtual Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Virtual HHitProxy *

CreateHitProxies ( IPrimitiveComponent* ComponentInterface,
TArray< TRefCountPtr< HHitProxy > >& OutHitProxies
)

 Creates the hit proxies are used when DrawDynamicElements is called. Called in the game thread.
Public function Virtual HHitProxy *

CreateHitProxies ( UPrimitiveComponent* Component,
TArray< TRefCountPtr< HHitProxy > >& OutHitProxies
)

 All FPrimitiveSceneProxy derived classes can decide to fully override the HHitProxy creation, or add their own and call any of their base classes to add theirs.
Public function Virtual void  
Public function Virtual void Called when the rendering thread adds the proxy to the scene.
Public function Virtual void Called when the rendering thread removes the proxy from the scene.
Public function Const bool Returns true to inform scene update that the mesh batches produced makes use of the (GPU)Scene instance count, and thus don't require recaching if the instance count changed.
Public function Const bool  
Public function Static void

DrawArc ( FPrimitiveDrawInterface* PDI,
const FVector& Start,
const FVector& End,
const float Height,
const uint32 Segments,
const FLinearColor& Color,
uint8 DepthPriorityGroup,
const float Thickness,
const bool bScreenSpace
)

 Drawing helper. Draws nice bouncy line.
Public function Static void

DrawArrowHead ( FPrimitiveDrawInterface* PDI,
const FVector& Tip,
const FVector& Origin,
const float Size,
const FLinearColor& Color,
uint8 DepthPriorityGroup,
const float Thickness,
const bool bScreenSpace
)

  
Protected function Const bool

DrawInVirtualTextureOnly ( bool bEditor
)

 Returns true if a primitive should currently be hidden because it is drawn only to the runtime virtual texture.
Public function Virtual void Draws the primitive's static elements.
Public function Const bool Returns true if this proxy can write velocity. This is used for setting velocity relevance.
Protected function void Call during setup to set flags to indicate GPU-Scene support for the proxy if GPU-Scene is enabled & supported for the current feature level.
Public function Const bool  
Public function Virtual Const void

GatherSimpleLights ( const FSceneViewFamily& ViewFamily,
FSimpleLightArray& OutParticleLights
)

 Callback from the renderer to gather simple lights that this proxy wants renderered.
Public function Const float  
Public function Const const FVector &  
Public function Const SIZE_T  
Public function Const const FBoxSphereBounds &  
Public function Virtual Const uint8  
Public function Const uint8  
Public function Virtual Const const FColorVertexBuffer * Allows a scene proxy to override hit proxy ids and generate more than one hit proxy id per draw call Useful for sub-section selection (faces, vertices, bones, etc)
Public function Virtual Const FBoxSphereBounds Return the custom occlusion bounds for this scene proxy.
Public function Const const FCustomPrimitiveData * Get the custom primitive data for this scene proxy.
Public function Const ESceneDepthPriorityGroup Determines the DPG to render the primitive in for the given view.
Public function Virtual Const FDesiredLODLevel  
Public function Virtual Const void

GetDistanceFieldAtlasData ( const FDistanceFieldVolumeData*& OutDistanceFieldData,
float& SelfShadowBias
)

  
Public function Virtual Const void

GetDistanceFieldInstanceData ( TArray< FRenderTransform >& InstanceLocalToPrimitiveTransforms
)

  
Public function Const float  
Public function Virtual Const void

GetDynamicMeshElements ( const TArray< const FSceneView* >& Views,
const FSceneViewFamily& ViewFamily,
uint32 VisibilityMap,
FMeshElementCollector& Collector
)

 Gathers the primitive's dynamic mesh elements.
Public function Virtual Const float Returns the instance radius to use for per instance GPU LOD calculation.
Public function Virtual Const void

GetHeightfieldRepresentation ( UTexture2D*& OutHeightmapTexture,
UTexture2D*& OutVisibilityTexture,
FHeightfieldComponentDescription& OutDescription
)

  
Public function Const EIndirectLightingCacheQuality  
Public function Const FInstanceDataBufferHeader  
Public function Virtual Const FInstanceDataUpdateTaskInfo * Return a pointer to a class that can be used to guard access to instance data that is being updated by a task.
Public function Virtual Const bool

GetInstanceDrawDistanceMinMax ( FVector2f& OutDistanceMinMax
)

 Retrieves the instance draw distance range (mostly only used by objects whose instances are culled on the GPU)
Public function Const const FInstanceSceneDataBuffers * Get the instance data view, which may be null for uninstanced primitives.
Public function Virtual Const bool

GetInstanceWorldPositionOffsetDisableDistance ( float& OutWPODisableDistance
)

 Retrieves the per-instance world position offset disable distance
Public function Virtual void

GetLCIs ( FLCIArray& LCIs
)

  
Public function Const FName  
Public function Const uint8  
Public function Const uint8  
Public function Virtual Const int32 Get the lightmap UV coordinate index for this primitive.
Public function Virtual Const int32 Get the lightmap resolution for this primitive. Used in VMI_LightmapDensity.
Public function Const ELightmapType  
Public function Virtual Const void

GetLightRelevance ( const FLightSceneProxy* LightSceneProxy,
bool& bDynamic,
bool& bRelevant,
bool& bLightMapped,
bool& bShadowMapped
)

 Determines the relevance of this primitive's elements to the given light.
Public function Const const FBoxSphereBounds &  
Public function Const const FMatrix &  
Public function Virtual Const int32

GetLOD ( const FSceneView* View
)

 Returns the LOD that the primitive will render at for this view.
Public function Virtual Const float Returns a scale to apply to ScreenSize used in LOD calculation.
Public function Virtual Const bool

GetMaterialTextureScales ( int32 LODIndex,
int32 SectionIndex,
const FMaterialRenderProxy* MaterialRenderProxy,
FVector4f* OneOverScales,
FIntVector4* UVChannelIndices
)

 Get mesh UV density for a LOD-section.
Public function Const float  
Public function Const float  
Public function Const uint32 Every derived class should override these functions
Public function Virtual Const const FCardRepresentationData *  
Public function Virtual Const void

GetMeshDescription ( int32 LODIndex,
TArray< FMeshBatch >& OutMeshElements
)

 Gathers a description of the mesh elements to be rendered for the given LOD index, without consideration for views.
Public function Const FName  
Public function Virtual Const FUintVector2  
Public function Virtual Const bool

GetMeshUVDensities ( int32 LODIndex,
int32 SectionIndex,
FVector4& WorldUVDensities
)

 Get mesh UV density for a LOD-section.
Public function Const float  
Public function Const const FVector2f &  
Public function Virtual Const void

GetNaniteResourceInfo ( uint32& ResourceID,
uint32& HierarchyOffset,
uint32& ImposterIndex
)

  
Public function int32  
Public function Virtual Const const TArray< FBoxSphereBounds > * Gets the boxes for sub occlusion queries
Public function Const FColor  
Public function Const FName  
Public function Virtual Const void  
Public function Const FLinearColor  
Public function Const FPrimitiveComponentId  
Public function Virtual Const bool

GetPrimitiveDistance ( int32 LODIndex,
int32 SectionIndex,
const FVector& ViewOrigin,
float& PrimitiveDistance
)

 Get primitive distance to view origin for a given LOD-section.
Public function Const FPrimitiveSceneInfo *  
Public function Const uint8  
Public function Const int32  
Public function Const FName  
Public function Const FSceneInterface & Accessors.
Public function Const uint8  
Public function Const EShadowCacheInvalidationBehavior  
Public function Virtual Const void

GetShadowShapes ( FVector PreViewTranslation,
TArray< FCapsuleShape3f >& OutCapsuleShapes
)

 Gathers shadow shapes from this proxy.
Public function Virtual Const ESceneDepthPriorityGroup Determines the DPG to render the primitive in regardless of view.
Public function Const TStatId  
Public function Const EStencilMask  
Public function Const float  
Public function Const int16  
Public function Const SIZE_T Return a type (or subtype) specific hash for sorting purposes
Public function Const FRHIUniformBuffer *  
Public function Virtual Const FPrimitiveViewRelevance

GetViewRelevance ( const FSceneView* View
)

 Determines the relevance of this primitive's elements to the given view.
Public function Const int32  
Public function Const int32  
Public function Const int32  
Public function Const int32  
Public function Const FLinearColor  
Public function Virtual Const bool Returns whether the proxy utilizes custom occlusion bounds or not
Public function Const bool Returns true if this proxy has any deformable mesh, meaning the mesh is animated e.g., by deforming the vertices through skinning, morphing or some procedural update.
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Const bool Returns true if this proxy can change transform so that we should cache previous transform for calculating velocity.
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Virtual Const bool  
Public function Const bool  
Public function Const bool  
Public function Virtual Const bool  
Public function Const bool

Holdout ()

  
Public function Const bool Returns whether this proxy is always visible.
Public function Const bool  
Public function Virtual Const bool  
Public function Virtual Const bool Returns whether this proxy should be considered a "detail mesh".
Public function Const bool Tell us if this proxy is drawn in editor.
Public function Virtual Const bool Tell us if this proxy is drawn in game.
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool Returns whether this proxy is a heterogeneous volume.
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool Whether instance data only exists in the GPU Scene (instance data not present in CPU memory).
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool Returns whether this proxy is a Nanite mesh.
Public function Const bool  
Public function Const bool  
Public function Const bool

IsOwnedBy ( const AActor* Actor
)

  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool

IsShadowCast ( const FSceneView* View
)

  
Public function Const bool

IsShown ( const FSceneView* View
)

  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Virtual Const bool  
Protected function Const bool Returns true if a primitive can never be rendered outside of a runtime virtual texture.
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Virtual void

OnDetachLight ( const FLightSceneInfo* Light
)

 Called by the rendering thread to notify the proxy when a light is no longer associated with the proxy, so that it can clean up any cached resources.
Protected function Virtual void Allows child implementations to do render-thread work when bEvaluateWorldPositionOffset changes
Public function Virtual bool Called to notify the proxy that the level has been fully added to the world and the primitive will now be rendered.
Public function Virtual void Called to notify the proxy that the level has been fully removed from the world and the primitive will not be rendered.
Public function Virtual void Called to notify the proxy when its transform has been updated.
Public function void  
Protected function void

OverrideOwnerName ( FName InOwnerName
)

 Allow subclasses to override the primitive name. Used primarily by BSP.
Protected function FRenderBounds  
Public function Const const bool  
Public function Const void

RenderBounds ( FPrimitiveDrawInterface* PDI,
const FEngineShowFlags& EngineShowFlags,
const FBoxSphereBounds& Bounds,
bool bRenderInEditor
)

 Helper for components that want to render bounds.
Public function void Enqueue and update for the render thread to remove the velocity data for this component from the scene.
Public function void

SetCollisionEnabled_GameThread ( const bool bNewEnabled
)

 Set the collision flag on the scene proxy to enable/disable collision drawing
Public function void

SetCollisionEnabled_RenderThread ( const bool bNewEnabled
)

 Set the collision flag on the scene proxy to enable/disable collision drawing (RENDER THREAD)
Public function void

SetCustomDepthEnabled_GameThread ( const bool bInRenderCustomDepth
)

 Set the custom depth enabled flag
Public function void

SetCustomDepthEnabled_RenderThread ( const bool bInRenderCustomDepth
)

 Set the custom depth enabled flag (RENDER THREAD)
Public function void

SetCustomDepthStencilValue_GameThread ( const int32 InCustomDepthStencilValue
)

 Set the custom depth stencil value
Public function void

SetCustomDepthStencilValue_RenderThread ( const int32 InCustomDepthStencilValue
)

 Set the custom depth stencil value (RENDER THREAD)
Public function Virtual void

SetDebugMassData ( const TArray< FDebugMassData >& InDebugMassData
)

 Sets the primitive proxy's mass space to component space.
Public function void  
Public function void

SetDrawDistance_RenderThread ( float MinDrawDistance,
float MaxDrawDistance,
float VirtualTextureMaxDrawDistance
)

  
Public function void Enqueue updated setting for evaluation of World Position Offset.
Protected function void

SetForceHidden ( bool bForceHiddenIn
)

  
Public function void

SetHiddenEdViews_GameThread ( uint64 InHiddenEditorViews
)

 Updates the hidden editor view visibility map on the game thread which just enqueues a command on the render thread
Public function void

SetHovered_GameThread ( const bool bInHovered
)

 Updates hover state for the primitive proxy.
Protected function void

SetHovered_RenderThread ( const bool bInHovered
)

 Updates hover state for the primitive proxy.
Public function Virtual void

SetInstanceCullDistance_RenderThread ( float StartCullDistance,
float EndCullDistance
)

  
Protected function void

SetInstanceLocalBounds ( uint32 InstanceIndex,
const FRenderBounds& InBounds,
bool bPadForWPO
)

 Sets the instance local bounds for the specified instance index, and optionally will pad the bounds extents to accomodate Max World Position Offset Distance.
Public function void

SetIsBeingMovedByEditor_GameThread ( bool bIsBeingMoved
)

 Enqueue and update for the render thread to notify it that the editor is currently moving the owning component with gizmos.
Public function void

SetLevelInstanceEditingState_GameThread ( const bool bInEditingState
)

 Updates the LevelInstance editing state for the primitive proxy.
Protected function void

SetLevelInstanceEditingState_RenderThread ( const bool bInLevelInstanceEditingState
)

 Updates LevelInstance editing state for the primitive proxy.
Public function void Updates the lighting channels for the primitive proxy.
Public function void Enqueue updated overlay color for the render thread to use.
Public function void

SetPrimitiveColor ( const FLinearColor& InPrimitiveColor
)

  
Public function void

SetPrimitiveColor_GameThread ( const FLinearColor& InPrimitiveColor
)

 Enqueue and update for the render thread to notify it that the primitive color changed.
Public function void

SetSelection_GameThread ( const bool bInParentSelected,
const bool bInIndividuallySelected
)

 Updates selection for the primitive proxy.
Protected function void

SetSelection_RenderThread ( const bool bInParentSelected,
const bool bInIndividuallySelected
)

 Updates selection for the primitive proxy.
Public function void Enqueue updated selection outline color for the render thread to use.
Public function void

SetSelectionOverride_GameThread ( bool bForceSelection
)

 Force the proxy to render as though it is selected. Shows outlines and overlays.
Protected function void

SetupInstanceSceneDataBuffers ( const FInstanceSceneDataBuffers* InInstanceSceneDataBuffers
)

  
Public function void

SetUsedMaterialForVerification ( const TArray< UMaterialInterface* >& InUsedMaterialsForVerification
)

 This function exist only to perform an update of the UsedMaterialsForVerification on the render thread
Public function void

SetWireframeColor ( const FLinearColor& InWireframeColor
)

  
Public function Virtual void  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Virtual Const bool  
Public function Const bool  
Public function Const bool  
Public function Virtual Const bool  
Public function Const bool  
Public function Const bool Returns true if all meshes drawn by this proxy support GPU scene.
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Protected function Virtual void

UpdateInstances_RenderThread ( FRHICommandListBase& RHICmdList,
const FBoxSphereBounds& InBounds,
const FBoxSphereBounds& InLocalBounds,
const FBoxSphereBounds& InStaticMeshBounds
)

 Called on the render thread for a proxy that has an instance data update, the buffers are updated asynchronously so it is unclear what this should do, except update legacy data if needed.
Public function void Updates the primitive proxy's uniform buffer.
Public function void  
Protected function void Updates bVisibleInLumen, which indicated whether a primitive should be tracked by Lumen scene.
Public function Const bool  
Public function Const bool  
Public function Const bool

VerifyUsedMaterial ( const FMaterialRenderProxy* MaterialRenderProxy
)

 Verifies that a material used for rendering was present in the component's GetUsedMaterials list.
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool  

Classes

  Type Name Description
Public struct FDebugMassData    

Enums

  Type Name Description
Public enum EInstanceBufferAccessFlags    

Typedefs

Name Description
FLCIArray Get the list of LCIs.

Constants

Name Description
InvalidRayTracingGroupId  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page