UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FLightPrimitiveInteraction Class Reference

#include <SceneCore.h>

Classes

struct  FShouldCreateResult
 

Public Member Functions

bool HasShadow () const
 
bool IsLightMapped () const
 
bool IsDynamic () const
 
bool IsShadowMapped () const
 
bool IsUncachedStaticLighting () const
 
bool HasTranslucentObjectShadow () const
 
bool HasInsetObjectShadow () const
 
bool CastsSelfShadowOnly () const
 
bool IsMobileDynamicLocalLight () const
 
FORCEINLINE bool IsNaniteMeshProxy () const
 
FORCEINLINE bool ProxySupportsGPUScene () const
 
FLightSceneInfoGetLight () const
 
int32 GetLightId () const
 
FPrimitiveSceneInfoGetPrimitiveSceneInfo () const
 
FLightPrimitiveInteractionGetNextPrimitive () const
 
FLightPrimitiveInteractionGetNextLight () const
 
void FlushCachedShadowMapData ()
 
voidoperator new (size_t Size)
 
void operator delete (void *RawMemory)
 

Static Public Member Functions

static void InitializeMemoryPool ()
 
static FShouldCreateResult ShouldCreate (FLightSceneInfo *LightSceneInfo, FPrimitiveSceneInfo *PrimitiveSceneInfo)
 
static void Create (FLightSceneInfo *LightSceneInfo, FPrimitiveSceneInfo *PrimitiveSceneInfo)
 
static void Destroy (FLightPrimitiveInteraction *LightPrimitiveInteraction)
 
static uint32 GetMemoryPoolSize ()
 

Friends

uint32 GetTypeHash (const FLightPrimitiveInteraction *Interaction)
 

Detailed Description

An interaction between a light and a primitive.

Member Function Documentation

◆ CastsSelfShadowOnly()

bool FLightPrimitiveInteraction::CastsSelfShadowOnly ( ) const
inline

◆ Create()

void FLightPrimitiveInteraction::Create ( FLightSceneInfo LightSceneInfo,
FPrimitiveSceneInfo PrimitiveSceneInfo 
)
static

◆ Destroy()

void FLightPrimitiveInteraction::Destroy ( FLightPrimitiveInteraction LightPrimitiveInteraction)
static

◆ FlushCachedShadowMapData()

void FLightPrimitiveInteraction::FlushCachedShadowMapData ( )

Clears cached shadow maps, if possible

◆ GetLight()

FLightSceneInfo * FLightPrimitiveInteraction::GetLight ( ) const
inline

◆ GetLightId()

int32 FLightPrimitiveInteraction::GetLightId ( ) const
inline

◆ GetMemoryPoolSize()

uint32 FLightPrimitiveInteraction::GetMemoryPoolSize ( )
static

Returns current size of memory pool

◆ GetNextLight()

FLightPrimitiveInteraction * FLightPrimitiveInteraction::GetNextLight ( ) const
inline

◆ GetNextPrimitive()

FLightPrimitiveInteraction * FLightPrimitiveInteraction::GetNextPrimitive ( ) const
inline

◆ GetPrimitiveSceneInfo()

FPrimitiveSceneInfo * FLightPrimitiveInteraction::GetPrimitiveSceneInfo ( ) const
inline

◆ HasInsetObjectShadow()

bool FLightPrimitiveInteraction::HasInsetObjectShadow ( ) const
inline

◆ HasShadow()

bool FLightPrimitiveInteraction::HasShadow ( ) const
inline

◆ HasTranslucentObjectShadow()

bool FLightPrimitiveInteraction::HasTranslucentObjectShadow ( ) const
inline

◆ InitializeMemoryPool()

void FLightPrimitiveInteraction::InitializeMemoryPool ( )
static

Creates an interaction for a light-primitive pair.

Initialize the memory pool with a default size from the ini file. Called at render thread startup. Since the render thread is potentially created/destroyed multiple times, must make sure we only do it once.

◆ IsDynamic()

bool FLightPrimitiveInteraction::IsDynamic ( ) const
inline

◆ IsLightMapped()

bool FLightPrimitiveInteraction::IsLightMapped ( ) const
inline

◆ IsMobileDynamicLocalLight()

bool FLightPrimitiveInteraction::IsMobileDynamicLocalLight ( ) const
inline

◆ IsNaniteMeshProxy()

FORCEINLINE bool FLightPrimitiveInteraction::IsNaniteMeshProxy ( ) const
inline

◆ IsShadowMapped()

bool FLightPrimitiveInteraction::IsShadowMapped ( ) const
inline

◆ IsUncachedStaticLighting()

bool FLightPrimitiveInteraction::IsUncachedStaticLighting ( ) const
inline

◆ operator delete()

void FLightPrimitiveInteraction::operator delete ( void RawMemory)

Custom delete

◆ operator new()

void * FLightPrimitiveInteraction::operator new ( size_t  Size)

Custom new/delete

Custom new

◆ ProxySupportsGPUScene()

FORCEINLINE bool FLightPrimitiveInteraction::ProxySupportsGPUScene ( ) const
inline

◆ ShouldCreate()

FLightPrimitiveInteraction::FShouldCreateResult FLightPrimitiveInteraction::ShouldCreate ( FLightSceneInfo LightSceneInfo,
FPrimitiveSceneInfo PrimitiveSceneInfo 
)
static

Friends And Related Symbol Documentation

◆ GetTypeHash

uint32 GetTypeHash ( const FLightPrimitiveInteraction Interaction)
friend

Hash function required for TMap support


The documentation for this class was generated from the following files: