FLandscapePhysicalMaterialRenderTask

A single task for calculating the landscape physical material.

Choose your operating system:

Windows

macOS

Linux

References

Module

Landscape

Header

/Engine/Source/Runtime/Landscape/Classes/LandscapePhysicalMaterial.h

Include

#include "LandscapePhysicalMaterial.h"

Syntax

class FLandscapePhysicalMaterialRenderTask

Remarks

A single task for calculating the landscape physical material. The work uses the GPU so this object handles reading back the data without stalling. We need to call Tick() until IsComplete() returns true. We need to call Release() after use to prevent leaking of internal objects. All calls are expected to be made on the game thread only.

Constructors

Name Description

Public function

FLandscapePhysicalMaterialRenderTask()

Task constructs with IsValid() false.

Destructors

Functions

Name Description

Public function

void

 

Flush()

Flush a task to completion. This may stall waiting for completion.

Public function Const

TArray< uint...

 

GetResultIds()

Get the result data.

Public function Const

TArray< clas...

 

GetResultMaterials()

Get the result data.

Public function

void

 

Init

(
    ULandscapeComponent const* Lan...
)

Initialize the task for a component.

Public function Const

bool

 

IsComplete()

Returns true if the task is complete and the result is available.

Public function Const

bool

 

IsValid()

Returns true if Init() has been called without a Release().

Public function

void

 

Release()

Release the task.

Public function

void

 

Tick()

Update a task. Does nothing if the task is complete.