1. Epic GamesDeveloper
  3. FResourceSizeEx

FResourceSizeEx

Struct used to count up the amount of memory used by a resource.

API > API/Runtime > API/Runtime/Core

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

   
Name FResourceSizeEx
Type struct
Header File /Engine/Source/Runtime/Core/Public/ProfilingDebugging/ResourceSize.h
Include Path #include "ProfilingDebugging/ResourceSize.h"

Syntax

struct FResourceSizeEx

Constructors

Name Remarks Include Path Unreal Specifiers

FResourceSizeEx ( const EResourceSizeMode::Type InResourceSizeMode
)

 Construct using a given mode. ProfilingDebugging/ResourceSize.h  
Default constructor. ProfilingDebugging/ResourceSize.h  

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

 Construct from known sizes. ProfilingDebugging/ResourceSize.h  

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

 Construct from legacy unknown size. Deliberately explicit to avoid accidental use. ProfilingDebugging/ResourceSize.h  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
DedicatedSystemMemoryBytesMap TMap< FName, SIZE_T > The number of bytes of memory that this resource is using for CPU resources that have been allocated from dedicated system memory. ProfilingDebugging/ResourceSize.h  
DedicatedVideoMemoryBytesMap TMap< FName, SIZE_T > The number of bytes of memory that this resource is using for GPU resources that have been allocated from dedicated video memory. ProfilingDebugging/ResourceSize.h  
ResourceSizeMode EResourceSizeMode::Type Type of resource size held in this struct. ProfilingDebugging/ResourceSize.h  
UnknownMemoryBytesMap TMap< FName, SIZE_T > The number of bytes of memory that this resource is using from an unspecified section of memory. ProfilingDebugging/ResourceSize.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

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

   ProfilingDebugging/ResourceSize.h  

FResourceSizeEx & AddDedicatedSystemMemoryBytes ( const SIZE_T InMemoryBytes
)

 Add the given number of bytes to the dedicated system memory count. ProfilingDebugging/ResourceSize.h  

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

   ProfilingDebugging/ResourceSize.h  

FResourceSizeEx & AddDedicatedVideoMemoryBytes ( const SIZE_T InMemoryBytes
)

 Add the given number of bytes to the dedicated video memory count. ProfilingDebugging/ResourceSize.h  

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

   ProfilingDebugging/ResourceSize.h  

FResourceSizeEx & AddUnknownMemoryBytes ( const SIZE_T InMemoryBytes
)

 Add the given number of bytes to the unknown memory count. ProfilingDebugging/ResourceSize.h  
Get the number of bytes allocated from dedicated system memory. ProfilingDebugging/ResourceSize.h  
Get the number of bytes allocated from dedicated video memory. ProfilingDebugging/ResourceSize.h  

EResourceSizeMode::Type GetResourceSizeMode()

 Get the type of resource size held in this struct. ProfilingDebugging/ResourceSize.h  

SIZE_T GetTotalMemoryBytes()

 Get the total number of bytes allocated from any memory. ProfilingDebugging/ResourceSize.h  
Get the number of bytes allocated from unknown memory. ProfilingDebugging/ResourceSize.h  

void LogSummary ( FOutputDevice& Ar
) const

   ProfilingDebugging/ResourceSize.h  

Operators

Name Remarks Include Path Unreal Specifiers

FResourceSizeEx & operator+= ( const FResourceSizeEx& InRHS
)

 Add another FResourceSizeEx to this one. ProfilingDebugging/ResourceSize.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page