UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
UE::FDerivedData Class Reference

#include <DerivedData.h>

Public Member Functions

 FDerivedData ()=default
 
 FDerivedData (const DerivedData::Private::FCookedData &CookedData)
 
void Reset ()
 
bool IsNull () const
 
 operator bool () const
 
bool HasData () const
 
bool IsCooked () const
 
EDerivedDataFlags GetFlags () const
 
UE_API bool ReferenceEquals (const FDerivedData &Other) const
 
UE_API uint32 ReferenceHash () const
 
UE_API void Serialize (FArchive &Ar, UObject *Owner)
 

Static Public Attributes

static const FDerivedData Null
 

Friends

UE_API friend FStringBuilderBaseoperator<< (FStringBuilderBase &Builder, const FDerivedData &DerivedData)
 

Detailed Description

Derived Data Reference

Provides a consistent way to reference derived data:

  • That has the same API for the editor as for builds with cooked packages.
  • That has the same API to load from the cache as from a raw buffer, a compressed buffer, or a cooked package.
  • That supports asynchronous, event-driven, prioritized loading of derived data.
  • That supports saving to a cooked package without loading from the cache, when using Zen.
  • That replaces serialized bulk data, such as FByteBulkData, in a cooked package.

Constructor & Destructor Documentation

◆ FDerivedData() [1/2]

UE::FDerivedData::FDerivedData ( )
default

Constructs a null reference.

◆ FDerivedData() [2/2]

UE::FDerivedData::FDerivedData ( const DerivedData::Private::FCookedData CookedData)
inlineexplicit

Constructs a reference from the private representation of a cooked reference.

Member Function Documentation

◆ GetFlags()

EDerivedDataFlags UE::FDerivedData::GetFlags ( ) const
inline

Returns the flags, which are mainly relevant for staged references.

◆ HasData()

bool UE::FDerivedData::HasData ( ) const
inline

Returns true if this is a non-null reference.

◆ IsCooked()

bool UE::FDerivedData::IsCooked ( ) const
inline

Returns true if this is a cooked reference.

◆ IsNull()

bool UE::FDerivedData::IsNull ( ) const
inline

Returns true if this is a null reference.

◆ operator bool()

UE::FDerivedData::operator bool ( ) const
inlineexplicit

Returns true if this is a non-null reference.

◆ ReferenceEquals()

bool UE::FDerivedData::ReferenceEquals ( const FDerivedData Other) const

Returns true if this and the other are equivalent references.

◆ ReferenceHash()

uint32 UE::FDerivedData::ReferenceHash ( ) const

Returns a hash that factors in the same members as ReferenceEquals.

◆ Reset()

void UE::FDerivedData::Reset ( )
inline

Resets the reference to null.

◆ Serialize()

void UE::FDerivedData::Serialize ( FArchive Ar,
UObject Owner 
)

Serializes this reference to or from a cooked package.

Friends And Related Symbol Documentation

◆ operator<<

UE_API friend FStringBuilderBase & operator<< ( FStringBuilderBase Builder,
const FDerivedData DerivedData 
)
friend

Appends the name and description of this reference to the builder.

Member Data Documentation

◆ Null

const FDerivedData UE::FDerivedData::Null
inlinestatic

A null reference.


The documentation for this class was generated from the following files: