UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FShadowMap Class Referenceabstract

#include <ShadowMap.h>

+ Inheritance diagram for FShadowMap:

Public Types

enum  { SMT_None = 0 , SMT_2D = 2 }
 

Public Member Functions

 FShadowMap ()
 
 FShadowMap (TArray< FGuid > InLightGuids)
 
virtual ~FShadowMap ()
 
bool ContainsLight (const FGuid &LightGuid) const
 
virtual void AddReferencedObjects (FReferenceCollector &Collector)
 
virtual ENGINE_API void Serialize (FArchive &Ar)
 
virtual FShadowMapInteraction GetInteraction () const =0
 
virtual FShadowMap2DGetShadowMap2D ()
 
virtual const FShadowMap2DGetShadowMap2D () const
 
void AddRef ()
 
void Release ()
 

Public Attributes

TArray< FGuidLightGuids
 

Protected Member Functions

virtual ENGINE_API void Cleanup ()
 

Detailed Description

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

Member Enumeration Documentation

◆ anonymous enum

Enumerator
SMT_None 
SMT_2D 

Constructor & Destructor Documentation

◆ FShadowMap() [1/2]

FShadowMap::FShadowMap ( )
inline

Default constructor.

◆ FShadowMap() [2/2]

FShadowMap::FShadowMap ( TArray< FGuid InLightGuids)
inline

◆ ~FShadowMap()

virtual FShadowMap::~FShadowMap ( )
inlinevirtual

Destructor.

Member Function Documentation

◆ AddRef()

void FShadowMap::AddRef ( )
inline

◆ AddReferencedObjects()

virtual void FShadowMap::AddReferencedObjects ( FReferenceCollector Collector)
inlinevirtual

Reimplemented in FShadowMap2D.

◆ Cleanup()

void FShadowMap::Cleanup ( )
protectedvirtual

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

◆ ContainsLight()

bool FShadowMap::ContainsLight ( const FGuid LightGuid) const
inline

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

Parameters
LightGuid- The GUID of the light to check for.
Returns
True if the light is stored in the light-map.

◆ GetInteraction()

virtual FShadowMapInteraction FShadowMap::GetInteraction ( ) const
pure virtual

Implemented in FShadowMap2D.

◆ GetShadowMap2D() [1/2]

virtual FShadowMap2D * FShadowMap::GetShadowMap2D ( )
inlinevirtual

Reimplemented in FShadowMap2D.

◆ GetShadowMap2D() [2/2]

virtual const FShadowMap2D * FShadowMap::GetShadowMap2D ( ) const
inlinevirtual

Reimplemented in FShadowMap2D.

◆ Release()

void FShadowMap::Release ( )
inline

◆ Serialize()

void FShadowMap::Serialize ( FArchive Ar)
virtual

Reimplemented in FShadowMap2D.

Member Data Documentation

◆ LightGuids

TArray<FGuid> FShadowMap::LightGuids

The GUIDs of lights which this shadow-map stores.


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