FLightMap2D

A 2D array of incident lighting data.

Windows
MacOS
Linux

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

Name Description

Public variable

FVector4[NUM_ST...

 

AddVectors

Bias value to apply to the coefficients.

Public variable

ULightMapTextur...

 

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

FVector4

 

InvUniformPenumbraSize

Stores the inverse of the penumbra size, normalized.

Public variable

FVector4[NUM_ST...

 

ScaleVectors

A scale to apply to the coefficients.

Public variable

UShadowMapTextu...

 

ShadowMapTexture

Public variable

ULightMapTextur...

 

SkyOcclusionTexture

Public variable

ULightMapTextur...

 

Textures

The textures containing the light-map data.

Public variable

ULightMapVirtua...

 

VirtualTextures

The virtual textures containing the light-map data.

Constructors

Name Description

Public function

FLightMap2D()

Public function

FLightMap2D

(
    bool InAllowHighQualityLightMaps
)

Protected function

FLightMap2D

(
    const TArray< FGuid >& InLightGuid...
)

Functions

Name Description

Public function Static

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.

Public function Static

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.

Public function Static

int32

 

EncodeShadowTexture

(
    ULevel* LightingScenario,
    FLightMapPendingTexture& PendingTe...,
    TArray< TArray< FFourDistanceFieldS...
)

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 &...

 

GetAOMaterialMaskTexture()

Public function Const

const FVecto...

 

GetCoordinateBias()

Public function Const

const FVecto...

 

GetCoordinateScale()

Public function Const

void

 

GetReferencedTextures

(
    TArray< UTexture2D* >& OutTex...
)

Public function Const

UTexture2D &...

 

GetSkyOcclusionTexture()

Returns SkyOcclusionTexture.

Public function Static

bool

 

GetStatusUpdate()

Public function Const

const UTextu...

 

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

ULightMapVir...

 

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

 

IsVirtualTextureValid()

Public function Static

void

 

SetStatusUpdate

(
    bool bInEnable
)

Call to enable/disable status update of LightMap encoding

Overridden from FLightMap

Name Description

Public function Virtual

void

 

AddReferencedObjects

(
    FReferenceCollector& Collector
)

Public function Virtual Const

FLightMapInt...

 

GetInteraction

(
    ERHIFeatureLevel::Type InFeatureLev...
)

Public function Virtual

FLightMap2D ...

 

GetLightMap2D()

Runtime type casting.

Public function Virtual Const

const FLight...

 

GetLightMap2D()

Runtime type casting.

Public function Virtual Const

FShadowMapIn...

 

GetShadowInteraction

(
    ERHIFeatureLevel::Type InFeatureLev...
)

Public function Virtual

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