FLightMap Class Reference

#include <LightMap.h>

Inheritance diagram for FLightMap:

Public Types
enum	{ LMT_None = 0 , LMT_1D = 1 , LMT_2D = 2 }

Public Member Functions
ENGINE_API	FLightMap ()
virtual	~FLightMap ()
bool	ContainsLight (const FGuid &LightGuid) const
virtual void	AddReferencedObjects (FReferenceCollector &Collector)
virtual ENGINE_API void	Serialize (FArchive &Ar)
virtual FLightMapInteraction	GetInteraction (ERHIFeatureLevel::Type InFeatureLevel) const =0
virtual FShadowMapInteraction	GetShadowInteraction (ERHIFeatureLevel::Type InFeatureLevel) const
virtual FLightMap2D *	GetLightMap2D ()
virtual const FLightMap2D *	GetLightMap2D () const
void	AddRef ()
void	Release ()
bool	AllowsHighQualityLightmaps () const

Public Attributes
TArray< FGuid >	LightGuids

Protected Member Functions
virtual ENGINE_API void	Cleanup ()

Protected Attributes
bool	bAllowHighQualityLightMaps

Detailed Description

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

Member Enumeration Documentation

anonymous enum

anonymous enum

Enumerator
LMT_None
LMT_1D
LMT_2D

Constructor & Destructor Documentation

FLightMap()

FLightMap::FLightMap

(

)

Default constructor.

~FLightMap()

virtual FLightMap::~FLightMap ( )

inlinevirtual

Destructor.

Member Function Documentation

AddRef()

void FLightMap::AddRef ( )

inline

AddReferencedObjects()

virtual void FLightMap::AddReferencedObjects ( FReferenceCollector &  Collector )

inlinevirtual

Reimplemented in FLightMap2D.

AllowsHighQualityLightmaps()

bool FLightMap::AllowsHighQualityLightmaps ( ) const

inline

Returns

true if high quality lightmaps are allowed

Cleanup()

void FLightMap::Cleanup ( )

protectedvirtual

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

ContainsLight()

bool FLightMap::ContainsLight ( const FGuid &  LightGuid ) const

inline

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

Parameters

LightGuid

- The GUID of the light to check for.

Returns

True if the light is stored in the light-map.

GetInteraction()

virtual FLightMapInteraction FLightMap::GetInteraction ( ERHIFeatureLevel::Type  InFeatureLevel ) const

pure virtual

Implemented in FLightMap2D, and FLegacyLightMap1D.

GetLightMap2D() [1/2]

virtual FLightMap2D * FLightMap::GetLightMap2D ( )

inlinevirtual

Reimplemented in FLightMap2D.

GetLightMap2D() [2/2]

virtual const FLightMap2D * FLightMap::GetLightMap2D ( ) const

inlinevirtual

Reimplemented in FLightMap2D.

GetShadowInteraction()

virtual FShadowMapInteraction FLightMap::GetShadowInteraction ( ERHIFeatureLevel::Type  InFeatureLevel ) const

inlinevirtual

Reimplemented in FLightMap2D.

Release()

void FLightMap::Release ( )

inline

Serialize()

void FLightMap::Serialize ( FArchive &  Ar )

virtual

Reimplemented in FLightMap2D, and FLegacyLightMap1D.

Member Data Documentation

bAllowHighQualityLightMaps

bool FLightMap::bAllowHighQualityLightMaps

protected

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

LightGuids

TArray<FGuid> FLightMap::LightGuids

The GUIDs of lights which this light-map stores.

---

The documentation for this class was generated from the following files:

• Engine/Source/Runtime/Engine/Public/LightMap.h
• Engine/Source/Runtime/Engine/Private/LightMap.cpp