UE::Landscape Namespace Reference

Namespaces
namespace	Culling
namespace	EditLayers
namespace	Grass
namespace	Nanite
namespace	Private

Classes
struct	FHeightmapTexel
struct	FNeighborSnapshots
class	FRDGBuilderRecorder
struct	FScratchRenderTargetParams
struct	FScratchRenderTargetScope

Typedefs
typedef EDirectionIndex	EEdgeIndex
typedef EDirectionFlags	EEdgeFlags
typedef EDirectionIndex	ENeighborIndex
typedef EDirectionFlags	ENeighborFlags

Enumerations
enum class	EDirectionIndex : uint8 {   Bottom = 0 , BottomRight = 1 , Right = 2 , TopRight = 3 ,   Top = 4 , TopLeft = 5 , Left = 6 , BottomLeft = 7 ,   First = 0 , Last = 7 , Count = 8 , FirstEdge = 0 ,   LastEdge = 6 , EdgeCount = 4 , FirstCorner = 1 , LastCorner = 7 ,   CornerCount = 4 }
enum class	EDirectionFlags : uint8 {   Bottom = 0x00000001 , BottomRight = 0x00000002 , Right = 0x00000004 , TopRight = 0x00000008 ,   Top = 0x00000010 , TopLeft = 0x00000020 , Left = 0x00000040 , BottomLeft = 0x00000080 ,   None = 0 , AllCorners = BottomRight | TopRight | TopLeft | BottomLeft , AllEdges = Bottom | Right | Top | Left , All = AllEdges | AllCorners }
enum class	EOutdatedDataFlags : uint8 {   None = 0 , GrassMaps = (1 << 0) , PhysicalMaterials = (1 << 1) , NaniteMeshes = (1 << 2) ,   PackageModified = (1 << 3) , LastPlusOne , Last = LastPlusOne - 1 , All = (GrassMaps | PhysicalMaterials | NaniteMeshes | PackageModified) }
enum class	EBuildFlags : uint8 { None = 0 , WriteFinalLog = (1 << 0) , ForceRebuild = (1 << 1) }

Functions
FIntPoint	GetNeighborRelativePosition (ENeighborIndex NeighborIndex)
ENeighborFlags	EdgesToAffectedNeighbors (EEdgeFlags LocalEdgeFlags)
EDirectionFlags	ToFlag (EDirectionIndex Index)
const FString &	GetDirectionString (EDirectionIndex Index)
LANDSCAPE_API bool	CanRenderGrassMap (ULandscapeComponent *Component)
LANDSCAPE_API bool	IsRuntimeGrassMapGenerationSupported ()
EDirectionIndex	GetOppositeIndex (EDirectionIndex Index)
bool	IsDiagonalCorner (EDirectionIndex DirectionIndex)
bool	IsTopOrBottomEdge (EEdgeIndex EdgeIndex)
bool	IsDoubleTriangleCorner (EEdgeIndex EdgeIndex)
EEdgeFlags	NeighborsToBlendedEdges (ENeighborFlags NeighborFlags)
EDirectionIndex	RotateDirection (EDirectionIndex NeighborIndex, int32 ClockwiseRotationOffset)
EDirectionFlags	RotateFlags (EDirectionFlags DirFlags, int32 ClockwiseRotationOffset)
void	GetSourceTextureEdgeStartCoord (EEdgeIndex EdgeIndex, int32 EdgeLength, int32 &OutStartX, int32 &OutStartY)
int32	GetSourceTextureEdgeStartStrideCount (EEdgeIndex EdgeIndex, int32 EdgeLength, int32 &OutStride, int32 &OutCount)
const TArrayView< const ENeighborIndex >	AllEdgeNeighbors ()
const TArrayView< const ENeighborIndex >	AllCornerNeighbors ()
int32	GetEdgeArrayMipOffset (int32 MipEdgeLength)
int32	GetEdgeDataSize (int32 EdgeLength)
uint32	ComputeGrassMapGenerationHash (const ULandscapeComponent *Component, UMaterialInterface *Material)
uint32	ComputeGrassInstanceGenerationHash (uint32 GrassMapGenerationHash, const TArray< TObjectPtr< ULandscapeGrassType > > &GrassTypes)
void	SubmitGPUCommands (bool bBlockUntilRTComplete, bool bBlockRTUntilGPUComplete)
bool	ShouldInstallEdgeFixup ()
bool	ShouldPatchStreamingMipEdges ()
bool	ShouldPatchAllLandscapeComponentEdges (bool bResetForNext)
bool	NeedsFixedGridVertexFactory (EShaderPlatform InShaderPlatform)
bool	ShouldBuildGrassMapRenderingResources ()
bool	DoesPlatformSupportEditLayers (EShaderPlatform InShaderPlatform)
void	ModifyShaderCompilerEnvironmentForDebug (FShaderCompilerEnvironment &OutEnvironment)
ELandscapeToolTargetTypeFlags	GetLandscapeToolTargetTypeAsFlags (ELandscapeToolTargetType InTargetType)
ELandscapeToolTargetType	GetLandscapeToolTargetTypeSingleFlagAsType (ELandscapeToolTargetTypeFlags InSingleFlag)
FString	GetLandscapeToolTargetTypeFlagsAsString (ELandscapeToolTargetTypeFlags InTargetTypeFlags)
bool	LandscapeProxySortPredicate (const TWeakObjectPtr< ALandscapeProxy > APtr, const TWeakObjectPtr< ALandscapeProxy > BPtr)
	ENUM_CLASS_FLAGS (EOutdatedDataFlags)
uint32	GetOutdatedDataFlagIndex (EOutdatedDataFlags InFlag)
	DECLARE_DELEGATE_RetVal_OneParam (FPrimitiveSceneProxy *, FCreateLandscapeComponentSceneProxyDelegate, ULandscapeComponent *)

Variables
int32	RenderCaptureNextMergeRenders = 0
int32	GInstallEdgeFixup = 1
int32	GPatchEdges = 1
int32	GPatchStreamingMipEdges = 1
int32	GForcePatchAllEdges = 0
int32	GAmortizedGroupValidation = 1
int32	NaniteExportCacheMaxQuadCount

Typedef Documentation

EEdgeFlags

typedef EDirectionFlags UE::Landscape::EEdgeFlags

EEdgeIndex

typedef EDirectionIndex UE::Landscape::EEdgeIndex

ENeighborFlags

typedef EDirectionFlags UE::Landscape::ENeighborFlags

ENeighborIndex

typedef EDirectionIndex UE::Landscape::ENeighborIndex

Enumeration Type Documentation

EBuildFlags

enum class UE::Landscape::EBuildFlags : uint8

strong

Enumerator
None
WriteFinalLog
ForceRebuild

EDirectionFlags

enum class UE::Landscape::EDirectionFlags : uint8

strong

Enumerator
Bottom
BottomRight
Right
TopRight
Top
TopLeft
Left
BottomLeft
None
AllCorners
AllEdges
All

EDirectionIndex

enum class UE::Landscape::EDirectionIndex : uint8

strong

Enumerator
Bottom
BottomRight
Right
TopRight
Top
TopLeft
Left
BottomLeft
First
Last
Count
FirstEdge
LastEdge
EdgeCount
FirstCorner
LastCorner
CornerCount

EOutdatedDataFlags

enum class UE::Landscape::EOutdatedDataFlags : uint8

strong

Enumerator
None
GrassMaps
PhysicalMaterials
NaniteMeshes
PackageModified
LastPlusOne
Last
All

Function Documentation

AllCornerNeighbors()

const TArrayView< const ENeighborIndex > UE::Landscape::AllCornerNeighbors

(

)

AllEdgeNeighbors()

const TArrayView< const ENeighborIndex > UE::Landscape::AllEdgeNeighbors

(

)

CanRenderGrassMap()

bool UE::Landscape::CanRenderGrassMap

(

ULandscapeComponent *

Component

)

ComputeGrassInstanceGenerationHash()

uint32 UE::Landscape::ComputeGrassInstanceGenerationHash	(	uint32	GrassMapGenerationHash,
		const TArray< TObjectPtr< ULandscapeGrassType > > &	GrassTypes
	)

ComputeGrassMapGenerationHash()

uint32 UE::Landscape::ComputeGrassMapGenerationHash	(	const ULandscapeComponent *	Component,
		UMaterialInterface *	Material
	)

DECLARE_DELEGATE_RetVal_OneParam()

UE::Landscape::DECLARE_DELEGATE_RetVal_OneParam	(	FPrimitiveSceneProxy *	,
		FCreateLandscapeComponentSceneProxyDelegate	,
		ULandscapeComponent *
	)

DoesPlatformSupportEditLayers()

LANDSCAPE_API bool UE::Landscape::DoesPlatformSupportEditLayers

(

EShaderPlatform

InShaderPlatform

)

Returns true if edit layers (GPU landscape tools) are enabled on this platform : Note: this is intended for the editor but is in runtime code since global shaders need to exist in runtime modules

EdgesToAffectedNeighbors()

ENeighborFlags UE::Landscape::EdgesToAffectedNeighbors

(

EEdgeFlags

LocalEdgeFlags

)

ENUM_CLASS_FLAGS()

UE::Landscape::ENUM_CLASS_FLAGS

(

EOutdatedDataFlags

)

GetDirectionString()

const FString & UE::Landscape::GetDirectionString

(

EDirectionIndex

Index

)

GetEdgeArrayMipOffset()

int32 UE::Landscape::GetEdgeArrayMipOffset

(

int32

MipEdgeLength

)

GetEdgeDataSize()

int32 UE::Landscape::GetEdgeDataSize

(

int32

EdgeLength

)

GetLandscapeToolTargetTypeAsFlags()

LANDSCAPE_API ELandscapeToolTargetTypeFlags UE::Landscape::GetLandscapeToolTargetTypeAsFlags

(

ELandscapeToolTargetType

InTargetType

)

GetLandscapeToolTargetTypeFlagsAsString()

LANDSCAPE_API FString UE::Landscape::GetLandscapeToolTargetTypeFlagsAsString

(

ELandscapeToolTargetTypeFlags

InTargetTypeFlags

)

GetLandscapeToolTargetTypeSingleFlagAsType()

LANDSCAPE_API ELandscapeToolTargetType UE::Landscape::GetLandscapeToolTargetTypeSingleFlagAsType

(

ELandscapeToolTargetTypeFlags

InSingleFlag

)

GetNeighborRelativePosition()

FIntPoint UE::Landscape::GetNeighborRelativePosition

(

ENeighborIndex

NeighborIndex

)

GetOppositeIndex()

EDirectionIndex UE::Landscape::GetOppositeIndex

(

EDirectionIndex

Index

)

GetOutdatedDataFlagIndex()

uint32 UE::Landscape::GetOutdatedDataFlagIndex ( EOutdatedDataFlags  InFlag )

inline

GetSourceTextureEdgeStartCoord()

void UE::Landscape::GetSourceTextureEdgeStartCoord	(	EEdgeIndex	EdgeIndex,
		int32	EdgeLength,
		int32 &	OutStartX,
		int32 &	OutStartY
	)

GetSourceTextureEdgeStartStrideCount()

int32 UE::Landscape::GetSourceTextureEdgeStartStrideCount	(	EEdgeIndex	EdgeIndex,
		int32	EdgeLength,
		int32 &	OutStride,
		int32 &	OutCount
	)

IsDiagonalCorner()

bool UE::Landscape::IsDiagonalCorner

(

EDirectionIndex

DirectionIndex

)

IsDoubleTriangleCorner()

bool UE::Landscape::IsDoubleTriangleCorner

(

EEdgeIndex

EdgeIndex

)

IsRuntimeGrassMapGenerationSupported()

bool UE::Landscape::IsRuntimeGrassMapGenerationSupported

(

)

IsTopOrBottomEdge()

bool UE::Landscape::IsTopOrBottomEdge

(

EEdgeIndex

EdgeIndex

)

LandscapeProxySortPredicate()

LANDSCAPE_API bool UE::Landscape::LandscapeProxySortPredicate	(	const TWeakObjectPtr< ALandscapeProxy >	APtr,
		const TWeakObjectPtr< ALandscapeProxy >	BPtr
	)

Helper to sort ALandscapeProxy actors by their section base. Compares X axis values by default and Y values if needed

ModifyShaderCompilerEnvironmentForDebug()

LANDSCAPE_API void UE::Landscape::ModifyShaderCompilerEnvironmentForDebug

(

FShaderCompilerEnvironment &

OutEnvironment

)

Provides an opportunity to modify the shader compiler environment (for landscape debugging purposes)

NeedsFixedGridVertexFactory()

bool UE::Landscape::NeedsFixedGridVertexFactory

(

EShaderPlatform

InShaderPlatform

)

NeighborsToBlendedEdges()

EEdgeFlags UE::Landscape::NeighborsToBlendedEdges

(

ENeighborFlags

NeighborFlags

)

RotateDirection()

EDirectionIndex UE::Landscape::RotateDirection	(	EDirectionIndex	NeighborIndex,
		int32	ClockwiseRotationOffset
	)

RotateFlags()

EDirectionFlags UE::Landscape::RotateFlags	(	EDirectionFlags	DirFlags,
		int32	ClockwiseRotationOffset
	)

ShouldBuildGrassMapRenderingResources()

bool UE::Landscape::ShouldBuildGrassMapRenderingResources

(

)

ShouldInstallEdgeFixup()

bool UE::Landscape::ShouldInstallEdgeFixup

(

)

ShouldPatchAllLandscapeComponentEdges()

bool UE::Landscape::ShouldPatchAllLandscapeComponentEdges

(

bool

bResetForNext

)

ShouldPatchStreamingMipEdges()

bool UE::Landscape::ShouldPatchStreamingMipEdges

(

)

SubmitGPUCommands()

void UE::Landscape::SubmitGPUCommands	(	bool	bBlockUntilRTComplete,
		bool	bBlockRTUntilGPUComplete
	)

ToFlag()

EDirectionFlags UE::Landscape::ToFlag

(

EDirectionIndex

Index

)

Variable Documentation

GAmortizedGroupValidation

int32 UE::Landscape::GAmortizedGroupValidation = 1

GForcePatchAllEdges

int32 UE::Landscape::GForcePatchAllEdges = 0

GInstallEdgeFixup

int32 UE::Landscape::GInstallEdgeFixup = 1

GPatchEdges

int32 UE::Landscape::GPatchEdges = 1

GPatchStreamingMipEdges

int32 UE::Landscape::GPatchStreamingMipEdges = 1

NaniteExportCacheMaxQuadCount

int32 UE::Landscape::NaniteExportCacheMaxQuadCount

extern

RenderCaptureNextMergeRenders

int32 UE::Landscape::RenderCaptureNextMergeRenders = 0