FLightMap

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

Windows
MacOS
Linux

Inheritance Hierarchy

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

void

 

Release()

Public function Virtual

void

 

Serialize

(
    FArchive& Ar
)

Constants

Name

Description

LMT_1D

LMT_2D

LMT_None

References

Module

Engine

Header

Runtime/Engine/Public/LightMap.h

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback