UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | Public Attributes | List of all members
FStaticLightingTextureMapping Class Referenceabstract

#include <StaticLighting.h>

+ Inheritance diagram for FStaticLightingTextureMapping:

Public Member Functions

ENGINE_API FStaticLightingTextureMapping (FStaticLightingMesh *InMesh, UObject *InOwner, int32 InSizeX, int32 InSizeY, int32 InLightmapTextureCoordinateIndex, bool bInBilinearFilter=true)
 
virtual void Apply (struct FQuantizedLightmapData *QuantizedData, const TMap< ULightComponent *, class FShadowMapData2D * > &ShadowMapData, const FStaticLightingBuildContext *LightingContext)=0
 
virtual FStaticLightingTextureMapping * GetTextureMapping ()
 
virtual bool IsTextureMapping () const
 
virtual bool IsValidMapping () const
 
virtual FString GetDescription () const
 
virtual int32 GetTexelCount () const
 
 FStaticLightingTextureMapping (const FArchive &Ar)
 
- Public Member Functions inherited from FStaticLightingMapping
 FStaticLightingMapping (FStaticLightingMesh *InMesh, UObject *InOwner)
 
virtual ~FStaticLightingMapping ()
 
virtual const FGuid & GetLightingGuid () const
 
bool IsDeferred () const
 
 FStaticLightingMapping (const FArchive &)
 
- Public Member Functions inherited from FRefCountedObject
 FRefCountedObject ()
 
virtual ~FRefCountedObject ()
 
 FRefCountedObject (const FRefCountedObject &Rhs)=delete
 
FRefCountedObject & operator= (const FRefCountedObject &Rhs)=delete
 
FReturnedRefCountValue AddRef () const
 
uint32 Release () const
 
uint32 GetRefCount () const
 

Public Attributes

int32 SizeX
 
int32 SizeY
 
int32 LightmapTextureCoordinateIndex
 
bool bBilinearFilter
 
- Public Attributes inherited from FStaticLightingMapping
class FStaticLightingMesh * Mesh
 
UObject * Owner
 
uint32 bProcessMapping: 1
 
uint32 bIsDeferred: 1
 

Detailed Description

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

Constructor & Destructor Documentation

◆ FStaticLightingTextureMapping() [1/2]

FStaticLightingTextureMapping::FStaticLightingTextureMapping ( FStaticLightingMesh *  InMesh,
UObject *  InOwner,
int32  InSizeX,
int32  InSizeY,
int32  InLightmapTextureCoordinateIndex,
bool  bInBilinearFilter = true 
)

Initialization constructor.

◆ FStaticLightingTextureMapping() [2/2]

FStaticLightingTextureMapping::FStaticLightingTextureMapping ( const FArchive &  Ar)
inline

Default constructor used by serializer

Member Function Documentation

◆ Apply()

virtual void FStaticLightingTextureMapping::Apply ( struct FQuantizedLightmapData *  QuantizedData,
const TMap< ULightComponent *, class FShadowMapData2D * > &  ShadowMapData,
const FStaticLightingBuildContext *  LightingContext 
)
pure virtual

Called when the static lighting has been computed to apply it to the mapping's owner. This function is responsible for deleting ShadowMapData and QuantizedData.

Parameters
LightMapData- The light-map data which has been computed for the mapping.

Implemented in FLandscapeStaticLightingTextureMapping, FStaticLightingGlobalVolumeMapping, and FLandscapeStaticLightingGlobalVolumeMapping.

◆ GetDescription()

virtual FString FStaticLightingTextureMapping::GetDescription ( ) const
inlinevirtual

Reimplemented from FStaticLightingMapping.

Reimplemented in FStaticLightingGlobalVolumeMapping, FLandscapeStaticLightingTextureMapping, FBSPSurfaceStaticLighting, FStaticMeshStaticLightingTextureMapping, and FLandscapeStaticLightingGlobalVolumeMapping.

◆ GetTexelCount()

virtual int32 FStaticLightingTextureMapping::GetTexelCount ( ) const
inlinevirtual

Reimplemented from FStaticLightingMapping.

◆ GetTextureMapping()

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

Reimplemented from FStaticLightingMapping.

◆ IsTextureMapping()

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

Reimplemented from FStaticLightingMapping.

◆ IsValidMapping()

virtual bool FStaticLightingTextureMapping::IsValidMapping ( ) const
inlinevirtual

Whether or not this mapping should be processed or imported

Reimplemented in FStaticLightingGlobalVolumeMapping, FBSPSurfaceStaticLighting, FStaticMeshStaticLightingTextureMapping, and FLandscapeStaticLightingGlobalVolumeMapping.

Member Data Documentation

◆ bBilinearFilter

bool FStaticLightingTextureMapping::bBilinearFilter

Whether to apply a bilinear filter to the sample or not.

◆ LightmapTextureCoordinateIndex

int32 FStaticLightingTextureMapping::LightmapTextureCoordinateIndex

The lightmap texture coordinate index which is used for the mapping.

◆ SizeX

int32 FStaticLightingTextureMapping::SizeX

The width of the static lighting textures used by the mapping.

◆ SizeY

int32 FStaticLightingTextureMapping::SizeY

The height of the static lighting textures used by the mapping.

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