1. Epic GamesDeveloper
  3. FLightMap2D

FLightMap2D

A 2D array of incident lighting data.

Unreal Engine C++ API Reference > Runtime > Engine

Inheritance Hierarchy

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

  Type Name Description
Public variable FVector4f[NUM_STORED_LIGHTMAP_COEF] AddVectors Bias value to apply to the coefficients.
Public variable TObjectPtr< ULightMapTexture2D > AOMaterialMaskTexture  
Public variable bool[4] bShadowChannelValid Tracks which of the 4 channels has valid texture data.
Public variable FVector2D CoordinateBias The bias which is applied to the light-map coordinates before sampling the light-map textures.
Public variable FVector2D CoordinateScale The scale which is applied to the light-map coordinates before sampling the light-map textures.
Public variable FVector4f InvUniformPenumbraSize Stores the inverse of the penumbra size, normalized.
Public variable FVector4f[NUM_STORED_LIGHTMAP_COEF] ScaleVectors A scale to apply to the coefficients.
Public variable TObjectPtr< UShadowMapTexture2D > ShadowMapTexture  
Public variable TObjectPtr< ULightMapTexture2D > SkyOcclusionTexture  
Public variable TObjectPtr< ULightMapTexture2D >[2] Textures The textures containing the light-map data.
Public variable TObjectPtr< ULightMapVirtualTexture2D >[2] VirtualTextures The virtual textures containing the light-map data.

Constructors

  Type Name Description
Public function    
Public function  

FLightMap2D ( bool InAllowHighQualityLightMaps
)

  
Protected function  

FLightMap2D ( const TArray< FGuid >& InLightGuids
)

  

Functions

  Type Name Description
Public function Static TRefCountPtr< FLightMap2D >

AllocateInstancedLightMap ( UObject* LightMapOuter,
UInstancedStaticMeshComponent* Component,
TArray< TUniquePtr< FQuantizedLightmapData >> SourceQuantizedData,
TArray< TMap< ULightComponent*, TUniquePtr< FShadowMapData2D >>>&& InstancedShadowMapData,
UMapBuildDataRegistry* Registry,
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.
Public function Static TRefCountPtr< FLightMap2D >

AllocateLightMap ( UObject* LightMapOuter,
FQuantizedLightmapData*& SourceQuantizedData,
const TMap< ULightComponent*, FShadowMapData2D* >& SourceShadowMapData,
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.
Public function Static int32

EncodeShadowTexture ( ULevel* LightingScenario,
FLightMapPendingTexture& PendingTexture,
TArray< TArray< FFourDistanceFieldSamples >>& MipData
)

 Constructs mip maps for a single shadowmap texture.
Public function Static void

EncodeTextures ( UWorld* InWorld,
ULevel* LightingScenario,
bool bLightingSuccessful,
bool bMultithreadedEncode
)

 Executes all pending light-map encoding requests.
Public function Const UTexture2D *  
Public function Const const FVector2D &  
Public function Const const FVector2D &  
Public function Const void

GetReferencedTextures ( TArray< UTexture2D* >& OutTextures
)

  
Public function Const UTexture2D * Returns SkyOcclusionTexture.
Public function Static bool  
Public function Const const UTexture2D *

GetTexture ( uint32 BasisIndex
)

 Returns the texture containing the RGB coefficients for a specific basis.
Public function UTexture2D *

GetTexture ( uint32 BasisIndex
)

 Returns the texture containing the RGB coefficients for a specific basis.
Public function Const ULightMapVirtualTexture2D *

GetVirtualTexture ( uint32 BasisIndex
)

  
Public function Const bool

IsValid ( uint32 BasisIndex
)

 Returns whether the specified basis has a valid lightmap texture or not.
Public function Const bool  
Public function Static void

SetStatusUpdate ( bool bInEnable
)

 Call to enable/disable status update of LightMap encoding

Overridden from FLightMap

  Type Name Description
Public function Virtual void  
Public function Virtual Const FLightMapInteraction  
Public function Virtual FLightMap2D * Runtime type casting.
Public function Virtual Const const FLightMap2D * Runtime type casting.
Public function Virtual Const FShadowMapInteraction  
Public function Virtual void  

Constants

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

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page