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

#include <StaticLighting.h>

+ Inheritance diagram for FStaticLightingMapping:

Public Member Functions

 FStaticLightingMapping (FStaticLightingMesh *InMesh, UObject *InOwner)
 
virtual ~FStaticLightingMapping ()
 
virtual FStaticLightingTextureMappingGetTextureMapping ()
 
virtual bool IsTextureMapping () const
 
virtual const FGuidGetLightingGuid () const
 
virtual FString GetDescription () const
 
virtual int32 GetTexelCount () const
 
bool IsDeferred () const
 
 FStaticLightingMapping (const FArchive &)
 
- Public Member Functions inherited from FRefCountedObject
 FRefCountedObject ()
 
virtual ~FRefCountedObject ()
 
 FRefCountedObject (const FRefCountedObject &Rhs)=delete
 
FRefCountedObjectoperator= (const FRefCountedObject &Rhs)=delete
 
FReturnedRefCountValue AddRef () const
 
uint32 Release () const
 
uint32 GetRefCount () const
 

Public Attributes

class FStaticLightingMeshMesh
 
UObjectOwner
 
uint32 bProcessMapping: 1
 
uint32 bIsDeferred: 1
 

Detailed Description

A mapping between world-space surfaces and a static lighting cache.

Constructor & Destructor Documentation

◆ FStaticLightingMapping() [1/2]

FStaticLightingMapping::FStaticLightingMapping ( FStaticLightingMesh InMesh,
UObject InOwner 
)
inline

Initialization constructor.

◆ ~FStaticLightingMapping()

virtual FStaticLightingMapping::~FStaticLightingMapping ( )
inlinevirtual

Virtual destructor.

◆ FStaticLightingMapping() [2/2]

FStaticLightingMapping::FStaticLightingMapping ( const FArchive )
inline

Member Function Documentation

◆ GetDescription()

◆ GetLightingGuid()

virtual const FGuid & FStaticLightingMapping::GetLightingGuid ( ) const
inlinevirtual

Returns the Guid used for static lighting.

Returns
FGuid that identifies the mapping

Reimplemented in FBSPSurfaceStaticLighting.

◆ GetTexelCount()

virtual int32 FStaticLightingMapping::GetTexelCount ( ) const
inlinevirtual

Reimplemented in FStaticLightingTextureMapping.

◆ GetTextureMapping()

virtual FStaticLightingTextureMapping * FStaticLightingMapping::GetTextureMapping ( )
inlinevirtual
Returns
If the mapping is a texture mapping, returns a pointer to this mapping as a texture mapping. Otherwise, returns NULL.

Reimplemented in FStaticLightingTextureMapping.

◆ IsDeferred()

bool FStaticLightingMapping::IsDeferred ( ) const
inline

◆ IsTextureMapping()

virtual bool FStaticLightingMapping::IsTextureMapping ( ) const
inlinevirtual
Returns
true if the mapping is a texture mapping. Otherwise, returns false.

Reimplemented in FStaticLightingTextureMapping.

Member Data Documentation

◆ bIsDeferred

uint32 FStaticLightingMapping::bIsDeferred

true if the mapping should be deferred until a finalizing pass.

◆ bProcessMapping

uint32 FStaticLightingMapping::bProcessMapping

true if the mapping should be processed by Lightmass.

◆ Mesh

class FStaticLightingMesh* FStaticLightingMapping::Mesh

The mesh associated with the mapping.

◆ Owner

UObject* FStaticLightingMapping::Owner

The object which owns the mapping.


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