Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > Engine > FLightMap2D

Light Theme

Dark Theme

FLightMap2D

A 2D array of incident lighting data.

Windows

MacOS

Linux

Inheritance Hierarchy

FDeferredCleanupInterface

FLightMap

FLightMap2D

References

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

Syntax

class FLightMap2D : public FLightMap

Remarks

A 2D array of incident lighting data.

Variables

	Name	Description
FVector4[NUM_ST...	AddVectors	Bias value to apply to the coefficients.
ULightMapTextur...	AOMaterialMaskTexture
bool[4]	bShadowChannelValid	Tracks which of the 4 channels has valid texture data.
FVector2D	CoordinateBias	The bias which is applied to the light-map coordinates before sampling the light-map textures.
FVector2D	CoordinateScale	The scale which is applied to the light-map coordinates before sampling the light-map textures.
FVector4	InvUniformPenumbraSize	Stores the inverse of the penumbra size, normalized.
FVector4[NUM_ST...	ScaleVectors	A scale to apply to the coefficients.
UShadowMapTextu...	ShadowMapTexture
ULightMapTextur...	SkyOcclusionTexture
ULightMapTextur...	Textures	The textures containing the light-map data.
ULightMapVirtua...	VirtualTexture	The virtual textures containing the light-map data.

Constructors

	Name	Description
	FLightMap2D()
	FLightMap2D ( bool InAllowHighQualityLightMaps )
	FLightMap2D ( const TArray< FGuid >& InLightGuid... )

Functions

	Name	Description
TRefCountPtr...	AllocateInstancedLightMap ( UObject* LightMapOuter, UInstancedStaticMeshComponent..., TArray< TUniquePtr< FQuantizedLight..., TArray< TMap< ULightComponent..., UMapBuildDataRegistry* Registr..., FGuid MapBuildDataId, const FBoxSphereBounds& Bounds, ELightMapPaddingType InPaddingType, ELightMapFlags LightmapFlags )	Allocates texture space for the light-map and stores the light-map's raw data for deferred encoding.
TRefCountPtr...	AllocateLightMap ( UObject* LightMapOuter, FQuantizedLightmapData& Sourc..., const TMap< ULightComponent, ..., const FBoxSphereBounds& Bounds, ELightMapPaddingType InPaddingType, ELightMapFlags InLightmapFlags )	Allocates texture space for the light-map and stores the light-map's raw data for deferred encoding.
int32	EncodeShadowTexture ( ULevel* LightingScenario, FLightMapPendingTexture& PendingTe..., TArray< TArray< FFourDistanceFieldS... )	Constructs mip maps for a single shadowmap texture.
void	EncodeTextures ( UWorld* InWorld, bool bLightingSuccessful, bool bMultithreadedEncode )	Executes all pending light-map encoding requests.
UTexture2D &...	GetAOMaterialMaskTexture()
const FVecto...	GetCoordinateBias()
const FVecto...	GetCoordinateScale()
void	GetReferencedTextures ( TArray< UTexture2D* >& OutTex... )
UTexture2D &...	GetSkyOcclusionTexture()	Returns SkyOcclusionTexture.
bool	GetStatusUpdate()
const UTextu...	GetTexture ( uint32 BasisIndex )	Returns the texture containing the RGB coefficients for a specific basis.
UTexture2D &...	GetTexture ( uint32 BasisIndex )	Returns the texture containing the RGB coefficients for a specific basis.
ULightMapVir...	GetVirtualTexture()
bool	IsValid ( uint32 BasisIndex )	Returns whether the specified basis has a valid lightmap texture or not.
void	SetStatusUpdate ( bool bInEnable )	Call to enable/disable status update of LightMap encoding

Overridden from FLightMap

	Name	Description
void	AddReferencedObjects ( FReferenceCollector& Collector )
FLightMapInt...	GetInteraction ( ERHIFeatureLevel::Type InFeatureLev... )
FLightMap2D ...	GetLightMap2D()	Runtime type casting.
const FLight...	GetLightMap2D()	Runtime type casting.
FShadowMapIn...	GetShadowInteraction ( ERHIFeatureLevel::Type InFeatureLev... )
void	Serialize ( FArchive& Ar )

Constants

Name	Description
bUpdateStatus	If true, update the status when encoding light maps

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss