Navigation
API > API/Runtime > API/Runtime/Engine
The abstract base class of 1D and 2D light-maps.
| Name | FLightMap |
| Type | class |
| Header File | /Engine/Source/Runtime/Engine/Public/LightMap.h |
| Include Path | #include "LightMap.h" |
Syntax
class FLightMap : private FDeferredCleanupInterface
Inheritance Hierarchy
- FDeferredCleanupInterface → FLightMap
Derived Classes
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FLightMap() |
Default constructor. | LightMap.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FLightMap() |
Destructor. | LightMap.h |
Enums
Public
| Name | Remarks |
|---|---|
| FLightMap |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| LightGuids | TArray< FGuid > | The GUIDs of lights which this light-map stores. | LightMap.h |
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| NumRefs | int32 | LightMap.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void AddRef() |
Reference counting. | LightMap.h | |
virtual void AddReferencedObjects
(
FReferenceCollector& Collector |
LightMap.h | ||
bool AllowsHighQualityLightmaps() |
LightMap.h | ||
bool ContainsLight
(
const FGuid& LightGuid |
Checks if a light is stored in this light-map. | LightMap.h | |
FLightMapInteraction GetInteraction
(
ERHIFeatureLevel::Type InFeatureLevel |
LightMap.h | ||
virtual FLightMap2D * GetLightMap2D () |
Runtime type casting. | LightMap.h | |
virtual const FLightMap2D * GetLightMap2D () |
LightMap.h | ||
virtual FShadowMapInteraction GetShadowInteraction
(
ERHIFeatureLevel::Type InFeatureLevel |
LightMap.h | ||
void Release() |
LightMap.h | ||
virtual void Serialize
(
FArchive& Ar |
LightMap.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void Cleanup() |
Called when the light-map is no longer referenced. Should release the lightmap's resources. | LightMap.h |