FAudioStreamCacheMemoryHandle Class Reference

#include <AudioStreamCacheMemoryHandle.h>

Inheritance diagram for FAudioStreamCacheMemoryHandle:

Public Member Functions
UE_API	FAudioStreamCacheMemoryHandle (FName InFeatureName, uint64 InMemoryUseInBytes)
UE_API	~FAudioStreamCacheMemoryHandle ()
uint64	GetMemoryUseInBytes () const
FName	GetFeatureName () const
UE_API void	ResetMemoryUseInBytes (uint64 InMemoryUseInBytes)

Additional Inherited Members
Protected Member Functions inherited from FNoncopyable
	FNoncopyable ()
	~FNoncopyable ()

Detailed Description

Class for utilizing memory in the stream cache budget for an unrelated, temporary audio-based feature. Allows us to borrow from budgeted memory for audio features that would otherwise not fit in the overall memory budget.

Usage:

• Create an instance of this class on an object or subsystem where want to track memory usage
• Memory usage will immediately be taken out of the Audio Stream Cache budget on construction of the object
• Update memory usage via this class as necessary.
• Deleting the instance will automatically reset the memory usage to 0

Constructor & Destructor Documentation

FAudioStreamCacheMemoryHandle()

FAudioStreamCacheMemoryHandle::FAudioStreamCacheMemoryHandle	(	FName	InFeatureName,
		uint64	InMemoryUseInBytes
	)

~FAudioStreamCacheMemoryHandle()

FAudioStreamCacheMemoryHandle::~FAudioStreamCacheMemoryHandle

(

)

Member Function Documentation

GetFeatureName()

FName FAudioStreamCacheMemoryHandle::GetFeatureName ( ) const

inline

GetMemoryUseInBytes()

uint64 FAudioStreamCacheMemoryHandle::GetMemoryUseInBytes ( ) const

inline

ResetMemoryUseInBytes()

void FAudioStreamCacheMemoryHandle::ResetMemoryUseInBytes

(

uint64

InMemoryUseInBytes

)

---

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

• Engine/Source/Runtime/Engine/Public/AudioStreamCacheMemoryHandle.h
• Engine/Source/Runtime/Engine/Private/AudioStreamCacheMemoryHandle.cpp