You've already forked UnrealEngineUWP
mirror of
https://github.com/izzy2lost/UnrealEngineUWP.git
synced 2026-03-26 18:15:20 -07:00
4bffbab5d7
* Added list of layers affected to each channel to the weightmap readback struct, in order to properly analyze the content of the texture when the weightmap layer allocations might have changed on the component since the moment the readback was issued #rb luc.eygasier #preflight 62d7d0f01133256db643a10d #tests UEENGQA-74353 #ROBOMERGE-AUTHOR: jonathan.bard #ROBOMERGE-SOURCE: CL 21178628 via CL 21178949 via CL 21181390 #ROBOMERGE-BOT: UE5 (Release-Engine-Staging -> Main) (v972-20964824) [CL 21192538 by jonathan bard in ue5-main branch]
74 lines
3.2 KiB
C++
74 lines
3.2 KiB
C++
// Copyright Epic Games, Inc. All Rights Reserved.
|
|
|
|
#pragma once
|
|
|
|
#include "CoreMinimal.h"
|
|
#include "TextureResource.h"
|
|
|
|
/**
|
|
* Read back queue for a landscape edit layer texture.
|
|
* This handles reading landscape edit data back from the GPU to the game thread.
|
|
* Multiple read backs can be queued in a single object and any completed results can be retrieved.
|
|
* Tick() must be called regularly to update the internal read back tasks.
|
|
* When results are available GetCompletedResultNum() will be greater than zero.
|
|
* After getting latest results with GetResult()/GetResultContext() you should call ReleaseCompletedResults() to prevent leaks.
|
|
*/
|
|
class FLandscapeEditLayerReadback
|
|
{
|
|
public:
|
|
FLandscapeEditLayerReadback();
|
|
~FLandscapeEditLayerReadback();
|
|
|
|
/** Hash function to generate a hash used to detect change in read back data. This expects to take raw data from first mip. */
|
|
static uint32 CalculateHash(const uint8* InMipData, int32 InSizeInBytes);
|
|
|
|
/** Update the stored hash value. Return true if this changes the value. */
|
|
bool SetHash(uint32 InHash);
|
|
/** Get the stored hash value. */
|
|
uint32 GetHash() const { return Hash; }
|
|
|
|
using FPerChannelLayerNames = TStaticArray<FName, 4>;
|
|
|
|
/** Per component context required for processing read back results. */
|
|
struct FComponentReadbackContext
|
|
{
|
|
/** Component identifier key. */
|
|
FIntPoint ComponentKey;
|
|
/** Component ELandscapeLayerUpdateMode flags. */
|
|
int32 UpdateModes = 0;
|
|
/** For weightmaps only : configuration of the channels for this component and texture when the readback was performed (useful in case the channel configuration changed before we could perform the readback) */
|
|
FPerChannelLayerNames PerChannelLayerNames;
|
|
};
|
|
/** Full context for processing read back results. */
|
|
using FReadbackContext = TArray<FComponentReadbackContext>;
|
|
|
|
/** Queue a new texture to read back. The GPU copy will be queued to the render thread inside this function. */
|
|
void Enqueue(UTexture2D const* InSourceTexture, FReadbackContext&& InReadbackContext);
|
|
|
|
/* Tick the read back tasks. */
|
|
void Tick();
|
|
/* Flush all read back tasks to completion. This may stall waiting for the render thread. */
|
|
void Flush();
|
|
|
|
/** Returns a value greater than 0 if there are completed read back tasks for which we can retrieve results. */
|
|
int32 GetCompletedResultNum() const;
|
|
|
|
/** Get the result for the completed task index. Returned reference will be valid until we next call ReleaseCompletedResults(). */
|
|
TArray< TArray<FColor> > const& GetResult(int32 InResultIndex) const;
|
|
/** Get the result context for the completed task index. Returned reference will be valid until we next call ReleaseCompletedResults(). */
|
|
FReadbackContext const& GetResultContext(int32 InResultIndex) const;
|
|
|
|
/* Release results. Pass in a value which is no more than the value returned by GetCompletedResultNum(). */
|
|
void ReleaseCompletedResults(int32 InResultNum);
|
|
|
|
/** Returns true if there are any queued tasks that haven't been released. */
|
|
static bool HasWork();
|
|
|
|
/** Optional call to allow garbage collection of any task resources and check for leaks. Call once per frame. */
|
|
static void GarbageCollectTasks();
|
|
|
|
private:
|
|
uint32 Hash;
|
|
TArray<int32> TaskHandles;
|
|
};
|