UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
LightMap.h File Reference

Go to the source code of this file.

Classes

class  FLightMap
 
struct  FLightSample
 
class  FLightMapData2D
 
class  FLightMap2D
 
struct  FLegacyQuantizedDirectionalLightSample
 
struct  FLegacyQuantizedSimpleLightSample
 
struct  FQuantizedDirectionalLightSample
 
struct  FQuantizedSimpleLightSample
 
struct  TIsPODType< FQuantizedDirectionalLightSample >
 
struct  TIsPODType< FQuantizedSimpleLightSample >
 
struct  TQuantizedLightSampleBulkData< QuantizedLightSampleType >
 
class  FLegacyLightMap1D
 
struct  FSelectedLightmapSample
 
class  FDebugShadowRay
 
struct  FLightMapCoefficients
 
struct  FQuantizedLightmapData
 
class  FLightmapResourceCluster
 

Functions

ENGINE_API bool IsTexelDebuggingEnabled ()
 
ENGINE_API FArchiveoperator<< (FArchive &Ar, FLightMap *&R)
 
bool IsTexelMapped (const TArray< FLightMapCoefficients > &MappingData, int32 X, int32 Y, int32 Pitch)
 
template<class TMappingData >
void CropUnmappedTexels (const TMappingData &MappingData, int32 SizeX, int32 SizeY, FIntRect &CroppedRect)
 

Variables

ENGINE_API bool GUseBilinearLightmaps
 
ENGINE_API bool GAllowLightmapPadding
 
ENGINE_API ELightingBuildQuality GLightingBuildQuality
 
ENGINE_API FColor GTexelSelectionColor
 

Function Documentation

◆ CropUnmappedTexels()

template<class TMappingData >
void CropUnmappedTexels ( const TMappingData MappingData,
int32  SizeX,
int32  SizeY,
FIntRect CroppedRect 
)

Calculates the minimum rectangle that encompasses all mapped texels.

Parameters
MappingDataArray of lightmap/shadowmap texels
SizeXNumber of texels along the X-axis
SizeYNumber of texels along the Y-axis
CroppedRect[out] Upon return, contains the minimum rectangle that encompasses all mapped texels

◆ IsTexelDebuggingEnabled()

ENGINE_API bool IsTexelDebuggingEnabled ( )
extern

◆ IsTexelMapped()

bool IsTexelMapped ( const TArray< FLightMapCoefficients > &  MappingData,
int32  X,
int32  Y,
int32  Pitch 
)
inline

Checks if a lightmap texel is mapped or not.

Parameters
MappingDataArray of lightmap texels
XX-coordinate for the texel to check
YY-coordinate for the texel to check
PitchNumber of texels per row
Returns
true if the texel is mapped

◆ operator<<()

ENGINE_API FArchive & operator<< ( FArchive Ar,
FLightMap *&  R 
)
extern

Lightmap reference serializer Intended to be used by TRefCountPtr's serializer, not called directly

Variable Documentation

◆ GAllowLightmapPadding

ENGINE_API bool GAllowLightmapPadding
extern

Whether to allow padding around mappings. Old-style lighting doesn't use this.

Whether to allow padding around mappings.

◆ GLightingBuildQuality

ENGINE_API ELightingBuildQuality GLightingBuildQuality
extern

The quality level of the current lighting build

◆ GTexelSelectionColor

ENGINE_API FColor GTexelSelectionColor
extern

◆ GUseBilinearLightmaps

ENGINE_API bool GUseBilinearLightmaps
extern

Whether to use bilinear filtering on lightmaps