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

> Unreal Engine API Reference > Runtime > Landscape > FLandscapeComponentSceneProxy

Light Theme

Dark Theme

FLandscapeComponentSceneProxy

[FLandscapeComponentSceneProxy](API\Runtime\Landscape\FLandscapeComponentSceneProxy)

Windows

MacOS

Linux

Inheritance Hierarchy

FPrimitiveSceneProxy

FLandscapeNeighborInfo

FLandscapeComponentSceneProxy

FLandscapeComponentSceneProxyMobile

References

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

Syntax

class FLandscapeComponentSceneProxy :
public FPrimitiveSceneProxy,
public FLandscapeNeighborInfo

Remarks

FLandscapeComponentSceneProxy

Variables

	Name	Description
TArray< UMateri...	AvailableMaterials	All available materials for non mobile, including LOD Material, Tessellation generated materials
UTexture2D *...	BaseColorForGITexture
uint8	BlendableLayerMask
bool: 1	bRequiresAdjacencyInformation
int32	CollisionMipLevel	Data used in editor or visualisers
FCollisionRespo...	CollisionResponse
TUniquePtr< FLa...	ComponentLightInfo
float	ComponentMaxExtend
int32	ComponentSizeQuads	Size of the component in unique heights.
int32	ComponentSizeVerts	ComponentSizeQuads + 1.
float	ComponentSquaredScreenSizeToUseSubSections
FLandscapeEditT...	EditToolRenderData
int32	FirstLOD
int32	FirstVirtualTextureLOD
FLandscapeVerte...	FixedGridVertexFactory
friend	FLandscapeRenderSystem
TArray< FLandsc...	GrassBatchParams
FMeshBatch	GrassMeshBatch	Precomputed grass rendering MeshBatch and per-LOD params.
FVector4	HeightmapScaleBias
float	HeightmapSubsectionOffsetU
float	HeightmapSubsectionOffsetV
const ULandscap...	LandscapeComponent
TArray< TUnifor...	LandscapeFixedGridUniformShaderParameters
TUniformBuffer<...	LandscapeUniformShaderParameters
int32	LastLOD
int32	LastVirtualTextureLOD
TArray< FLinear...	LayerColors
int32	LightMapResolution	LightMap resolution used for VMI_LightmapDensity
FMatrix	LocalToWorldNoScaling
TArray< int8 >	LODIndexToMaterialIndex	Mapping between LOD and Material Index
TArray< float >	LODScreenRatioSquared
FLandscapeRende...	LODSettings
TBitArray	MaterialHasTessellationEnabled	A cache to know if the material stored in AvailableMaterials[X] has tessellation enabled
TArray< int8 >	MaterialIndexToDisabledTessellationMaterial	Mapping between Material Index to associated generated disabled Tessellation Material
TArray< int8 >	MaterialIndexToStaticMeshBatchLOD	Mapping between Material Index to Static Mesh Batch
TArray< FMateri...	MaterialRelevances	Material Relevance for each material in AvailableMaterials
int8	MaxLOD
float	MaxValidLOD
float	MinValidLOD
UTexture2D *...	NormalmapTexture
int32	NumSubsections	Number of subsections within the component in each dimension, this can be 1 or 2.
int8	NumWeightmapLayerAllocations
FIntPoint	SectionBase	Address of the component within the parent Landscape in unique height texels.
FLandscapeShare...	SharedBuffers
uint32	SharedBuffersKey
int32	SimpleCollisionMipLevel
TArray< FLandsc...	StaticBatchParamArray	Storage for static draw list batch params.
uint8	StaticLightingLOD
float	StaticLightingResolution
TArray< FVector...	SubSectionScreenSizeTestingPosition
int32	SubsectionSizeQuads	Number of unique heights in the subsection.
int32	SubsectionSizeVerts	Number of heightmap heights in the subsection. This includes the duplicate row at the end.
float	TessellationComponentScreenSizeFalloff
float	TessellationComponentSquaredScreenSize
bool: 1	UseTessellationComponentScreenSizeFalloff
FLandscapeVerte...	VertexFactory
int32	VisibilityWeightmapChannel
UTexture2D *...	VisibilityWeightmapTexture
FVector4	WeightmapScaleBias
float	WeightmapSubsectionOffset
TArray< UTextur...	WeightmapTextures
FMatrix	WorldToLocal	Cached versions of these.
UTexture2D *...	XYOffsetmapTexture

Constructors

	Name	Description
	FLandscapeComponentSceneProxy ( ULandscapeComponent* InCompone... )	Constructor

Destructors

	Name	Description
	~FLandscapeComponentSceneProxy()

Functions

	Name	Description
void	ApplyMeshElementModifier ( FMeshBatchElement& InOutMeshElemen..., int32 InLodIndex )
void	BuildDynamicMeshElement ( const FViewCustomDataLOD* InPr..., bool InToolMesh, bool InHasTessellation, bool InDisableTessellation, FMeshBatch& OutMeshBatch, TArray< FLandscapeBatchElementParam... )
void	CalculateBatchElementLOD ( const FSceneView& InView, float InMeshScreenSizeSquared, float InViewLODScale, FViewCustomDataLOD& InOutLODData, bool InForceCombined )
void	CalculateLODFromScreenSize ( const FSceneView& InView, float InMeshScreenSizeSquared, float InViewLODScale, int32 InSubSectionIndex, FViewCustomDataLOD& InOutLODData )
bool	CanUseMeshBatchForShadowCascade ( int8 InLODIndex, float InShadowMapTextureResolution, float InShadowMapCascadeSize )
void	ChangeComponentScreenSizeToUseSubSections_RenderThread ( float InComponentScreenSizeToUseSub... )
void	ChangeTessellationComponentScreenSize_RenderThread ( float InTessellationComponentScreen... )	FLandcapeSceneProxy.
void	ChangeTessellationComponentScreenSizeFalloff_RenderThread ( float InTessellationComponentScreen... )
void	ChangeUseTessellationComponentScreenSizeFalloff_RenderThread ( bool InUseTessellationComponentScre... )
float	ComputeBatchElementCurrentLOD ( int32 InSelectedLODIndex, float InComponentScreenSize, float InViewLODScale )
void	ComputeStaticBatchIndexToRender ( FViewCustomDataLOD& OutLODData, int32 InSubSectionIndex )
void	ComputeTessellationFalloffShaderValues ( const FViewCustomDataLOD& InLODDat..., const FMatrix& InViewProjectionMat..., float& OutC, float& OutK )
int32	ConvertBatchElementLODToBatchElementIndex ( int8 InBatchElementLOD, bool InUseCombinedMeshBatch )
float	GetComponentScreenSize ( const FSceneView* View, const FVector& Origin, float MaxExtend, float ElementRadius )
const FMeshB...	GetGrassMeshBatch()
int8	GetLODFromScreenSize ( float InScreenSizeSquared, float InViewLODScale )
bool	GetMeshElement ( bool UseSeperateBatchForShadow, bool ShadowOnly, bool HasTessellation, int8 InLODIndex, UMaterialInterface* InMaterial..., FMeshBatch& OutMeshBatch, TArray< FLandscapeBatchElementParam... )
bool	GetMeshElementForVirtualTexture ( int32 InLodIndex, ERuntimeVirtualTextureMaterialType ..., UMaterialInterface* InMaterial..., FMeshBatch& OutMeshBatch, TArray< FLandscapeBatchElementParam... )	Creates a mesh batch for virtual texture rendering.
float	GetNeighborLOD ( const FSceneView& InView, float InBatchElementCurrentLOD, int8 InNeighborIndex, int8 InSubSectionX, int8 InSubSectionY, int8 InCurrentSubSectionIndex )
void	GetShaderCurrentNeighborLOD ( const FSceneView& InView, float InBatchElementCurrentLOD, int8 InSubSectionX, int8 InSubSectionY, int8 InCurrentSubSectionIndex, FVector4& OutShaderCurrentNeighbor... )
FVector4	GetShaderLODBias()
FVector4	GetShaderLODValues ( int8 BatchElementCurrentLOD )
uint64	GetStaticBatchElementVisibility ( const FSceneView& InView, const FMeshBatch* InBatch, const void* InViewCustomData )
bool	GetStaticMeshElement ( int32 LODIndex, bool bForToolMesh, bool bForcedLOD, FMeshBatch& MeshBatch, ArrayType& OutStaticBatchParamArra... )

Overridden from FPrimitiveSceneProxy

	Name	Description
void	ApplyWorldOffset ( FVector InOffset )	Shifts primitive position and all relevant data by an arbitrary delta.
bool	CanBeOccluded()
int32	CollectOccluderElements ( FOccluderElementsCollector& Collec... )	Collects occluder geometry for software occlusion culling
void	CreateRenderThreadResources()	Called when the rendering thread adds the proxy to the scene.
void	DestroyRenderThreadResources()	Called when the rendering thread removes the proxy from the scene.
void	DrawStaticElements ( FStaticPrimitiveDrawInterface*... )	Draws the primitive's static elements.
void	GetDynamicMeshElements ( const TArray< const FSceneView*..., const FSceneViewFamily& ViewFamily, uint32 VisibilityMap, FMeshElementCollector& Collector )	Gathers the primitive's dynamic mesh elements.
void	GetHeightfieldRepresentation ( UTexture2D& OutHeightmapTextu..., UTexture2D& OutDiffuseColorTe..., UTexture2D*& OutVisibilityText..., FHeightfieldComponentDescription& ... )
void	GetLCIs ( FLCIArray& LCIs )
int32	GetLightMapResolution()	Get the lightmap resolution for this primitive. Used in VMI_LightmapDensity.
void	GetLightRelevance ( const FLightSceneProxy* LightS..., bool& bDynamic, bool& bRelevant, bool& bLightMapped, bool& bShadowMapped )	Determines the relevance of this primitive's elements to the given light.
uint32	GetMemoryFootprint()	Every derived class should override these functions
FPrimitiveVi...	GetViewRelevance ( const FSceneView* View )	Determines the relevance of this primitive's elements to the given view.
bool	HeightfieldHasPendingStreaming()
void	OnLevelAddedToWorld()	Called to notify the proxy that the level has been fully added to the world and the primitive will now be rendered.
void	OnTransformChanged()	Called to notify the proxy when its transform has been updated.

Overridden from FLandscapeNeighborInfo

		Name	Description
	const ULands...	GetLandscapeComponent()

Classes

	Name	Description
	FViewCustomDataLOD	NOTE: CustomData is added in a FMemStack of the render thread, so no destructor will be called on any of the elements.
	FViewCustomDataSubSectionLOD	NOTE: CustomData is added in a FMemStack of the render thread, so no destructor will be called on any of the elements.

Constants

Name	Description
MAX_SUBSECTION_COUNT
SharedBuffersMap	Reference counted vertex and index buffer shared among all landscape scene proxies of the same component size Key is the component size and number of subsections.

Deprecated Variables

		Name	Description
	ELandscapeLODFa...	LODFalloff_DEPRECATED

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

Take our survey

Dismiss