Navigation
API > API/Runtime > API/Runtime/Landscape
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.
| Name | FLandscapePhysicalMaterialRenderTask |
| Type | class |
| Header File | /Engine/Source/Runtime/Landscape/Classes/LandscapePhysicalMaterial.h |
| Include Path | #include "LandscapePhysicalMaterial.h" |
Syntax
class FLandscapePhysicalMaterialRenderTask
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| LandscapePhysicalMaterial.h | |||
| LandscapePhysicalMaterial.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
~FLandscapePhysicalMaterialRenderTask() |
LandscapePhysicalMaterial.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| Hash | uint32 | LandscapePhysicalMaterial.h | ||
| PoolHandle | int32 | LandscapePhysicalMaterial.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void Flush() |
Flush a task to completion. This may stall waiting for completion. | LandscapePhysicalMaterial.h | |
uint32 GetHash() |
LandscapePhysicalMaterial.h | ||
TArray< uint8 > const & GetResultIds() |
Get the result data. Assumes that IsComplete() is true. This doesn't Release() the data. | LandscapePhysicalMaterial.h | |
TArray< class UPhysicalMaterial * > const & GetResultMaterials() |
Get the result data. Assumes that IsComplete() is true. This doesn't Release() the data. | LandscapePhysicalMaterial.h | |
bool Init
(
ULandscapeComponent const* LandscapeComponent, |
Initialize the task for a component. | LandscapePhysicalMaterial.h | |
bool IsComplete() |
Returns true if the task is complete and the result is available. | LandscapePhysicalMaterial.h | |
bool IsInProgress() |
Is this Task in progress (valid and incomplete) | LandscapePhysicalMaterial.h | |
bool IsValid() |
Returns true if Init() has been called without a Release(). | LandscapePhysicalMaterial.h | |
void Release () |
Release the task. | LandscapePhysicalMaterial.h | |
void Tick() |
Update a task. Does nothing if the task is complete. | LandscapePhysicalMaterial.h |