1. Epic GamesDeveloper
  3. Landscape

Landscape

API > API/Runtime

Filters

Classes

  Type Name Description
Public class UClass ConversionRoot, MinimalAPI NotPlaceable, ShowCategories, HideCategories, Meta componentwrapperclass AControlPointMeshActor ControlPointMeshActor is an actor with a ControlPointMeshComponent.  
Public class UClass MinimalAPI ShowCategories, HideCategories ALandscape    
Public class UClass Abstract, MinimalAPI notblueprintable ALandscapeBlueprintBrushBase    
Public class UClass MinimalAPI NotPlaceable ALandscapeGizmoActiveActor    
Public class UClass MinimalAPI NotPlaceable notblueprintable ALandscapeGizmoActor    
Public class UClass MinimalAPI ALandscapeMeshProxyActor    
Public class UClass Abstract, MinimalAPI NotPlaceable, ShowCategories, HideCategories notblueprintable ALandscapeProxy    
Public class UClass MinimalAPI NotPlaceable, HideCategories notblueprintable ALandscapeSplineActor    
Public class UClass ConversionRoot, MinimalAPI NotPlaceable, ShowCategories, HideCategories, Meta componentwrapperclass, notblueprintable ALandscapeSplineMeshesActor This class is only intended to be used by UWorldPartitionLandscapeSplineMeshesBuilder which extracts and clones landscape spline and control point static meshes into partitioned actors  
Public class UClass MinimalAPI NotPlaceable ALandscapeStreamingProxy    
Public struct FAlphamapAccessor FAlphamapAccessor  
Public struct FAsyncBuildData Context for an Async Static Mesh (nanite) build.  
Public struct FAsyncComponentData Copy of Component level data required to generate Nanite asynchronously.  
Public class FAsyncGrassTask    
Public struct FAsyncWorkMonitor Tracks delayed updates triggered by landscape updates.  
Public class FBatchTextureCopy    
Public struct FCachedLandscapeFoliage    
Public struct FComponentMergeRenderInfo Utility struct for attaching some information that pertains to a given landscape component in the context of a batch render  
Public struct FEditLayerRendererState FEditLayerRendererState describes the entire state of an edit layer renderer : what it is capable of doing (SupportedTargetTypeState, immutable) and what it is currently doing (EnabledTargetTypeState, mutable) These states are provided by IEditLayerRendererProvider in order to describe both what the renderer can do and what it currently does by default.  
Public class FEditLayerRenderItem Each edit layer render item represents the capabilities of what a given edit layer can render in terms of landscape data : a renderer can provide one or many render items, which contain the "locality" (what area do I affect?) as well as the "capability" (what target tool type do I affect? what weightmap(s)?) information related to what this layer item can do.  
Public struct FEditLayerTargetTypeState FEditLayerTargetTypeState fully describes the state of an edit layer renderer wrt its target types.  
Public struct UStruct FForeignControlPointData Structs for ForeignWorldSplineDataMap these are editor-only, but we don't have the concept of an editor-only USTRUCT  
Public struct UStruct FForeignSplineSegmentData    
Public struct UStruct FForeignWorldSplineData    
Public struct UStruct FGizmoSelectData    
Public struct UStruct BlueprintType FGrassVariety    
Public struct FHeightmapAccessor FHeightmapAccessor  
Public struct UStruct notblueprintable FHeightmapData    
Public class FInputWorldArea Describes the input area needed for a given edit layer renderer's render item: this allows to infer the dependency between each component being rendered and the components it depends on  
Public struct FLandscapeAddCollision Structure storing Collision for LandscapeComponent Add  
Public struct UStruct BlueprintType FLandscapeBrushParameters    
Public struct FLandscapeComponentDataInterface    
Public struct FLandscapeComponentDataInterfaceBase    
Public struct FLandscapeComponentGrassData    
Public class FLandscapeComponentSceneProxy FLandscapeComponentSceneProxy  
Public struct FLandscapeConfig    
Public struct FLandscapeConfigChange    
Public class FLandscapeConfigHelper    
Public struct FLandscapeDataInterface    
Public class FLandscapeDebugMaterialRenderProxy    
Public struct FLandscapeDebugOptions FLandscapeDebugOptions  
Public struct FLandscapeDirtyOnlyInModeScope    
Public struct FLandscapeDoNotDirtyScope    
Public struct FLandscapeEditDataInterface    
Public struct UStruct FLandscapeEditToolRenderData FLandscapeEditToolRenderData  
Public class FLandscapeElementParamArray    
Public class FLandscapeFixedGridVertexFactory Vertex factory for fixed grid runtime virtual texture lod  
Public struct UStruct FLandscapeImportLayerInfo Structure storing Layer Data for import  
Public struct UStruct FLandscapeInfoLayerSettings    
Public struct UStruct FLandscapeLayer    
Public struct UStruct FLandscapeLayerBrush    
Public struct UStruct notblueprintable FLandscapeLayerComponentData    
Public class FLandscapeLayerUsageRenderProxy    
Public class FLandscapeLODOverridesCustomRenderPassUserData FLandscapeLODOverridesCustomRenderPassUserData  
Public class FLandscapeMaskMaterialRenderProxy    
Public struct UStruct FLandscapeMaterialTextureStreamingInfo    
Public class FLandscapeMeshProxySceneProxy FLandscapeMeshProxySceneProxy  
Public struct FLandscapeNotification    
Public class FLandscapeNotificationManager FLandscapeNotificationManager : centralizes landscape-related user notifications so that the user doesn't get flooded by toasts when multiple messages from possibly multiple landscapes are tossed around  
Public struct UStruct notblueprintable FLandscapePerLODMaterialOverride    
Public class FLandscapePhysicalMaterialBuilder Helper class used to Build or monitor Landscape Physical Material  
Public class FLandscapePhysicalMaterialRenderTask A single task for calculating the landscape physical material.  
Public class FLandscapeProxyComponentDataChangedParams Helper class to store proxy changes information  
Public struct FLandscapeRenderSystem FLandscapeRenderSystem  
Public class FLandscapeSceneViewExtension FLandscapeSceneViewExtension  
Public class FLandscapeSectionInfo FLandscapeSectionInfo  
Public class FLandscapeSelectMaterialRenderProxy    
Public class FLandscapeSharedBuffers FLandscapeSharedBuffers  
Public struct UStruct FLandscapeSplineConnection    
Public struct UStruct FLandscapeSplineInterpPoint    
Public struct UStruct FLandscapeSplineMeshEntry    
Public struct UStruct FLandscapeSplineSegmentConnection    
Public class FLandscapeStaticLightingGlobalVolumeMapping    
Public class FLandscapeStaticLightingMesh Represents the triangles of a Landscape component to the static lighting system.  
Public class FLandscapeStaticLightingTextureMapping A texture mapping for landscapes  
Public struct UStruct FLandscapeTargetLayerSettings    
Public struct UStruct FLandscapeTexture2DMipMap    
Public struct FLandscapeTextureDataInfo    
Public struct FLandscapeTextureDataInterface    
Public class FLandscapeTextureStorageMipProvider    
Public struct FLandscapeVertex    
Public class FLandscapeVertexBuffer FLandscapeVertexBuffer  
Public class FLandscapeVertexFactory Vertex factory for VTF-heightmap terrain  
Public class FLandscapeVertexFactoryPixelShaderParameters Pixel shader parameters for use with FLandscapeVertexFactory  
Public class FLandscapeVertexFactoryVertexShaderParameters    
Public struct FLandscapeVertexRef Used to uniquely reference a landscape vertex in a component.  
Public class FLandscapeVisibilityHelper FLandscapeVisibilityHelper  
Public class FLandscapeXYOffsetVertexFactory Vertex factory for VTF-heightmap terrain  
Public struct FLayerInfoFinder    
Public struct FMergeRenderBatch Defines an individual render batch when merging the landscape.  
Public class FMergeRenderContext Utility class that contains everything necessary to perform the batched merge : scratch render targets, list of batches, etc.  
Public struct FMergeRenderParams Params struct passed to the merge function.  
Public struct FMergeRenderStep Defines an individual render step of the batch merge  
Public struct FOnHeightmapStreamedContext    
Public struct FOnLandscapeEditLayersMergedParams TODO [jonathan.bard] : When global merge is a thing of the past, we should pass FOnRenderBatchTargetGroupDoneParams here, or extract some of its higher-level information, because there is a lot more useful information accessible in there (components being rendered, target layers, validity render targets, etc.)  
Public struct FOnLandscapeProxyFixupSharedDataParams    
Public struct FOOBox2D TODO [jonathan.bard] : use FOrientedBox2d instead?  
Public class FOutputWorldArea Describes the output area needed where a given edit layer renderer's render item writes: this allows to define the components of landscape that need to be processed and allows to divide the work into batches  
Public class FScopedSetLandscapeEditingLayer    
Public struct FScratchRenderTargetParams    
Public struct FScratchRenderTargetScope    
Public struct FTextureCopyChannelMapping Represents the DestinationChannel->SourceChannel binding.DestinationChannel is used as index.  
Public struct FTextureCopyRequest    
Public struct UStruct notblueprintable FWeightmapData    
Public struct UStruct FWeightmapLayerAllocationInfo Stores information about which weightmap texture and channel each layer is stored  
Public struct FWeightmapPaintLayerInfo Must match FWeightmapPaintLayerInfo in LandscapeLayersWeightmapsPS.usf / LandscapeEditLayersWeightmaps.usf.  
Public struct HLandscapeSplineProxy    
Public struct HLandscapeSplineProxy_ControlPoint    
Public struct HLandscapeSplineProxy_Segment    
Public struct HLandscapeSplineProxy_Tangent    
Public struct IBuffer2DView    
Public class IEditLayerRendererProvider Interface to implement to be able to provide an ordered list of renderers to the landscape.  
Public class ILandscapeBrushRenderCallAdapter_GlobalMergeLegacySupport Interface that allows an edit layer UObject to receive a render call the way that a blueprint brush would in global merge mode, so that an edit layer UObject that implements custom batched merge functions can still perform its work if global merge mode is used instead.  
Public class ILandscapeEditLayerRenderer Interface that needs to be implemented for anything that can render heightmap/weightmap/visibility when merging landscape edit layers.  
Public class ILandscapeEditorServices    
Public class ILandscapeEdModeInterface Landscape EdMode Interface (used by ALandscape in Editor mode to access EdMode properties)  
Public class ILandscapeModule Landscape module interface  
Public class ILandscapeSplineInterface    
Public class UClass MinimalAPI UControlPointMeshComponent    
Public class ULandscapeBrushRenderCallAdapter_GlobalMergeLegacySupport    
Public class UClass MinimalAPI ShowCategories, HideCategories within ULandscapeComponent    
Public class UClass MinimalAPI ULandscapeEditLayer This is the standard type of edit layer.  
Public class UClass Abstract, MinimalAPI ULandscapeEditLayerBase Base class for all landscape edit layers.  
Public class UClass Abstract, MinimalAPI ULandscapeEditLayerPersistent Base class for persistent layers, i.e. layers that have a set of backing textures (heightmaps, weightmaps) and can therefore be rendered in a similar fashion  
Public class UClass Abstract, MinimalAPI ULandscapeEditLayerProcedural Base class for procedural layers. Procedural layers cannot be edited through standard editing tools  
Public class ULandscapeEditLayerRenderer UInterface for a landscape edit layer renderer  
Public class UClass MinimalAPI ULandscapeEditLayerSplines Procedural edit layer that lets the user manipulate its content using landscape splines (Splines tool in the Manage panel)  
Public class UClass ULandscapeEditResourcesSubsystem ULandscapeEditResourcesSubsystem provides services to manage/pool render resources used by the landscape tools, across landscape actors, in order to minimize memory consumption  
Public class UClass HideCategories ULandscapeGizmoRenderComponent    
Public class UClass MinimalAPI BlueprintType ULandscapeGrassType    
Public class UClass MinimalAPI within ULandscapeHeightfieldCollisionComponent    
Public class UClass MinimalAPI hidedropdown ULandscapeHLODBuilder    
Public class UClass Transient ULandscapeInfo    
Public class UClass ULandscapeInfoMap    
Public class UClass MinimalAPI BlueprintType ULandscapeLayerInfoObject    
Public class UClass MinimalAPI ULandscapeLODStreamingProxy_DEPRECATED    
Public class UClass MinimalAPI ULandscapeMaterialInstanceConstant    
Public class UClass ULandscapeMeshCollisionComponent    
Public class UClass MinimalAPI ULandscapeMeshProxyComponent    
Public class UClass MinimalAPI ShowCategories, HideCategories within ULandscapeNaniteComponent    
Public class UClass Transient ULandscapeScratchRenderTarget ULandscapeScratchRenderTarget holds a UTextureRenderTarget2D.  
Public class UClass MinimalAPI Meta Config defaultconfig ULandscapeSettings    
Public class UClass MinimalAPI AutoExpandCategories within ULandscapeSplineControlPoint    
Public class ULandscapeSplineInterface    
Public class UClass MinimalAPI ULandscapeSplinesComponent ULandscapeSplinesComponent.  
Public class UClass MinimalAPI AutoExpandCategories within ULandscapeSplineSegment    
Public class UClass MinimalAPI ULandscapeSubsystem    
Public class UClass MinimalAPI ULandscapeTextureStorageProviderFactory    
Public class UClass MinimalAPI notblueprintable ULandscapeWeightmapUsage    

Constants

Name Description
DefaultSplineHash  

Typedefs

Name Description
FOnHeightmapStreamedDelegate  
FOnLandscapeProxyComponentDataChanged  
FOnLandscapeProxyFixupSharedDataDelegate  

Enums

  Type Name Description
Public enum UEnum EGrassScaling    
Public enum EHeightfieldSource    
Public enum UEnum EHeightmapRTType    
Public enum UEnum ELandscapeBlendMode    
Public enum UEnum ELandscapeClearMode TODO [jonathan.bard] : Deprecate : this is now kinda redundant with ELandscapeToolTargetType.  
Public enum ELandscapeComponentUpdateFlag    
Public enum UEnum ELandscapeDirtyingMode    
Public enum ELandscapeEditLayersMergeMode    
Public enum ELandscapeEditRenderMode::Type    
Public enum UEnum ELandscapeGizmoSnapType    
Public enum UEnum ELandscapeGizmoType    
Public enum UEnum ELandscapeHLODMeshSourceLODPolicy    
Public enum UEnum ELandscapeHLODTextureSizePolicy    
Public enum UEnum ELandscapeImportAlphamapType    
Public enum UEnum ELandscapeLayerDisplayMode    
Public enum UEnum ELandscapeLayerPaintingRestriction This is only here because putting it in LandscapeEditorObject.h (where it belongs) results in Engine being dependent on LandscapeEditor, as the actual landscape editing code (e.g. LandscapeEdit.h) is in /Engine/ for some reason...  
Public enum ELandscapeLayerUpdateMode    
Public enum UEnum ELandscapeLODFalloff::Type    
Public enum ELandscapeNotificationType The various types of landscape notifications, ordered by priority (a single notification is displayed at a time).  
Public enum UEnum ELandscapeResizeMode    
Public enum UEnum ELandscapeToolTargetType    
Public enum ELandscapeToolTargetTypeFlags    
Public enum ELandscapeViewMode::Type    
Public enum UEnum ERTDrawingType    
Public enum UEnum ESplineModulationColorMask    
Public enum UEnum EWeightmapRTType    
Public enum UEnum LandscapeSplineMeshOrientation Deprecated.  
Public enum UE::Landscape::EditLayers::EWeightmapBlendMode Must match EEditLayerWeightmapBlendMode in LandscapeLayersWeightmapsPS.usf / LandscapeEditLayersWeightmapsPS.usf.  
Public enum UE::Landscape::EditLayers::EWeightmapPaintLayerFlags Must match EWeightmapPaintLayerFlags in LandscapeLayersWeightmapsPS.usf / LandscapeEditLayersWeightmapsPS.usf.  
Public enum UE::Landscape::EOutdatedDataFlags    

Functions

  Type Name Description
Public function  

BEGIN_GLOBAL_SHADER_PARAMETER_STRUCT ( FLandscapeSectionLODUniformParameters,
LANDSCAPE_API
)

  
Public function  

BEGIN_GLOBAL_SHADER_PARAMETER_STRUCT ( FLandscapeUniformShaderParameters,
LANDSCAPE_API
)

 The uniform shader parameters for a landscape draw call.
Public function  

DEFINE_ACTORDESC_TYPE ( ALandscapeProxy,
FLandscapeActorDesc
)

  
Public function    
Public function    
Public function void

FillCornerValues ( uint8& CornerSet,
T* CornerValues
)

 Helper functions.
Public function    
Public function  

FLandscapeEditorLayerSettings ( ULandscapeLayerInfoObject* InLayerInfo,
const FString& InFilePath
)

  
Public function uint32  
Public function float  
Public function uint16  
Public function FColor  
Public function float

LandscapeDataAccess::UnpackHeight ( const FColor& InHeightmapSample
)

  
Public function FVector

LandscapeDataAccess::UnpackNormal ( const FColor& InHeightmapSample
)

  
Public function Const bool

operator== ( const ULandscapeLayerInfoObject* LayerInfo
)

 To allow FindByKey etc.
Public function LandscapeIndex Size LANDSCAPE_API

SHADER_PARAMETER ( FVector4f,
LodValues
)

 Data needed for the landscape vertex factory to set the render state for an individual batch element
Public function LandscapeIndex

SHADER_PARAMETER ( FIntPoint,
Min
)

  
Public function ComponentBaseX SubsectionSizeVerts LastLOD InvLODBlendRange HeightmapTextureSize WeightmapUVScaleBia...

SHADER_PARAMETER ( FIntPoint,
SubXY
)

  
Public function ComponentBaseX SubsectionSizeVerts LastLOD InvLODBlendRange HeightmapTextureSize WeightmapUVScaleBia...

SHADER_PARAMETER ( FMatrix44f,
LocalToWorldNoScaling
)

  
Public function ComponentBaseX SubsectionSizeVerts LastLOD InvLODBlendRange HeightmapTextureSize WeightmapUVScaleBia...

SHADER_PARAMETER ( FVector4f,
SubsectionOffsetParams
)

  
Public function ComponentBaseX SubsectionSizeVerts LastLOD InvLODBlendRange HeightmapTextureSize WeightmapUVScaleBia...

SHADER_PARAMETER ( FVector4f,
LandscapeLightmapScaleBias
)

  
Public function ComponentBaseX SubsectionSizeVerts LastLOD InvLODBlendRange HeightmapTextureSize

SHADER_PARAMETER ( FVector4f,
HeightmapUVScaleBias
)

  
Public function ComponentBaseX SubsectionSizeVerts LastLOD InvLODBlendRange

SHADER_PARAMETER ( float,
NonNaniteVirtualShadowMapConstantDepthBias
)

  
Public function ComponentBaseX SubsectionSizeVerts

SHADER_PARAMETER ( int32,
NumSubsections
)

  
Public function ComponentBaseX

SHADER_PARAMETER ( int32,
ComponentBaseY
)

  
Public function ComponentBaseX SubsectionSizeVerts LastLOD

SHADER_PARAMETER ( uint32,
VirtualTexturePerPixelHeight
)

  
Public function ComponentBaseX SubsectionSizeVerts LastLOD InvLODBlendRange HeightmapTextureSize WeightmapUVScaleBia...

SHADER_PARAMETER_SAMPLER ( SamplerState,
HeightmapTextureSampler
)

  
Public function ComponentBaseX SubsectionSizeVerts LastLOD InvLODBlendRange HeightmapTextureSize WeightmapUVScaleBia...

SHADER_PARAMETER_SAMPLER ( SamplerState,
NormalmapTextureSampler
)

  
Public function ComponentBaseX SubsectionSizeVerts LastLOD InvLODBlendRange HeightmapTextureSize WeightmapUVScaleBia...

SHADER_PARAMETER_SAMPLER ( SamplerState,
XYOffsetmapTextureSampler
)

  
Public function LandscapeIndex Size

SHADER_PARAMETER_SRV ( Buffer< float >,
SectionLODBias
)

  
Public function FString

UE::Landscape::EditLayers::ConvertTargetLayerNamesToString ( const TArrayView< const FName >& InTargetLayerNames
)

  
Public function    
Public function    
Public function uint32  
Public function struct

UE_DEPRECATED ( all,
"FLandscapeComponentMaterialOverride is deprecated; please use FLandscapePerLODMaterialOverride inst...
)

  
Public function struct

UE_DEPRECATED ( all,
"FLandscapeProxyMaterialOverride is deprecated; please use FLandscapePerLODMaterialOverride instead"
)

  

Variables

  Type Name Description
Public variable TAutoConsoleVariable< int32 > CVarLandscapeSplineFalloffModulation  
Public variable TObjectPtr< UMaterialInterface > GColorMaskRegionMaterial  
Public variable int32 GGrassMapUseRuntimeGeneration  
Public variable TObjectPtr< UTexture2D > GLandscapeBlackTexture  
Public variable FLandscapeDebugOptions GLandscapeDebugOptions  
Public variable TObjectPtr< UMaterialInterface > GLandscapeDirtyMaterial  
Public variable bool GLandscapeEditModeActive  
Public variable bool GLandscapeEditModeActive  
Public variable int32 GLandscapeEditRenderMode  
Public variable TObjectPtr< UMaterialInterface > GLandscapeLayerUsageMaterial  
Public variable int32 GLandscapeViewMode  
Public variable TObjectPtr< UMaterialInterface > GLayerDebugColorMaterial  
Public variable TObjectPtr< UMaterialInterface > GMaskRegionMaterial  
Public variable TObjectPtr< UMaterialInterface > GSelectionColorMaterial  
Public variable TObjectPtr< UMaterialInterface > GSelectionRegionMaterial  
Public variable int32 MaxValue  
Public variable float MidValue  
Public variable UProperty FString ReimportLayerFilePath  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page