FLightMap

The abstract base class of 1D and 2D light-maps.

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

Engine

Header

/Engine/Source/Runtime/Engine/Public/LightMap.h

Include

#include "LightMap.h"

Syntax

class FLightMap : private FDeferredCleanupInterface

Remarks

The abstract base class of 1D and 2D light-maps.

Variables

Name Description

Protected variable

bool

 

bAllowHighQualityLightMaps

Indicates whether the lightmap is being used for directional or simple lighting.

Public variable

TArray< FGuid >

 

LightGuids

The GUIDs of lights which this light-map stores.

Constructors

Name Description

Public function

FLightMap()

Default constructor.

Destructors

Name Description

Public function Virtual

~FLightMap()

Destructor.

Functions

Name Description

Public function

void

 

AddRef()

Reference counting.

Public function Virtual

void

 

AddReferencedObjects

(
    FReferenceCollector& Collector
)

Public function Const

bool

 

AllowsHighQualityLightmaps()

Protected function Virtual

void

 

Cleanup()

Called when the light-map is no longer referenced. Should release the lightmap's resources.

Public function Const

bool

 

ContainsLight

(
    const FGuid& LightGuid
)

Checks if a light is stored in this light-map.

Public function Const

FLightMapInt...

 

GetInteraction

(
    ERHIFeatureLevel::Type InFeatureLev...
)

Public function Virtual

FLightMap2D ...

 

GetLightMap2D()

Runtime type casting.

Public function Virtual Const

const FLight...

 

GetLightMap2D()

Public function Virtual Const

FShadowMapIn...

 

GetShadowInteraction

(
    ERHIFeatureLevel::Type InFeatureLev...
)

Public function

void

 

Release()

Public function Virtual

void

 

Serialize

(
    FArchive& Ar
)

Constants

Name

Description

LMT_1D

LMT_2D

LMT_None

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