Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

Light Theme

Dark Theme

FShadowMap2D

Windows

MacOS

Linux

Inheritance Hierarchy

FDeferredCleanupInterface

FShadowMap

FShadowMap2D

References

Module	Engine
Header	/Engine/Source/Runtime/Engine/Public/ShadowMap.h
Include	#include "ShadowMap.h"

Syntax

class FShadowMap2D : public FShadowMap

Variables

	Name	Description
bool[4]	bChannelValid	Tracks which of the 4 channels has valid texture data.
FVector2D	CoordinateBias	The bias which is applied to the shadow-map coordinates before sampling the shadow-map textures.
FVector2D	CoordinateScale	The scale which is applied to the shadow-map coordinates before sampling the shadow-map textures.
FVector4	InvUniformPenumbraSize	Stores the inverse of the penumbra size, normalized.
UShadowMapTextu...	Texture	The texture which contains the shadow-map data.

Constructors

	Name	Description
	FShadowMap2D()
	FShadowMap2D ( const TMap< ULightComponent*, ... )
	FShadowMap2D ( TArray< FGuid > LightGuids )

Functions

	Name	Description
TRefCountPtr...	AllocateInstancedShadowMap ( UObject* LightMapOuter, UInstancedStaticMeshComponent..., TArray< TMap< ULightComponent..., UMapBuildDataRegistry* Registr..., FGuid MapBuildDataId, const FBoxSphereBounds& Bounds, ELightMapPaddingType PaddingType, EShadowMapFlags ShadowmapFlags )	Allocates texture space for the shadow-map and stores the shadow-map's raw data for deferred encoding.
TRefCountPtr...	AllocateShadowMap ( UObject* LightMapOuter, const TMap< ULightComponent*, ..., const FBoxSphereBounds& Bounds, ELightMapPaddingType InPaddingType, EShadowMapFlags InShadowmapFlags )
int32	EncodeSingleTexture ( ULevel* LightingScenario, FShadowMapPendingTexture& PendingT..., UShadowMapTexture2D* Texture, TArray< TArray< FFourDistanceFieldS... )	Constructs mip maps for a single shadowmap texture.
void	EncodeTextures ( UWorld* InWorld, ULevel* LightingScenario, bool bLightingSuccessful, bool bMultithreadedEncode )	Executes all pending shadow-map encoding requests.
const FVecto...	GetCoordinateBias()
const FVecto...	GetCoordinateScale()
bool	GetStatusUpdate()
const UTextu...	GetTexture()	Accessors.
UTexture2D &...	GetTexture()	Accessors.
bool	IsShadowFactorTexture()
bool	IsValid()
void	SetStatusUpdate ( bool bInEnable )	Call to enable/disable status update of LightMap encoding

Overridden from FShadowMap

	Name	Description
void	AddReferencedObjects ( FReferenceCollector& Collector )
FShadowMapIn...	GetInteraction()
const FShado...	GetShadowMap2D()
FShadowMap2D...	GetShadowMap2D()	Runtime type casting.
void	Serialize ( FArchive& Ar )

Constants

Name	Description
bUpdateStatus	If true, update the status when encoding light maps

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

Take our survey

Dismiss