UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FResourceSizeEx Struct Reference

#include <ResourceSize.h>

Public Member Functions

CORE_API FResourceSizeEx ()
 
CORE_API FResourceSizeEx (const EResourceSizeMode::Type InResourceSizeMode)
 
CORE_API FResourceSizeEx (const EResourceSizeMode::Type InResourceSizeMode, const SIZE_T InDedicatedSystemMemoryBytes, const SIZE_T InDedicatedVideoMemoryBytes)
 
CORE_API FResourceSizeEx (const EResourceSizeMode::Type InResourceSizeMode, const SIZE_T InUnknownMemoryBytes)
 
CORE_API void LogSummary (FOutputDevice &Ar) const
 
CORE_API EResourceSizeMode::Type GetResourceSizeMode () const
 
CORE_API FResourceSizeExAddDedicatedSystemMemoryBytes (const FName &Tag, const SIZE_T InMemoryBytes)
 
CORE_API FResourceSizeExAddDedicatedSystemMemoryBytes (const SIZE_T InMemoryBytes)
 
CORE_API SIZE_T GetDedicatedSystemMemoryBytes () const
 
CORE_API FResourceSizeExAddDedicatedVideoMemoryBytes (const FName &Tag, const SIZE_T InMemoryBytes)
 
CORE_API FResourceSizeExAddDedicatedVideoMemoryBytes (const SIZE_T InMemoryBytes)
 
CORE_API SIZE_T GetDedicatedVideoMemoryBytes () const
 
CORE_API FResourceSizeExAddUnknownMemoryBytes (const FName &Tag, const SIZE_T InMemoryBytes)
 
CORE_API FResourceSizeExAddUnknownMemoryBytes (const SIZE_T InMemoryBytes)
 
CORE_API SIZE_T GetUnknownMemoryBytes () const
 
CORE_API SIZE_T GetTotalMemoryBytes () const
 
CORE_API FResourceSizeExoperator+= (const FResourceSizeEx &InRHS)
 

Detailed Description

Struct used to count up the amount of memory used by a resource. This is typically used for assets via UObject::GetResourceSizeEx(...).

Constructor & Destructor Documentation

◆ FResourceSizeEx() [1/4]

FResourceSizeEx::FResourceSizeEx ( )
explicit

Default constructor.

◆ FResourceSizeEx() [2/4]

FResourceSizeEx::FResourceSizeEx ( const EResourceSizeMode::Type  InResourceSizeMode)
explicit

Construct using a given mode.

◆ FResourceSizeEx() [3/4]

FResourceSizeEx::FResourceSizeEx ( const EResourceSizeMode::Type  InResourceSizeMode,
const SIZE_T  InDedicatedSystemMemoryBytes,
const SIZE_T  InDedicatedVideoMemoryBytes 
)

Construct from known sizes.

◆ FResourceSizeEx() [4/4]

FResourceSizeEx::FResourceSizeEx ( const EResourceSizeMode::Type  InResourceSizeMode,
const SIZE_T  InUnknownMemoryBytes 
)

Construct from legacy unknown size. Deliberately explicit to avoid accidental use.

Member Function Documentation

◆ AddDedicatedSystemMemoryBytes() [1/2]

FResourceSizeEx & FResourceSizeEx::AddDedicatedSystemMemoryBytes ( const FName Tag,
const SIZE_T  InMemoryBytes 
)

◆ AddDedicatedSystemMemoryBytes() [2/2]

FResourceSizeEx & FResourceSizeEx::AddDedicatedSystemMemoryBytes ( const SIZE_T  InMemoryBytes)

Add the given number of bytes to the dedicated system memory count.

See also
DedicatedSystemMemoryBytes for a description of that memory type.

◆ AddDedicatedVideoMemoryBytes() [1/2]

FResourceSizeEx & FResourceSizeEx::AddDedicatedVideoMemoryBytes ( const FName Tag,
const SIZE_T  InMemoryBytes 
)

◆ AddDedicatedVideoMemoryBytes() [2/2]

FResourceSizeEx & FResourceSizeEx::AddDedicatedVideoMemoryBytes ( const SIZE_T  InMemoryBytes)

Add the given number of bytes to the dedicated video memory count.

See also
DedicatedVideoMemoryBytes for a description of that memory type.

◆ AddUnknownMemoryBytes() [1/2]

FResourceSizeEx & FResourceSizeEx::AddUnknownMemoryBytes ( const FName Tag,
const SIZE_T  InMemoryBytes 
)

◆ AddUnknownMemoryBytes() [2/2]

FResourceSizeEx & FResourceSizeEx::AddUnknownMemoryBytes ( const SIZE_T  InMemoryBytes)

Add the given number of bytes to the unknown memory count.

See also
UnknownMemoryBytes for a description of that memory type.

◆ GetDedicatedSystemMemoryBytes()

SIZE_T FResourceSizeEx::GetDedicatedSystemMemoryBytes ( ) const

Get the number of bytes allocated from dedicated system memory.

See also
DedicatedSystemMemoryBytes for a description of that memory type.

◆ GetDedicatedVideoMemoryBytes()

SIZE_T FResourceSizeEx::GetDedicatedVideoMemoryBytes ( ) const

Get the number of bytes allocated from dedicated video memory.

See also
DedicatedVideoMemoryBytes for a description of that memory type.

◆ GetResourceSizeMode()

EResourceSizeMode::Type FResourceSizeEx::GetResourceSizeMode ( ) const

Get the type of resource size held in this struct.

◆ GetTotalMemoryBytes()

SIZE_T FResourceSizeEx::GetTotalMemoryBytes ( ) const

Get the total number of bytes allocated from any memory.

◆ GetUnknownMemoryBytes()

SIZE_T FResourceSizeEx::GetUnknownMemoryBytes ( ) const

Get the number of bytes allocated from unknown memory.

See also
UnknownMemoryBytes for a description of that memory type.

◆ LogSummary()

void FResourceSizeEx::LogSummary ( FOutputDevice Ar) const

◆ operator+=()

FResourceSizeEx & FResourceSizeEx::operator+= ( const FResourceSizeEx InRHS)

Add another FResourceSizeEx to this one.


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