You've already forked UnrealEngineUWP
mirror of
https://github.com/izzy2lost/UnrealEngineUWP.git
synced 2026-03-26 18:15:20 -07:00
9c01e2fc04
#rb Zousar.Shaker #rnx #ROBOMERGE-SOURCE: CL 17426140 in //UE5/Main/... #ROBOMERGE-BOT: STARSHIP (Main -> Release-Engine-Test) (v865-17346139) [CL 17426194 by devin doucette in ue5-release-engine-test branch]
121 lines
3.7 KiB
C++
121 lines
3.7 KiB
C++
// Copyright Epic Games, Inc. All Rights Reserved.
|
|
|
|
#pragma once
|
|
|
|
#include "CoreTypes.h"
|
|
#include "Compression/CompressedBuffer.h"
|
|
#include "DerivedDataPayloadId.h"
|
|
#include "IO/IoHash.h"
|
|
|
|
namespace UE::DerivedData
|
|
{
|
|
|
|
/**
|
|
* A payload is described by an ID and by the hash and size of its raw buffer (uncompressed).
|
|
*
|
|
* Payloads may be constructed with or without data in the form of a compressed buffer. A payload
|
|
* without data can be used as a reference to the payload.
|
|
*/
|
|
class FPayload
|
|
{
|
|
public:
|
|
/** Construct a null payload. */
|
|
FPayload() = default;
|
|
|
|
/** Construct a payload with no hash, size, or data. */
|
|
inline explicit FPayload(const FPayloadId& Id);
|
|
|
|
/** Construct a payload from a the hash and size of the raw buffer. */
|
|
inline FPayload(const FPayloadId& Id, const FIoHash& RawHash, uint64 RawSize);
|
|
|
|
/** Construct a payload from a compressed buffer, which is cloned if not owned. */
|
|
inline FPayload(const FPayloadId& Id, const FCompressedBuffer& Data);
|
|
inline FPayload(const FPayloadId& Id, FCompressedBuffer&& Data);
|
|
|
|
/** Returns the ID for the payload. */
|
|
inline const FPayloadId& GetId() const { return Id; }
|
|
|
|
/** Returns the hash of the raw buffer (uncompressed) for the payload. */
|
|
inline const FIoHash& GetRawHash() const { return RawHash; }
|
|
|
|
/** Returns the size of the raw buffer (uncompressed) for the payload. */
|
|
inline uint64 GetRawSize() const { return RawSize; }
|
|
|
|
/** Returns the compressed buffer for the payload. May be null. */
|
|
inline const FCompressedBuffer& GetData() const { return Data; }
|
|
|
|
/** Whether the compressed buffer for the payload is available. */
|
|
inline bool HasData() const { return !!Data; }
|
|
|
|
/** Whether this is null. */
|
|
inline bool IsNull() const { return Id.IsNull(); }
|
|
/** Whether this is not null. */
|
|
inline bool IsValid() const { return !IsNull(); }
|
|
/** Whether this is not null. */
|
|
inline explicit operator bool() const { return IsValid(); }
|
|
|
|
/** Reset this to null. */
|
|
inline void Reset() { *this = FPayload(); }
|
|
|
|
/** A null payload. */
|
|
static const FPayload Null;
|
|
|
|
private:
|
|
FPayloadId Id;
|
|
FIoHash RawHash;
|
|
uint64 RawSize = 0;
|
|
FCompressedBuffer Data;
|
|
};
|
|
|
|
inline const FPayload FPayload::Null;
|
|
|
|
inline FPayload::FPayload(const FPayloadId& InId)
|
|
: Id(InId)
|
|
{
|
|
checkf(Id.IsValid(), TEXT("A valid ID is required to construct a payload."));
|
|
}
|
|
|
|
inline FPayload::FPayload(const FPayloadId& InId, const FIoHash& InRawHash, const uint64 InRawSize)
|
|
: Id(InId)
|
|
, RawHash(InRawHash)
|
|
, RawSize(InRawSize)
|
|
{
|
|
checkf(Id.IsValid(), TEXT("A valid ID is required to construct a payload."));
|
|
}
|
|
|
|
inline FPayload::FPayload(const FPayloadId& InId, const FCompressedBuffer& InData)
|
|
: Id(InId)
|
|
, RawHash(InData.GetRawHash())
|
|
, RawSize(InData.GetRawSize())
|
|
, Data(InData.MakeOwned())
|
|
{
|
|
checkf(Id.IsValid(), TEXT("A valid ID is required to construct a payload."));
|
|
}
|
|
|
|
inline FPayload::FPayload(const FPayloadId& InId, FCompressedBuffer&& InData)
|
|
: Id(InId)
|
|
, RawHash(InData.GetRawHash())
|
|
, RawSize(InData.GetRawSize())
|
|
, Data(MoveTemp(InData).MakeOwned())
|
|
{
|
|
checkf(Id.IsValid(), TEXT("A valid ID is required to construct a payload."));
|
|
}
|
|
|
|
/** Compare payloads by their ID and the hash and size of their raw buffer. */
|
|
inline bool operator==(const FPayload& A, const FPayload& B)
|
|
{
|
|
return A.GetId() == B.GetId() && A.GetRawHash() == B.GetRawHash() && A.GetRawSize() == B.GetRawSize();
|
|
}
|
|
|
|
/** Compare payloads by their ID and the hash and size of their raw buffer. */
|
|
inline bool operator<(const FPayload& A, const FPayload& B)
|
|
{
|
|
const FPayloadId& IdA = A.GetId();
|
|
const FPayloadId& IdB = B.GetId();
|
|
const FIoHash& HashA = A.GetRawHash();
|
|
const FIoHash& HashB = B.GetRawHash();
|
|
return !(IdA == IdB) ? IdA < IdB : !(HashA == HashB) ? HashA < HashB : A.GetRawSize() < B.GetRawSize();
|
|
}
|
|
|
|
} // UE::DerivedData
|